C# Class FarseerPhysics.Controllers.AbstractForceController

Inheritance: Controller

Mostrar archivo Open project: prime31/Nez

Public Properties

Property	Type	Description
DecayCurve	Curve
ForceType	ForceTypes
StrengthCurve	Curve

Protected Properties

Property	Type	Description
Randomize	Random

Public Methods

Method	Description
AbstractForceController ( ) : System	Constructor
AbstractForceController ( TimingModes mode ) : System	Overloaded Contstructor with supplying Timing Mode
ApplyForce ( float dt, float strength ) : void	Apply the force supplying strength (wich is modified in Update() according to the TimingMode
Trigger ( ) : void	Triggers the trigger modes (Trigger and Curve)
Update ( float dt ) : void	Inherited from Controller Depending on the TimingMode perform timing logic and call ApplyForce()

Protected Methods

Method	Description
GetDecayMultiplier ( Body body ) : float	Calculate the Decay for a given body. Meant to ease force development and stick to the DRY principle and provide unified and predictable decay math.

Method Details

AbstractForceController() public method

Constructor

public AbstractForceController ( ) : System
return	System

AbstractForceController() public method

Overloaded Contstructor with supplying Timing Mode

public AbstractForceController ( TimingModes mode ) : System
mode	TimingModes
return	System

ApplyForce() public abstract method

Apply the force supplying strength (wich is modified in Update() according to the TimingMode

public abstract ApplyForce ( float dt, float strength ) : void
dt	float
strength	float	The strength
return	void

GetDecayMultiplier() protected method

Calculate the Decay for a given body. Meant to ease force development and stick to the DRY principle and provide unified and predictable decay math.

protected GetDecayMultiplier ( Body body ) : float
body	Body	The body to calculate decay for
return	float

Trigger() public method

Triggers the trigger modes (Trigger and Curve)

public Trigger ( ) : void
return	void

Update() public method

Inherited from Controller Depending on the TimingMode perform timing logic and call ApplyForce()

public Update ( float dt ) : void
dt	float
return	void

Property Details

DecayCurve public_oe property

Curve to be used for Decay in Curve mode

public Curve DecayCurve
return	Curve

ForceType public_oe property

The Forcetype of the instance

public ForceTypes ForceType
return	ForceTypes

Randomize protected_oe property

Provided for reuse to provide Variation functionality in inheriting classes

protected Random Randomize
return	Random

StrengthCurve public_oe property

Curve used by Curve Mode as an animated multiplier for the force strength. Only positions between 0 and 1 are considered as that range is stretched to have ImpulseLength.

public Curve StrengthCurve
return	Curve