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 > Sequencer > UMovieSceneControlRigParameterSection

Light Theme

Dark Theme

UMovieSceneControlRigParameterSection

Movie scene section that controls animation controller animation

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMovieSceneSignedObject

UMovieSceneSection

UMovieSceneParameterSection

UMovieSceneControlRigParameterSection

References

Module	ControlRig
Header	/Engine/Plugins/Experimental/ControlRig/Source/ControlRig/Public/Sequencer/MovieSceneControlRigParameterSection.h
Include	#include "Sequencer/MovieSceneControlRigParameterSection.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UMovieSceneControlRigParameterSection : public UMovieSceneParameterSection

Remarks

Movie scene section that controls animation controller animation

Variables

	Name	Description
bool	bDoNotKey	When true we do not set a key on the section, since it will be set because we changed the value We need this because control rig notifications are set on every change even when just changing sequencer time which forces a sequencer eval, not like the editor where changes are only set on UI changes(changing time doesn't send change delegate)
TMap< FName, FC...	ControlChannelMap	Map from the control name to where it starts as a channel
TSubclassOf< UC...	ControlRigClass	The class of control rig to instantiate
TArray< bool >	ControlsMask	Mask for controls themselves
TSet< FName >	ControlsToSet	Special list of Names that we should only Modify.
TArray< FEnumPa...	EnumParameterNamesAndCurves	Enum Curves
TArray< FIntege...	IntegerParameterNamesAndCurves	Integer Curves
FMovieSceneTran...	TransformMask	Mask for Transform Mask
FMovieSceneFloa...	Weight	The weight curve for this animation controller section

Constructors

	Name	Description
	UMovieSceneControlRigParameterSection()

Functions

	Name	Description
void	AddBoolParameter ( FName InParameterName, TOptional< bool > DefaultValue, bool bReconstructChannel )	Adds specified bool parameter.
void	AddColorParameter ( FName InParameterName, TOptional< FLinearColor > DefaultVa..., bool bReconstructChannel )	Adds a a key for a specific color parameter.
void	AddEnumParameter ( FName InParameterName, UEnum* Enum, TOptional< uint8 > DefaultValue, bool bReconstructChannel )	Adds specified enum parameter.
void	AddEnumParameterKey ( FName InParameterName, FFrameNumber InTime, uint8 InValue )
void	AddIntegerParameter ( FName InParameterName, TOptional< int32 > DefaultValue, bool bReconstructChannel )	Adds specified int parameter.
void	AddIntegerParameterKey ( FName InParameterName, FFrameNumber InTime, int32 InValue )
void	AddScalarParameter ( FName InParameterName, TOptional< float > DefaultValue, bool bReconstructChannel )	Adds specified scalar parameter.
void	AddTransformParameter ( FName InParameterName, TOptional< FTransform > DefaultValu..., bool bReconstructChannel )	Adds a a key for a specific color parameter
void	AddVector2DParameter ( FName InParameterName, TOptional< FVector2D > DefaultValue, bool bReconstructChannel )	Adds a a key for a specific vector2D parameter.
void	AddVectorParameter ( FName InParameterName, TOptional< FVector > DefaultValue, bool bReconstructChannel )	Adds a a key for a specific vector parameter.
void	ClearAllParameters()	Clear Everything Out
void	FillControlsMask ( bool Val )
UControlRig ...	GetControlRig()	Get the control rig for this section
bool	GetControlsMask ( int32 Index )
const TArray...	GetControlsMask()
bool	GetDoNotKey()	Get Whether to key or not
const TArray...	GetEnumParameterNamesAndCurves()
TArray< FEnu...	GetEnumParameterNamesAndCurves()
FMovieSceneI...	GetFloatInterrogationKey()	Access the interrogation key for control rig data
const TArray...	GetIntegerParameterNamesAndCurves()
TArray< FInt...	GetIntegerParameterNamesAndCurves()
FMovieSceneI...	GetTransformInterrogationKey()
FMovieSceneT...	GetTransformMask()	Access the transform mask that defines which channels this track should animate
FMovieSceneI...	GetVector2DInterrogationKey()
FMovieSceneI...	GetVector4InterrogationKey()
FMovieSceneI...	GetVectorInterrogationKey()
bool	HasBoolParameter ( FName InParameterName )	Whether or not this section his bool
bool	HasColorParameter ( FName InParameterName )	Whether or not this section his scalar
bool	HasEnumParameter ( FName InParameterName )	Whether or not this section his enum
bool	HasIntegerParameter ( FName InParameterName )	Whether or not this section his int
bool	HasScalarParameter ( FName InParameterName )	Whether or not this section his scalar
bool	HasTransformParameter ( FName InParameterName )	Whether or not this section his scalar
bool	HasVector2DParameter ( FName InParameterName )	Whether or not this section his scalar
bool	HasVectorParameter ( FName InParameterName )	Whether or not this section his scalar
bool	LoadAnimSequenceIntoThisSection ( UAnimSequence* Sequence, UMovieScene* MovieScene, USkeleton* Skeleton, bool bKeyReduce, float Tolerance, FFrameNumber InStartFrame )	Function to load an Anim Sequence into this section.
void	RecordControlRigKey ( FFrameNumber FrameNumber, bool bSetDefault, bool bDoAutoKey )	Function to save control rig key when recording.
void	RecreateWithThisControlRig ( UControlRig* InControlRig, bool bSetDefault )	Recreate with this Control Rig
bool	RemoveEnumParameter ( FName InParameterName )
bool	RemoveIntegerParameter ( FName InParameterName )
void	SetControlRig ( UControlRig* InControlRig )	Set the control rig for this section
void	SetControlsMask ( const TArray< bool >& InMask )
void	SetControlsMask ( int32 Index, bool Val )
void	SetDoNotKey ( bool bIn )	Whether or not to key currently, maybe evaluating so don't
void	SetTransformMask ( FMovieSceneTransformMask NewMask )	Set the transform mask that defines which channels this track should animate

Overridden from UMovieSceneParameterSection

		Name	Description
	void	ReconstructChannelProxy ( bool bForce )

Overridden from UMovieSceneSection

		Name	Description
	float	GetTotalWeightValue ( FFrameTime InTime )	Get The Total Weight Value for this Section For Most Sections it's just the Ease Value, but for some Sections also have an extra Weight Curve
	void	SetBlendType ( EMovieSceneBlendType InBlendType )	Sets this section's blend type

Overridden from UObject

	Name	Description
void	PostEditImport()	Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

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

Take our survey

Dismiss