unreal.PerformanceCaptureSettings

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

Bases: Object

  • Per Project Settings for Performance Capture.

C++ Source:

  • Plugin: PerformanceCaptureWorkflow

  • Module: PerformanceCaptureWorkflow

  • File: PCapSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • allowed_capture_character_actor_classes (Array[Class]): [Read-Write] Skeletal Mesh Actor classes that are explicitly to be used as Characters with Mocap Manager. These skeletal mesh actors must contain a retarget component

  • database_helper_class (Class): [Read-Write] Blueprint helper class for making database calls. If you change class you will need to restart the editor to pick up the change

  • default_performer_skel_mesh (SkeletalMesh): [Read-Write] Base skeletal mesh for Mocap performers.

  • default_session_template (PCapSessionTemplate): [Read-Write] This Asset defines the folder structure and settings used in a performance capture session

  • disallowed_capture_character_actor_classes (Array[Class]): [Read-Write] Skeletal Mesh Actor classes that are explicitly disallowed for use as Characters with Mocap Manager.

  • mocap_manager_ui (EditorUtilityWidgetBlueprint): [Read-Write] Editor Utility Widget class that will be used for the Mocap Manager UI

  • on_p_cap_settings_changed (OnPCapSettingsChanged): [Read-Write] Multicast delegate called whenever the Performance Capture settings object is modified.

  • production_table (PCapDataTable): [Read-Write] Proint to the datatable Mocap Manager will use for recording production data.

  • session_table (PCapDataTable): [Read-Write] Pointer to the datatable Mocap Manager will use for recording all session data.

  • stage_root (Class): [Read-Write] Stage Root Actor to spawn for Performance Capture. Class must derive from APerformanceCaptureStageRoot.

  • view_model_class (Class): [Read-Write] Blueprint Viewmodel class. If you change class you will need to restart the editor to pick up the change.

property allowed_capture_character_actor_classes: None

[Read-Only] Skeletal Mesh Actor classes that are explicitly to be used as Characters with Mocap Manager. These skeletal mesh actors must contain a retarget component

Type:

(Array[Class])

property default_performer_skel_mesh: SkeletalMesh

[Read-Only] Base skeletal mesh for Mocap performers.

Type:

(SkeletalMesh)

property default_session_template: PCapSessionTemplate

[Read-Only] This Asset defines the folder structure and settings used in a performance capture session

Type:

(PCapSessionTemplate)

property disallowed_capture_character_actor_classes: None

[Read-Only] Skeletal Mesh Actor classes that are explicitly disallowed for use as Characters with Mocap Manager.

Type:

(Array[Class])

classmethod get_performance_capture_settings() → PerformanceCaptureSettings

Get the Performance Capture settings uobject

Returns:

Settings Object.

Return type:

PerformanceCaptureSettings

property mocap_manager_ui: EditorUtilityWidgetBlueprint

[Read-Only] Editor Utility Widget class that will be used for the Mocap Manager UI

Type:

(EditorUtilityWidgetBlueprint)

property on_p_cap_settings_changed: OnPCapSettingsChanged

[Read-Write] Multicast delegate called whenever the Performance Capture settings object is modified.

Type:

(OnPCapSettingsChanged)

property production_table: PCapDataTable

[Read-Only] Proint to the datatable Mocap Manager will use for recording production data.

Type:

(PCapDataTable)

property session_table: PCapDataTable

[Read-Only] Pointer to the datatable Mocap Manager will use for recording all session data.

Type:

(PCapDataTable)

set_default_session_template(new_session_template) → None

Set the default session template in Performance Capture Settings.

Parameters:

new_session_template (PCapSessionTemplate) – Session Template data asset ref.

set_production_table(new_data_table) → None

Set the production table in Performance Capture Settings.

Parameters:

new_data_table (PCapDataTable) – Datatable ref. Must be of the FPCapProduction struct type.

set_session_table(new_data_table) → None

Set the session table in Performance Capture settings.

Parameters:

new_data_table (PCapDataTable) – Datatable ref. Must be of the FPCapSession struct type.

show_performance_capture_project_settings() → None

Open the project settings panel and show the Performance Capture section.

property stage_root: Class

[Read-Only] Stage Root Actor to spawn for Performance Capture. Class must derive from APerformanceCaptureStageRoot.

Type:

(Class)

property view_model_class: Class

[Read-Only] Blueprint Viewmodel class. If you change class you will need to restart the editor to pick up the change.

Type:

(Class)