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.
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
EMotionFX::Pipeline::Rule::MetaDataRule Class Reference

Inherits AZ::SceneAPI::DataTypes::IRule.

Public Member Functions

 AZ_RTTI (MetaDataRule, "{8D759063-7D2E-4543-8EB3-AB510A5886CF}", AZ::SceneAPI::DataTypes::IRule)
 
 MetaDataRule (const AZStd::string &metaData)
 
 MetaDataRule (const AZStd::vector< MCore::Command * > metaData)
 
template<typename T >
const T & GetMetaData () const
 
void SetMetaData (const AZStd::string &metaData)
 
void SetMetaData (const AZStd::vector< MCore::Command * > &metaData)
 

Static Public Member Functions

template<typename T >
static bool LoadMetaData (const AZ::SceneAPI::DataTypes::IGroup &group, T &outMetaDataString)
 
template<typename T >
static void SaveMetaData (AZ::SceneAPI::Containers::Scene &scene, AZ::SceneAPI::DataTypes::IGroup &group, const T &metaData)
 
template<typename T , typename MetaDataType >
static bool SaveMetaDataToFile (const AZStd::string &sourceAssetFilename, const AZStd::string &groupName, const MetaDataType &metaDataString)
 
template<typename T , typename MetaDataType >
static bool SaveMetaDataToFile (const AZStd::string &sourceAssetFilename, const AZStd::string &groupName, const MetaDataType &metaDataString, AZStd::string &outResult)
 
static void Reflect (AZ::ReflectContext *context)
 

Protected Attributes

AZStd::string m_metaData
 
AZStd::vector< MCore::Command * > m_commands
 

Member Function Documentation

◆ GetMetaData()

template<typename T >
const T & EMotionFX::Pipeline::Rule::MetaDataRule::GetMetaData ( ) const

Get the string containing the list of commands representing the changes the user did on the source asset.

Returns
A string called meta data containing a list of commands.

◆ LoadMetaData()

template<typename T >
static bool EMotionFX::Pipeline::Rule::MetaDataRule::LoadMetaData ( const AZ::SceneAPI::DataTypes::IGroup &  group,
T &  outMetaDataString 
)
static

Get the meta data string from the group. Search the rule container of the given group for a meta data rule and read out the meta data string.

Parameters
groupThe group to search for the meta data.
[out]outMetaDataStringHolds the meta data string after the operation has been completed. String will be empty in case something failed or there is no meta data.

◆ SaveMetaData()

template<typename T >
static void EMotionFX::Pipeline::Rule::MetaDataRule::SaveMetaData ( AZ::SceneAPI::Containers::Scene &  scene,
AZ::SceneAPI::DataTypes::IGroup &  group,
const T &  metaData 
)
static

Set the meta data string to the given group. Search the rule container of the given group for a meta data rule, create one in case there is none yet and set the given meta data string to the rule.

Parameters
groupThe group to set the meta data for.
metaDataStringThe meta data string to set. In case the string is empty, any existing meta data rule will be removed.

◆ SetMetaData()

void EMotionFX::Pipeline::Rule::MetaDataRule::SetMetaData ( const AZStd::string &  metaData)

Set the meta data string which contains a list of commands representing the changes the user did on the source asset. This string can be constructed using CommandSystem::GenerateActorMetaData().

Parameters
metaDataThe meta data string containing a list of commands to be applied on the source asset.
The documentation for this class was generated from the following files: