1. Epic GamesDeveloper
  3. UMovieSceneControlRigParameterSection

UMovieSceneControlRigParameterSection

Movie scene section that controls animation controller animation

API > API/Plugins > API/Plugins/ControlRig

Movie scene section that controls animation controller animation

   
Name UMovieSceneControlRigParameterSection
Type class
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Sequencer/MovieSceneControlRigParameterSection.h
Include Path #include "Sequencer/MovieSceneControlRigParameterSection.h"

Syntax

UCLASS (MinimalAPI)  
class UMovieSceneControlRigParameterSection :  
    public UMovieSceneParameterSection ,  
    public IMovieSceneConstrainedSection

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneControlRigParameterSection()

   Sequencer/MovieSceneControlRigParameterSection.h  

Structs

Name Remarks
FLoadAnimSequenceData  

Typedefs

Name Type Remarks Include Path
FSpaceChannelAddedEvent TMulticastDelegate_ThreeParams< void, UMovieSceneControlRigParameterSection *, const FName &, FMovieSceneControlRigSpaceChannel * > Bindable events for when we add space or constraint channels. Sequencer/MovieSceneControlRigParameterSection.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ControlChannelMap TMap< FName, FChannelMapInfo > Map from the control name to where it starts as a channel Sequencer/MovieSceneControlRigParameterSection.h  
ControlNameMask TSet< FName > Names of Controls that are masked out on this section Sequencer/MovieSceneControlRigParameterSection.h  
ControlRigClass TSubclassOf< UControlRig > The class of control rig to instantiate Sequencer/MovieSceneControlRigParameterSection.h
  • EditAnywhere
  • Category="Animation"
ControlsMask TArray< bool > Deprecrated, use ControlNameMask Sequencer/MovieSceneControlRigParameterSection.h  
ControlsToSet TSet< FName > Special list of Names that we should only Modify. Sequencer/MovieSceneControlRigParameterSection.h  
TransformMask FMovieSceneTransformMask Mask for Transform Mask Sequencer/MovieSceneControlRigParameterSection.h  
Weight FMovieSceneFloatChannel The weight curve for this animation controller section Sequencer/MovieSceneControlRigParameterSection.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ControlRig TObjectPtr< UControlRig > Control Rig that controls us Sequencer/MovieSceneControlRigParameterSection.h  
LastControlsUsedToReconstruct TArray< TPair< FName, ERigControlType > > Last set of Controls used to reconstruct the channel proxies, used to make sure controls really changed if we want to reconstruct only care to check name and type Sequencer/MovieSceneControlRigParameterSection.h  
OnSpaceChannelAdded FSpaceChannelAddedEvent   Sequencer/MovieSceneControlRigParameterSection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddBoolParameter ( FName InParameterName,
TOptional< bool > DefaultValue,
bool bReconstructChannel
)

 Adds specified bool parameter. Sequencer/MovieSceneControlRigParameterSection.h  

void AddColorParameter ( FName InParameterName,
TOptional< FLinearColor > DefaultValue,
bool bReconstructChannel
)

 Adds a a key for a specific color parameter. Sequencer/MovieSceneControlRigParameterSection.h  

void AddEnumParameter ( FName InParameterName,
UEnum* Enum,
TOptional< uint8 > DefaultValue,
bool bReconstructChannel
)

 Adds specified enum parameter. Sequencer/MovieSceneControlRigParameterSection.h  

void AddEnumParameterKey ( FName InParameterName,
FFrameNumber InTime,
uint8 InValue
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void AddIntegerParameter ( FName InParameterName,
TOptional< int32 > DefaultValue,
bool bReconstructChannel
)

 Adds specified int parameter. Sequencer/MovieSceneControlRigParameterSection.h  

void AddIntegerParameterKey ( FName InParameterName,
FFrameNumber InTime,
int32 InValue
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void AddScalarParameter ( FName InParameterName,
TOptional< float > DefaultValue,
bool bReconstructChannel
)

 Adds specified scalar parameter. Sequencer/MovieSceneControlRigParameterSection.h  

void AddSpaceChannel ( FName InControlName,
bool bReconstructChannel
)

 Add Space Parameter for a specified Control, no Default since that is Parent space Sequencer/MovieSceneControlRigParameterSection.h  

void AddTransformParameter ( FName InParameterName,
TOptional< FEulerTransform > DefaultValue,
bool bReconstructChannel
)

 Adds a a key for a specific transform parameter Sequencer/MovieSceneControlRigParameterSection.h  

void AddVector2DParameter ( FName InParameterName,
TOptional< FVector2D > DefaultValue,
bool bReconstructChannel
)

 Adds a a key for a specific vector2D parameter. Sequencer/MovieSceneControlRigParameterSection.h  

void AddVectorParameter ( FName InParameterName,
TOptional< FVector > DefaultValue,
bool bReconstructChannel
)

 Adds a a key for a specific vector parameter. Sequencer/MovieSceneControlRigParameterSection.h  

void AutoSetTangents ( const FName& ControlName
)

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual EMovieSceneChannelProxyType CacheChannelProxy()

   Sequencer/MovieSceneControlRigParameterSection.h  

bool CanCreateSpaceChannel ( FName InControlName
) const

 Whether or not create a space channel for a particular control Sequencer/MovieSceneControlRigParameterSection.h  

void ChangeControlRotationOrder ( const FName& InControlName,
const TOptional< EEulerRotationOrder >& CurrentOrder,
const TOptional< EEulerRotationOrder >& NewOrder,
EMovieSceneKeyInterpolation Interpolation
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void ClearAllParameters()

 Clear Everything Out Sequencer/MovieSceneControlRigParameterSection.h  

bool CopyVectorParameterCurvesToTransform ( const FName& InControlName,
ERigControlType InType
)

 Copy existing internal vector paramter of Position/Rotator/Scale type to a transform parameter type Sequencer/MovieSceneControlRigParameterSection.h  

TOptional< bool > EvaluateBoolParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates specified bool parameter. Will not get set if not found Sequencer/MovieSceneControlRigParameterSection.h  

TOptional< FLinearColor > EvaluateColorParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates a a key for a specific color parameter. Will not get set if not found Sequencer/MovieSceneControlRigParameterSection.h  

TOptional< uint8 > EvaluateEnumParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates specified enum parameter. Will not get set if not found Sequencer/MovieSceneControlRigParameterSection.h  

TOptional< int32 > EvaluateIntegerParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates specified int parameter. Will not get set if not found Sequencer/MovieSceneControlRigParameterSection.h  

TOptional< float > EvaluateScalarParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates specified scalar parameter. Will not get set if not found Sequencer/MovieSceneControlRigParameterSection.h  

TOptional< FMovieSceneControlRigSpaceBaseKey > EvaluateSpaceChannel ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates a a key for a specific space parameter. Will not get set if not found Sequencer/MovieSceneControlRigParameterSection.h  

TOptional< FEulerTransform > EvaluateTransformParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates a a key for a specific transform parameter. Will not get set if not found Sequencer/MovieSceneControlRigParameterSection.h  

TOptional< FVector2D > EvaluateVector2DParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates a a key for a specific vector2D parameter. Will not get set if not found Sequencer/MovieSceneControlRigParameterSection.h  

TOptional< FVector > EvaluateVectorParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates a a key for a specific vector parameter. Will not get set if not found Sequencer/MovieSceneControlRigParameterSection.h  

void FillControlNameMask ( bool bValue
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void FillControlsMask ( bool Val
)

   Sequencer/MovieSceneControlRigParameterSection.h  

const FName & FindControlNameFromConstraintChannel ( const FMovieSceneConstraintChannel* InConstraintChannel
) const

   Sequencer/MovieSceneControlRigParameterSection.h  

FName FindControlNameFromSpaceChannel ( const FMovieSceneControlRigSpaceChannel* SpaceChannel
) const

   Sequencer/MovieSceneControlRigParameterSection.h  

void FixRotationWinding ( const FName& ControlName,
FFrameNumber StartFrame,
FFrameNumber EndFrame
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void ForEachParameter ( TArray< T >& InParameterArray,
TFunction< void(FBaseParameterNameAndValue*)> InCallback
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void ForEachParameter ( TOptional< ERigControlType > InControlType,
TFunction< void(FBaseParameterNameAndValue*)> InCallback
)

   Sequencer/MovieSceneControlRigParameterSection.h  
  Sequencer/MovieSceneControlRigParameterSection.h  

int32 GetActiveCategoryIndex ( FName ControlName
) const

 This function returns the active category index of the control, based upon what controls are active/masked or not If itself is masked it returns INDEX_NONE Sequencer/MovieSceneControlRigParameterSection.h  

UE::MovieScene::FControlRigChannelMetaData GetChannelMetaData ( const FMovieSceneChannel* Channel
) const

 Retrieve meta-data pertaining to a given channel ptr including the control it animates and its index within the control. Sequencer/MovieSceneControlRigParameterSection.h  
Not override but needed Sequencer/MovieSceneControlRigParameterSection.h  

bool GetControlNameMask ( const FName& Name
) const

   Sequencer/MovieSceneControlRigParameterSection.h  

UControlRig * GetControlRig ( UWorld* InGameWorld
) const

 Get the control rig for this section, by default in non-game world Sequencer/MovieSceneControlRigParameterSection.h  

bool GetControlsMask ( int32 Index
)

   Sequencer/MovieSceneControlRigParameterSection.h  

const TArray< bool > & GetControlsMask ()

   Sequencer/MovieSceneControlRigParameterSection.h  

const TArray< bool > & GetControlsMask ()

   Sequencer/MovieSceneControlRigParameterSection.h  

bool GetDoNotKey()

 Get Whether to key or not Sequencer/MovieSceneControlRigParameterSection.h  
  Sequencer/MovieSceneControlRigParameterSection.h  
  Sequencer/MovieSceneControlRigParameterSection.h  
  Sequencer/MovieSceneControlRigParameterSection.h  
  Sequencer/MovieSceneControlRigParameterSection.h  

FSpaceControlNameAndChannel * GetSpaceChannel ( FName InParameterName
)

 Get The Space Channel for the Control Sequencer/MovieSceneControlRigParameterSection.h  
  Sequencer/MovieSceneControlRigParameterSection.h  
  Sequencer/MovieSceneControlRigParameterSection.h  

FMovieSceneTransformMask GetTransformMask()

 Access the transform mask that defines which channels this track should animate Sequencer/MovieSceneControlRigParameterSection.h  

bool HasBoolParameter ( FName InParameterName
) const

 Whether or not this section has bool Sequencer/MovieSceneControlRigParameterSection.h  

bool HasColorParameter ( FName InParameterName
) const

 Whether or not this section has scalar Sequencer/MovieSceneControlRigParameterSection.h  

bool HasEnumParameter ( FName InParameterName
) const

 Whether or not this section has enum Sequencer/MovieSceneControlRigParameterSection.h  

bool HasIntegerParameter ( FName InParameterName
) const

 Whether or not this section has int Sequencer/MovieSceneControlRigParameterSection.h  

bool HasScalarParameter ( FName InParameterName
) const

 Whether or not this section has scalar Sequencer/MovieSceneControlRigParameterSection.h  

bool HasSpaceChannel ( FName InParameterName
) const

 Whether or not this section has space Sequencer/MovieSceneControlRigParameterSection.h  

bool HasTransformParameter ( FName InParameterName
) const

 Whether or not this section has scalar Sequencer/MovieSceneControlRigParameterSection.h  

bool HasVector2DParameter ( FName InParameterName
) const

 Whether or not this section has scalar Sequencer/MovieSceneControlRigParameterSection.h  

bool HasVectorParameter ( FName InParameterName
) const

 Whether or not this section has scalar Sequencer/MovieSceneControlRigParameterSection.h  

bool IsDifferentThanLastControlsUsedToReconstruct ( const TArray< FRigControlElement* >& NewControls
) const

 Test Controls really are new. Sequencer/MovieSceneControlRigParameterSection.h  

void KeyWeightValue ( FFrameNumber InFrame,
EMovieSceneKeyInterpolation DefaultInterpolation,
float InVal
)

 Key the Weights to the specified value Sequencer/MovieSceneControlRigParameterSection.h  

void KeyZeroValue ( FFrameNumber InFrame,
EMovieSceneKeyInterpolation DefaultInterpolation,
bool bSelected
)

 Key Zero Values on all or just selected controls in these section at the specified time Sequencer/MovieSceneControlRigParameterSection.h  

virtual bool LoadAnimSequenceIntoThisSection ( UAnimSequence* Sequence,
const FFrameNumber& SequenceStart,
UMovieScene* MovieScene,
UObject* BoundObject,
bool bKeyReduce,
float Tolerance,
bool bResetControls,
const FFrameNumber& InStartFrame,
EMovieSceneKeyInterpolation InInterpolation
)

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual bool LoadAnimSequenceIntoThisSection ( UAnimSequence* Sequence,
const FFrameNumber& SequenceStart,
UMovieScene* MovieScene,
UObject* BoundObject,
const FLoadAnimSequenceData& LoadData,
EMovieSceneKeyInterpolation Interpolation
)

 Function to load an Anim Sequence into this section. Sequencer/MovieSceneControlRigParameterSection.h  

virtual bool LoadAnimSequenceIntoThisSection ( UAnimSequence* Sequence,
UMovieScene* MovieScene,
UObject* BoundObject,
bool bKeyReduce,
float Tolerance,
bool bResetControls,
FFrameNumber InStartFrame,
EMovieSceneKeyInterpolation InInterpolation
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void OnControlRigEditorSettingChanged ( UObject* InSettingsChanged,
FPropertyChangedEvent& InPropertyChangedEvent
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void OptimizeSection ( const FName& ControlName,
const FKeyDataOptimizationParams& InParams
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void RecordControlRigKey ( FFrameNumber FrameNumber,
bool bSetDefault,
EMovieSceneKeyInterpolation InInterpMode,
bool bOntoSelectedControls
)

 Function to save control rig key when recording. Sequencer/MovieSceneControlRigParameterSection.h  

void RecreateWithThisControlRig ( UControlRig* InControlRig,
bool bSetDefault
)

 Recreate with this Control Rig Sequencer/MovieSceneControlRigParameterSection.h  

void RemoveAllKeys ( bool bIncludeSpaceKeys
)

 Remove All Keys, but maybe not space keys if bIncludeSpaceKeys is false Sequencer/MovieSceneControlRigParameterSection.h  

bool RemoveEnumParameter ( FName InParameterName
)

   Sequencer/MovieSceneControlRigParameterSection.h  

bool RemoveIntegerParameter ( FName InParameterName
)

   Sequencer/MovieSceneControlRigParameterSection.h  

bool RenameParameterName ( const FName& OldParameterName,
const FName& NewParameterName,
TOptional< ERigControlType > ControlType
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void SetControlNameMask ( const FName& Name,
bool bValue
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void SetControlRig ( UControlRig* InControlRig
)

 Set the control rig for this section Sequencer/MovieSceneControlRigParameterSection.h  

void SetControlsMask ( const TArray< bool >& InMask
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void SetControlsMask ( int32 Index,
bool Val
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void SetDoNotKey ( bool bIn
) const

 Whether or not to key currently, maybe evaluating so don't Sequencer/MovieSceneControlRigParameterSection.h  

void SetTransformMask ( FMovieSceneTransformMask NewMask
)

 Set the transform mask that defines which channels this track should animate Sequencer/MovieSceneControlRigParameterSection.h  

FSpaceChannelAddedEvent & SpaceChannelAdded()

   Sequencer/MovieSceneControlRigParameterSection.h  

Overridden from UMovieSceneParameterSection

Name Remarks Include Path Unreal Specifiers

virtual void ImportEntityImpl ( UMovieSceneEntitySystemLinker* EntityLinker,
const FEntityImportParams& Params,
FImportedEntity* OutImportedEntity
)

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual bool PopulateEvaluationFieldImpl ( const TRange< FFrameNumber >& EffectiveRange,
const FMovieSceneEvaluationFieldEntityMetaData& InMetaData,
FMovieSceneEntityComponentFieldBuilder* OutFieldBuilder
)

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual void ReconstructChannelProxy()

   Sequencer/MovieSceneControlRigParameterSection.h  

Overridden from UMovieSceneSection

Name Remarks Include Path Unreal Specifiers

virtual UObject * GetImplicitObjectOwner()

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual float GetTotalWeightValue ( FFrameTime InTime
) const

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual void SetBlendType ( EMovieSceneBlendType InBlendType
)

 UMovieSceneSection virtuals. Sequencer/MovieSceneControlRigParameterSection.h  

Overridden from IMovieSceneConstrainedSection

Name Remarks Include Path Unreal Specifiers

virtual void AddConstraintChannel ( UTickableConstraint* InConstraint
)

 Add Constraint channel Sequencer/MovieSceneControlRigParameterSection.h  

virtual FConstraintAndActiveChannel * GetConstraintChannel ( const FGuid& InConstraintID
)

 Get constraint with that name Sequencer/MovieSceneControlRigParameterSection.h  
Get The channels Sequencer/MovieSceneControlRigParameterSection.h  

virtual bool HasConstraintChannel ( const FGuid& InConstraintName
) const

 Whether it has that channel Sequencer/MovieSceneControlRigParameterSection.h  

virtual void OnConstraintsChanged()

 What to do if the constraint object has been changed, for example by an undo or redo. Sequencer/MovieSceneControlRigParameterSection.h  

virtual void RemoveConstraintChannel ( const UTickableConstraint* InConstraint
)

 Remove Constraint channel Sequencer/MovieSceneControlRigParameterSection.h  

virtual void ReplaceConstraint ( const FName InConstraintName,
UTickableConstraint* InConstraint
)

 Replace the constraint with the specified name with the new one Sequencer/MovieSceneControlRigParameterSection.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ConvertMaskArrayToNameSet()

   Sequencer/MovieSceneControlRigParameterSection.h  

void HandleOverrideAssetChanged ( const UControlRigOverrideAsset* InOverrideAsset
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void HandleOverrideAssetsChanged ( UControlRig* InControlRig
)

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual bool IsBlendingHandledExternally()

   Sequencer/MovieSceneControlRigParameterSection.h  

void MaskOutIfThereAreMaskedControls ( const FName& InControlName
)

   Sequencer/MovieSceneControlRigParameterSection.h  

void UpdateOverrideAssetDelegates()

   Sequencer/MovieSceneControlRigParameterSection.h  

Overridden from UMovieSceneSection

Name Remarks Include Path Unreal Specifiers

virtual void GetReferencedBindings ( TArray< FGuid >& OutBindings
)

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual void OnBindingIDsUpdated ( const TMap< UE::MovieScene::FFixedObjectBindingID, UE::MovieScene::FFixedObjectBindingID >& OldFixe...,
FMovieSceneSequenceID LocalSequenceID,
TSharedRef< UE::MovieScene::FSharedPlaybackState > SharedPlaybackState
)

   Sequencer/MovieSceneControlRigParameterSection.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual void PostEditImport()

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual void PostLoad()

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual void PreSave ( FObjectPreSaveContext SaveContext
)

   Sequencer/MovieSceneControlRigParameterSection.h  

virtual void Serialize ( FArchive& Ar
)

   Sequencer/MovieSceneControlRigParameterSection.h  

Static

Name Remarks Include Path Unreal Specifiers

static FMovieSceneInterrogationKey GetFloatInterrogationKey()

 Access the interrogation key for control rig data Sequencer/MovieSceneControlRigParameterSection.h  

static FMovieSceneInterrogationKey GetTransformInterrogationKey()

   Sequencer/MovieSceneControlRigParameterSection.h  

static FMovieSceneInterrogationKey GetVector2DInterrogationKey()

   Sequencer/MovieSceneControlRigParameterSection.h  

static FMovieSceneInterrogationKey GetVector4InterrogationKey()

   Sequencer/MovieSceneControlRigParameterSection.h  

static FMovieSceneInterrogationKey GetVectorInterrogationKey()

   Sequencer/MovieSceneControlRigParameterSection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page