DefinitionReader

Read-only accessors for DNA attributes that represent the rig's static data.

Windows
MacOS
Linux

Warnings

  • Implementors should inherit from Reader itself and not this class.

Inheritance Hierarchy

References

Module

RigLogicLib

Header

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

Include

#include "dna/layers/DefinitionReader.h"

Syntax

class DefinitionReader : public dna::DescriptorReader

Remarks

Implementors should inherit from Reader itself and not this class.

Destructors

Name Description

Protected function Virtual

~DefinitionReader()

Functions

Name Description

Public function Const

std::uint16_...

 

getAnimatedMapCount()

Public function Const

std::uint16_...

 

getAnimatedMapIndexListCount()

Number of animated map index lists. @note This value is useful only in the context of DefinitionWriter.

Public function Const

ConstArrayVi...

 

getAnimatedMapIndicesForLOD

(
    std::uint16_t lod
)

List of animated map indices for the specified LOD.

Public function Const

StringView

 

getAnimatedMapName

(
    std::uint16_t index
)

Name of the requested animated map.

Public function Const

std::uint16_...

 

getBlendShapeChannelCount()

Public function Const

std::uint16_...

 

getBlendShapeChannelIndexListCount()

Number of blend shape channel index lists. @note This value is useful only in the context of DefinitionWriter.

Public function Const

ConstArrayVi...

 

getBlendShapeChannelIndicesForLOD

(
    std::uint16_t lod
)

List of blend shape channel indices for the specified LOD.

Public function Const

StringView

 

getBlendShapeChannelName

(
    std::uint16_t index
)

Name of the requested blend shape channel.

Public function Const

std::uint16_...

 

getGUIControlCount()

Public function Const

StringView

 

getGUIControlName

(
    std::uint16_t index
)

Name of the requested GUI control.

Public function Const

std::uint16_...

 

getJointCount()

Public function Const

std::uint16_...

 

getJointIndexListCount()

Number of joint index lists. @note This value is useful only in the context of DefinitionWriter.

Public function Const

ConstArrayVi...

 

getJointIndicesForLOD

(
    std::uint16_t lod
)

List of joint indices for the specified LOD.

Public function Const

StringView

 

getJointName

(
    std::uint16_t index
)

Name of the requested joint.

Public function Const

std::uint16_...

 

getJointParentIndex

(
    std::uint16_t index
)

Index of the requested joint's parent. @note The joint hierarchy may be traversed and reconstructed using this function. Example: Joint names: [A, B, C, D, E, F, G, H, I] Hierarchy: [0, 0, 0, 1, 1, 4, 2, 6, 2] Describes the following hierarchy: A.

Public function Const

MeshBlendSha...

 

getMeshBlendShapeChannelMapping

(
    std::uint16_t index
)

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

Public function Const

std::uint16_...

 

getMeshBlendShapeChannelMappingCount()

Number of mesh-blend shape channel mapping items.

Public function Const

ConstArrayVi...

 

getMeshBlendShapeChannelMappingIndicesForLOD

(
    std::uint16_t lod
)

List of mesh-blend shape channel mapping indices for the specified LOD. @note The indices from this list can be used with the getMeshBlendShapeChannelMapping API to retrieve individual mapping items.

Public function Const

std::uint16_...

 

getMeshCount()

Public function Const

std::uint16_...

 

getMeshIndexListCount()

Number of mesh index lists. @note This value is useful only in the context of DefinitionWriter.

Public function Const

ConstArrayVi...

 

getMeshIndicesForLOD

(
    std::uint16_t lod
)

List of mesh indices for the specified LOD.

Public function Const

StringView

 

getMeshName

(
    std::uint16_t index
)

Name of the requested mesh.

Public function Const

Vector3

 

getNeutralJointRotation

(
    std::uint16_t index
)

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

Public function Const

ConstArrayVi...

 

getNeutralJointRotationXs()

List of all rotation X values. @note This is an advanced API for performance critical access, for more convenient usage see getNeutralJointRotation.

Public function Const

ConstArrayVi...

 

getNeutralJointRotationYs()

List of all rotation Y values. @note This is an advanced API for performance critical access, for more convenient usage see getNeutralJointRotation.

Public function Const

ConstArrayVi...

 

getNeutralJointRotationZs()

List of all rotation Z values. @note This is an advanced API for performance critical access, for more convenient usage see getNeutralJointRotation.

Public function Const

Vector3

 

getNeutralJointTranslation

(
    std::uint16_t index
)

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

Public function Const

ConstArrayVi...

 

getNeutralJointTranslationXs()

List of all translation X values. @note This is an advanced API for performance critical access, for more convenient usage see getNeutralJointTranslation.

Public function Const

ConstArrayVi...

 

getNeutralJointTranslationYs()

List of all translation Y values. @note This is an advanced API for performance critical access, for more convenient usage see getNeutralJointTranslation.

Public function Const

ConstArrayVi...

 

getNeutralJointTranslationZs()

List of all translation Z values. @note This is an advanced API for performance critical access, for more convenient usage see getNeutralJointTranslation.

Public function Const

std::uint16_...

 

getRawControlCount()

Public function Const

StringView

 

getRawControlName

(
    std::uint16_t index
)

Name of the requested raw control.

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