DescriptorReader

Read-only accessors for various metadata about the character and the rig.

Windows
MacOS
Linux

Warnings

  • Implementors should inherit from Reader itself and not this class. @note The inherited LODExtentReader provides the interface to access the LOD count.

Inheritance Hierarchy

References

Module

RigLogicLib

Header

/Engine/Plugins/Animation/RigLogic/Source/RigLogicLib/Public/dna/layers/DescriptorReader.h

Include

#include "dna/layers/DescriptorReader.h"

Syntax

class DescriptorReader

Remarks

Implementors should inherit from Reader itself and not this class. @note The inherited LODExtentReader provides the interface to access the LOD count.

Destructors

Name Description

Protected function Virtual

~DescriptorReader()

Functions

Name Description

Public function Const

std::uint16_...

 

getAge()

Public function Const

Archetype

 

getArchetype()

Public function Const

CoordinateSy...

 

getCoordinateSystem()

Public function Const

StringView

 

getDBComplexity()

Name of the input control interface used to drive this character rig. @note This parameter denotes the character's input control complexity.

Public function Const

std::uint16_...

 

getDBMaxLOD()

The maximum level of detail stored in the DNA data for this character. @note The value is relative to LOD-0 from the database.

Public function Const

StringView

 

getDBName()

Name of the database from which the character originates. @note All characters from the same database must have the same Definition, but may have different complexity or LOD.

Public function Const

Gender

 

getGender()

Public function Const

std::uint16_...

 

getLODCount()

Available levels of detail (e.g. 6 which means the following levels are available: [0,1,2,3,4,5], where 0 is the LOD with the highest details, and 5 is the LOD with lowest details).

Public function Const

std::uint32_...

 

getMetaDataCount()

Public function Const

StringView

 

getMetaDataKey

(
    std::uint32_t index
)

The index must be less than the value returned by getMetaDataCount.

Public function Const

StringView

 

getMetaDataValue

(
    const char* key
)

Stored metadata value associated with the given key. @note If no value is associated with the given key, the returned view will contain nullptr and will have a size of 0.

Public function Const

StringView

 

getName()

Public function Const

RotationUnit

 

getRotationUnit()

Public function Const

TranslationU...

 

getTranslationUnit()

See Also

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss