// CGSizeExtensions.swift - Copyright 2024 SwifterSwift
|
|
#if canImport(CoreGraphics)
|
import CoreGraphics
|
|
// MARK: - Methods
|
|
public extension CGSize {
|
/// SwifterSwift: Returns the aspect ratio.
|
var aspectRatio: CGFloat {
|
guard height != 0 else { return 0 }
|
return width / height
|
}
|
|
/// SwifterSwift: Returns width or height, whichever is the bigger value.
|
var maxDimension: CGFloat {
|
return max(width, height)
|
}
|
|
/// SwifterSwift: Returns width or height, whichever is the smaller value.
|
var minDimension: CGFloat {
|
return min(width, height)
|
}
|
}
|
|
// MARK: - Methods
|
|
public extension CGSize {
|
/// SwifterSwift: Aspect fit CGSize.
|
///
|
/// let rect = CGSize(width: 120, height: 80)
|
/// let parentRect = CGSize(width: 100, height: 50)
|
/// let newRect = rect.aspectFit(to: parentRect)
|
/// // newRect.width = 75 , newRect = 50
|
///
|
/// - Parameter boundingSize: bounding size to fit self to.
|
/// - Returns: self fitted into given bounding size.
|
func aspectFit(to boundingSize: CGSize) -> CGSize {
|
let minRatio = min(boundingSize.width / width, boundingSize.height / height)
|
return CGSize(width: width * minRatio, height: height * minRatio)
|
}
|
|
/// SwifterSwift: Aspect fill CGSize.
|
///
|
/// let rect = CGSize(width: 20, height: 120)
|
/// let parentRect = CGSize(width: 100, height: 60)
|
/// let newRect = rect.aspectFit(to: parentRect)
|
/// // newRect.width = 100 , newRect = 60
|
///
|
/// - Parameter boundingSize: bounding size to fill self to.
|
/// - Returns: self filled into given bounding size.
|
func aspectFill(to boundingSize: CGSize) -> CGSize {
|
let minRatio = max(boundingSize.width / width, boundingSize.height / height)
|
let aWidth = min(width * minRatio, boundingSize.width)
|
let aHeight = min(height * minRatio, boundingSize.height)
|
return CGSize(width: aWidth, height: aHeight)
|
}
|
}
|
|
// MARK: - Operators
|
|
public extension CGSize {
|
/// SwifterSwift: Add two CGSize.
|
///
|
/// let sizeA = CGSize(width: 5, height: 10)
|
/// let sizeB = CGSize(width: 3, height: 4)
|
/// let result = sizeA + sizeB
|
/// // result = CGSize(width: 8, height: 14)
|
///
|
/// - Parameters:
|
/// - lhs: CGSize to add to.
|
/// - rhs: CGSize to add.
|
/// - Returns: The result comes from the addition of the two given CGSize struct.
|
static func + (lhs: CGSize, rhs: CGSize) -> CGSize {
|
return CGSize(width: lhs.width + rhs.width, height: lhs.height + rhs.height)
|
}
|
|
/// SwifterSwift: Add a tuple to CGSize.
|
///
|
/// let sizeA = CGSize(width: 5, height: 10)
|
/// let result = sizeA + (5, 4)
|
/// // result = CGSize(width: 10, height: 14)
|
///
|
/// - Parameters:
|
/// - lhs: CGSize to add to.
|
/// - tuple: tuple value.
|
/// - Returns: The result comes from the addition of the given CGSize and tuple.
|
static func + (lhs: CGSize, tuple: (width: CGFloat, height: CGFloat)) -> CGSize {
|
return CGSize(width: lhs.width + tuple.width, height: lhs.height + tuple.height)
|
}
|
|
/// SwifterSwift: Add a CGSize to self.
|
///
|
/// var sizeA = CGSize(width: 5, height: 10)
|
/// let sizeB = CGSize(width: 3, height: 4)
|
/// sizeA += sizeB
|
/// // sizeA = CGPoint(width: 8, height: 14)
|
///
|
/// - Parameters:
|
/// - lhs: `self`.
|
/// - rhs: CGSize to add.
|
static func += (lhs: inout CGSize, rhs: CGSize) {
|
lhs.width += rhs.width
|
lhs.height += rhs.height
|
}
|
|
/// SwifterSwift: Add a tuple to self.
|
///
|
/// var sizeA = CGSize(width: 5, height: 10)
|
/// sizeA += (3, 4)
|
/// // result = CGSize(width: 8, height: 14)
|
///
|
/// - Parameters:
|
/// - lhs: `self`.
|
/// - tuple: tuple value.
|
static func += (lhs: inout CGSize, tuple: (width: CGFloat, height: CGFloat)) {
|
lhs.width += tuple.width
|
lhs.height += tuple.height
|
}
|
|
/// SwifterSwift: Subtract two CGSize.
|
///
|
/// let sizeA = CGSize(width: 5, height: 10)
|
/// let sizeB = CGSize(width: 3, height: 4)
|
/// let result = sizeA - sizeB
|
/// // result = CGSize(width: 2, height: 6)
|
///
|
/// - Parameters:
|
/// - lhs: CGSize to subtract from.
|
/// - rhs: CGSize to subtract.
|
/// - Returns: The result comes from the subtract of the two given CGSize struct.
|
static func - (lhs: CGSize, rhs: CGSize) -> CGSize {
|
return CGSize(width: lhs.width - rhs.width, height: lhs.height - rhs.height)
|
}
|
|
/// SwifterSwift: Subtract a tuple from CGSize.
|
///
|
/// let sizeA = CGSize(width: 5, height: 10)
|
/// let result = sizeA - (3, 2)
|
/// // result = CGSize(width: 2, height: 8)
|
///
|
/// - Parameters:
|
/// - lhs: CGSize to subtract from.
|
/// - tuple: tuple value.
|
/// - Returns: The result comes from the subtract of the given CGSize and tuple.
|
static func - (lhs: CGSize, tuple: (width: CGFloat, heoght: CGFloat)) -> CGSize {
|
return CGSize(width: lhs.width - tuple.width, height: lhs.height - tuple.heoght)
|
}
|
|
/// SwifterSwift: Subtract a CGSize from self.
|
///
|
/// var sizeA = CGSize(width: 5, height: 10)
|
/// let sizeB = CGSize(width: 3, height: 4)
|
/// sizeA -= sizeB
|
/// // sizeA = CGPoint(width: 2, height: 6)
|
///
|
/// - Parameters:
|
/// - lhs: `self`.
|
/// - rhs: CGSize to subtract.
|
static func -= (lhs: inout CGSize, rhs: CGSize) {
|
lhs.width -= rhs.width
|
lhs.height -= rhs.height
|
}
|
|
/// SwifterSwift: Subtract a tuple from self.
|
///
|
/// var sizeA = CGSize(width: 5, height: 10)
|
/// sizeA -= (2, 4)
|
/// // result = CGSize(width: 3, height: 6)
|
///
|
/// - Parameters:
|
/// - lhs: `self`.
|
/// - tuple: tuple value.
|
static func -= (lhs: inout CGSize, tuple: (width: CGFloat, height: CGFloat)) {
|
lhs.width -= tuple.width
|
lhs.height -= tuple.height
|
}
|
|
/// SwifterSwift: Multiply two CGSize.
|
///
|
/// let sizeA = CGSize(width: 5, height: 10)
|
/// let sizeB = CGSize(width: 3, height: 4)
|
/// let result = sizeA * sizeB
|
/// // result = CGSize(width: 15, height: 40)
|
///
|
/// - Parameters:
|
/// - lhs: CGSize to multiply.
|
/// - rhs: CGSize to multiply with.
|
/// - Returns: The result comes from the multiplication of the two given CGSize structs.
|
static func * (lhs: CGSize, rhs: CGSize) -> CGSize {
|
return CGSize(width: lhs.width * rhs.width, height: lhs.height * rhs.height)
|
}
|
|
/// SwifterSwift: Multiply a CGSize with a scalar.
|
///
|
/// let sizeA = CGSize(width: 5, height: 10)
|
/// let result = sizeA * 5
|
/// // result = CGSize(width: 25, height: 50)
|
///
|
/// - Parameters:
|
/// - lhs: CGSize to multiply.
|
/// - scalar: scalar value.
|
/// - Returns: The result comes from the multiplication of the given CGSize and scalar.
|
static func * (lhs: CGSize, scalar: CGFloat) -> CGSize {
|
return CGSize(width: lhs.width * scalar, height: lhs.height * scalar)
|
}
|
|
/// SwifterSwift: Multiply a CGSize with a scalar.
|
///
|
/// let sizeA = CGSize(width: 5, height: 10)
|
/// let result = 5 * sizeA
|
/// // result = CGSize(width: 25, height: 50)
|
///
|
/// - Parameters:
|
/// - scalar: scalar value.
|
/// - rhs: CGSize to multiply.
|
/// - Returns: The result comes from the multiplication of the given scalar and CGSize.
|
static func * (scalar: CGFloat, rhs: CGSize) -> CGSize {
|
return CGSize(width: scalar * rhs.width, height: scalar * rhs.height)
|
}
|
|
/// SwifterSwift: Multiply self with a CGSize.
|
///
|
/// var sizeA = CGSize(width: 5, height: 10)
|
/// let sizeB = CGSize(width: 3, height: 4)
|
/// sizeA *= sizeB
|
/// // result = CGSize(width: 15, height: 40)
|
///
|
/// - Parameters:
|
/// - lhs: `self`.
|
/// - rhs: CGSize to multiply.
|
static func *= (lhs: inout CGSize, rhs: CGSize) {
|
lhs.width *= rhs.width
|
lhs.height *= rhs.height
|
}
|
|
/// SwifterSwift: Multiply self with a scalar.
|
///
|
/// var sizeA = CGSize(width: 5, height: 10)
|
/// sizeA *= 3
|
/// // result = CGSize(width: 15, height: 30)
|
///
|
/// - Parameters:
|
/// - lhs: `self`.
|
/// - scalar: scalar value.
|
static func *= (lhs: inout CGSize, scalar: CGFloat) {
|
lhs.width *= scalar
|
lhs.height *= scalar
|
}
|
}
|
|
#endif
|
