Structuremigueldeicaza.swiftgodot 0.46.0SwiftGodot

Rect2

A 2D axis-aligned bounding box using floating-point coordinates.

struct Rect2

Mangled symbol

s10SwiftGodot5Rect2VWhat are these?

FNV24: [7UY52]

The Rect2 built-in Variant type represents an axis-aligned rectangle in a 2D space. It is defined by its position and size, which are Vector2. It is frequently used for fast overlap tests (see intersects(b:includeBorders:)). Although Rect2 itself is axis-aligned, it can be combined with Transform2D to represent a rotated or skewed rectangle.

For integer coordinates, use Rect2i. The 3D equivalent to Rect2 is AABB.

Citizens in SwiftGodot

Conformances

protocol Copyable
A type whose values can be implicitly or explicitly copied.
protocol Equatable
A type that can be compared for value equality.
protocol Escapable
protocol Hashable
A type that can be hashed into a Hasher to produce an integer hash value.
protocol SelfVariantRepresentable
Structs and scalar types use their own layout for storage.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.
protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Type members

init()
Constructs a Rect2 with its position and size set to Vector2.ZERO.
init(from: Rect2)
Constructs a Rect2 as a copy of the given Rect2.
init(from: Rect2i)
Constructs a Rect2 from a Rect2i.
init(position: Vector2, size: Vector2)
Constructs a Rect2 by position and size.
init(x: Float, y: Float, width: Float, height: Float)
Constructs a Rect2 by setting its position to (x, y), and its size to (width, height).
static var godotType: Variant.GType
static func != (lhs: Rect2, rhs: Rect2) -> Bool
Returns true if the position or size of both rectangles are not equal.
static func * (lhs: Rect2, rhs: Transform2D) -> Rect2
Inversely transforms (multiplies) the Rect2 by the given Transform2D transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).
static func == (lhs: Rect2, rhs: Rect2) -> Bool
Returns true if both position and size of the rectangles are exactly equal, respectively.

Instance members

var end: Vector2
The ending point. This is usually the bottom-right corner of the rectangle, and is equivalent to position + size. Setting this point affects the size.
var position: Vector2
The origin point. This is usually the top-left corner of the rectangle.
var size: Vector2
The rectangle’s width and height, starting from position. Setting this value also affects the end point.
func abs() -> Rect2
Returns a Rect2 equivalent to this rectangle, with its width and height modified to be non-negative values, and with its position being the top-left corner of the rectangle.
func encloses(b: Rect2) -> Bool
Returns true if this rectangle completely encloses the b rectangle.
func expand(to: Vector2) -> Rect2
Returns a copy of this rectangle expanded to align the edges with the given to point, if necessary.
func getArea() -> Double
Returns the rectangle’s area. This is equivalent to size.x * size.y. See also hasArea.
func getCenter() -> Vector2
Returns the center point of the rectangle. This is the same as position + (size / 2.0).
func grow(amount: Double) -> Rect2
Returns a copy of this rectangle extended on all sides by the given amount. A negative amount shrinks the rectangle instead. See also growIndividual(left:top:right:bottom:) and growSide(side:amount:).
func growIndividual(left: Double, top: Double, right: Double, bottom: Double) -> Rect2
Returns a copy of this rectangle with its left, top, right, and bottom sides extended by the given amounts. Negative values shrink the sides, instead. See also grow(amount:) and growSide(side:amount:).
func growSide(Int64, amount: Double) -> Rect2
Returns a copy of this rectangle with its side extended by the given amount (see Side constants). A negative amount shrinks the rectangle, instead. See also grow(amount:) and growIndividual(left:top:right:bottom:).
func hasArea() -> Bool
Returns true if this rectangle has positive width and height. See also getArea.
func hasPoint(Vector2) -> Bool
Returns true if the rectangle contains the given point. By convention, points on the right and bottom edges are not included.
func intersection(b: Rect2) -> Rect2
Returns the intersection between this rectangle and b. If the rectangles do not intersect, returns an empty Rect2.
func intersects(b: Rect2, includeBorders: Bool) -> Bool
Returns true if this rectangle overlaps with the b rectangle. The edges of both rectangles are excluded, unless includeBorders is true.
func isEqualApprox(rect: Rect2) -> Bool
Returns true if this rectangle and rect are approximately equal, by calling isEqualApprox(to:) on the position and the size.
func isFinite() -> Bool
Returns true if this rectangle’s values are finite, by calling isFinite on the position and the size.
func merge(b: Rect2) -> Rect2
Returns a Rect2 that encloses both this rectangle and b around the edges. See also encloses(b:).

Type features