UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMovieSceneConstraintChannel Struct Reference

#include <ConstraintChannel.h>

+ Inheritance diagram for FMovieSceneConstraintChannel:

Public Member Functions

 FMovieSceneConstraintChannel ()
 
virtual TMovieSceneChannelData< boolGetData () override
 
virtual TMovieSceneChannelData< const boolGetData () const override
 
virtual CONSTRAINTS_API bool Evaluate (FFrameTime InTime, bool &OutValue) const override
 
CONSTRAINTS_API bool IsInfinite () const
 
- Public Member Functions inherited from FMovieSceneBoolChannel
 FMovieSceneBoolChannel ()
 
MOVIESCENE_API bool SerializeFromMismatchedTag (const FPropertyTag &Tag, FStructuredArchive::FSlot Slot)
 
TArrayView< const FFrameNumberGetTimes () const
 
TArrayView< const boolGetValues () const
 
bool HasAnyData () const
 
void AddKeys (const TArray< FFrameNumber > &InTimes, const TArray< bool > &InValues)
 
virtual MOVIESCENE_API void GetKeys (const TRange< FFrameNumber > &WithinRange, TArray< FFrameNumber > *OutKeyTimes, TArray< FKeyHandle > *OutKeyHandles) override
 
virtual MOVIESCENE_API void GetKeyTimes (TArrayView< const FKeyHandle > InHandles, TArrayView< FFrameNumber > OutKeyTimes) override
 
virtual MOVIESCENE_API void SetKeyTimes (TArrayView< const FKeyHandle > InHandles, TArrayView< const FFrameNumber > InKeyTimes) override
 
virtual MOVIESCENE_API void DuplicateKeys (TArrayView< const FKeyHandle > InHandles, TArrayView< FKeyHandle > OutNewHandles) override
 
virtual MOVIESCENE_API void DeleteKeys (TArrayView< const FKeyHandle > InHandles) override
 
virtual MOVIESCENE_API void DeleteKeysFrom (FFrameNumber InTime, bool bDeleteKeysBefore) override
 
virtual MOVIESCENE_API void RemapTimes (const UE::MovieScene::IRetimingInterface &Retimer) override
 
virtual MOVIESCENE_API TRange< FFrameNumberComputeEffectiveRange () const override
 
virtual MOVIESCENE_API int32 GetNumKeys () const override
 
virtual MOVIESCENE_API void Reset () override
 
virtual MOVIESCENE_API void Offset (FFrameNumber DeltaPosition) override
 
virtual MOVIESCENE_API void Optimize (const FKeyDataOptimizationParams &InParameters) override
 
virtual MOVIESCENE_API void ClearDefault () override
 
virtual MOVIESCENE_API FKeyHandle GetHandle (int32 Index) override
 
virtual MOVIESCENE_API int32 GetIndex (FKeyHandle Handle) override
 
void SetDefault (bool InDefaultValue)
 
TOptional< boolGetDefault () const
 
void RemoveDefault ()
 
- Public Member Functions inherited from FMovieSceneChannel
 FMovieSceneChannel ()
 
virtual ~FMovieSceneChannel ()
 
MOVIESCENE_API void GetKeyTime (const FKeyHandle InHandle, FFrameNumber &OutKeyTime)
 
MOVIESCENE_API void SetKeyTime (const FKeyHandle InHandle, const FFrameNumber InKeyTime)
 
virtual MOVIESCENE_API void ChangeFrameResolution (FFrameRate SourceRate, FFrameRate DestinationRate)
 
virtual void PostEditChange ()
 
FMovieSceneChannelDataKeyAddedEventOnKeyAddedEvent ()
 
FMovieSceneChannelDataKeyDeletedEventOnKeyDeletedEvent ()
 
FMovieSceneChannelDataKeyMovedEventOnKeyMovedEvent ()
 

Additional Inherited Members

- Public Types inherited from FMovieSceneBoolChannel
typedef bool CurveValueType
 
- Public Attributes inherited from FMovieSceneBoolChannel
TEnumAsByte< ERichCurveExtrapolationPreInfinityExtrap
 
TEnumAsByte< ERichCurveExtrapolationPostInfinityExtrap
 
- Protected Attributes inherited from FMovieSceneBoolChannel
TArray< FFrameNumberTimes
 
bool DefaultValue
 
bool bHasDefaultValue
 
TArray< boolValues
 
FMovieSceneKeyHandleMap KeyHandles
 
- Protected Attributes inherited from FMovieSceneChannel
FMovieSceneChannelDataKeyAddedEvent KeyAddedEvent
 
FMovieSceneChannelDataKeyDeletedEvent KeyDeletedEvent
 
FMovieSceneChannelDataKeyMovedEvent KeyMovedEvent
 

Constructor & Destructor Documentation

◆ FMovieSceneConstraintChannel()

FMovieSceneConstraintChannel::FMovieSceneConstraintChannel ( )
inline

Member Function Documentation

◆ Evaluate()

bool FMovieSceneConstraintChannel::Evaluate ( FFrameTime  InTime,
bool OutValue 
) const
overridevirtual

Evaluate this channel

Parameters
InTimeThe time to evaluate at
OutValueA value to receive the result
Returns
true if the channel was evaluated successfully, false otherwise

Reimplemented from FMovieSceneBoolChannel.

◆ GetData() [1/2]

virtual TMovieSceneChannelData< const bool > FMovieSceneConstraintChannel::GetData ( ) const
inlineoverridevirtual

Access a constant interface for this channel's data

Returns
An object that is able to interrogate this channel's data

Reimplemented from FMovieSceneBoolChannel.

◆ GetData() [2/2]

virtual TMovieSceneChannelData< bool > FMovieSceneConstraintChannel::GetData ( )
inlineoverridevirtual

Access a mutable interface for this channel's data

Returns
An object that is able to manipulate this channel's data

Reimplemented from FMovieSceneBoolChannel.

◆ IsInfinite()

bool FMovieSceneConstraintChannel::IsInfinite ( ) const

Checks whether this constraint channel is infinite

Returns
true if there are no keys and the default value is set to true.

The documentation for this struct was generated from the following files: