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::FloatParameter Class Reference

Inherits EMotionFX::RangedValueParameter< float, FloatParameter >.

Inherited by EMotionFX::FloatSliderParameter, and EMotionFX::FloatSpinnerParameter.

Public Member Functions

 FloatParameter (AZStd::string name, AZStd::string description={})
 
MCore::AttributeConstructDefaultValueAsAttribute () const override
 
uint32 GetType () const override
 
bool AssignDefaultValueToAttribute (MCore::Attribute *attribute) const override
 
bool SetDefaultValueFromAttribute (MCore::Attribute *attribute) override
 
bool SetMinValueFromAttribute (MCore::Attribute *attribute) override
 
bool SetMaxValueFromAttribute (MCore::Attribute *attribute) override
 
- Public Member Functions inherited from EMotionFX::RangedValueParameter< float, FloatParameter >
 RangedValueParameter (const float &defaultValue, const float &minValue, const float &maxValue, bool hasMinValue=true, bool hasMaxValue=true, AZStd::string name={}, AZStd::string description={})
 
float GetMinValue () const
 
void SetMinValue (const float &newValue)
 
float GetMaxValue () const
 
void SetMaxValue (const float &newValue)
 
bool GetHasMinValue () const
 
void SetHasMinValue (const bool newValue)
 
bool GetHasMaxValue () const
 
void SetHasMaxValue (const bool newValue)
 
- Public Member Functions inherited from EMotionFX::DefaultValueParameter< ValueType, Derived >
 AZ_RTTI ((DefaultValueParameter, "{AE70C43D-6BAE-4EDF-A1CF-FC18B9F92ABB}", ValueType, Derived), ValueParameter)
 
 DefaultValueParameter (const ValueType &defaultValue, AZStd::string name={}, AZStd::string description={})
 
ValueType GetDefaultValue () const
 
void SetDefaultValue (const ValueType &newValue)
 
- Public Member Functions inherited from EMotionFX::ValueParameter
 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 float GetUnboundedMinValue ()
 
static float GetUnboundedMaxValue ()
 
- Static Public Member Functions inherited from EMotionFX::RangedValueParameter< float, FloatParameter >
static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from EMotionFX::DefaultValueParameter< ValueType, Derived >
static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from EMotionFX::ValueParameter
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 Member Functions inherited from EMotionFX::RangedValueParameter< float, FloatParameter >
AZ::Crc32 GetMinValueVisibility () const
 
AZ::Crc32 GetMaxValueVisibility () const
 
- Protected Attributes inherited from EMotionFX::RangedValueParameter< float, FloatParameter >
float m_minValue
 
float m_maxValue
 
bool m_hasMinValue
 
bool m_hasMaxValue
 
- Protected Attributes inherited from EMotionFX::DefaultValueParameter< ValueType, Derived >
ValueType m_defaultValue
 
- 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 []
 

Member Function Documentation

◆ AssignDefaultValueToAttribute()

bool EMotionFX::FloatParameter::AssignDefaultValueToAttribute ( MCore::Attribute attribute) const
overridevirtual

◆ ConstructDefaultValueAsAttribute()

MCore::Attribute * EMotionFX::FloatParameter::ConstructDefaultValueAsAttribute ( ) const
overridevirtual

◆ GetType()

uint32 EMotionFX::FloatParameter::GetType ( ) const
overridevirtual

◆ SetDefaultValueFromAttribute()

bool EMotionFX::FloatParameter::SetDefaultValueFromAttribute ( MCore::Attribute attribute)
overridevirtual

◆ SetMaxValueFromAttribute()

bool EMotionFX::FloatParameter::SetMaxValueFromAttribute ( MCore::Attribute attribute)
overridevirtual

Reimplemented from EMotionFX::ValueParameter.

◆ SetMinValueFromAttribute()

bool EMotionFX::FloatParameter::SetMinValueFromAttribute ( MCore::Attribute attribute)
overridevirtual

Reimplemented from EMotionFX::ValueParameter.


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