Click or drag to resize

PrismaticJoint Class

A prismatic joint. This joint provides one degree of freedom: translation along an axis fixed in bodyA. Relative rotation is prevented. You can use a joint limit to restrict the range of motion and a joint motor to drive the motion or to model joint friction.
Inheritance Hierarchy
SystemObject
  Internal.tainicom.Aether.Physics2D.Dynamics.JointsJoint
    Internal.tainicom.Aether.Physics2D.Dynamics.JointsPrismaticJoint

Namespace: Internal.tainicom.Aether.Physics2D.Dynamics.Joints
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2026.1.1.0 (2026.1.1.0)
Syntax
C#
public class PrismaticJoint : Joint

The PrismaticJoint type exposes the following members.

Constructors
 NameDescription
Public methodPrismaticJoint(Body, Body, Vector2, Vector2, Boolean)Initializes a new instance of the PrismaticJoint class
Public methodPrismaticJoint(Body, Body, Vector2, Vector2, Vector2, Boolean) This requires defining a line of motion using an axis and an anchor point. The definition uses local anchor points and a local axis so that the initial configuration can violate the constraint slightly. The joint translation is zero when the local anchor points coincide in world space. Using local anchors and a local axis helps when saving and loading a game.
Top
Properties
 NameDescription
Public propertyAxis The axis at which the joint moves.
Public propertyBodyA Get the first body attached to this joint.
(Inherited from Joint)
Public propertyBodyB Get the second body attached to this joint.
(Inherited from Joint)
Public propertyBreakpoint 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)
Public propertyCollideConnected Set this flag to true if the attached bodies should collide.
(Inherited from Joint)
Public propertyJointSpeed Get the current joint translation speed, usually in meters per second.
Public propertyJointTranslation Get the current joint translation, usually in meters.
Public propertyJointType Gets or sets the type of the joint.
(Inherited from Joint)
Public propertyLimitEnabled Is the joint limit enabled?
Public propertyLocalAnchorA The local anchor point on BodyA
Public propertyLocalAnchorB The local anchor point on BodyB
Public propertyLocalXAxis The axis in local coordinates relative to BodyA
Public propertyLowerLimit Get the lower joint limit, usually in meters.
Public propertyMaxMotorForce Set the maximum motor force, usually in N.
Public propertyMotorEnabled Is the joint motor enabled?
Public propertyMotorImpulse Get the current motor impulse, usually in N.
Public propertyMotorSpeed Set the motor speed, usually in meters per second.
Public propertyReferenceAngle The reference angle.
Public propertyUpperLimit Get the upper joint limit, usually in meters.
Public propertyWorld Get the parent World of this joint. This is null if the joint is not attached.
(Inherited from Joint)
Public propertyWorldAnchorA
(Overrides JointWorldAnchorA)
Public propertyWorldAnchorB
(Overrides JointWorldAnchorB)
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetMotorForce Gets the motor force.
Public methodGetReactionForce
(Overrides JointGetReactionForce(Single))
Public methodGetReactionTorque
(Overrides JointGetReactionTorque(Single))
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsFixedType Return true if the joint is a fixed type.
(Inherited from Joint)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodSetLimits Set the joint limits, usually in meters.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Protected methodWakeBodies
(Inherited from Joint)
Top
Events
 NameDescription
Public eventBroke Fires when the joint is broken.
(Inherited from Joint)
Top
Fields
 NameDescription
Public fieldEnabled Indicate if this join is enabled or not. Disabling a joint means it is still in the simulation, but inactive.
(Inherited from Joint)
Public fieldTag Set the user data pointer.
(Inherited from Joint)
Top
Extension Methods
 NameDescription
Public Extension MethodMethodInvoke Calls the object method by name.
(Defined by ObjectEx)
Public Extension MethodPropertyGet Gets the value of the object property by name.
(Defined by ObjectEx)
Public Extension MethodPropertyGetT Gets the value of the object property by name.
(Defined by ObjectEx)
Public Extension MethodPropertySet Sets the value of the object property by name.
(Defined by ObjectEx)
Top
See Also