unreal.MLDeformerComponent

class unreal.MLDeformerComponent(outer=None, name='None')

Bases: unreal.ActorComponent

The ML mesh deformer component. This works in combination with a MLDeformerAsset and SkeletalMeshComponent. The component will perform runtime inference using the network trained in the asset.

C++ Source:

  • Plugin: MLDeformer

  • Module: MLDeformer

  • File: MLDeformerComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation

  • component_tags (Array(Name)): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • deformer_asset (MLDeformerAsset): [Read-Write] Deformer Asset: The deformer asset to use.

  • editable_when_inherited (bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class

  • is_editor_only (bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component

  • replicates (bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • vertex_delta_multiplier (float): [Read-Write] Vertex Delta Multiplier: The scale factor of the vertex deltas that are being applied.

setup_component(deformer_asset, skel_mesh_component) → None

Configure MLDeformerComponent with an MLRigDeformerAsset (network + parameters).

Parameters