Navigation
API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/Bindings
Inheritance Hierarchy
- UObject
- UMovieSceneCustomBinding
- UMovieSceneReplaceableBindingBase
References
| Module | MovieScene |
| Header | /Engine/Source/Runtime/MovieScene/Public/Bindings/MovieSceneReplaceableBinding.h |
| Include | #include "Bindings/MovieSceneReplaceableBinding.h" |
Syntax
UCLASS (Abstract)
class UMovieSceneReplaceableBindingBase : public UMovieSceneCustomBinding
Remarks
The base class for custom replaceable bindings. A replaceable binding uses an internal custom spawnable at editor time to produce a preview object, while in editor will use some other mechanism to dynamically bind an object to the track. Different replaceable types can choose different combinations of how to create a spawnable for preview vs. how to dynamically bind an object at runtime. UMovieSceneReplaceableActorBinding as an example is the simplest type of replaceable binding and provides no method for binding at runtime and relies on the LevelSequenceActor's Binding Override mechanism to bind an actor at runtime.
Variables
| Type | Name | Description | |
|---|---|---|---|
     |
TObjectPtr< UMovieSceneSpawnableBindingBase > | PreviewSpawnable | Optional Editor-only preview object. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
UMovieSceneSpawnableBindingBase * | CreateInnerSpawnable
(
UObject* SourceObject, |
Called from CreateNewCustomBinding to create the inner spawnable used for sequencer preview. |
   |
TSubclassOf< UMovieSceneSpawnableBindingBase > | Must be implemented and return a non abstract spawnable binding class inheriting from UMovieSceneSpawnableBindingBase to use for the preview for this replaceable binding. | |
  |
void | InitReplaceableBinding
(
UObject* SourceObject, |
Must be implemented. |
   |
FMovieSceneBindingResolveResult | ResolveRuntimeBindingInternal
(
const FMovieSceneBindingResolveParams& ResolveParams, |
Must be implemented. |
Overridden from UMovieSceneCustomBinding
| Type | Name | Description | |
|---|---|---|---|
   |
const UMovieSceneSpawnableBindingBase * | AsSpawnable
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
For custom bindings inheriting from UMovieSceneSpawnableBindingBase, returns this object cast to UMovieSceneSpawnableBindingBase. |
  |
UMovieSceneCustomBinding * | CreateCustomBindingFromBinding
(
const FMovieSceneBindingReference& BindingReference, |
Called during binding conversion to create a new binding of this type from a selected binding, if supported. |
  |
UMovieSceneCustomBinding * | CreateNewCustomBinding
(
UObject* SourceObject, |
Note that we choose to implement CreateCustomBinding here rather than in subclasses. |
   |
FSlateIcon | Allows the custom binding to optionally provide a custom icon overlay for the object binding track. | |
   |
FText | Allows the custom binding to optionally provide a custom tooltip to show when hovering over the icon area in the object binding track. | |
   |
UClass * | Must be implemented. | |
   |
FMovieSceneBindingResolveResult | ResolveBinding
(
const FMovieSceneBindingResolveParams& ResolveParams, |
Must be implemented. |
  |
void | SetupDefaults
(
UObject* SpawnedObject, |
Called by Sequencer upon creating a new custom binding or converting a binding to use this type. |
   |
bool | SupportsBindingCreationFromObject
(
const UObject* SourceObject |
UMovieSceneCustomBinding overrides |
   |
bool | SupportsConversionFromBinding
(
const FMovieSceneBindingReference& BindingReference, |
Called by UI code to see if this custom binding type supports conversions from the presented binding, including any current bound or spawned object as reference. |
   |
bool | WillSpawnObject
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
UMovieSceneCustomBinding overrides |