1. Epic GamesDeveloper
  3. RigInstance

RigInstance

[RigInstance](API\Plugins\RigLogicLib\riglogic\riglogic\RigInstance) contains the instance specific data of a rig.

Unreal Engine C++ API Reference > Plugins > RigLogicLib > riglogic > riglogic

References

   
Module RigLogicLib
Header /Engine/Plugins/Animation/RigLogic/Source/RigLogicLib/Public/riglogic/riglogic/RigInstance.h
Include #include "riglogic/riglogic/RigInstance.h"

Syntax

class RigInstance

Remarks

The input / output buffers are all contained within a rig instance. It provides functions for setting the level of detail and input control values of a single instance, as well as accessors to the output values of joints, blend shapes and animated maps. To evaluate / drive the rig instance, it must be passed to the RigLogic::calculate function.

Destructors

  Type Name Description
Protected function Virtual    

Functions

  Type Name Description
Public function Static RigInstance *

create ( RigLogic* rigLogic,
MemoryResource* memRes
)

 Factory method for the creation of rig instances.
Public function Static void

destroy ( RigInstance* instance
)

 Method for freeing rig instances.
Public function Const ConstArrayView< float > Calculated values for animated map deformations.
Public function Const ConstArrayView< float > Calculated values for blend shape deformations.
Public function Const float

getGUIControl ( std::uint16_t index
)

  
Public function Const std::uint16_t  
Public function Const ConstArrayView< float >  
Public function Const TransformationArrayView Calculated values for joint transformations.
Public function Const std::uint16_t

getLOD ()

 The current level of details of this instance.
Public function Const float

getMLControl ( std::uint16_t index
)

  
Public function Const std::uint16_t  
Public function Const ConstArrayView< float >  
Public function Const std::uint16_t  
Public function Const float

getNeuralNetworkMask ( std::uint16_t neuralNetIndex
)

  
Public function Const float

getPSDControl ( std::uint16_t index
)

  
Public function Const std::uint16_t  
Public function Const ConstArrayView< float >  
Public function Const float

getRawControl ( std::uint16_t index
)

  
Public function Const std::uint16_t  
Public function Const ConstArrayView< float >  
Public function Const ConstArrayView< float > Calculated values for joint transformations.
Public function void

setGUIControl ( std::uint16_t index,
float value
)

  
Public function void

setGUIControlValues ( const float* values
)

  
Public function void

setLOD ( std::uint16_t level
)

 The current level of details of this instance.
Public function void

setNeuralNetworkMask ( std::uint16_t neuralNetIndex,
float value
)

  
Public function void

setRawControl ( std::uint16_t index,
float value
)

  
Public function void

setRawControlValues ( const float* values
)

  

See Also

RigLogic

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page