1. Epic GamesDeveloper
  3. FReader

FReader

The code is similar to the [FSkelMeshDNAReader](API\Plugins\RigLogicModule\FSkelMeshDNAReader) but implements the [dna::BinaryStreamReader](API\Plugins\RigLogicLib\BinaryStreamReader) interface instead of the [IDNAReader](API\Plugins\RigLogicModule\IDNAReader) one.

API > API/Plugins > API/Plugins/MetaHumanCoreTechLib

The code is similar to the FSkelMeshDNAReader but implements the dna::BinaryStreamReader interface instead of the IDNAReader one.

   
Name FReader
Type class
Header File /Engine/Plugins/MetaHuman/MetaHumanCoreTechLib/Source/MetaHumanCoreTechLib/Public/FReader.h
Include Path #include "FReader.h"

Syntax

class FReader : public dna::BinaryStreamReader

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FReader ( UDNAAsset* DNAAsset
)

   FReader.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BehaviorReader const Reader *   FReader.h  
GeometryReader const Reader *   FReader.h  

Functions

Public

Overridden from StreamReader

Name Remarks Include Path Unreal Specifiers

virtual void read()

 StreamReader. FReader.h  

Overridden from Reader

Name Remarks Include Path Unreal Specifiers

virtual void unload ( dna::DataLayer Layer
)

 Reader. FReader.h  

Overridden from RBFBehaviorReader

Name Remarks Include Path Unreal Specifiers

virtual ConstArrayView< std::uint16_t > getRBFPoseAnimatedMapOutputIndices ( std::uint16_t poseIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getRBFPoseBlendShapeChannelOutputIndices ( std::uint16_t poseIndex
) const

   FReader.h  

virtual std::uint16_t getRBFPoseControlCount()

   FReader.h  

virtual StringView getRBFPoseControlName ( std::uint16_t poseControlIndex
) const

   FReader.h  

virtual std::uint16_t getRBFPoseCount()

 RBFBehaviorReader methods. FReader.h  

virtual ConstArrayView< std::uint16_t > getRBFPoseInputControlIndices ( std::uint16_t poseIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getRBFPoseJointOutputIndices ( std::uint16_t poseIndex
) const

   FReader.h  

virtual ConstArrayView< float > getRBFPoseJointOutputValues ( std::uint16_t poseIndex
) const

   FReader.h  

virtual StringView getRBFPoseName ( std::uint16_t poseIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getRBFPoseOutputControlIndices ( std::uint16_t poseIndex
) const

   FReader.h  

virtual ConstArrayView< float > getRBFPoseOutputControlWeights ( std::uint16_t poseIndex
) const

   FReader.h  

virtual float getRBFPoseScale ( std::uint16_t poseIndex
) const

   FReader.h  

virtual AutomaticRadius getRBFSolverAutomaticRadius ( std::uint16_t solverIndex
) const

   FReader.h  

virtual std::uint16_t getRBFSolverCount()

   FReader.h  

virtual RBFDistanceMethod getRBFSolverDistanceMethod ( std::uint16_t solverIndex
) const

   FReader.h  

virtual RBFFunctionType getRBFSolverFunctionType ( std::uint16_t solverIndex
) const

   FReader.h  

virtual std::uint16_t getRBFSolverIndexListCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getRBFSolverIndicesForLOD ( std::uint16_t lod
) const

   FReader.h  

virtual StringView getRBFSolverName ( std::uint16_t solverIndex
) const

   FReader.h  

virtual RBFNormalizeMethod getRBFSolverNormalizeMethod ( std::uint16_t solverIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getRBFSolverPoseIndices ( std::uint16_t solverIndex
) const

   FReader.h  

virtual float getRBFSolverRadius ( std::uint16_t solverIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getRBFSolverRawControlIndices ( std::uint16_t solverIndex
) const

   FReader.h  

virtual ConstArrayView< float > getRBFSolverRawControlValues ( std::uint16_t solverIndex
) const

   FReader.h  

virtual TwistAxis getRBFSolverTwistAxis ( std::uint16_t solverIndex
) const

   FReader.h  

virtual RBFSolverType getRBFSolverType ( std::uint16_t solverIndex
) const

   FReader.h  

virtual float getRBFSolverWeightThreshold ( std::uint16_t solverIndex
) const

   FReader.h  

Overridden from BehaviorReader

Name Remarks Include Path Unreal Specifiers

virtual ConstArrayView< float > getAnimatedMapCutValues()

   FReader.h  

virtual ConstArrayView< float > getAnimatedMapFromValues()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getAnimatedMapInputIndices()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getAnimatedMapLODs()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getAnimatedMapOutputIndices()

   FReader.h  

virtual ConstArrayView< float > getAnimatedMapSlopeValues()

   FReader.h  

virtual ConstArrayView< float > getAnimatedMapToValues()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getBlendShapeChannelInputIndices()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getBlendShapeChannelLODs()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getBlendShapeChannelOutputIndices()

   FReader.h  

virtual ConstArrayView< float > getGUIToRawCutValues()

   FReader.h  

virtual ConstArrayView< float > getGUIToRawFromValues()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getGUIToRawInputIndices()

 Behaviour FReader.h  

virtual ConstArrayView< std::uint16_t > getGUIToRawOutputIndices()

   FReader.h  

virtual ConstArrayView< float > getGUIToRawSlopeValues()

   FReader.h  

virtual ConstArrayView< float > getGUIToRawToValues()

   FReader.h  

virtual std::uint16_t getJointColumnCount()

   FReader.h  

virtual std::uint16_t getJointGroupCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getJointGroupInputIndices ( std::uint16_t jointGroupIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getJointGroupJointIndices ( std::uint16_t jointGroupIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getJointGroupLODs ( std::uint16_t jointGroupIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getJointGroupOutputIndices ( std::uint16_t jointGroupIndex
) const

   FReader.h  

virtual ConstArrayView< float > getJointGroupValues ( std::uint16_t jointGroupIndex
) const

   FReader.h  

virtual std::uint16_t getJointRowCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getJointVariableAttributeIndices ( std::uint16_t lod
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getPSDColumnIndices()

   FReader.h  

virtual std::uint16_t getPSDCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getPSDRowIndices()

   FReader.h  

virtual ConstArrayView< float > getPSDValues()

   FReader.h  

Overridden from DefinitionReader

Name Remarks Include Path Unreal Specifiers

virtual std::uint16_t getAnimatedMapCount()

   FReader.h  

virtual std::uint16_t getAnimatedMapIndexListCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getAnimatedMapIndicesForLOD ( std::uint16_t lod
) const

   FReader.h  

virtual StringView getAnimatedMapName ( std::uint16_t index
) const

   FReader.h  

virtual std::uint16_t getBlendShapeChannelCount()

   FReader.h  

virtual std::uint16_t getBlendShapeChannelIndexListCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getBlendShapeChannelIndicesForLOD ( std::uint16_t lod
) const

   FReader.h  

virtual StringView getBlendShapeChannelName ( std::uint16_t index
) const

   FReader.h  

virtual std::uint16_t getGUIControlCount()

 Definition FReader.h  

virtual StringView getGUIControlName ( std::uint16_t index
) const

   FReader.h  

virtual std::uint16_t getJointCount()

   FReader.h  

virtual std::uint16_t getJointIndexListCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getJointIndicesForLOD ( std::uint16_t lod
) const

   FReader.h  

virtual StringView getJointName ( std::uint16_t index
) const

   FReader.h  

virtual std::uint16_t getJointParentIndex ( std::uint16_t index
) const

   FReader.h  

virtual MeshBlendShapeChannelMapping getMeshBlendShapeChannelMapping ( std::uint16_t index
) const

   FReader.h  

virtual std::uint16_t getMeshBlendShapeChannelMappingCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getMeshBlendShapeChannelMappingIndicesForLOD ( std::uint16_t lod
) const

   FReader.h  

virtual std::uint16_t getMeshCount()

   FReader.h  

virtual std::uint16_t getMeshIndexListCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getMeshIndicesForLOD ( std::uint16_t lod
) const

   FReader.h  

virtual StringView getMeshName ( std::uint16_t index
) const

   FReader.h  

virtual Vector3 getNeutralJointRotation ( std::uint16_t index
) const

   FReader.h  

virtual ConstArrayView< float > getNeutralJointRotationXs()

   FReader.h  

virtual ConstArrayView< float > getNeutralJointRotationYs()

   FReader.h  

virtual ConstArrayView< float > getNeutralJointRotationZs()

   FReader.h  

virtual Vector3 getNeutralJointTranslation ( std::uint16_t index
) const

   FReader.h  

virtual ConstArrayView< float > getNeutralJointTranslationXs()

   FReader.h  

virtual ConstArrayView< float > getNeutralJointTranslationYs()

   FReader.h  

virtual ConstArrayView< float > getNeutralJointTranslationZs()

   FReader.h  

virtual std::uint16_t getRawControlCount()

   FReader.h  

virtual StringView getRawControlName ( std::uint16_t index
) const

   FReader.h  

Overridden from DescriptorReader

Name Remarks Include Path Unreal Specifiers

virtual std::uint16_t getAge()

   FReader.h  

virtual Archetype getArchetype()

   FReader.h  

virtual CoordinateSystem getCoordinateSystem()

   FReader.h  

virtual StringView getDBComplexity()

   FReader.h  

virtual std::uint16_t getDBMaxLOD()

   FReader.h  

virtual StringView getDBName()

   FReader.h  

virtual Gender getGender()

   FReader.h  

virtual std::uint16_t getLODCount()

   FReader.h  

virtual std::uint32_t getMetaDataCount()

   FReader.h  

virtual StringView getMetaDataKey ( std::uint32_t index
) const

   FReader.h  

virtual StringView getMetaDataValue ( const char* key
) const

   FReader.h  

virtual StringView getName()

 Description FReader.h  

virtual RotationUnit getRotationUnit()

   FReader.h  

virtual TranslationUnit getTranslationUnit()

   FReader.h  

Overridden from HeaderReader

Name Remarks Include Path Unreal Specifiers

virtual std::uint16_t getFileFormatGeneration()

 Machine Learned Behavior. FReader.h  

virtual std::uint16_t getFileFormatVersion()

   FReader.h  

Overridden from GeometryReader

Name Remarks Include Path Unreal Specifiers

virtual std::uint16_t getBlendShapeChannelIndex ( std::uint16_t meshIndex,
std::uint16_t blendShapeTargetIndex
) const

   FReader.h  

virtual std::uint16_t getBlendShapeTargetCount ( std::uint16_t meshIndex
) const

   FReader.h  

virtual Delta getBlendShapeTargetDelta ( std::uint16_t meshIndex,
std::uint16_t blendShapeTargetIndex,
std::uint32_t deltaIndex
) const

   FReader.h  

virtual std::uint32_t getBlendShapeTargetDeltaCount ( std::uint16_t meshIndex,
std::uint16_t blendShapeTargetIndex
) const

   FReader.h  

virtual ConstArrayView< float > getBlendShapeTargetDeltaXs ( std::uint16_t meshIndex,
std::uint16_t blendShapeTargetIndex
) const

   FReader.h  

virtual ConstArrayView< float > getBlendShapeTargetDeltaYs ( std::uint16_t meshIndex,
std::uint16_t blendShapeTargetIndex
) const

   FReader.h  

virtual ConstArrayView< float > getBlendShapeTargetDeltaZs ( std::uint16_t meshIndex,
std::uint16_t blendShapeTargetIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint32_t > getBlendShapeTargetVertexIndices ( std::uint16_t meshIndex,
std::uint16_t blendShapeTargetIndex
) const

   FReader.h  

virtual std::uint32_t getFaceCount ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint32_t > getFaceVertexLayoutIndices ( std::uint16_t meshIndex,
std::uint32_t faceIndex
) const

   FReader.h  

virtual std::uint16_t getMaximumInfluencePerVertex ( std::uint16_t meshIndex
) const

   FReader.h  

virtual std::uint32_t getSkinWeightsCount ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getSkinWeightsJointIndices ( std::uint16_t meshIndex,
std::uint32_t vertexIndex
) const

   FReader.h  

virtual ConstArrayView< float > getSkinWeightsValues ( std::uint16_t meshIndex,
std::uint32_t vertexIndex
) const

   FReader.h  

virtual VertexLayout getVertexLayout ( std::uint16_t meshIndex,
std::uint32_t layoutIndex
) const

   FReader.h  

virtual std::uint32_t getVertexLayoutCount ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint32_t > getVertexLayoutNormalIndices ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint32_t > getVertexLayoutPositionIndices ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint32_t > getVertexLayoutTextureCoordinateIndices ( std::uint16_t meshIndex
) const

   FReader.h  

virtual Normal getVertexNormal ( std::uint16_t meshIndex,
std::uint32_t normalIndex
) const

   FReader.h  

virtual std::uint32_t getVertexNormalCount ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< float > getVertexNormalXs ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< float > getVertexNormalYs ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< float > getVertexNormalZs ( std::uint16_t meshIndex
) const

   FReader.h  

virtual Position getVertexPosition ( std::uint16_t meshIndex,
std::uint32_t vertexIndex
) const

   FReader.h  

virtual std::uint32_t getVertexPositionCount ( std::uint16_t meshIndex
) const

 Geometry FReader.h  

virtual ConstArrayView< float > getVertexPositionXs ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< float > getVertexPositionYs ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< float > getVertexPositionZs ( std::uint16_t meshIndex
) const

   FReader.h  

virtual TextureCoordinate getVertexTextureCoordinate ( std::uint16_t meshIndex,
std::uint32_t textureCoordinateIndex
) const

   FReader.h  

virtual std::uint32_t getVertexTextureCoordinateCount ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< float > getVertexTextureCoordinateUs ( std::uint16_t meshIndex
) const

   FReader.h  

virtual ConstArrayView< float > getVertexTextureCoordinateVs ( std::uint16_t meshIndex
) const

   FReader.h  

Overridden from MachineLearnedBehaviorReader

Name Remarks Include Path Unreal Specifiers

virtual std::uint16_t getMeshRegionCount ( std::uint16_t meshIndex
) const

   FReader.h  

virtual StringView getMeshRegionName ( std::uint16_t meshIndex,
std::uint16_t regionIndex
) const

   FReader.h  

virtual std::uint16_t getMLControlCount()

   FReader.h  

virtual StringView getMLControlName ( std::uint16_t index
) const

   FReader.h  

virtual std::uint16_t getNeuralNetworkCount()

   FReader.h  

virtual std::uint16_t getNeuralNetworkIndexListCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getNeuralNetworkIndicesForLOD ( std::uint16_t lod
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getNeuralNetworkIndicesForMeshRegion ( std::uint16_t meshIndex,
std::uint16_t regionIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getNeuralNetworkInputIndices ( std::uint16_t netIndex
) const

   FReader.h  

virtual ActivationFunction getNeuralNetworkLayerActivationFunction ( std::uint16_t netIndex,
std::uint16_t layerIndex
) const

   FReader.h  

virtual ConstArrayView< float > getNeuralNetworkLayerActivationFunctionParameters ( std::uint16_t netIndex,
std::uint16_t layerIndex
) const

   FReader.h  

virtual ConstArrayView< float > getNeuralNetworkLayerBiases ( std::uint16_t netIndex,
std::uint16_t layerIndex
) const

   FReader.h  

virtual std::uint16_t getNeuralNetworkLayerCount ( std::uint16_t netIndex
) const

   FReader.h  

virtual ConstArrayView< float > getNeuralNetworkLayerWeights ( std::uint16_t netIndex,
std::uint16_t layerIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getNeuralNetworkOutputIndices ( std::uint16_t netIndex
) const

   FReader.h  

Overridden from JointBehaviorMetadataReader

Name Remarks Include Path Unreal Specifiers

virtual RotationRepresentation getJointRotationRepresentation ( std::uint16_t jointIndex
) const

   FReader.h  

virtual ScaleRepresentation getJointScaleRepresentation ( std::uint16_t jointIndex
) const

   FReader.h  

virtual TranslationRepresentation getJointTranslationRepresentation ( std::uint16_t jointIndex
) const

 JointBehaviorMetadataReader methods. FReader.h  

Overridden from TwistSwingBehaviorReader

Name Remarks Include Path Unreal Specifiers

virtual ConstArrayView< float > getSwingBlendWeights ( std::uint16_t swingIndex
) const

   FReader.h  

virtual std::uint16_t getSwingCount()

   FReader.h  

virtual ConstArrayView< std::uint16_t > getSwingInputControlIndices ( std::uint16_t swingIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getSwingOutputJointIndices ( std::uint16_t swingIndex
) const

   FReader.h  

virtual TwistAxis getSwingSetupTwistAxis ( std::uint16_t swingIndex
) const

   FReader.h  

virtual ConstArrayView< float > getTwistBlendWeights ( std::uint16_t twistIndex
) const

   FReader.h  

virtual std::uint16_t getTwistCount()

 TwistSwingBehaviorReader methods. FReader.h  

virtual ConstArrayView< std::uint16_t > getTwistInputControlIndices ( std::uint16_t twistIndex
) const

   FReader.h  

virtual ConstArrayView< std::uint16_t > getTwistOutputJointIndices ( std::uint16_t twistIndex
) const

   FReader.h  

virtual TwistAxis getTwistSetupTwistAxis ( std::uint16_t twistIndex
) const

   FReader.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page