RealityFoundation · IOS API REFERENCE

PhysicsPrismaticJoint

struct · iOS 18.0+ · SDK 27.1

struct PhysicsPrismaticJoint

A joint that allows movement along a straight line, similar to a sliding drawer. `PhysicsPrismaticJoint`, also called a "slider joint", allows one linear degree of freedom along the x-axis between two ``Entity`` pins. - Tip: Pass an orientation when creating the ``GeometricPin`` instances to change the axis of rotation.

Members (10)

get · iOS 18.0+

linearLimit

TypeScript

get linearLimit(): (SDKHandle) | null

Swift declaration

var linearLimit: ClosedRange<Float>?

A limit of the translation between the pins in the direction of the x-axis. If defined, this limits the translation of ``pin1`` from ``pin0``, in the direction of the x-axis of ``pin0``. There is no limit if this property is `nil`.

set · iOS 18.0+

linearLimit

TypeScript

set linearLimit(value: (SDKHandle) | null)

Swift declaration

var linearLimit: ClosedRange<Float>?

get · iOS 18.0+

checksForInternalCollisions

TypeScript

get checksForInternalCollisions(): boolean

Swift declaration

var checksForInternalCollisions: Bool

A Boolean that indicates whether the joint checks and reports collisions between the two entity instances. - Note: This does not affect how collisions of the two entities referenced in ``pin0`` and ``pin1`` interact with other entities.

set · iOS 18.0+

checksForInternalCollisions

TypeScript

set checksForInternalCollisions(value: boolean)

Swift declaration

var checksForInternalCollisions: Bool

init · iOS 18.0+

init

TypeScript

static init(pin0: GeometricPin, pin1: GeometricPin, linearLimit?: (SDKHandle) | null, checksForInternalCollisions?: boolean): PhysicsPrismaticJoint

Swift declaration

init(pin0: GeometricPin, pin1: GeometricPin, linearLimit: ClosedRange<Float>? = nil, checksForInternalCollisions: Bool = false)

Creates a new prismatic joint. - Parameters: - pin0: The local position and orientation on the first entity. - pin1: The local position and orientation on the second entity. - linearLimit: A limit of the the translation of `pin1` from `pin0` in the direction of the x-axis of `pin0`. - checksForInternalCollisions: A Boolean that indicates whether the joint checks for collisions between the two ``Entity`` instances.

get · iOS 18.0+

pin0

TypeScript

get pin0(): GeometricPin

Swift declaration

var pin0: GeometricPin

The pin that defines a local position and orientation on the first entity.

set · iOS 18.0+

pin0

TypeScript

set pin0(value: GeometricPin)

Swift declaration

var pin0: GeometricPin

The pin that defines a local position and orientation on the first entity.

get · iOS 18.0+

pin1

TypeScript

get pin1(): GeometricPin

Swift declaration

var pin1: GeometricPin

The pin that defines a local position and orientation on the second entity.

set · iOS 18.0+

pin1

TypeScript

set pin1(value: GeometricPin)

Swift declaration

var pin1: GeometricPin

The pin that defines a local position and orientation on the second entity.

get · iOS 18.0+

isActive

TypeScript

get isActive(): boolean

Swift declaration

var isActive: Bool { get }

A Boolean that indicates whether the joint is active. Inactive joints do not participate in the physics simulation. One example is a joint that does not reference any ``Entity`` with ``PhysicsBodyMode/dynamic``, or when one or both the referenced entities are not active.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →