Public Member Functions | Static Public Member Functions | Properties
RAIN.Motion.Instantaneous.Steering Class Reference

Steering represents the output of SteeringBehaviors as a velocity request and an angularvelocity (rotation) request. More...

List of all members.

Public Member Functions

 Steering ()
 Default constructor.

Static Public Member Functions

static Steering operator/ (Steering s, float div)
 Reduce the contribution of the steering behavior through division.
static Steering operator* (Steering s, float mult)
 Increase the contribution of the steering behavior through multiplication.
static Steering operator- (Steering s1, Steering s2)
 Subtract one steering behavior from another. The result is a subtraction of the two vectors for velocity and angular velocity.
static Steering operator+ (Steering s1, Steering s2)
 Add one steering behavior to another. The result is an addition of the two vectors for velocity and angular velocity.
static Steering Negate (Steering s)
 Negate inverts the values of the velocity and angular velocity vectors.

Properties

Vector3 Velocity [get, set]
 Velocity Property accessor.
Vector3 AngularVelocity [get, set]
 Angular Velocity Property accessor.
static Steering Zero [get]
 Returns a Steering instance that represents no steering.

Detailed Description

Steering represents the output of SteeringBehaviors as a velocity request and an angularvelocity (rotation) request.


Constructor & Destructor Documentation

Default constructor.


Member Function Documentation

Negate inverts the values of the velocity and angular velocity vectors.

Parameters:
sThe Steering to negate
Returns:
Returns a new SteeringBehavior with the new values.
static Steering RAIN.Motion.Instantaneous.Steering.operator* ( Steering  s,
float  mult 
) [static]

Increase the contribution of the steering behavior through multiplication.

Parameters:
sThe steering behavior to increase
multThe multiplier
Returns:
Returns a new SteeringBehavior with the new values. The original remains unaffected
static Steering RAIN.Motion.Instantaneous.Steering.operator+ ( Steering  s1,
Steering  s2 
) [static]

Add one steering behavior to another. The result is an addition of the two vectors for velocity and angular velocity.

Parameters:
s1The steering behavior to add to
s2The steering behavior to add
Returns:
Returns a new SteeringBehavior with the new values.
static Steering RAIN.Motion.Instantaneous.Steering.operator- ( Steering  s1,
Steering  s2 
) [static]

Subtract one steering behavior from another. The result is a subtraction of the two vectors for velocity and angular velocity.

Parameters:
s1The steering behavior to subtract from
s2The steering behavior to subtract
Returns:
Returns a new SteeringBehavior with the new values.
static Steering RAIN.Motion.Instantaneous.Steering.operator/ ( Steering  s,
float  div 
) [static]

Reduce the contribution of the steering behavior through division.

Parameters:
sThe steering behavior to reduce
divThe divisor
Returns:
Returns a new SteeringBehavior with the new values. The original remains unaffected

Property Documentation

Angular Velocity Property accessor.

Velocity Property accessor.

Returns a Steering instance that represents no steering.