DNA Calib 1.1
Project brief
Public Member Functions | Static Public Attributes | List of all members
dna::StreamReader Class Referenceabstract

#include <StreamReader.h>

Inheritance diagram for dna::StreamReader:
Inheritance graph
Collaboration diagram for dna::StreamReader:
Collaboration graph

Public Member Functions

 ~StreamReader () override
 
virtual void read ()=0
 read data from stream into internal structures. More...
 
- Public Member Functions inherited from dna::Reader
 ~Reader () override
 
virtual void unload (DataLayer layer)=0
 Unload all data of the specified layer and all layers dependent on it. More...
 
- Public Member Functions inherited from dna::BehaviorReader
virtual ConstArrayView< std::uint16_t > getGUIToRawInputIndices () const =0
 Input indices used for mapping gui to raw controls. More...
 
virtual ConstArrayView< std::uint16_t > getGUIToRawOutputIndices () const =0
 Output indices used for mapping gui to raw controls. More...
 
virtual ConstArrayView< float > getGUIToRawFromValues () const =0
 Filter values(lower-bounds) used to decide whether a particular entry should be evaluated or not during gui to raw control mapping. More...
 
virtual ConstArrayView< float > getGUIToRawToValues () const =0
 Filter values(upper-bounds) used to decide whether a particular entry should be evaluated or not during gui to raw control mapping. More...
 
virtual ConstArrayView< float > getGUIToRawSlopeValues () const =0
 Computational values(slope/gradient) used for calculating the output value during gui to raw control mapping. More...
 
virtual ConstArrayView< float > getGUIToRawCutValues () const =0
 Computational values(vertical intercept) used for calculating the output value during gui to raw control mapping. More...
 
virtual std::uint16_t getPSDCount () const =0
 The number of distinct PSD expressions. More...
 
virtual ConstArrayView< std::uint16_t > getPSDRowIndices () const =0
 PSD(input) indices. More...
 
virtual ConstArrayView< std::uint16_t > getPSDColumnIndices () const =0
 Control(input) indices. More...
 
virtual ConstArrayView< float > getPSDValues () const =0
 Weights associated with each PSD row and column pair. More...
 
virtual std::uint16_t getJointRowCount () const =0
 Number of rows in the entire, uncompressed joint matrix. More...
 
virtual std::uint16_t getJointColumnCount () const =0
 Number of columns in the entire, uncompressed joint matrix. More...
 
virtual ConstArrayView< std::uint16_t > getJointVariableAttributeIndices (std::uint16_t lod) const =0
 Joint attribute indices (output indices) for the requested LOD. More...
 
virtual std::uint16_t getJointGroupCount () const =0
 Number of joint groups present in the entire joint matrix. More...
 
virtual ConstArrayView< std::uint16_t > getJointGroupLODs (std::uint16_t jointGroupIndex) const =0
 Number of rows per each level of detail for the requested joint group. More...
 
virtual ConstArrayView< std::uint16_t > getJointGroupInputIndices (std::uint16_t jointGroupIndex) const =0
 Column indices that the requested joint group contains. More...
 
virtual ConstArrayView< std::uint16_t > getJointGroupOutputIndices (std::uint16_t jointGroupIndex) const =0
 Row indices that the requested joint group contains. More...
 
virtual ConstArrayView< float > getJointGroupValues (std::uint16_t jointGroupIndex) const =0
 Values that the requested joint group contains. More...
 
virtual ConstArrayView< std::uint16_t > getJointGroupJointIndices (std::uint16_t jointGroupIndex) const =0
 Joint indices that the requested joint group contains. More...
 
virtual ConstArrayView< std::uint16_t > getBlendShapeChannelLODs () const =0
 Input index count per each level of detail for blend shape channels. More...
 
virtual ConstArrayView< std::uint16_t > getBlendShapeChannelInputIndices () const =0
 Input indices used to index into the input vector. More...
 
virtual ConstArrayView< std::uint16_t > getBlendShapeChannelOutputIndices () const =0
 Output indices specify the positions of blend shape channel output values. More...
 
virtual ConstArrayView< std::uint16_t > getAnimatedMapLODs () const =0
 Row count per each level of detail for animated maps. More...
 
virtual ConstArrayView< std::uint16_t > getAnimatedMapInputIndices () const =0
 Input indices used to index into the array of input values. More...
 
virtual ConstArrayView< std::uint16_t > getAnimatedMapOutputIndices () const =0
 Output indices that specify the computed output value's position. More...
 
virtual ConstArrayView< float > getAnimatedMapFromValues () const =0
 Filter values(lower-bounds) used to decide whether a particular entry should be evaluated or not. More...
 
virtual ConstArrayView< float > getAnimatedMapToValues () const =0
 Filter values(upper-bounds) used to decide whether a particular entry should be evaluated or not. More...
 
virtual ConstArrayView< float > getAnimatedMapSlopeValues () const =0
 Computational values(slope/gradient) used for calculating the output value. More...
 
virtual ConstArrayView< float > getAnimatedMapCutValues () const =0
 Computational values(vertical intercept) used for calculating the output value. More...
 
- Public Member Functions inherited from dna::DefinitionReader
virtual std::uint16_t getGUIControlCount () const =0
 
virtual StringView getGUIControlName (std::uint16_t index) const =0
 Name of the requested GUI control. More...
 
virtual std::uint16_t getRawControlCount () const =0
 
virtual StringView getRawControlName (std::uint16_t index) const =0
 Name of the requested raw control. More...
 
virtual std::uint16_t getJointCount () const =0
 
virtual StringView getJointName (std::uint16_t index) const =0
 Name of the requested joint. More...
 
virtual std::uint16_t getJointIndexListCount () const =0
 Number of joint index lists. More...
 
virtual ConstArrayView< std::uint16_t > getJointIndicesForLOD (std::uint16_t lod) const =0
 List of joint indices for the specified LOD. More...
 
virtual std::uint16_t getJointParentIndex (std::uint16_t index) const =0
 Index of the requested joint's parent. More...
 
virtual std::uint16_t getBlendShapeChannelCount () const =0
 
virtual StringView getBlendShapeChannelName (std::uint16_t index) const =0
 Name of the requested blend shape channel. More...
 
virtual std::uint16_t getBlendShapeChannelIndexListCount () const =0
 Number of blend shape channel index lists. More...
 
virtual ConstArrayView< std::uint16_t > getBlendShapeChannelIndicesForLOD (std::uint16_t lod) const =0
 List of blend shape channel indices for the specified LOD. More...
 
virtual std::uint16_t getAnimatedMapCount () const =0
 
virtual StringView getAnimatedMapName (std::uint16_t index) const =0
 Name of the requested animated map. More...
 
virtual std::uint16_t getAnimatedMapIndexListCount () const =0
 Number of animated map index lists. More...
 
virtual ConstArrayView< std::uint16_t > getAnimatedMapIndicesForLOD (std::uint16_t lod) const =0
 List of animated map indices for the specified LOD. More...
 
virtual std::uint16_t getMeshCount () const =0
 
virtual StringView getMeshName (std::uint16_t index) const =0
 Name of the requested mesh. More...
 
virtual std::uint16_t getMeshIndexListCount () const =0
 Number of mesh index lists. More...
 
virtual ConstArrayView< std::uint16_t > getMeshIndicesForLOD (std::uint16_t lod) const =0
 List of mesh indices for the specified LOD. More...
 
virtual std::uint16_t getMeshBlendShapeChannelMappingCount () const =0
 Number of mesh-blend shape channel mapping items. More...
 
virtual MeshBlendShapeChannelMapping getMeshBlendShapeChannelMapping (std::uint16_t index) const =0
 
virtual ConstArrayView< std::uint16_t > getMeshBlendShapeChannelMappingIndicesForLOD (std::uint16_t lod) const =0
 List of mesh-blend shape channel mapping indices for the specified LOD. More...
 
virtual Vector3 getNeutralJointTranslation (std::uint16_t index) const =0
 
virtual ConstArrayView< float > getNeutralJointTranslationXs () const =0
 List of all translation X values. More...
 
virtual ConstArrayView< float > getNeutralJointTranslationYs () const =0
 List of all translation Y values. More...
 
virtual ConstArrayView< float > getNeutralJointTranslationZs () const =0
 List of all translation Z values. More...
 
virtual Vector3 getNeutralJointRotation (std::uint16_t index) const =0
 
virtual ConstArrayView< float > getNeutralJointRotationXs () const =0
 List of all rotation X values. More...
 
virtual ConstArrayView< float > getNeutralJointRotationYs () const =0
 List of all rotation Y values. More...
 
virtual ConstArrayView< float > getNeutralJointRotationZs () const =0
 List of all rotation Z values. More...
 
- Public Member Functions inherited from dna::DescriptorReader
virtual StringView getName () const =0
 
virtual Archetype getArchetype () const =0
 
virtual Gender getGender () const =0
 
virtual std::uint16_t getAge () const =0
 
virtual std::uint32_t getMetaDataCount () const =0
 
virtual StringView getMetaDataKey (std::uint32_t index) const =0
 
virtual StringView getMetaDataValue (const char *key) const =0
 Stored metadata value associated with the given key. More...
 
virtual TranslationUnit getTranslationUnit () const =0
 
virtual RotationUnit getRotationUnit () const =0
 
virtual CoordinateSystem getCoordinateSystem () const =0
 
virtual std::uint16_t getLODCount () const =0
 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). More...
 
virtual std::uint16_t getDBMaxLOD () const =0
 The maximum level of detail stored in the DNA data for this character. More...
 
virtual StringView getDBComplexity () const =0
 Name of the input control interface used to drive this character rig. More...
 
virtual StringView getDBName () const =0
 Name of the database from which the character originates. More...
 
- Public Member Functions inherited from dna::GeometryReader
virtual std::uint32_t getVertexPositionCount (std::uint16_t meshIndex) const =0
 Number of vertex positions in the entire mesh. More...
 
virtual Position getVertexPosition (std::uint16_t meshIndex, std::uint32_t vertexIndex) const =0
 
virtual ConstArrayView< float > getVertexPositionXs (std::uint16_t meshIndex) const =0
 List of all vertex position X values for the referenced mesh. More...
 
virtual ConstArrayView< float > getVertexPositionYs (std::uint16_t meshIndex) const =0
 List of all vertex position Y values for the referenced mesh. More...
 
virtual ConstArrayView< float > getVertexPositionZs (std::uint16_t meshIndex) const =0
 List of all vertex position Z values for the referenced mesh. More...
 
virtual std::uint32_t getVertexTextureCoordinateCount (std::uint16_t meshIndex) const =0
 Number of texture coordinates in the entire mesh. More...
 
virtual TextureCoordinate getVertexTextureCoordinate (std::uint16_t meshIndex, std::uint32_t textureCoordinateIndex) const =0
 
virtual ConstArrayView< float > getVertexTextureCoordinateUs (std::uint16_t meshIndex) const =0
 List of all texture coordinate U values for the referenced mesh. More...
 
virtual ConstArrayView< float > getVertexTextureCoordinateVs (std::uint16_t meshIndex) const =0
 List of all texture coordinate V values for the referenced mesh. More...
 
virtual std::uint32_t getVertexNormalCount (std::uint16_t meshIndex) const =0
 Number of vertex normals in the entire mesh. More...
 
virtual Normal getVertexNormal (std::uint16_t meshIndex, std::uint32_t normalIndex) const =0
 
virtual ConstArrayView< float > getVertexNormalXs (std::uint16_t meshIndex) const =0
 List of all normal X values for the referenced mesh. More...
 
virtual ConstArrayView< float > getVertexNormalYs (std::uint16_t meshIndex) const =0
 List of all normal Y value for the referenced meshs. More...
 
virtual ConstArrayView< float > getVertexNormalZs (std::uint16_t meshIndex) const =0
 List of all normal Z values for the referenced mesh. More...
 
virtual std::uint32_t getVertexLayoutCount (std::uint16_t meshIndex) const =0
 Number of vertex layouts in the entire mesh. More...
 
virtual VertexLayout getVertexLayout (std::uint16_t meshIndex, std::uint32_t layoutIndex) const =0
 Vertex layouts contain only attribute indices which can be used to query the actual attributes, such as positions, texture coordinates and normals, which are associated with the vertex. More...
 
virtual ConstArrayView< std::uint32_t > getVertexLayoutPositionIndices (std::uint16_t meshIndex) const =0
 Position indices for each vertex of the referenced mesh. More...
 
virtual ConstArrayView< std::uint32_t > getVertexLayoutTextureCoordinateIndices (std::uint16_t meshIndex) const =0
 Texture coordinate indices for each vertex of the referenced mesh. More...
 
virtual ConstArrayView< std::uint32_t > getVertexLayoutNormalIndices (std::uint16_t meshIndex) const =0
 Normal indices for each vertex of the referenced mesh. More...
 
virtual std::uint32_t getFaceCount (std::uint16_t meshIndex) const =0
 Number of faces that belong to the specified mesh. More...
 
virtual ConstArrayView< std::uint32_t > getFaceVertexLayoutIndices (std::uint16_t meshIndex, std::uint32_t faceIndex) const =0
 List of vertex layout indices the belong to a face on the specified mesh. More...
 
virtual std::uint16_t getMaximumInfluencePerVertex (std::uint16_t meshIndex) const =0
 The maximum number of joints that may influence any single vertex. More...
 
virtual std::uint32_t getSkinWeightsCount (std::uint16_t meshIndex) const =0
 Number of skin weights associated with the specified mesh. More...
 
virtual ConstArrayView< float > getSkinWeightsValues (std::uint16_t meshIndex, std::uint32_t vertexIndex) const =0
 List of skin weights influencing the requested vertex. More...
 
virtual ConstArrayView< std::uint16_t > getSkinWeightsJointIndices (std::uint16_t meshIndex, std::uint32_t vertexIndex) const =0
 List of joint indices associated with each skin weight for the specified vertex. More...
 
virtual std::uint16_t getBlendShapeTargetCount (std::uint16_t meshIndex) const =0
 Number of blend shapes that belong to the specified mesh. More...
 
virtual std::uint16_t getBlendShapeChannelIndex (std::uint16_t meshIndex, std::uint16_t blendShapeTargetIndex) const =0
 The matching blend shape channel index of the requested blend shape target. More...
 
virtual std::uint32_t getBlendShapeTargetDeltaCount (std::uint16_t meshIndex, std::uint16_t blendShapeTargetIndex) const =0
 Number of deltas that belong to the specified blend shape. More...
 
virtual Delta getBlendShapeTargetDelta (std::uint16_t meshIndex, std::uint16_t blendShapeTargetIndex, std::uint32_t deltaIndex) const =0
 List of deltas for each affected vertex. More...
 
virtual ConstArrayView< float > getBlendShapeTargetDeltaXs (std::uint16_t meshIndex, std::uint16_t blendShapeTargetIndex) const =0
 List of all delta X values for the referenced blend shape target. More...
 
virtual ConstArrayView< float > getBlendShapeTargetDeltaYs (std::uint16_t meshIndex, std::uint16_t blendShapeTargetIndex) const =0
 List of all delta Y values for the referenced blend shape target. More...
 
virtual ConstArrayView< float > getBlendShapeTargetDeltaZs (std::uint16_t meshIndex, std::uint16_t blendShapeTargetIndex) const =0
 List of all delta Z values for the referenced blend shape target. More...
 
virtual ConstArrayView< std::uint32_t > getBlendShapeTargetVertexIndices (std::uint16_t meshIndex, std::uint16_t blendShapeTargetIndex) const =0
 Vertex position indices affected by the referenced blend shape target. More...
 

Static Public Attributes

static const sc::StatusCode SignatureMismatchError {200, "DNA signature mismatched, expected %.3s, got %.3s"}
 
static const sc::StatusCode VersionMismatchError {201, "DNA version mismatched, expected %hu.%hu, got %hu.%hu"}
 
static const sc::StatusCode InvalidDataError {202, "Invalid data in DNA"}
 

Additional Inherited Members

- Protected Member Functions inherited from dna::BehaviorReader
virtual ~BehaviorReader ()
 
- Protected Member Functions inherited from dna::DefinitionReader
virtual ~DefinitionReader ()
 
- Protected Member Functions inherited from dna::DescriptorReader
virtual ~DescriptorReader ()
 
- Protected Member Functions inherited from dna::GeometryReader
virtual ~GeometryReader ()
 

Constructor & Destructor Documentation

◆ ~StreamReader()

dna::StreamReader::~StreamReader ( )
overridedefault

Member Function Documentation

◆ read()

virtual void dna::StreamReader::read ( )
pure virtual

read data from stream into internal structures.

Implemented in dna::BinaryStreamReaderImpl, and dna::JSONStreamReaderImpl.

Member Data Documentation

◆ InvalidDataError

const sc::StatusCode dna::StreamReader::InvalidDataError {202, "Invalid data in DNA"}
static

◆ SignatureMismatchError

const sc::StatusCode dna::StreamReader::SignatureMismatchError {200, "DNA signature mismatched, expected %.3s, got %.3s"}
static

◆ VersionMismatchError

const sc::StatusCode dna::StreamReader::VersionMismatchError {201, "DNA version mismatched, expected %hu.%hu, got %hu.%hu"}
static

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