Open 3D Engine EMotionFX Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
EMotionFX::SharedHelperData Class Reference

#include <ChunkProcessors.h>

Inherits EMotionFX::SharedData.

Public Types

enum  { TYPE_ID = 0x00000001 }
 

Public Member Functions

uint32 GetType () const
 
void Reset ()
 
- Public Member Functions inherited from EMotionFX::BaseObject
 BaseObject ()
 
virtual ~BaseObject ()
 
- Public Member Functions inherited from MCore::MemoryObject
 MemoryObject ()
 
virtual ~MemoryObject ()
 
void IncreaseReferenceCount ()
 
void DecreaseReferenceCount ()
 
void Destroy ()
 
uint32 GetReferenceCount () const
 

Static Public Member Functions

static SharedHelperData * Create ()
 
static const char * ReadString (MCore::Stream *file, AZStd::vector< SharedData * > *sharedData, MCore::Endian::EEndianType endianType)
 

Public Attributes

uint32 m_fileHighVersion
 
uint32 m_fileLowVersion
 
uint32 m_stringStorageSize
 
bool m_isUnicodeFile
 
char * m_stringStorage
 

Protected Member Functions

 SharedHelperData ()
 
 ~SharedHelperData ()
 
- Protected Member Functions inherited from EMotionFX::BaseObject
void Delete () override
 

Detailed Description

Helper class for reading strings from files and file information storage.

Constructor & Destructor Documentation

EMotionFX::SharedHelperData::SharedHelperData ( )
protected

The constructor.

EMotionFX::SharedHelperData::~SharedHelperData ( )
protected

The destructor.

Member Function Documentation

uint32 EMotionFX::SharedHelperData::GetType ( ) const
inlinevirtual

Get the unique attribute type.

Returns
The attribute ID.

Implements EMotionFX::SharedData.

static const char* EMotionFX::SharedHelperData::ReadString ( MCore::Stream *  file,
AZStd::vector< SharedData * > *  sharedData,
MCore::Endian::EEndianType  endianType 
)
static

Read a string chunk from a file.

Parameters
fileThe stream to read the string chunk from.
sharedDataThe array which holds the shared data objects.
endianTypeThe endian type to read the string in.
Returns
The actual string.
void EMotionFX::SharedHelperData::Reset ( )
virtual

Get rid of the information provided by the shared data.

Reimplemented from EMotionFX::SharedData.

Member Data Documentation

uint32 EMotionFX::SharedHelperData::m_fileHighVersion

The high file version. For example 3 in case of v3.10.

uint32 EMotionFX::SharedHelperData::m_fileLowVersion

The low file version. For example 10 in case of v3.10.

bool EMotionFX::SharedHelperData::m_isUnicodeFile

True in case strings in the file are saved using unicode character set, false in case they are saved using multi-byte.

char* EMotionFX::SharedHelperData::m_stringStorage

The shared string buffer.

uint32 EMotionFX::SharedHelperData::m_stringStorageSize

The size of the string buffer.

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