| 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 |
Whether the shapes on the pair of bodies can come into contact.
|
| currentAngularSeparationError |
Get the current angular separation error for this joint, in degrees.
This does not consider admissible movement.
|
| currentConstraintForce |
Get the current constraint force used by the joint, usually in newtons.
|
| currentConstraintTorque |
Get the current constraint torque used by the joint, usually in newton-meters.
|
| currentDistance |
Get the current distance.
|
| currentLinearSeparationError |
Get the current linear separation error for this joint, usually in meters.
This does not consider admissible movement.
|
| currentMotorForce |
The current motor force, usually in newtons.
|
| definition |
Get or set the joint definition.
Reading returns the joint's current configuration, including PhysicsDistanceJoint.bodyA and PhysicsDistanceJoint.bodyB.
Writing applies every configurable property in place but does not change the connected bodies, which are fixed when the joint is created.
|
| distance |
The desired distance constraint i.e. the rest length of this joint.
This has a lower stable limit of just above zero.
|
| drawScale |
Controls the scaling of the joint drawing.
|
| enableLimit |
Enable/Disable the joint distance limit.
|
| enableMotor |
Enable/Disable the joint motor.
|
| enableSpring |
Enable/Disable the spring behaviour.
If false then the joint will be rigid, overriding the limit and motor.
|
| forceThreshold |
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 |
The local anchor frame constraint relative to bodyA's origin.
|
| localAnchorB |
The local anchor frame constraint relative to bodyB's origin.
|
| maxDistanceLimit |
Maximum distance limit of this joint.
|
| maxMotorForce |
The maximum force the motor can apply, usually in newtons.
|
| minDistanceLimit |
Minimum distance limit of this joint.
This will be clamped to a lower stable limit.
|
| motorSpeed |
The desired motor speed, usually in meters per second.
|
| ownerUserData |
Get PhysicsUserData that can be used for any purpose, typically by the owner only.
|
| physicsHandle |
Get the physics handle.
|
| springDamping |
The spring linear damping, non-dimensional.
|
| springFrequency |
The spring linear stiffness frequency, in cycles per second.
|
| springLowerForce |
The lower spring force controls how much tension the spring can sustain.
|
| springUpperForce |
The upper spring force controls how much compression the spring can sustain.
|
| torqueThreshold |
The torque threshold beyond which a joint event will be produced.
|
| tuningDamping |
Controls the joint stiffness damping, non-dimensional. Use 1 for critical damping.
|
| tuningFrequency |
Controls 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.
|