Plane
A plane in Hessian normal form.
Plane.swift:14struct PlaneRepresents a normalized plane equation. normal is the normal of the plane (a, b, c normalized), and d is the distance from the origin to the plane (in the direction of “normal”). “Over” or “Above” the plane is considered the side of the plane towards where the normal is pointing.
Citizens in SwiftGodot
Conformances
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol EquatableA type that can be compared for value equality.
protocol Escapableprotocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol SelfVariantRepresentableStructs and scalar types use their own layout for storage.
protocol VariantRepresentableTypes that conform to VariantRepresentable can be stored directly in
Variantwith no conversion. These include all of the Variant types from Godot (for exampleGString,Rect,Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
init() Constructs a default-initialized
Planewith all components set to0.init(a: Float, b: Float, c: Float, d: Float) Creates a plane from the four parameters. The three components of the resulting plane’s
normalarea,bandc, and the plane has a distance ofdfrom the origin.init(from: Plane) init(normal: Vector3) Creates a plane from the normal vector. The plane will intersect the origin.
init(normal: Vector3, d: Float) Creates a plane from the normal vector and the plane’s distance from the origin.
init(normal: Vector3, point: Vector3) Creates a plane from the normal vector and a point on the plane.
init(point1: Vector3, point2: Vector3, point3: Vector3) Creates a plane from the three points, given in clockwise order.
static var godotType: Variant.GTypestatic let planeXy: PlaneA plane that extends in the X and Y axes (normal vector points +Z).
static let planeXz: PlaneA plane that extends in the X and Z axes (normal vector points +Y).
static let planeYz: PlaneA plane that extends in the Y and Z axes (normal vector points +X).
static func != (lhs: Plane, rhs: Plane) -> Bool Returns
trueif the planes are not equal.static func * (lhs: Plane, rhs: Transform3D) -> Plane Inversely transforms (multiplies) the
Planeby the givenTransform3Dtransformation matrix.static func - (p: `Self`) -> Plane Returns the negative value of the Plane. This is the same as writing Plane(-p.normal, -p.d). This operation flips the direction of the normal vector and also flips the distance value, resulting in a Plane that is in the same place, but facing the opposite direction.
static func == (lhs: Plane, rhs: Plane) -> Bool Returns
trueif the planes are exactly equal.
Instance members
var d: FloatThe distance from the origin to the plane, expressed in terms of
normal(according to its direction and magnitude). Actual absolute distance from the origin to the plane can be calculated asabs(d) / normal.length()(ifnormalhas zero length then thisPlanedoes not represent a valid plane).var normal: Vector3The normal of the plane, typically a unit vector. Shouldn’t be a zero vector as
Planewith suchnormaldoes not represent a valid plane.func distanceTo(point: Vector3) -> Double Returns the shortest distance from the plane to the position
point. If the point is above the plane, the distance will be positive. If below, the distance will be negative.func getCenter() -> Vector3 Returns the center of the plane.
func hasPoint(Vector3, tolerance: Double) -> Bool Returns
trueifpointis inside the plane. Comparison uses a custom minimumtolerancethreshold.func intersect3(b: Plane, c: Plane) -> Variant Returns the intersection point of the three planes
b,cand this plane. If no intersection is found,nullis returned.func intersectsRay(from: Vector3, dir: Vector3) -> Variant Returns the intersection point of a ray consisting of the position
fromand the direction normaldirwith this plane. If no intersection is found,nullis returned.func intersectsSegment(from: Vector3, to: Vector3) -> Variant Returns the intersection point of a segment from position
fromto positiontowith this plane. If no intersection is found,nullis returned.func isEqualApprox(toPlane: Plane) -> Bool Returns
trueif this plane andtoPlaneare approximately equal, by running@GlobalScope.is_equal_approxon each component.func isFinite() -> Bool Returns
trueif this plane is finite, by calling@GlobalScope.is_finiteon each component.func isPointOver(point: Vector3) -> Bool Returns
trueifpointis located above the plane.func normalized() -> Plane Returns a copy of the plane, with normalized
normal(so it’s a unit vector). ReturnsPlane(0, 0, 0, 0)ifnormalcan’t be normalized (it has zero length).func project(point: Vector3) -> Vector3 Returns the orthogonal projection of
pointinto a point in the plane.
Type features
init?(Variant) static func makeOrUnwrap(Variant) -> Self? Unwraps an object from a variant.
static func makeOrUnwrap(Variant) -> Self? Unwraps an object from a variant. This is useful when you want one method to call that will return the unwrapped Variant, regardless of whether it is a SwiftGodot.Object or not.
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.