CylindricalJoint Class

Defines a cylindrical slider joint.

Inheritance Hierarchy

SystemObject
DigitalRune.Physics.ConstraintsConstraint
DigitalRune.Physics.ConstraintsCylindricalJoint

Namespace: DigitalRune.Physics.Constraints
Assembly: DigitalRune.Physics (in DigitalRune.Physics.dll) Version: 1.10.0.0 (1.10.0.14427)

Syntax

C++

Copy

public class CylindricalJoint : Constraint

Public Class CylindricalJoint
	Inherits Constraint

public ref class CylindricalJoint : public Constraint

type CylindricalJoint =  
    class
        inherit Constraint
    end

The CylindricalJoint type exposes the following members.

Constructors

	Name	Description
	CylindricalJoint	Initializes a new instance of the CylindricalJoint class.

Top

Methods

	Name	Description
	ApplyImpulse	Called by the simulation to apply an impulse that satisfies the constraint. (Inherited from Constraint.)
	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 a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAddToSimulation	Called when this constraint is added to a simulation. (Overrides ConstraintOnAddToSimulation.)
	OnApplyImpulse	Called when the constraint impulse should be applied. (Overrides ConstraintOnApplyImpulse.)
	OnChanged	Called when properties of this constraint were changed. (Overrides ConstraintOnChanged.)
	OnRemoveFromSimulation	Called when this constraint is removed from a simulation. (Overrides ConstraintOnRemoveFromSimulation.)
	OnSetup	Called when constraint should be set-up for a new time step. (Overrides ConstraintOnSetup.)
	Setup	Called by the simulation to prepare this constraint for constraint solving for a new time step. (Inherited from Constraint.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	AnchorPoseALocal	Gets or sets the constraint anchor pose on BodyA in local space of BodyA.
	AnchorPoseBLocal	Gets or sets the constraint anchor pose on BodyB in local space of BodyB.
	AngularConstraintImpulse	Gets or sets the angular constraint impulse that was applied. (Overrides ConstraintAngularConstraintImpulse.)
	AngularMaximum	Gets or sets the minimum rotation limit for rotations about the slider axis.
	AngularMinimum	Gets or sets the minimum rotation limit for rotations about the slider axis.
	AngularRelativePosition	Gets the relative rotation about the slider axis.
	BodyA	Gets or sets the first body. (Inherited from Constraint.)
	BodyB	Gets or sets the second body. (Inherited from Constraint.)
	CollisionEnabled	Gets or sets a value indicating whether collisions between BodyA and BodyB are disabled. (Inherited from Constraint.)
	Enabled	Gets or sets a value indicating whether this constraint is enabled. (Inherited from Constraint.)
	ErrorReduction	Gets or sets the error reduction parameter.
	LinearConstraintImpulse	Gets or sets the linear constraint impulse that was applied. (Overrides ConstraintLinearConstraintImpulse.)
	LinearMaximum	Gets or sets the maximum translational movement limit on the slider axis.
	LinearMinimum	Gets or sets the minimum translational movement limit on the slider axis.
	LinearRelativePosition	Gets the relative position on the slider axis.
	MaxForce	Gets or sets the maximal force that is applied by this constraint.
	Restitution	Gets or sets the coefficient of restitution for slider limits.
	Simulation	Gets the simulation to which this constraint belongs. (Inherited from Constraint.)
	Softness	Gets or sets the softness.

Top

Remarks

This joint allows only translational movement and rotational movement along the slider axis. It removes all other translational and rotational degrees of freedom. The slider axis is the x-axis of the constraint anchor.

Reference

DigitalRune.Physics.Constraints Namespace