GeometryReader

Read-only accessors to the geometry data associated with a rig.

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/GeometryReader.h

Include

#include "dna/layers/GeometryReader.h"

Syntax

class GeometryReader : public virtual dna::DefinitionReader

Remarks

Implementors should inherit from Reader itself and not this class.

Destructors

Name Description

Protected function Virtual

~GeometryReader()

Functions

Name Description

Public function Const

std::uint16_...

 

getBlendShapeChannelIndex

(
    std::uint16_t meshIndex,
    std::uint16_t blendShapeTargetIndex
)

The matching blend shape channel index of the requested blend shape target.

Public function Const

std::uint16_...

 

getBlendShapeTargetCount

(
    std::uint16_t meshIndex
)

Number of blend shapes that belong to the specified mesh.

Public function Const

Delta

 

getBlendShapeTargetDelta

(
    std::uint16_t meshIndex,
    std::uint16_t blendShapeTargetIndex,
    std::uint32_t deltaIndex
)

List of deltas for each affected vertex.

Public function Const

std::uint32_...

 

getBlendShapeTargetDeltaCount

(
    std::uint16_t meshIndex,
    std::uint16_t blendShapeTargetIndex
)

Number of deltas that belong to the specified blend shape.

Public function Const

ConstArrayVi...

 

getBlendShapeTargetDeltaXs

(
    std::uint16_t meshIndex,
    std::uint16_t blendShapeTargetIndex
)

List of all delta X values for the referenced blend shape target. @note This is an advanced API for performance critical access, for more convenient usage see getBlendShapeTargetDelta.

Public function Const

ConstArrayVi...

 

getBlendShapeTargetDeltaYs

(
    std::uint16_t meshIndex,
    std::uint16_t blendShapeTargetIndex
)

List of all delta Y values for the referenced blend shape target. @note This is an advanced API for performance critical access, for more convenient usage see getBlendShapeTargetDelta.

Public function Const

ConstArrayVi...

 

getBlendShapeTargetDeltaZs

(
    std::uint16_t meshIndex,
    std::uint16_t blendShapeTargetIndex
)

List of all delta Z values for the referenced blend shape target. @note This is an advanced API for performance critical access, for more convenient usage see getBlendShapeTargetDelta.

Public function Const

ConstArrayVi...

 

getBlendShapeTargetVertexIndices

(
    std::uint16_t meshIndex,
    std::uint16_t blendShapeTargetIndex
)

Vertex position indices affected by the referenced blend shape target.

Public function Const

std::uint32_...

 

getFaceCount

(
    std::uint16_t meshIndex
)

Number of faces that belong to the specified mesh.

Public function Const

ConstArrayVi...

 

getFaceVertexLayoutIndices

(
    std::uint16_t meshIndex,
    std::uint32_t faceIndex
)

List of vertex layout indices the belong to a face on the specified mesh.

Public function Const

std::uint16_...

 

getMaximumInfluencePerVertex

(
    std::uint16_t meshIndex
)

The maximum number of joints that may influence any single vertex.

Public function Const

std::uint32_...

 

getSkinWeightsCount

(
    std::uint16_t meshIndex
)

Number of skin weights associated with the specified mesh.

Public function Const

ConstArrayVi...

 

getSkinWeightsJointIndices

(
    std::uint16_t meshIndex,
    std::uint32_t vertexIndex
)

List of joint indices associated with each skin weight for the specified vertex.

Public function Const

ConstArrayVi...

 

getSkinWeightsValues

(
    std::uint16_t meshIndex,
    std::uint32_t vertexIndex
)

List of skin weights influencing the requested vertex.

Public function Const

VertexLayout

 

getVertexLayout

(
    std::uint16_t meshIndex,
    std::uint32_t layoutIndex
)

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. @note The indices from a layout are usable with the above defined APIs.

Public function Const

std::uint32_...

 

getVertexLayoutCount

(
    std::uint16_t meshIndex
)

Number of vertex layouts in the entire mesh. @note A vertex layout is a collection of vertex attributes.

Public function Const

ConstArrayVi...

 

getVertexLayoutNormalIndices

(
    std::uint16_t meshIndex
)

Normal indices for each vertex of the referenced mesh. @note This is an advanced API for performance critical access, for more convenient usage see getVertexLayout.

Public function Const

ConstArrayVi...

 

getVertexLayoutPositionIndices

(
    std::uint16_t meshIndex
)

Position indices for each vertex of the referenced mesh. @note This is an advanced API for performance critical access, for more convenient usage see getVertexLayout.

Public function Const

ConstArrayVi...

 

getVertexLayoutTextureCoordinateIndices

(
    std::uint16_t meshIndex
)

Texture coordinate indices for each vertex of the referenced mesh. @note This is an advanced API for performance critical access, for more convenient usage see getVertexLayout.

Public function Const

Normal

 

getVertexNormal

(
    std::uint16_t meshIndex,
    std::uint32_t normalIndex
)

MeshIndex must be less than the value returned by getMeshCount.

Public function Const

std::uint32_...

 

getVertexNormalCount

(
    std::uint16_t meshIndex
)

Number of vertex normals in the entire mesh.

Public function Const

ConstArrayVi...

 

getVertexNormalXs

(
    std::uint16_t meshIndex
)

List of all normal X values for the referenced mesh. @note This is an advanced API for performance critical access, for more convenient usage see getVertexNormal.

Public function Const

ConstArrayVi...

 

getVertexNormalYs

(
    std::uint16_t meshIndex
)

List of all normal Y value for the referenced meshs. @note This is an advanced API for performance critical access, for more convenient usage see getVertexNormal.

Public function Const

ConstArrayVi...

 

getVertexNormalZs

(
    std::uint16_t meshIndex
)

List of all normal Z values for the referenced mesh. @note This is an advanced API for performance critical access, for more convenient usage see getVertexNormal.

Public function Const

Position

 

getVertexPosition

(
    std::uint16_t meshIndex,
    std::uint32_t vertexIndex
)

MeshIndex must be less than the value returned by getMeshCount.

Public function Const

std::uint32_...

 

getVertexPositionCount

(
    std::uint16_t meshIndex
)

Number of vertex positions in the entire mesh.

Public function Const

ConstArrayVi...

 

getVertexPositionXs

(
    std::uint16_t meshIndex
)

List of all vertex position X values for the referenced mesh. @note This is an advanced API for performance critical access, for more convenient usage see getVertexPosition.

Public function Const

ConstArrayVi...

 

getVertexPositionYs

(
    std::uint16_t meshIndex
)

List of all vertex position Y values for the referenced mesh. @note This is an advanced API for performance critical access, for more convenient usage see getVertexPosition.

Public function Const

ConstArrayVi...

 

getVertexPositionZs

(
    std::uint16_t meshIndex
)

List of all vertex position Z values for the referenced mesh. @note This is an advanced API for performance critical access, for more convenient usage see getVertexPosition.

Public function Const

TextureCoord...

 

getVertexTextureCoordinate

(
    std::uint16_t meshIndex,
    std::uint32_t textureCoordinateInde...
)

MeshIndex must be less than the value returned by getMeshCount.

Public function Const

std::uint32_...

 

getVertexTextureCoordinateCount

(
    std::uint16_t meshIndex
)

Number of texture coordinates in the entire mesh.

Public function Const

ConstArrayVi...

 

getVertexTextureCoordinateUs

(
    std::uint16_t meshIndex
)

List of all texture coordinate U values for the referenced mesh. @note This is an advanced API for performance critical access, for more convenient usage see getVertexTextureCoordinate.

Public function Const

ConstArrayVi...

 

getVertexTextureCoordinateVs

(
    std::uint16_t meshIndex
)

List of all texture coordinate V values for the referenced mesh. @note This is an advanced API for performance critical access, for more convenient usage see getVertexTextureCoordinate.

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