DistanceJoint Class |
A distance joint rains two points on two bodies
to remain at a fixed distance from each other. You can view
this as a massless, rigid rod.
Inheritance HierarchySystemObject
Internal.tainicom.Aether.Physics2D.Dynamics.JointsJoint
Internal.tainicom.Aether.Physics2D.Dynamics.JointsDistanceJoint
Internal.tainicom.Aether.Physics2D.Dynamics.JointsJoint
Internal.tainicom.Aether.Physics2D.Dynamics.JointsDistanceJoint
Namespace: Internal.tainicom.Aether.Physics2D.Dynamics.Joints
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2024.1.1.0 (2024.1.1.0)
SyntaxC#
public class DistanceJoint : Joint
The DistanceJoint type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DistanceJoint |
This requires defining an
anchor point on both bodies and the non-zero length of the
distance joint. If you don't supply a length, the local anchor points
is used so that the initial configuration can violate the constraint
slightly. This helps when saving and loading a game.
Warning Do not use a zero or short length.
|
Properties| Name | Description | |
|---|---|---|
 | BodyA |
Get the first body attached to this joint.
(Inherited from Joint.) |
| BodyB |
Get the second body attached to this joint.
(Inherited from Joint.) |
| Breakpoint |
The Breakpoint simply indicates the maximum Value the JointError can be before it breaks.
The default value is float.MaxValue, which means it never breaks.
(Inherited from Joint.) |
| CollideConnected |
Set this flag to true if the attached bodies should collide.
(Inherited from Joint.) |
| DampingRatio |
The damping ratio. 0 = no damping, 1 = critical damping.
|
| Frequency |
The mass-spring-damper frequency in Hertz. A value of 0
disables softness.
|
| JointType |
Gets or sets the type of the joint.
(Inherited from Joint.) |
| Length |
The natural length between the anchor points.
Manipulating the length can lead to non-physical behavior when the frequency is zero.
|
| LocalAnchorA |
The local anchor point relative to bodyA's origin.
|
| LocalAnchorB |
The local anchor point relative to bodyB's origin.
|
| World |
Get the parent World of this joint. This is null if the joint is not attached.
(Inherited from Joint.) |
| WorldAnchorA | (Overrides JointWorldAnchorA.) |
| WorldAnchorB | (Overrides JointWorldAnchorB.) |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetReactionForce |
Get the reaction force given the inverse time step. Unit is N.
(Overrides JointGetReactionForce(Single).) |
| GetReactionTorque |
Get the reaction torque given the inverse time step.
Unit is N*m. This is always zero for a distance joint.
(Overrides JointGetReactionTorque(Single).) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsFixedType |
Return true if the joint is a fixed type.
(Inherited from Joint.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WakeBodies | (Inherited from Joint.) |
Events
Fields| Name | Description | |
|---|---|---|
 | Enabled |
Indicate if this join is enabled or not. Disabling a joint
means it is still in the simulation, but inactive.
(Inherited from Joint.) |
| Tag |
Set the user data pointer.
(Inherited from Joint.) |
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx.) |
| PropertyGet(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
| PropertyGetT(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx.) |
See Also