Open 3D Engine EMotionFX Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
EMotionFX::ValueParameter Class Referenceabstract

#include <ValueParameter.h>

Inherits EMotionFX::Parameter.

Inherited by EMotionFX::DefaultValueParameter< bool, BoolParameter >, EMotionFX::DefaultValueParameter< AZ::Color, RangedValueParameter< AZ::Color, ColorParameter > >, EMotionFX::DefaultValueParameter< float, RangedValueParameter< float, FloatParameter > >, EMotionFX::DefaultValueParameter< int, RangedValueParameter< int, IntParameter > >, EMotionFX::DefaultValueParameter< ValueType, RangedValueParameter< ValueType, Derived > >, EMotionFX::DefaultValueParameter< AZ::Quaternion, RangedValueParameter< AZ::Quaternion, RotationParameter > >, EMotionFX::DefaultValueParameter< AZStd::string, StringParameter >, EMotionFX::DefaultValueParameter< AZ::Vector2, RangedValueParameter< AZ::Vector2, Vector2Parameter > >, EMotionFX::DefaultValueParameter< AZ::Vector3, RangedValueParameter< AZ::Vector3, Vector3Parameter > >, EMotionFX::DefaultValueParameter< AZ::Vector4, RangedValueParameter< AZ::Vector4, Vector4Parameter > >, and EMotionFX::DefaultValueParameter< ValueType, Derived >.

Public Member Functions

 ValueParameter (AZStd::string name, AZStd::string description={})
 
virtual MCore::AttributeConstructDefaultValueAsAttribute () const =0
 
virtual uint32 GetType () const =0
 
virtual bool AssignDefaultValueToAttribute (MCore::Attribute *attribute) const =0
 
virtual bool SetDefaultValueFromAttribute (MCore::Attribute *attribute)=0
 
virtual bool SetMinValueFromAttribute (MCore::Attribute *attribute)
 
virtual bool SetMaxValueFromAttribute (MCore::Attribute *attribute)
 
- Public Member Functions inherited from EMotionFX::Parameter
 Parameter (AZStd::string name, AZStd::string description={})
 
virtual const char * GetTypeDisplayName () const =0
 
const AZStd::string & GetName () const
 
void SetName (const AZStd::string &name)
 
const AZStd::string & GetDescription () const
 
void SetDescription (const AZStd::string &description)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from EMotionFX::Parameter
static void Reflect (AZ::ReflectContext *context)
 
static bool IsNameValid (const AZStd::string &name, AZStd::string *outInvalidCharacters)
 

Additional Inherited Members

- Protected Attributes inherited from EMotionFX::Parameter
AZStd::string m_name
 
AZStd::string m_description
 
- Static Protected Attributes inherited from EMotionFX::Parameter
static const char s_invalidCharacters []
 

Detailed Description

ValueParameter inherits from Parameter and is the base type for all the parameters that contain a value (i.e. nOot groups)


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