1. Epic GamesDeveloper
  3. RigLogic

RigLogic

[RigLogic](API\Plugins\RigLogicLib\riglogic\riglogic\RigLogic) calculates rig output values based on input control values.

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

References

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

Syntax

class RigLogic

Remarks

A single RigLogic instance can create and drive an arbitrary number of rig instances. Since the rig instance specific data is located on the RigInstance class, RigLogic itself may be considered stateless, and all of it's functions thread-safe.

Destructors

  Type Name Description
Protected function Virtual    

Functions

  Type Name Description
Public function Const void

calculate ( RigInstance* instance
)

 Calculate outputs for joints, blend shapes, and animated maps.
Public function Const void Calculate only the animated map outputs of the rig.
Public function Const void Calculate only the blend shape channel weights of the rig.
Public function Const void Calculate only the input control values of the rig.
Public function Const void

calculateJoints ( RigInstance* instance,
std::uint16_t jointGroupIndex
)

 Calculate individual joint groups.
Public function Const void Calculate only the joint outputs of the rig.
Public function Const void Calculate controls driving the machine learned behavior of the rig.
Public function Const void

calculateMachineLearnedBehaviorControls ( RigInstance* instance,
std::uint16_t neuralNetIndex
)

 Calculate controls driving the machine learned behavior of the rig.
Public function Static RigLogic *

create ( const dna::Reader* reader,
Configuration config,
MemoryResource* memRes
)

 Factory method for the creation of RigLogic.
Public function Static void

destroy ( RigLogic* instance
)

 Method for freeing RigLogic.
Public function Const void

dump ( BoundedIOStream* destination
)

 Create a snapshot of an initialized RigLogic instance.
Public function Const std::uint16_t Number of joint groups present in the entire joint matrix.
Public function Const ConstArrayView< std::uint16_t >

getJointVariableAttributeIndices ( std::uint16_t lod
)

 All joint output indices concatenated into a single chunk per each LOD.
Public function Const std::uint16_t 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).
Public function Const std::uint16_t Number of meshes.
Public function Const std::uint16_t

getMeshRegionCount ( std::uint16_t meshIndex
)

 Number of regions within the specified mesh.
Public function Const std::uint16_t Number of neural networks for driving machine learned behavior.
Public function Const ConstArrayView< std::uint16_t >

getNeuralNetworkIndices ( std::uint16_t meshIndex,
std::uint16_t regionIndex
)

 Map a mesh and region index pair to the neural network indices that drive it.
Public function Const TransformationArrayView Neutral values for joint transformations.
Public function Const ConstArrayView< float > Neutral values of joint transformations.
Public function Const void Maps GUI controls to raw controls.
Public function Const void Maps raw controls to GUI controls.
Public function Static RigLogic *

restore ( BoundedIOStream* source,
MemoryResource* memRes
)

 Factory method for restoring an instance of RigLogic from a memory dump.

Typedefs

Name Description
Configuration  

See Also

RigInstance

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page