unreal.MovieSceneSectionExtensions
¶
- class unreal.MovieSceneSectionExtensions(outer=None, name='None')¶
Bases:
unreal.BlueprintFunctionLibrary
Function library containing methods that should be hoisted onto UMovieSceneSections for scripting
C++ Source:
Plugin: SequencerScripting
Module: SequencerScripting
File: MovieSceneSectionExtensions.h
- classmethod find_channels_by_type(section, channel_type)¶
Find all channels that belong to the specified UMovieSceneSection that match the specific type. This will filter out any children who do not inherit from the specified type for you.
- Parameters
section (MovieSceneSection) – The section to use.
- Returns
An array containing any key channels that match the type specified
- Return type
- classmethod get_channels(section)¶
Find all channels that belong to the specified UMovieSceneSection. Some sections have many channels (such as Transforms containing 9 float channels to represent Translation/Rotation/Scale), and a section may have mixed channel types.
- Parameters
section (MovieSceneSection) – The section to use.
- Returns
An array containing any key channels that match the type specified
- Return type
- classmethod get_end_frame(section) → int32¶
Get end frame
- Parameters
section (MovieSceneSection) – The section within which to get the end frame
- Returns
End frame of this section
- Return type
int32
- classmethod get_end_frame_seconds(section) → float¶
Get end time in seconds
- Parameters
section (MovieSceneSection) – The section within which to get the end time
- Returns
End time of this section
- Return type
- classmethod get_parent_sequence_frame(section, frame, parent_sequence) → int32¶
Get the frame in the space of its parent sequence
- Parameters
section (MovieSceneSubSection) – The section that the InFrame is local to
frame (int32) – The desired local frame
parent_sequence (MovieSceneSequence) – The parent sequence to traverse from
- Returns
The frame at the parent sequence
- Return type
int32
- classmethod get_start_frame(section) → int32¶
Get start frame
- Parameters
section (MovieSceneSection) – The section within which to get the start frame
- Returns
Start frame of this section
- Return type
int32
- classmethod get_start_frame_seconds(section) → float¶
Get start time in seconds
- Parameters
section (MovieSceneSection) – The section within which to get the start time
- Returns
Start time of this section
- Return type
- classmethod has_end_frame(section) → bool¶
Has end frame
- Parameters
section (MovieSceneSection) – The section being queried
- Returns
Whether this section has a valid end frame (else infinite)
- Return type
- classmethod has_start_frame(section) → bool¶
Has start frame
- Parameters
section (MovieSceneSection) – The section being queried
- Returns
Whether this section has a valid start frame (else infinite)
- Return type
- classmethod set_end_frame(section, end_frame) → None¶
Set end frame
- Parameters
section (MovieSceneSection) – The section within which to set the end frame
end_frame (int32) – The desired start frame for this section
- classmethod set_end_frame_bounded(section, is_bounded) → None¶
Set end frame bounded
- Parameters
section (MovieSceneSection) – The section to set whether the end frame is bounded or not
is_bounded (bool) –
- classmethod set_end_frame_seconds(section, end_time) → None¶
Set end time in seconds
- Parameters
section (MovieSceneSection) – The section within which to set the end time
end_time (float) – The desired end time for this section
- classmethod set_range(section, start_frame, end_frame) → None¶
Set range
- Parameters
section (MovieSceneSection) – The section within which to set the range
start_frame (int32) – The desired start frame for this section
end_frame (int32) – The desired end frame for this section
- classmethod set_range_seconds(section, start_time, end_time) → None¶
Set range in seconds
- Parameters
section (MovieSceneSection) – The section within which to set the range
start_time (float) – The desired start frame for this section
end_time (float) – The desired end frame for this section
- classmethod set_start_frame(section, start_frame) → None¶
Set start frame
- Parameters
section (MovieSceneSection) – The section within which to set the start frame
start_frame (int32) – The desired start frame for this section
- classmethod set_start_frame_bounded(section, is_bounded) → None¶
Set start frame bounded
- Parameters
section (MovieSceneSection) – The section to set whether the start frame is bounded or not
is_bounded (bool) –
- classmethod set_start_frame_seconds(section, start_time) → None¶
Set start time in seconds
- Parameters
section (MovieSceneSection) – The section within which to set the start time
start_time (float) – The desired start time for this section