unreal.AnimatedSparseVolumeTextureController

class unreal.AnimatedSparseVolumeTextureController(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Utility (blueprint) class for controlling SparseVolumeTexture playback.

C++ Source:

  • Module: Engine

  • File: SparseVolumeTexture.h

Editor Properties: (see get_editor_property/set_editor_property)

  • blocking_streaming_requests (bool): [Read-Write]

  • frame_rate (float): [Read-Write]

  • is_playing (bool): [Read-Write]

  • mip_level (int32): [Read-Write]

  • sparse_volume_texture (SparseVolumeTexture): [Read-Write]

  • time (float): [Read-Write]

property blocking_streaming_requests: bool

[Read-Write]

Type:

(bool)

property frame_rate: float

[Read-Write]

Type:

(float)

get_current_frame() SparseVolumeTextureFrame

Get Current Frame

Return type:

SparseVolumeTextureFrame

get_current_frames_for_interpolation() -> (frame0=SparseVolumeTextureFrame, frame1=SparseVolumeTextureFrame, lerp_alpha=float)

Get Current Frames for Interpolation

Returns:

frame0 (SparseVolumeTextureFrame):

frame1 (SparseVolumeTextureFrame):

lerp_alpha (float):

Return type:

tuple

get_duration() float

Get Duration

Return type:

float

get_fractional_frame_index() float

Get Fractional Frame Index

Return type:

float

get_frame_by_index(frame_index) SparseVolumeTextureFrame

Get Frame by Index

Parameters:

frame_index (int32) –

Return type:

SparseVolumeTextureFrame

property is_playing: bool

[Read-Write]

Type:

(bool)

property mip_level: int

[Read-Write]

Type:

(int32)

pause() None

Pause

play() None

Play

property sparse_volume_texture: SparseVolumeTexture

[Read-Write]

Type:

(SparseVolumeTexture)

stop() None

Stop

property time: float

[Read-Write]

Type:

(float)

update(delta_time) None

Update

Parameters:

delta_time (float) –