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 > ControlRig > Rigs > FRigControl

Light Theme

Dark Theme

FRigControl

Windows

MacOS

Linux

Inheritance Hierarchy

FRigElement

FRigControl

References

Module	ControlRig
Header	/Engine/Plugins/Experimental/ControlRig/Source/ControlRig/Public/Rigs/RigControlHierarchy.h
Include	#include "Rigs/RigControlHierarchy.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType))
struct FRigControl : public FRigElement

Variables

	Name	Description
bool	bAnimatable	If the control is animatable in sequencer
bool	bDrawLimits	True if the limits should be drawn in debug.
bool	bGizmoEnabled	Set to true if the gizmo is enabled in 3d
bool	bGizmoVisible	Set to true if the gizmo is currently visible in 3d
bool	bIsCurve	If Created from a Curve Container
bool	bIsTransientControl	If the control is transient and only visible in the control rig editor
bool	bLimitRotation	True if the control has to obey rotation limits.
bool	bLimitScale	True if the control has to obey scale limits.
bool	bLimitTranslation	True if the control has to obey translation limits.
UEnum *	ControlEnum	If the control is transient and only visible in the control rig editor
ERigControlType	ControlType
TArray< int32 >	Dependents	Dependent list - direct dependent for child or anything that needs to update due to this
FName	DisplayName
FLinearColor	GizmoColor
FName	GizmoName	This is optional UI setting - this doesn't mean this is always used, but it is optional for manipulation layer to use this
FTransform	GizmoTransform
FRigControlValu...	InitialValue	The value that a control is reset to during begin play or when the control rig is instantiated.
FRigControlValu...	MaximumValue	The maximum limit of the control's value
FRigControlValu...	MinimumValue	The minimum limit of the control's value
FTransform	OffsetTransform	Used to offset a control in global space.
int32	ParentIndex
FName	ParentName
ERigControlAxis	PrimaryAxis	The primary axis to use for float controls
int32	SpaceIndex
FName	SpaceName
FRigControlValu...	Value	The current value of the control.

Constructors

	Name	Description
	FRigControl()

Destructors

	Name	Description
	~FRigControl()

Functions

		Name	Description
	void	ApplyLimits ( FRigControlValue& InOutValue )
	float	Clamp ( float Value, float Minimum, float Maximum )
	FProperty &#...	FindPropertyForValueType ( ERigControlValueType InValueType )
	const FName ...	GetDisplayName()
	FRigElementK...	GetParentElementKey ( bool bForce )
	FRigElementK...	GetSpaceElementKey ( bool bForce )
	FTransform	GetTransformFromValue ( ERigControlValueType InValueType )
	const FRigCo...	GetValue ( ERigControlValueType InValueType )
	FRigControlV...	GetValue ( ERigControlValueType InValueType )
	void	SetValueFromTransform ( const FTransform& InTransform, ERigControlValueType InValueType )

Overridden from FRigElement

		Name	Description
	ERigElementT...	GetElementType()

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

Take our survey

Dismiss