1. Epic GamesDeveloper
  3. FMovieSceneStringChannel

FMovieSceneStringChannel

Unreal Engine C++ API Reference > Runtime > MovieSceneTracks > Channels

Inheritance Hierarchy

References

   
Module MovieSceneTracks
Header /Engine/Source/Runtime/MovieSceneTracks/Public/Channels/MovieSceneStringChannel.h
Include #include "Channels/MovieSceneStringChannel.h"

Syntax

struct FMovieSceneStringChannel : public FMovieSceneChannel

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

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

 Add keys with these times to channel.
Public function Const const FString *

Evaluate ( FFrameTime InTime
)

 Evaluate this channel
Public function TMovieSceneChannelData< FString >

GetData ()

 Access a mutable interface for this channel's data
Public function Const TMovieSceneChannelData< const FString >

GetData ()

 Access a constant interface for this channel's data
Public function Const TOptional< FString > Get this channel's default value that will be used when no keys are present
Public function Const TArrayView< const FFrameNumber > Const access to this channel's times
Public function Const bool Returns whether this channel has any values
Public function void Remove this channel's default value causing the channel to have no effect where no keys are present
Public function bool Serialize this type from another
Public function void

SetDefault ( FString InDefaultValue
)

 Set this channel's default value that should be used when no keys are present

Overridden from FMovieSceneChannel

  Type Name Description
Public function Virtual void

ChangeFrameResolution ( FFrameRate SourceRate,
FFrameRate DestinationRate
)

 Called when the frame resolution of this channel is to be changed.
Public function Virtual void Clear all the default value on this channel
Public function Virtual Const TRange< FFrameNumber > Compute the effective range of this channel, for example, the extents of its key times
Public function Virtual void

DeleteKeys ( TArrayView< const FKeyHandle > InHandles
)

 Delete the keys for the specified key handles
Public function Virtual void

DeleteKeysFrom ( FFrameNumber InTime,
bool bDeleteKeysBefore
)

 Delete keys before or after a specified time
Public function Virtual void

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

 Duplicate the keys for the specified key handles
Public function 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
Public function Virtual void

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

 Get all key times for the specified key handles
Public function Virtual Const int32 Get the total number of keys on this channel
Public function Virtual void

Offset ( FFrameNumber DeltaPosition
)

 Offset the keys within this channel by a given delta position
Public function Virtual void

Optimize ( const FKeyDataOptimizationParams& InParameters
)

 Optimize this channel by removing any redundant data according to the specified parameters
Public function Virtual void

Reset ()

 Reset this channel back to its original state
Public function Virtual void

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

 Set key times for the specified key handles

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page