1. Epic GamesDeveloper
  3. FMovieSceneConstraintChannelHelper

FMovieSceneConstraintChannelHelper

API > API/Editor > API/Editor/MovieSceneTools

   
Name FMovieSceneConstraintChannelHelper
Type struct
Header File /Engine/Source/Editor/MovieSceneTools/Public/Constraints/MovieSceneConstraintChannelHelper.h
Include Path #include "Constraints/MovieSceneConstraintChannelHelper.h"

Syntax

struct FMovieSceneConstraintChannelHelper

Constants

Name Type Remarks Include Path
bDoNotCompensate bool   Constraints/MovieSceneConstraintChannelHelper.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AddConstraintToSequencer ( const TSharedPtr< ISequencer >& InSequencer,
UTickableTransformConstraint* InConstraint,
const FSequencerCreationOptions& InOptions
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static void ChangeKeyInterpolation ( const TArrayView< ChannelType* >& InChannels,
const FFrameNumber& InTime,
EMovieSceneKeyInterpolation KeyInterpolation
)

 Change key interpolation at the specified time Constraints/MovieSceneConstraintChannelHelper.h  

static void Compensate ( const TSharedPtr< ISequencer >& InSequencer,
const UTickableTransformConstraint* InConstraint,
const TOptional< FFrameNumber >& InOptTime,
const bool bCompPreviousTick
)

 Compensate transform on handles when a constraint switches state. Constraints/MovieSceneConstraintChannelHelper.h  

static void CompensateIfNeeded ( const TSharedPtr< ISequencer >& InSequencer,
IMovieSceneConstrainedSection* Section,
const TOptional< FFrameNumber >& OptionalTime,
const bool bCompPreviousTick,
const int32 InChildHash
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static void CompensateScale ( UTickableParentConstraint* InParentConstraint,
const FMovieSceneConstraintChannel& InActiveChannel,
const TSharedPtr< ISequencer >& InSequencer,
UMovieSceneSection* InSection
)

 Compensate scale keys when enabling/disabling scaling for parent constraints. Constraints/MovieSceneConstraintChannelHelper.h  

static void CreateBindingIDForHandle ( const TSharedPtr< ISequencer >& InSequencer,
UTransformableHandle* InHandle
)

 For the given handle create any movie scene binding for it based upon the current sequencer that's open Constraints/MovieSceneConstraintChannelHelper.h  

static void DeleteTransformKeys ( const TArrayView< ChannelType* >& InChannels,
const FFrameNumber& InTime
)

 Delete transform keys at that time Constraints/MovieSceneConstraintChannelHelper.h  

static void DeleteTransformTimes ( const TArrayView< ChannelType* >& InChannels,
const FFrameNumber& StartTime,
const FFrameNumber& EndTime,
EMovieSceneTransformChannel Channels
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static FConstraintSections GetConstraintSectionAndChannel ( const UTickableTransformConstraint* InConstraint,
const TSharedPtr< ISequencer >& InSequencer
)

 Get the section and the channel for the given constraint, will be nullptr's if it doesn't exist in Sequencer Constraints/MovieSceneConstraintChannelHelper.h  

static void GetFramesAfter ( const FMovieSceneConstraintChannel& InActiveChannel,
const FFrameNumber& InTime,
const TArrayView< ChannelType* >& InChannels,
TArray< FFrameNumber >& OutFrames
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static void GetFramesToCompensate ( const FMovieSceneConstraintChannel& InActiveChannel,
const bool InActiveValueToBeSet,
const TOptional< FFrameNumber >& InTime,
const TArrayView< ChannelType* >& InChannels,
TArray< FFrameNumber >& OutFrames
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static void GetFramesWithinActiveState ( const FMovieSceneConstraintChannel& InActiveChannel,
const TArrayView< ChannelType* >& InChannels,
TArray< FFrameNumber >& OutFrames
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static ITransformConstraintChannelInterface * GetHandleInterface ( const UTransformableHandle* InHandle
)

 Get the animatable interface for that handle if registered. Constraints/MovieSceneConstraintChannelHelper.h  

static void GetTransformFramesForConstraintHandles ( const UTickableTransformConstraint* InConstraint,
const TSharedPtr< ISequencer >& InSequencer,
const FFrameNumber& StartFrame,
const FFrameNumber& EndFrame,
TArray< FFrameNumber >& OutFramesToBake
)

 For the given constraint get all of the transform keys for it's child and parent handles Constraints/MovieSceneConstraintChannelHelper.h  

static TArray< FFrameNumber > GetTransformTimes ( const TArrayView< ChannelType* >& InChannels,
const FFrameNumber& StartTime,
const FFrameNumber& EndTime
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static void HandleConstraintKeyDeleted ( UTickableTransformConstraint* InConstraint,
const FMovieSceneConstraintChannel* InConstraintChannel,
const TSharedPtr< ISequencer >& InSequencer,
UMovieSceneSection* InSection,
const FFrameNumber& InTime
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static void HandleConstraintKeyMoved ( const UTickableTransformConstraint* InConstraint,
const FMovieSceneConstraintChannel* InConstraintChannel,
UMovieSceneSection* InSection,
const FFrameNumber& InCurrentFrame,
const FFrameNumber& InNextFrame
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static void HandleConstraintPropertyChanged ( UTickableTransformConstraint* InConstraint,
const FMovieSceneConstraintChannel& InActiveChannel,
const FPropertyChangedEvent& InPropertyChangedEvent,
const TSharedPtr< ISequencer >& InSequencer,
UMovieSceneSection* InSection
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static void HandleConstraintRemoved ( UTickableConstraint* InConstraint,
const FMovieSceneConstraintChannel* InChannel,
const TSharedPtr< ISequencer >& InSequencer,
UMovieSceneSection* InSection
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static void HandleOffsetChanged ( UTickableTransformConstraint* InConstraint,
const FMovieSceneConstraintChannel& InActiveChannel,
const TSharedPtr< ISequencer >& InSequencer
)

 Handle offset modifications so that the child's transform channels are synced. Constraints/MovieSceneConstraintChannelHelper.h  

static TPair< TOptional< FFrameNumber >, bool > IsActiveKeyAddedBeforeCurrentTime ( const FFrameNumber& InCurrentTime,
const FFrameNumber& InTime,
const TArrayView< ChannelType* >& InChannels,
TArray< FFrameNumber >& InOutFramesToCompensate
)

 Checks whether the key to be added is prior to the current frame and updates the frames to be compensated accordingly. Constraints/MovieSceneConstraintChannelHelper.h  

static bool IsHandleSpawnable ( const TSharedPtr< ISequencer >& InSequencer,
const UTransformableHandle* InHandle
)

 For the given handle, return true if a binding exists and if that binding represents a spawnable. Constraints/MovieSceneConstraintChannelHelper.h  

static void MoveTransformKeys ( const TArrayView< ChannelType* >& InChannels,
const FFrameNumber& InCurrentTime,
const FFrameNumber& InNextTime
)

   Constraints/MovieSceneConstraintChannelHelper.h  

static void SetTransformTimes ( const TArrayView< ChannelType* >& InChannels,
const TArray< FFrameNumber >& Frames,
const TArray< FTransform >& Transforms
)

 This will only set the value son channels with keys at the specified time, reusing tangent time etc. Constraints/MovieSceneConstraintChannelHelper.h  

static bool SmartConstraintKey ( const TSharedPtr< ISequencer >& InSequencer,
UTickableTransformConstraint* InConstraint,
const TOptional< bool >& InOptActive,
const TOptional< FFrameNumber >& InOptFrameTime
)

 Adds an active key if needed and does the compensation when switching. Constraints/MovieSceneConstraintChannelHelper.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page