unreal.ControlRigTestData

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

Bases: Object

Control Rig Test Data

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: ControlRigTestData.h

Editor Properties: (see get_editor_property/set_editor_property)

  • control_rig_object_path (SoftObjectPath): [Read-Only]

  • frames_to_skip (Array[int32]): [Read-Write]

  • initial (ControlRigTestDataFrame): [Read-Only]

  • input_frames (Array[ControlRigTestDataFrame]): [Read-Only]

  • output_frames (Array[ControlRigTestDataFrame]): [Read-Only]

  • tolerance (double): [Read-Write]

property control_rig_object_path: SoftObjectPath

[Read-Only]

Type:

(SoftObjectPath)

classmethod create_new_asset(desired_package_path, blueprint_path_name) → ControlRigTestData

Create New Asset

Parameters:

  • desired_package_path (str) –

  • blueprint_path_name (str) –

Return type:

ControlRigTestData

property frames_to_skip: None

[Read-Only]

Type:

(Array[int32])

get_frame_index_for_time(seconds, input=False) → int32

Get Frame Index for Time

Parameters:

  • seconds (double) –

  • input (bool) –

Return type:

int32

get_playback_mode() → ControlRigTestDataPlaybackMode

Get Playback Mode

Return type:

ControlRigTestDataPlaybackMode

get_time_range(input=False) → Vector2D

Get Time Range

Parameters:

input (bool) –

Return type:

Vector2D

property initial: ControlRigTestDataFrame

[Read-Only]

Type:

(ControlRigTestDataFrame)

property input_frames: None

[Read-Only]

Type:

(Array[ControlRigTestDataFrame])

is_recording() → bool

Is Recording

Return type:

bool

is_replaying() → bool

Is Replaying

Return type:

bool

property output_frames: None

[Read-Only]

Type:

(Array[ControlRigTestDataFrame])

record(control_rig, recording_duration=0.000000) → bool

Record

Parameters:

  • control_rig (ControlRig) –

  • recording_duration (double) –

Return type:

bool

release_replay() → None

Release Replay

setup_replay(control_rig, ground_truth=True) → bool

Setup Replay

Parameters:
Return type:

bool

property tolerance: float

[Read-Only]

Type:

(double)