PointOnPlaneConstraint Class

Restricts a body to move in a plane that is fixed on another body.

Inheritance Hierarchy

SystemObject
DigitalRune.Physics.ConstraintsConstraint
DigitalRune.Physics.ConstraintsPointOnPlaneConstraint

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 PointOnPlaneConstraint : Constraint

Public Class PointOnPlaneConstraint
	Inherits Constraint

public ref class PointOnPlaneConstraint : public Constraint

type PointOnPlaneConstraint =  
    class
        inherit Constraint
    end

The PointOnPlaneConstraint type exposes the following members.

Constructors

	Name	Description
	PointOnPlaneConstraint	Initializes a new instance of the PointOnPlaneConstraint 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
	AnchorPositionALocal	Gets or sets the constraint anchor position on BodyA in local space of BodyA.
	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.)
	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.
	Maximum	Gets or sets the maximum movement limits on the plane.
	Minimum	Gets or sets the minimum movement limits on the plane.
	RelativePosition	Gets the position on the plane axes relative to AnchorPositionALocal.
	Restitution	Gets or sets the coefficient of restitution for limits.
	Simulation	Gets the simulation to which this constraint belongs. (Inherited from Constraint.)
	Softness	Gets or sets the softness.
	XAxisALocal	Gets or sets the x-axis in the plane that is fixed on BodyA in local space of BodyA.
	YAxisALocal	Gets or sets the y-axis in the plane that is fixed on BodyA in local space of BodyA.

Top

Remarks

A plane is fixed on BodyA. The plane goes through AnchorPositionALocal and is defined by the two axes XAxisALocal and YAxisALocal that are also fixed on the first body. The point AnchorPositionBLocal on the second body can only move in this plane.

This constraint removes 1 translational degree of movement (the movement normal to the plane). It does not restrict rotational movement.

Reference

DigitalRune.Physics.Constraints Namespace