1. Epic GamesDeveloper
  3. UMovieSceneControlRigParameterSection

UMovieSceneControlRigParameterSection

Movie scene section that controls animation controller animation

Unreal Engine C++ API Reference > Plugins > ControlRig > Sequencer

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
class UMovieSceneControlRigParameterSection :  
    public UMovieSceneParameterSection,  
    public IMovieSceneConstrainedSection

Remarks

Movie scene section that controls animation controller animation

Variables

  Type Name Description
Protected variable 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)
Protected variable UProperty TArray< FConstraintAndActiveChannel > ConstraintsChannels Space Channels
Public variable UProperty TMap< FName, FChannelMapInfo > ControlChannelMap Map from the control name to where it starts as a channel
Public variable UProperty Category, EditAnywhere TSubclassOf< UControlRig > ControlRigClass The class of control rig to instantiate
Public variable UProperty TArray< bool > ControlsMask Mask for controls themselves
Public variable TSet< FName > ControlsToSet Special list of Names that we should only Modify.
Protected variable UProperty TArray< FEnumParameterNameAndCurve > EnumParameterNamesAndCurves Enum Curves
Protected variable UProperty TArray< FIntegerParameterNameAndCurve > IntegerParameterNamesAndCurves Integer Curves
Protected variable UProperty TArray< FSpaceControlNameAndChannel > SpaceChannels Space Channels
Public variable UProperty FMovieSceneTransformMask TransformMask Mask for Transform Mask
Public variable UProperty FMovieSceneFloatChannel Weight The weight curve for this animation controller section

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

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

 Adds specified bool parameter.
Public function void

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

 Adds a a key for a specific color parameter.
Public function void

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

 Adds specified enum parameter.
Public function void

AddEnumParameterKey ( FName InParameterName,
FFrameNumber InTime,
uint8 InValue
)

  
Public function void

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

 Adds specified int parameter.
Public function void

AddIntegerParameterKey ( FName InParameterName,
FFrameNumber InTime,
int32 InValue
)

  
Public function void

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

 Adds specified scalar parameter.
Public function void

AddSpaceChannel ( FName InControlName,
bool bReconstructChannel
)

 Add Space Parameter for a specified Control, no Default since that is Parent space
Public function void

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

 Adds a a key for a specific transform parameter
Public function void

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

 Adds a a key for a specific vector2D parameter.
Public function void

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

 Adds a a key for a specific vector parameter.
Public function void

AutoSetTangents ( const FName& ControlName
)

  
Public function Const bool

CanCreateSpaceChannel ( FName InControlName
)

 Whether or not create a space channel for a particular control
Public function void

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

  
Public function void Clear Everything Out
Public function TOptional< bool >

EvaluateBoolParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates specified bool parameter. Will not get set if not found
Public function TOptional< FLinearColor >

EvaluateColorParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates a a key for a specific color parameter. Will not get set if not found
Public function TOptional< uint8 >

EvaluateEnumParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates specified enum parameter. Will not get set if not found
Public function TOptional< int32 >

EvaluateIntegerParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates specified int parameter. Will not get set if not found
Public function TOptional< float >

EvaluateScalarParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates specified scalar parameter. Will not get set if not found
Public function TOptional< FMovieSceneControlRigSpaceBaseKey >

EvaluateSpaceChannel ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates a a key for a specific space parameter. Will not get set if not found
Public function TOptional< FEulerTransform >

EvaluateTransformParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates a a key for a specific transform parameter. Will not get set if not found
Public function TOptional< FVector2D >

EvaluateVector2DParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates a a key for a specific vector2D parameter. Will not get set if not found
Public function TOptional< FVector >

EvaluateVectorParameter ( const FFrameTime& InTime,
FName InParameterName
)

 Evaluates a a key for a specific vector parameter. Will not get set if not found
Public function void

FillControlsMask ( bool Val
)

  
Public function Const const FName &  
Public function Const FName  
Public function void

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

  
Public function Const int32

GetActiveCategoryIndex ( FName ControlName
)

 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
Public function Const const TArray< FConstraintAndActiveChannel > & Not override but needed
Public function Const UControlRig * Get the control rig for this section
Public function Const bool

GetControlsMask ( int32 Index
)

  
Public function Const const TArray< bool > &  
Public function Const bool Get Whether to key or not
Public function Const const TArray< FEnumParameterNameAndCurve > &  
Public function TArray< FEnumParameterNameAndCurve > &  
Public function Static FMovieSceneInterrogationKey Access the interrogation key for control rig data
Public function Const const TArray< FIntegerParameterNameAndCurve > &  
Public function TArray< FIntegerParameterNameAndCurve > &  
Public function FSpaceControlNameAndChannel *

GetSpaceChannel ( FName InParameterName
)

 Get The Space Channel for the Control
Public function Const const TArray< FSpaceControlNameAndChannel > &  
Public function TArray< FSpaceControlNameAndChannel > &  
Public function Static FMovieSceneInterrogationKey  
Public function Const FMovieSceneTransformMask Access the transform mask that defines which channels this track should animate
Public function Static FMovieSceneInterrogationKey  
Public function Static FMovieSceneInterrogationKey  
Public function Static FMovieSceneInterrogationKey  
Public function Const bool

HasBoolParameter ( FName InParameterName
)

 Whether or not this section has bool
Public function Const bool

HasColorParameter ( FName InParameterName
)

 Whether or not this section has scalar
Public function Const bool

HasEnumParameter ( FName InParameterName
)

 Whether or not this section has enum
Public function Const bool

HasIntegerParameter ( FName InParameterName
)

 Whether or not this section has int
Public function Const bool

HasScalarParameter ( FName InParameterName
)

 Whether or not this section has scalar
Public function Const bool

HasSpaceChannel ( FName InParameterName
)

 Whether or not this section has space
Public function Const bool

HasTransformParameter ( FName InParameterName
)

 Whether or not this section has scalar
Public function Const bool

HasVector2DParameter ( FName InParameterName
)

 Whether or not this section has scalar
Public function Const bool

HasVectorParameter ( FName InParameterName
)

 Whether or not this section has scalar
Public function Const bool Test Controls really are new.
Public function void

KeyWeightValue ( FFrameNumber InFrame,
EMovieSceneKeyInterpolation DefaultInterpolation,
float InVal
)

 Key the Weights to the specified value
Public function void

KeyZeroValue ( FFrameNumber InFrame,
EMovieSceneKeyInterpolation DefaultInterpolation,
bool bSelected
)

 Key Zero Values on all or just selected controls in these section at the specified time
Public function Virtual bool

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

 Function to load an Anim Sequence into this section.
Public function void

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

  
Public function void

RecordControlRigKey ( FFrameNumber FrameNumber,
bool bSetDefault,
ERichCurveInterpMode InInterpMode
)

 Function to save control rig key when recording.
Public function void

RecreateWithThisControlRig ( UControlRig* InControlRig,
bool bSetDefault
)

 Recreate with this Control Rig
Public function void

RemoveAllKeys ( bool bIncludeSpaceKeys
)

 Remove All Keys, but maybe not space keys if bIncludeSpaceKeys is false
Public function bool

RemoveEnumParameter ( FName InParameterName
)

  
Public function bool

RemoveIntegerParameter ( FName InParameterName
)

  
Public function bool

RenameParameterName ( const FName& OldParameterName,
const FName& NewParameterName
)

  
Public function void

SetControlRig ( UControlRig* InControlRig
)

 Set the control rig for this section
Public function void

SetControlsMask ( const TArray< bool >& InMask
)

  
Public function void

SetControlsMask ( int32 Index,
bool Val
)

  
Public function Const void

SetDoNotKey ( bool bIn
)

 Whether or not to key currently, maybe evaluating so don't
Public function void Set the transform mask that defines which channels this track should animate
Public function FSpaceChannelAddedEvent &  

Overridden from UMovieSceneParameterSection

  Type Name Description
Public function Virtual void  

Overridden from UMovieSceneSection

  Type Name Description
Public function Virtual UObject * Get the implicit owner of this section, usually this will be the section's outer possessable or spawnable, but some sections, like Control Rig, this will be the Control Rig object instead.
Protected function Virtual void

GetReferencedBindings ( TArray< FGuid >& OutBindings
)

 Get the referenced bindings for this section
Protected function Virtual Const float 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
Protected function Virtual void When guid bindings are updated to allow this section to fix-up any internal bindings
Public function Virtual void

SetBlendType ( EMovieSceneBlendType InBlendType
)

 UMovieSceneSection virtuals.

Overridden from UObject

  Type Name Description
Protected function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Protected function Virtual void 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
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.
Protected function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Protected function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IMovieSceneConstrainedSection

  Type Name Description
Public function Virtual void Add Constraint channel
Public function Virtual FConstraintAndActiveChannel *

GetConstraintChannel ( const FName& InConstraintName
)

 Get constraint with that name
Public function Virtual TArray< FConstraintAndActiveChannel > & Get The channels
Public function Virtual Const bool

HasConstraintChannel ( const FName& InConstraintName
)

 Whether it has that channel
Public function Virtual void What to do if the constraint object has been changed, for example by an undo or redo.
Public function Virtual void Remove Constraint channel
Public function Virtual void

ReplaceConstraint ( const FName InConstraintName,
UTickableConstraint* InConstraint
)

 Replace the constraint with the specified name with the new one

Typedefs

Name Description
FSpaceChannelAddedEvent Bindable events for when we add space or constraint channels.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page