Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > RigLogicLib > riglogic > riglogic > RigInstance

Light Theme

Dark Theme

RigInstance

[RigInstance](API\Plugins\RigLogicLib\riglogic\riglogic\RigInstance) contains the instance specific data of a rig. @note 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](API\Plugins\RigLogicLib\riglogic\riglogic\RigLogic\calculate) function.

Windows

MacOS

Linux

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

RigInstance contains the instance specific data of a rig. @note 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

	Name	Description
	~RigInstance()

Functions

	Name	Description
RigInstance ...	create ( RigLogic* rigLogic, MemoryResource* memRes )	Factory method for the creation of rig instances. @note Rig instances are all tied to their parent RigLogic instance. All rig instances created through a particular RigLogic instance are based on the same DNA.
void	destroy ( RigInstance* instance )	Method for freeing rig instances.
ConstArrayVi...	getAnimatedMapOutputs()	Calculated values for animated map deformations.
ConstArrayVi...	getBlendShapeOutputs()	Calculated values for blend shape deformations.
std::uint16_...	getGUIControlCount()
Transformati...	getJointOutputs()	Calculated values for joint transformations. @note A more user-friendly representation that groups values belonging to separate transformations into single units, while providing accessors to the actual values they represent.
std::uint16_...	getLOD()	The current level of details of this instance.
std::uint16_...	getRawControlCount()
ConstArrayVi...	getRawJointOutputs()	Calculated values for joint transformations. @note This is just a primitive array of floats, providing access to all the values of all transformations.
void	setGUIControl ( std::uint16_t index, float value )
void	setGUIControlValues ( const float* values )
void	setLOD ( std::uint16_t level )	The current level of details of this instance.
void	setRawControl ( std::uint16_t index, float value )
void	setRawControlValues ( const float* values )