Navigation
API > API/Plugins > API/Plugins/RigLogicLib
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.
| Name | RigInstance |
| Type | class |
| Header File | /Engine/Plugins/Animation/RigLogic/Source/RigLogicLib/Public/riglogic/riglogic/RigInstance.h |
| Include Path | #include "riglogic/riglogic/RigInstance.h" |
Syntax
class RigInstance
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~RigInstance() |
riglogic/riglogic/RigInstance.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ConstArrayView< float > getAnimatedMapOutputs() |
Calculated values for animated map deformations. | riglogic/riglogic/RigInstance.h | |
ConstArrayView< float > getBlendShapeOutputs() |
Calculated values for blend shape deformations. | riglogic/riglogic/RigInstance.h | |
float getGUIControl
(
std::uint16_t index |
riglogic/riglogic/RigInstance.h | ||
std::uint16_t getGUIControlCount() |
riglogic/riglogic/RigInstance.h | ||
ConstArrayView< float > getGUIControlValues() |
riglogic/riglogic/RigInstance.h | ||
ConstArrayView< float > getJointOutputs () |
Calculated values for joint transformations. | riglogic/riglogic/RigInstance.h | |
std::uint16_t getLOD() |
The current level of details of this instance. | riglogic/riglogic/RigInstance.h | |
float getMLControl
(
std::uint16_t index |
riglogic/riglogic/RigInstance.h | ||
std::uint16_t getMLControlCount() |
riglogic/riglogic/RigInstance.h | ||
ConstArrayView< float > getMLControlValues() |
riglogic/riglogic/RigInstance.h | ||
std::uint16_t getNeuralNetworkCount() |
riglogic/riglogic/RigInstance.h | ||
float getNeuralNetworkMask
(
std::uint16_t neuralNetIndex |
riglogic/riglogic/RigInstance.h | ||
float getPSDControl
(
std::uint16_t index |
riglogic/riglogic/RigInstance.h | ||
std::uint16_t getPSDControlCount() |
riglogic/riglogic/RigInstance.h | ||
ConstArrayView< float > getPSDControlValues() |
riglogic/riglogic/RigInstance.h | ||
float getRawControl
(
std::uint16_t index |
riglogic/riglogic/RigInstance.h | ||
std::uint16_t getRawControlCount() |
riglogic/riglogic/RigInstance.h | ||
ConstArrayView< float > getRawControlValues() |
riglogic/riglogic/RigInstance.h | ||
float getRBFControl
(
std::uint16_t index |
riglogic/riglogic/RigInstance.h | ||
std::uint16_t getRBFControlCount() |
riglogic/riglogic/RigInstance.h | ||
ConstArrayView< float > getRBFControlValues() |
riglogic/riglogic/RigInstance.h | ||
void setGUIControl
(
std::uint16_t index, |
riglogic/riglogic/RigInstance.h | ||
void setGUIControlValues
(
const float* values |
riglogic/riglogic/RigInstance.h | ||
void setLOD
(
std::uint16_t level |
The current level of details of this instance. | riglogic/riglogic/RigInstance.h | |
void setNeuralNetworkMask
(
std::uint16_t neuralNetIndex, |
riglogic/riglogic/RigInstance.h | ||
void setRawControl
(
std::uint16_t index, |
riglogic/riglogic/RigInstance.h | ||
void setRawControlValues
(
const float* values |
riglogic/riglogic/RigInstance.h |
Protected
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static RigInstance * create
(
RigLogic* rigLogic, |
Factory method for the creation of rig instances. | riglogic/riglogic/RigInstance.h | |
static void destroy
(
RigInstance* instance |
Method for freeing rig instances. | riglogic/riglogic/RigInstance.h |