Drag[en]gine Script Module DragonScript Script API  1.0
SmoothVector2 Class Reference

Smooth 2-component vector value. More...

Inheritance diagram for SmoothVector2:

Public Member Functions

Constructors
SmoothVector2 new ()
 Create smooth vector. More...
 
SmoothVector2 new (SmoothVector2 copy)
 Create copy of smooth vector. More...
 
Management
Vector2 getValue ()
 Current value. More...
 
void setValue (Vector2 value)
 Set current value. More...
 
Vector2 getGoal ()
 Goal value. More...
 
void setGoal (Vector2 goal)
 Set goal value. More...
 
float getAdjustTime ()
 Adjustment time in seconds. More...
 
void setAdjustTime (float adjustTime)
 Adjustment time in seconds clamped to 0 or larger. More...
 
float getAdjustRange ()
 Adjustment range in units. More...
 
void setAdjustRange (float limit)
 Set adjustment range in units clamped to 0 or larger. More...
 
float getChangeSpeed ()
 Change speed of the value in units per second. More...
 
void setChangeSpeed (float changeSpeed)
 Set change speed of the value in units per second. More...
 
void reset ()
 Reset value, goal and change speed to 0. More...
 
void update (float elapsed)
 Update value with goal using current smoothing parameters. More...
 

Detailed Description

Smooth 2-component vector value.

Smooth dynamic changing vector value across time.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ getAdjustRange()

float getAdjustRange ( )

Adjustment range in units.

§ getAdjustTime()

float getAdjustTime ( )

Adjustment time in seconds.

§ getChangeSpeed()

float getChangeSpeed ( )

Change speed of the value in units per second.

§ getGoal()

Vector2 getGoal ( )

Goal value.

§ getValue()

Vector2 getValue ( )

Current value.

§ new() [1/2]

SmoothVector2 new ( )

Create smooth vector.

Value, goal and change speed are set to 0. Adjust time is set to 1s. Change speed limit is set to 1 unit per second.

§ new() [2/2]

Create copy of smooth vector.

§ reset()

void reset ( )

Reset value, goal and change speed to 0.

§ setAdjustRange()

void setAdjustRange ( float  limit)

Set adjustment range in units clamped to 0 or larger.

§ setAdjustTime()

void setAdjustTime ( float  adjustTime)

Adjustment time in seconds clamped to 0 or larger.

§ setChangeSpeed()

void setChangeSpeed ( float  changeSpeed)

Set change speed of the value in units per second.

§ setGoal()

void setGoal ( Vector2  goal)

Set goal value.

§ setValue()

void setValue ( Vector2  value)

Set current value.

§ update()

void update ( float  elapsed)

Update value with goal using current smoothing parameters.

Goal is not modified.

Parameters
[in]elapsedElapsed time in seconds. If less than 0.001s update is skipped.

The documentation for this class was generated from the following file: