GearJoint Class |
A gear joint is used to connect two joints together.
Either joint can be a revolute or prismatic joint.
You specify a gear ratio to bind the motions together:
coordinate1 + ratio * coordinate2 = ant
The ratio can be negative or positive. If one joint is a revolute joint
and the other joint is a prismatic joint, then the ratio will have units
of length or units of 1/length.
Warning: You have to manually destroy the gear joint if jointA or jointB is destroyed.
Inheritance HierarchySystemObject
Internal.tainicom.Aether.Physics2D.Dynamics.JointsJoint
Internal.tainicom.Aether.Physics2D.Dynamics.JointsGearJoint
Internal.tainicom.Aether.Physics2D.Dynamics.JointsJoint
Internal.tainicom.Aether.Physics2D.Dynamics.JointsGearJoint
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 GearJoint : Joint
The GearJoint type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GearJoint |
Requires two existing revolute or prismatic joints (any combination will work).
The provided joints must attach a dynamic body to a static body.
|
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.) |
| JointA |
The first revolute/prismatic joint attached to the gear joint.
|
| JointB |
The second revolute/prismatic joint attached to the gear joint.
|
| JointType |
Gets or sets the type of the joint.
(Inherited from Joint.) |
| Ratio |
The gear ratio.
|
| 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 | (Overrides JointGetReactionForce(Single).) |
| GetReactionTorque | (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