Class RbJoint

Joint representing a connection between two rigid bodies

Hierarchy

RbJoint
- RbSpringJoint

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RbJoint(rbStart: RigidBody, rbStartConnPtLocal: Vector3, rbEnd: RigidBody, rbEndConnPtLocal: Vector3): RbJoint

- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:15
Parameters
- rbStart: RigidBody
  
  rigid body where the joint starts
- rbStartConnPtLocal: Vector3
  
  point in the local space of the starting rigid body where the connection should start
- rbEnd: RigidBody
  
  rigid body where the joint ends
- rbEndConnPtLocal: Vector3
  
  point in the local space of the ending rigid body where the connection should end
Returns RbJoint

Properties

Private _breakForce

_breakForce: number

Protected _isBroken

_isBroken: boolean

Private Readonly _rbEnd

_rbEnd: RigidBody

Private Readonly _rbEndConnPtLocal

_rbEndConnPtLocal: Vector3

Private Readonly _rbStart

_rbStart: RigidBody

Private Readonly _rbStartConnPtLocal

_rbStartConnPtLocal: Vector3

Accessors

breakForce

get breakForce(): number
set breakForce(value: number): void

- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:66
Sets amount of force needed to break (basically tear-apart) this joint. Once the joint has been broken, setting new force cannot "repair" it.

Returns number

amount of force needed to break (basically tear-apart) this joint.
- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:74
Sets amount of force needed to break (basically tear-apart) this joint. Once the joint has been broken, setting new force cannot "repair" it.

Parameters
- value: number
Returns void

amount of force needed to break (basically tear-apart) this joint.

endConnectionPoint

get endConnectionPoint(): Vector3

- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:59
Returns Vector3

connection point in the local space of the ending rigid body

endRigidBody

get endRigidBody(): RigidBody

- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:45
Returns RigidBody

reference to rigid body where the join ends

isBroken

get isBroken(): boolean

- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:84
Returns boolean

true if this joint is broken, i.e., not applying any force to connected rigid bodies. Otherwise false.

startConnectionPoint

get startConnectionPoint(): Vector3

- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:52
Returns Vector3

connection point in the local space of the starting rigid body

startRigidBody

get startRigidBody(): RigidBody

- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:38
Returns RigidBody

reference to rigid body where the joint starts

Methods

applyForces

applyForces(): void

- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:91
Applies forces to the connected rigid bodies if not broken.

Returns void

Protected Abstract applyJointForces

applyJointForces(): void

- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:104
Applies forces to the connected rigid bodies.

Returns void

Private shouldBreak

shouldBreak(): boolean

- Defined in backend/src/catana/dynamics/joints/rb-joint.ts:111
Checks if this joint undergoes forces high enough to break it.

Returns boolean

true if the forces exceed the maximum break force and the joint should break.

Generated using TypeDoc