diguyActionParameters Struct Reference

This class encapsulates all parameters for a tasking a character with an action. More...

#include <diguyActionParameters.h>

Public Member Functions
	diguyActionParameters ()
	Default CTOR. More...
bool	include_transition_arc () const
	Returns whether transition arcs are included with the current parameters. More...

Public Attributes
diguyVec3f	m_offset
	The offset to apply to the action (or transition if present). More...
bool	m_include_transition
	Flag indicating whether transition arcs should be used (if present). More...
float	m_action_speed
	The speed at which to play the action. More...
float	m_transition_speed
	The target speed for the transition (if present). More...
float	m_action_speed_scale_factor
	The speed scale factor to apply to the action. More...
float	m_transition_speed_scale_factor
	The speed scale factor to apply to the transition (if present). More...
float	m_max_rampdown_interval
	The maximum interval for ramping down the previous action. More...
float	m_t_offset_into_action
	Amount of time into the arc to begin (AKA. m_first_arc_time_shift). More...
float	m_action_duration
	How long the action should last. More...
bool	m_retain_path_shape
	Flag for whether path mode should be preserved when setting action. More...

Detailed Description

This class encapsulates all parameters for a tasking a character with an action.

Constructor & Destructor Documentation

diguyActionParameters::diguyActionParameters ( )

inline

Default CTOR.

Member Function Documentation

bool diguyActionParameters::include_transition_arc ( ) const

inline

Returns whether transition arcs are included with the current parameters.

This will return false if m_include_transition is false, or if m_transition_speed_scale_factor is 0.

Member Data Documentation

diguyVec3f diguyActionParameters::m_offset

The offset to apply to the action (or transition if present).

bool diguyActionParameters::m_include_transition

Flag indicating whether transition arcs should be used (if present).

See also: m_transition_speed_scale_factor

float diguyActionParameters::m_action_speed

The speed at which to play the action.

float diguyActionParameters::m_transition_speed

The target speed for the transition (if present).

float diguyActionParameters::m_action_speed_scale_factor

The speed scale factor to apply to the action.

If set, this scale factor will override the speed set in m_action_speed.

float diguyActionParameters::m_transition_speed_scale_factor

The speed scale factor to apply to the transition (if present).

If set, this scale factor will override the speed set in m_transition_speed. Setting this value to zero will skip transition regardless of the state of m_include_transition.

float diguyActionParameters::m_max_rampdown_interval

The maximum interval for ramping down the previous action.

float diguyActionParameters::m_t_offset_into_action

Amount of time into the arc to begin (AKA. m_first_arc_time_shift).

float diguyActionParameters::m_action_duration

How long the action should last.

bool diguyActionParameters::m_retain_path_shape

Flag for whether path mode should be preserved when setting action.

---

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

• diguyActionParameters.h