unreal.AnimToTextureInstancePlaybackLibrary

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

Bases: BlueprintFunctionLibrary

Anim to Texture Instance Playback Library

C++ Source:

• Plugin: AnimToTexture

• Module: AnimToTexture

• File: AnimToTextureInstancePlaybackHelpers.h

classmethod batch_update_instances_auto_play_data(instanced_mesh_component, auto_play_data, transforms, mark_render_state_dirty=True) → bool

Updates all instances with the given Transforms and AutoPlayData

Parameters:

• instanced_mesh_component (InstancedStaticMeshComponent) –

• auto_play_data (Array[AnimToTextureAutoPlayData]) –

• transforms (Array[Matrix]) –

• mark_render_state_dirty (bool) –

Return type:

bool

classmethod batch_update_instances_frame_data(instanced_mesh_component, frame_data, transforms, mark_render_state_dirty=True) → bool

Updates all instances with the given Transforms and FrameData

Parameters:

• instanced_mesh_component (InstancedStaticMeshComponent) –

• frame_data (Array[AnimToTextureFrameData]) –

• transforms (Array[Matrix]) –

• mark_render_state_dirty (bool) –

Return type:

bool

classmethod get_auto_play_data_from_data_asset(data_asset, animation_index, time_offset=0.000000, play_rate=1.000000) → AnimToTextureAutoPlayData or None

Returns an AutoPlayData with the Start and End Frame for the given AnimationIndex. If AnimationIndex is out of range, false will be returned.

Parameters:

• data_asset (AnimToTextureDataAsset) –

• animation_index (int32) –

• time_offset (float) –

• play_rate (float) –

Returns:

auto_play_data (AnimToTextureAutoPlayData):

Return type:

AnimToTextureAutoPlayData or None

classmethod get_frame(time, start_frame, end_frame, time_offset=0.000000, play_rate=1.000000, sample_rate=30.000000) → float

Get Frame

Parameters:

• time (float) –

• start_frame (float) –

• end_frame (float) –

• time_offset (float) –

• play_rate (float) –

• sample_rate (float) –

Return type:

float

classmethod get_frame_data_from_data_asset(data_asset, animation_index, time, time_offset=0.000000, play_rate=1.000000) → AnimToTextureFrameData or None

Get Frame Data from Data Asset

Parameters:

• data_asset (AnimToTextureDataAsset) –

• animation_index (int32) –

• time (float) –

• time_offset (float) –

• play_rate (float) –

Returns:

auto_play_data (AnimToTextureFrameData):

Return type:

AnimToTextureFrameData or None

classmethod setup_instanced_mesh_component(instanced_mesh_component, num_instances, auto_play) → bool

Adds Instances and allocates the necessary CustomData.

Parameters:

• instanced_mesh_component (InstancedStaticMeshComponent) –

• num_instances (int32) –

• auto_play (bool) –

Return type:

bool

classmethod update_instance_auto_play_data(instanced_mesh_component, instance_index, auto_play_data, mark_render_state_dirty=True) → bool

Updates a single instance with given AutoPlayData

Parameters:

• instanced_mesh_component (InstancedStaticMeshComponent) –

• instance_index (int32) –

• auto_play_data (AnimToTextureAutoPlayData) –

• mark_render_state_dirty (bool) –

Return type:

bool

classmethod update_instance_frame_data(instanced_mesh_component, instance_index, frame_data, mark_render_state_dirty=True) → bool

• Updates a single instance with given FrameData

Parameters:

• instanced_mesh_component (InstancedStaticMeshComponent) –

• instance_index (int32) –

• frame_data (AnimToTextureFrameData) –

• mark_render_state_dirty (bool) –

Return type:

bool