PlaneLimit Class

PlaneLimit Class

Defines a limit plane and a limit point that must stay in front of the plane.

Inheritance Hierarchy

SystemObject
DigitalRune.Physics.ConstraintsConstraint
DigitalRune.Physics.ConstraintsPlaneLimit

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

Syntax

public class PlaneLimit : Constraint

Public Class PlaneLimit
	Inherits Constraint

public ref class PlaneLimit : public Constraint

type PlaneLimit =  
    class
        inherit Constraint
    end

The PlaneLimit type exposes the following members.

Constructors

	Name	Description
	PlaneLimit	Initializes a new instance of the PlaneLimit class

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. (Inherited from Constraint.)
	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. (Inherited from Constraint.)
	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.)

Properties

	Name	Description
	AnchorPositionBLocal	Gets or sets the constraint anchor position on BodyB in local space of BodyB.
	AngularConstraintImpulse	Gets or sets the angular constraint impulse that was applied. (Overrides ConstraintAngularConstraintImpulse.)
	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.)
	ConstraintImpulse	Gets or sets the constraint impulse that was applied.
	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.)
	MaxForce	Gets or sets the maximal force that is applied by this constraint.
	PlaneALocal	Gets or sets the constraint plane that this is fixed on BodyA (defined in local space of BodyA).
	Restitution	Gets or sets the coefficient of restitution.
	Simulation	Gets the simulation to which this constraint belongs. (Inherited from Constraint.)
	Softness	Gets or sets the softness.

Remarks

This limit places a plane on the first body. The constraint anchor point on the second body is forced to be in front of the plane on the other body.

This constraint can be added to other joints. For example, the rotations of a BallJoint can be limited by placing several PlaneLimits.