Curvy  2.3.0
CurvySplineMoveEventArgs Class Reference
+ Inheritance diagram for CurvySplineMoveEventArgs:
+ Collaboration diagram for CurvySplineMoveEventArgs:

Detailed Description

EventArgs used by spline controller movements

Properties

CurvySplineSegment ControlPoint [get]
 The control point which reaching triggered this event More...
 
float Delta [get]
 The left distance yet to move. More...
 
int Direction [get]
 Movement direction More...
 
CurvyControlPointEventArgs.ModeEnum Mode [get]
 
MovementDirection MovementDirection [get]
 The movement direction the controller had when sending the event More...
 
float Position [get]
 Controller Position on Spline More...
 
SplineController Sender [get]
 The Spline Controller raising the event More...
 
CurvySpline Spline [get]
 The related spline More...
 
float TF [get]
 Current TF (relative position) More...
 
bool WorldUnits [get]
 Are Delta and Position in world units (in opposition to relative units)? More...
 

Public Member Functions

float AngleTo (CurvySplineSegment controlPoint)
 Returns the angle from current position to another Control Point More...
 
 CurvySplineMoveEventArgs (SplineController sender, CurvySpline spline, CurvySplineSegment controlPoint, float tf, float delta, int direction, bool usingWorldUnits=false)
 
 CurvySplineMoveEventArgs (SplineController sender, CurvySpline spline, CurvySplineSegment controlPoint, float position, bool usingWorldUnits, float delta, MovementDirection direction)
 
 CurvySplineMoveEventArgs ()
 
void Follow (CurvySplineSegment controlPoint, ConnectionHeadingEnum direction=ConnectionHeadingEnum.Auto)
 Sets the movement to follow a new spline and alter movement direction to best fit More...
 
void SetPosition (float tf)
 Sets the movement to continue at a new position More...
 
void SetPosition (CurvySplineSegment segment, float localF=0)
 Sets the movement to continue at a new position More...
 

Constructor & Destructor Documentation

CurvySplineMoveEventArgs ( SplineController  sender,
CurvySpline  spline,
CurvySplineSegment  controlPoint,
float  tf,
float  delta,
int  direction,
bool  usingWorldUnits = false 
)
CurvySplineMoveEventArgs ( SplineController  sender,
CurvySpline  spline,
CurvySplineSegment  controlPoint,
float  position,
bool  usingWorldUnits,
float  delta,
MovementDirection  direction 
)

Member Function Documentation

float AngleTo ( CurvySplineSegment  controlPoint)

Returns the angle from current position to another Control Point

Parameters
controlPointthe reference Control point
Returns
an angle in degrees
void Follow ( CurvySplineSegment  controlPoint,
ConnectionHeadingEnum  direction = ConnectionHeadingEnum.Auto 
)

Sets the movement to follow a new spline and alter movement direction to best fit

Parameters
controlPointthe Control Point on the new spline to start with
directionthe direction to use
void SetPosition ( float  tf)

Sets the movement to continue at a new position

Parameters
tfTF (0..1)
void SetPosition ( CurvySplineSegment  segment,
float  localF = 0 
)

Sets the movement to continue at a new position

Parameters
segmentthe segment to continue movement on
localFthe local F within that segment

Property Documentation

CurvySplineSegment ControlPoint
get

The control point which reaching triggered this event

float Delta
get

The left distance yet to move.

int Direction
get

Movement direction

The movement direction the controller had when sending the event

float Position
get

Controller Position on Spline

SplineController Sender
get

The Spline Controller raising the event

CurvySpline Spline
get

The related spline

float TF
get

Current TF (relative position)

bool WorldUnits
get

Are Delta and Position in world units (in opposition to relative units)?


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