| Property |
Description |
| bodyA |
The first body the joint constrains.
|
| bodyB |
The second body the joint constrains.
|
| callbackTarget |
Get/Set the Object that event callbacks for this joint will be sent to.
Care should be taken with any Object assigned as a callback target that isn't a Object as this assignment will not in itself keep the object alive and can be garbage collected.
To avoid this, you should have at least a single reference to the object in your code.
To remove the object assigned here, set the callback target to NULL.
This includes the following events:
- A JointThresholdEvent with call IJointThresholdCallback.
|
| collideConnected |
This is unused in this specific joint and is always false.
Typically this gets whether the shapes on the pair of bodies can come into contact.
|
| currentAngularSeparationError |
This is unused in this specific joint.
Typically this would get the current angular separation error for this joint.
|
| currentConstraintForce |
This is unused in this specific joint.
Typically this would get the current constraint force used by the joint, usually in newtons.
|
| currentConstraintTorque |
This is unused in this specific joint.
Typically this would get the current constraint torque used by the joint, usually in newton-meters.
|
| currentLinearSeparationError |
This is unused in this specific joint.
Typically this would get the current linear separation error for this joint.
|
| definition |
Get or set the joint definition.
Reading returns the joint's current configuration, including PhysicsIgnoreJoint.bodyA and PhysicsIgnoreJoint.bodyB.
Writing applies every configurable property in place but does not change the connected bodies, which are fixed when the joint is created.
|
| drawScale |
This is unused in this specific joint.
Typically this would control the scaling of the joint drawing.
|
| forceThreshold |
This is unused in this specific joint.
Typically this is the force threshold beyond which a joint event will be produced.
|
| isOwned |
Get if the joint is owned.
See PhysicsJoint.SetOwner.
|
| isValid |
Checks if the joint is valid.
|
| jointType |
Gets the joint type.
See JointType.
|
| localAnchorA |
This is unused in this specific joint.
Typically this is the local anchor frame constraint relative to bodyA's origin.
|
| localAnchorB |
This is unused in this specific joint.
Typically this is the local anchor frame constraint relative to bodyB's origin.
|
| ownerUserData |
Get PhysicsUserData that can be used for any purpose, typically by the owner only.
|
| physicsHandle |
Get the physics handle.
|
| torqueThreshold |
This is unused in this specific joint.
Typically this is the torque threshold beyond which a joint event will be produced.
|
| tuningDamping |
This is unused in this specific joint.
Typically this would control the joint stiffness damping, non-dimensional.
Use 1 for critical damping.
|
| tuningFrequency |
This is unused in this specific joint.
Typically this would control the joint stiffness frequency, in cycles per second.
|
| userData |
Get/Set PhysicsUserData that can be used for any purpose.
The physics system doesn't use this data, it is entirely for custom use.
|
| world |
Get the world the body is attached to.
|
| worldDrawing |
Controls whether this joint is automatically drawn when the world is drawn.
|