PositionMotor Class

PositionMotor Class

Defines a motor that controls the linear distance of two constrained bodies.

Inheritance Hierarchy

SystemObject
DigitalRune.Physics.ConstraintsConstraint
DigitalRune.Physics.ConstraintsPositionMotor

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

Public Class PositionMotor
	Inherits Constraint

public ref class PositionMotor : public Constraint

type PositionMotor =  
    class
        inherit Constraint
    end

The PositionMotor type exposes the following members.

Constructors

	Name	Description
	PositionMotor	Initializes a new instance of the PositionMotor 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. (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.)

Top

Properties

	Name	Description
	AnchorPoseALocal	Gets or sets the constraint anchor pose 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.)
	DampingConstant	Gets or sets the damping constant.
	Enabled	Gets or sets a value indicating whether this constraint is enabled. (Inherited from Constraint.)
	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 motor.
	MaxVelocity	Gets or sets the maximal velocity.
	RelativePosition	Gets the relative position of the constraint anchor on BodyB relative to the constraint anchor on BodyA.
	Simulation	Gets the simulation to which this constraint belongs. (Inherited from Constraint.)
	SpringConstant	Gets or sets the spring constant.
	TargetPosition	Gets or sets the target position of the AnchorPositionBLocal relative to AnchorPoseALocal
	UseSingleAxisMode	Gets or sets a value indicating whether the motor applies forces only on a single axis.

Top

Remarks

The motor pushes both bodies until the relative position of the constraint anchor on the second body relative to the constraint anchor on the first body is equal to TargetPosition. The motor acts like a damped-spring that pushes the bodies at the constraint anchor points (controlled by SpringConstant and DampingConstant).

Reference

DigitalRune.Physics.Constraints Namespace