1. Epic GamesDeveloper
  3. FMovieSceneBoolChannel

FMovieSceneBoolChannel

API > API/Runtime > API/Runtime/MovieScene

   
Name FMovieSceneBoolChannel
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneBoolChannel.h
Include Path #include "Channels/MovieSceneBoolChannel.h"

Syntax

USTRUCT ()  
struct FMovieSceneBoolChannel : public FMovieSceneChannel

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FMovieSceneBoolChannel()

   Channels/MovieSceneBoolChannel.h  

Typedefs

Name Type Remarks Include Path
CurveValueType bool   Channels/MovieSceneBoolChannel.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
PostInfinityExtrap TEnumAsByte< ERichCurveExtrapolation > Post-infinity extrapolation state, bool channel only supports constant, cycle and oscillate Channels/MovieSceneBoolChannel.h  
PreInfinityExtrap TEnumAsByte< ERichCurveExtrapolation > Pre-infinity extrapolation state, bool channel only supports constant, cycle and oscillate Channels/MovieSceneBoolChannel.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddKeys ( const TArray< FFrameNumber >& InTimes,
const TArray< bool >& InValues
)

 Add keys with these times to channel. Channels/MovieSceneBoolChannel.h  

virtual bool Evaluate ( FFrameTime InTime,
bool& OutValue
) const

 Evaluate this channel Channels/MovieSceneBoolChannel.h  

virtual TMovieSceneChannelData< bool > GetData ()

 Access a mutable interface for this channel's data Channels/MovieSceneBoolChannel.h  

virtual TMovieSceneChannelData< const bool > GetData ()

 Access a constant interface for this channel's data Channels/MovieSceneBoolChannel.h  

TOptional< bool > GetDefault()

 Get this channel's default value that will be used when no keys are present Channels/MovieSceneBoolChannel.h  

TArrayView< const FFrameNumber > GetTimes()

 Const access to this channel's times Channels/MovieSceneBoolChannel.h  

TArrayView< const bool > GetValues()

 Const access to this channel's values Channels/MovieSceneBoolChannel.h  

bool HasAnyData()

 Check whether this channel has any data Channels/MovieSceneBoolChannel.h  

void RemoveDefault()

 Remove this channel's default value causing the channel to have no effect where no keys are present Channels/MovieSceneBoolChannel.h  

bool SerializeFromMismatchedTag ( const FPropertyTag& Tag,
FStructuredArchive::FSlot Slot
)

 Serialize this type from another Channels/MovieSceneBoolChannel.h  

void SetDefault ( bool InDefaultValue
)

 Set this channel's default value that should be used when no keys are present Channels/MovieSceneBoolChannel.h  

Overridden from FMovieSceneChannel

Name Remarks Include Path Unreal Specifiers

virtual void ClearDefault()

 Clear all the default value on this channel Channels/MovieSceneBoolChannel.h  

virtual TRange< FFrameNumber > ComputeEffectiveRange()

 Compute the effective range of this channel, for example, the extents of its key times Channels/MovieSceneBoolChannel.h  

virtual void DeleteKeys ( TArrayView< const FKeyHandle > InHandles
)

 Delete the keys for the specified key handles Channels/MovieSceneBoolChannel.h  

virtual void DeleteKeysFrom ( FFrameNumber InTime,
bool bDeleteKeysBefore
)

 Delete keys before or after a specified time Channels/MovieSceneBoolChannel.h  

virtual void DuplicateKeys ( TArrayView< const FKeyHandle > InHandles,
TArrayView< FKeyHandle > OutNewHandles
)

 Duplicate the keys for the specified key handles Channels/MovieSceneBoolChannel.h  

virtual FKeyHandle GetHandle ( int32 Index
)

 Retrieve a key handle for the specified key time index Channels/MovieSceneBoolChannel.h  

virtual int32 GetIndex ( FKeyHandle Handle
)

 Attempt to retrieve the index of key from its handle Channels/MovieSceneBoolChannel.h  

virtual void GetKeys ( const TRange< FFrameNumber >& WithinRange,
TArray< FFrameNumber >* OutKeyTimes,
TArray< FKeyHandle >* OutKeyHandles
)

 Get key information pertaining to all keys that exist within the specified range Channels/MovieSceneBoolChannel.h  

virtual void GetKeyTimes ( TArrayView< const FKeyHandle > InHandles,
TArrayView< FFrameNumber > OutKeyTimes
)

 Get all key times for the specified key handles Channels/MovieSceneBoolChannel.h  

virtual int32 GetNumKeys()

 Get the total number of keys on this channel Channels/MovieSceneBoolChannel.h  

virtual void Offset ( FFrameNumber DeltaPosition
)

 Offset the keys within this channel by a given delta position Channels/MovieSceneBoolChannel.h  

virtual void Optimize ( const FKeyDataOptimizationParams& InParameters
)

 Optimize this channel by removing any redundant data according to the specified parameters Channels/MovieSceneBoolChannel.h  

virtual void RemapTimes ( const UE::MovieScene::IRetimingInterface& Retimer
)

 Remap the times contained within this channel using a custom remapper Channels/MovieSceneBoolChannel.h  

virtual void Reset()

 Reset this channel back to its original state Channels/MovieSceneBoolChannel.h  

virtual void SetKeyTimes ( TArrayView< const FKeyHandle > InHandles,
TArrayView< const FFrameNumber > InKeyTimes
)

 Set key times for the specified key handles Channels/MovieSceneBoolChannel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page