unreal.ControlRigBlueprintLibrary

class unreal.ControlRigBlueprintLibrary(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: BlueprintFunctionLibrary

Control Rig Blueprint Editor Library

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRigEditor

  • File: ControlRigBlueprintEditorLibrary.h

classmethod cast_to_control_rig_blueprint(object) -> (branches=CastToControlRigBlueprintCases, as_control_rig_blueprint=ControlRigBlueprint)

Cast to Control Rig Blueprint

Parameters:

object (Object) –

Returns:

branches (CastToControlRigBlueprintCases):

as_control_rig_blueprint (ControlRigBlueprint):

Return type:

tuple

classmethod get_available_rig_units() → Array[Struct]

Get Available Rig Units

Return type:

Array[Struct]

classmethod get_controller(rig_blueprint) → RigVMController

Get Controller

Parameters:

rig_blueprint (ControlRigBlueprint) –

Return type:

RigVMController

classmethod get_currently_open_rig_blueprints() → Array[ControlRigBlueprint]

Get Currently Open Rig Blueprints

Return type:

Array[ControlRigBlueprint]

classmethod get_hierarchy(rig_blueprint) → RigHierarchy

Get Hierarchy

Parameters:

rig_blueprint (ControlRigBlueprint) –

Return type:

RigHierarchy

classmethod get_hierarchy_controller(rig_blueprint) → RigHierarchyController

Get Hierarchy Controller

Parameters:

rig_blueprint (ControlRigBlueprint) –

Return type:

RigHierarchyController

classmethod get_model(rig_blueprint) → RigVMGraph

Get Model

Parameters:

rig_blueprint (ControlRigBlueprint) –

Return type:

RigVMGraph

classmethod get_preview_mesh(rig_blueprint) → SkeletalMesh

Get Preview Mesh

Parameters:

rig_blueprint (ControlRigBlueprint) –

Return type:

SkeletalMesh

classmethod recompile_vm(rig_blueprint) → None

Recompile VM

Parameters:

rig_blueprint (ControlRigBlueprint) –

classmethod recompile_vm_if_required(rig_blueprint) → None

Recompile VMIf Required

Parameters:

rig_blueprint (ControlRigBlueprint) –

classmethod request_auto_vm_recompilation(rig_blueprint) → None

Request Auto VMRecompilation

Parameters:

rig_blueprint (ControlRigBlueprint) –

classmethod request_control_rig_init(rig_blueprint) → None

Request Control Rig Init

Parameters:

rig_blueprint (ControlRigBlueprint) –

classmethod set_preview_mesh(rig_blueprint, preview_mesh, mark_as_dirty=True) → None

Set Preview Mesh

Parameters: