GrooveJoint2D
A physics joint that restricts the movement of two 2D physics bodies to a fixed axis.
GrooveJoint2D.swift:17class GrooveJoint2D
A physics joint that restricts the movement of two 2D physics bodies to a fixed axis. For example, a StaticBody2D
representing a piston base can be attached to a RigidBody2D
representing the piston head, moving up and down.
Superclasses
class Joint2D
Abstract base class for all 2D physics joints.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
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 exampleGString
,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
Instance members
var initialOffset: Double
The body B’s initial anchor position defined by the joint’s origin and a local offset
initialOffset
along the joint’s Y axis (along the groove).var length: Double
The groove’s length. The groove is from the joint’s origin towards
length
along the joint’s local Y axis.