Navigation
API > API/Editor > API/Editor/MovieSceneTools
Helper class that is used to pick object bindings for movie scene data
| Name | FMovieSceneObjectBindingIDPicker |
| Type | class |
| Header File | /Engine/Source/Editor/MovieSceneTools/Public/MovieSceneObjectBindingIDPicker.h |
| Include Path | #include "MovieSceneObjectBindingIDPicker.h" |
Syntax
class FMovieSceneObjectBindingIDPicker
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneObjectBindingIDPicker
(
FMovieSceneSequenceID InLocalSequenceID, |
Constructor used from within the sequencer interface to generate IDs from the currently focused sequence if possible (else from the root sequence). | MovieSceneObjectBindingIDPicker.h | |
| Default constructor used in contexts external to the sequencer interface. | MovieSceneObjectBindingIDPicker.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FMovieSceneObjectBindingIDPicker() |
MovieSceneObjectBindingIDPicker.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsCurrentItemSpawnable | bool | Cached value indicating whether the current item is a spawnable | MovieSceneObjectBindingIDPicker.h | |
| CurrentIcon | FSlateIcon | Cached current icon | MovieSceneObjectBindingIDPicker.h | |
| CurrentText | FText | Cached current text and tooltips | MovieSceneObjectBindingIDPicker.h | |
| DataTree | TSharedPtr< FSequenceBindingTree > | Data tree that stores all the available bindings for the current sequence, and their identifiers | MovieSceneObjectBindingIDPicker.h | |
| DismissWidget | TWeakPtr< SWidget > | Weak ptr to a widget used to dismiss menus to | MovieSceneObjectBindingIDPicker.h | |
| ToolTipText | FText | MovieSceneObjectBindingIDPicker.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsEmpty() |
Check whether this picker actually has anything to pick | MovieSceneObjectBindingIDPicker.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateIcon GetCurrentIcon() |
Get the icon that represents the currently assigned binding | MovieSceneObjectBindingIDPicker.h | |
const FSlateBrush * GetCurrentIconBrush() |
MovieSceneObjectBindingIDPicker.h | ||
TSharedRef< SWidget > GetCurrentItemWidget
(
TSharedRef< STextBlock > TextContent |
Get a widget that represents the currently chosen item | MovieSceneObjectBindingIDPicker.h | |
FText GetCurrentText() |
Access the text that relates to the currently selected binding ID | MovieSceneObjectBindingIDPicker.h | |
FMovieSceneObjectBindingID GetCurrentValue() |
Get the current binding ID | MovieSceneObjectBindingIDPicker.h | |
TSharedRef< SWidget > GetPickerMenu () |
Build menu content that allows the user to choose a binding from inside the source sequence | MovieSceneObjectBindingIDPicker.h | |
void GetPickerMenu
(
FMenuBuilder& MenuBuilder |
Build menu content that allows the user to choose a binding from inside the source sequence | MovieSceneObjectBindingIDPicker.h | |
UMovieSceneSequence * GetSequence() |
Get the sequence to look up object bindings within. Only used when no sequencer is available. | MovieSceneObjectBindingIDPicker.h | |
EVisibility GetSpawnableIconOverlayVisibility() |
Get the visibility for the spawnable icon overlap | MovieSceneObjectBindingIDPicker.h | |
FText GetToolTipText() |
Access the tooltip text that relates to the currently selected binding ID | MovieSceneObjectBindingIDPicker.h | |
TSharedRef< SWidget > GetWarningWidget() |
Get a widget that represents a warning/fixup button for this binding | MovieSceneObjectBindingIDPicker.h | |
virtual bool HasMultipleValues() |
Whether there are multiple values | MovieSceneObjectBindingIDPicker.h | |
void Initialize() |
Initialize this class - rebuilds sequence hierarchy data and available IDs from the source sequence | MovieSceneObjectBindingIDPicker.h | |
void SetBindingId
(
UE::MovieScene::FFixedObjectBindingID InBindingId |
Assign a new binding ID in response to user-input | MovieSceneObjectBindingIDPicker.h | |
void SetCurrentValue
(
const FMovieSceneObjectBindingID& InBindingId |
Set the current binding ID | MovieSceneObjectBindingIDPicker.h | |
void UpdateCachedData() |
Update the cached text, tooltip and icon | MovieSceneObjectBindingIDPicker.h |