DI-Guy SDK Documentation  13.7
diguyActionParameters.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2023 MAK Technologies, Inc.
3  * All rights reserved.
4  ****************************************************************************/
5 
6 #pragma once
7 
8 #include <diguy_vector_classes.h>
9 #include <diguy_constants.h>
10 
12 struct BDI_DECLSPEC_diguy diguyActionParameters
13 {
14 
17  : m_offset( 0, 0, 0 )
18  , m_include_transition( true )
19  , m_action_speed( DIGUY_DEFAULT_FLOAT )
20  , m_transition_speed( DIGUY_DEFAULT_FLOAT )
21  , m_action_speed_scale_factor( DIGUY_DEFAULT_FLOAT )
22  , m_transition_speed_scale_factor( DIGUY_DEFAULT_FLOAT )
23  , m_max_rampdown_interval( 0.5f )
24  , m_t_offset_into_action( 0.0f )
25  , m_action_duration( DIGUY_DEFAULT_FLOAT )
26  , m_retain_path_shape( false )
27  {
28  }
29 
33  {
34  return ( m_include_transition && m_transition_speed_scale_factor != 0.0f );
35  }
36 
39 
43 
46 
49 
53 
58 
61 
64 
67 
70 
71 };
#define DIGUY_DEFAULT_FLOAT
This value is a magic number that, when passed to certain functions, means that the function should u...
Definition: diguy_constants.h:62
diguyActionParameters()
Default CTOR.
Definition: diguyActionParameters.h:16
bool m_retain_path_shape
Flag for whether path mode should be preserved when setting action.
Definition: diguyActionParameters.h:69
float m_transition_speed
The target speed for the transition (if present).
Definition: diguyActionParameters.h:48
diguyVec3f m_offset
The offset to apply to the action (or transition if present).
Definition: diguyActionParameters.h:38
This class encapsulates all parameters for a tasking a character with an action.
Definition: diguyActionParameters.h:12
float m_max_rampdown_interval
The maximum interval for ramping down the previous action.
Definition: diguyActionParameters.h:60
float m_action_duration
How long the action should last.
Definition: diguyActionParameters.h:66
Definition: diguy_vector_classes.h:74
float m_action_speed_scale_factor
The speed scale factor to apply to the action.
Definition: diguyActionParameters.h:52
float m_transition_speed_scale_factor
The speed scale factor to apply to the transition (if present).
Definition: diguyActionParameters.h:57
float m_t_offset_into_action
Amount of time into the arc to begin (AKA. m_first_arc_time_shift).
Definition: diguyActionParameters.h:63
bool m_include_transition
Flag indicating whether transition arcs should be used (if present).
Definition: diguyActionParameters.h:42
bool include_transition_arc() const
Returns whether transition arcs are included with the current parameters.
Definition: diguyActionParameters.h:32
float m_action_speed
The speed at which to play the action.
Definition: diguyActionParameters.h:45