FMovieSceneObjectBindingIDPicker

Helper class that is used to pick object bindings for movie scene data

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MovieSceneTools

Header

/Engine/Source/Editor/MovieSceneTools/Public/MovieSceneObjectBindingIDPicker.h

Include

#include "MovieSceneObjectBindingIDPicker.h"

Syntax

class FMovieSceneObjectBindingIDPicker

Remarks

Helper class that is used to pick object bindings for movie scene data

Variables

Name Description

Protected variable

FMovieSceneSequ...

 

LocalSequenceID

The ID of the sequence to generate IDs relative to

Protected variable

TWeakPtr< ISequ...

 

WeakSequencer

Optional sequencer ptr

Constructors

Name Description

Public function

FMovieSceneObjectBindingIDPicker()

Default constructor used in contexts external to the sequencer interface.

Public function

FMovieSceneObjectBindingIDPicker

(
    FMovieSceneSequenceID InLocalSequen...,
    TWeakPtr< ISequencer > InSequencer
)

Constructor used from within the sequencer interface to generate IDs from the currently focused sequence if possible (else from the root sequence).

Destructors

Functions

Name Description

Protected function Const

FSlateIcon

 

GetCurrentIcon()

Get the icon that represents the currently assigned binding

Protected function Const

const FSlate...

 

GetCurrentIconBrush()

Get the icon that represents the currently assigned binding

Protected function

TSharedRef< ...

 

GetCurrentItemWidget

(
    TSharedRef< STextBlock > TextConten...
)

Get a widget that represents the currently chosen item

Protected function Const

FText

 

GetCurrentText()

Access the text that relates to the currently selected binding ID

Protected function Const

FMovieSceneO...

 

GetCurrentValue()

Get the current binding ID

Protected function

void

 

GetPickerMenu

(
    FMenuBuilder& MenuBuilder
)

Build menu content that allows the user to choose a binding from inside the source sequence

Protected function

TSharedRef< ...

 

GetPickerMenu()

Build menu content that allows the user to choose a binding from inside the source sequence

Protected function Const

UMovieSceneS...

 

GetSequence()

Get the sequence to look up object bindings within. Only used when no sequencer is available.

Protected function Const

EVisibility

 

GetSpawnableIconOverlayVisibility()

Get the visibility for the spawnable icon overlap

Protected function Const

FText

 

GetToolTipText()

Access the tooltip text that relates to the currently selected binding ID

Protected function

void

 

Initialize()

Initialize this class - rebuilds sequence hierarchy data and available IDs from the source sequence

Public function Const

bool

 

IsEmpty()

Check whether this picker actually has anything to pick

Protected function

void

 

SetBindingId

(
    FMovieSceneObjectBindingID InBindin...
)

Assign a new binding ID in response to user-input

Protected function

void

 

SetCurrentValue

(
    const FMovieSceneObjectBindingID& ...
)

Set the current binding ID

Protected function

void

 

UpdateCachedData()

Update the cached text, tooltip and icon

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss