unreal.ControlRigComponentMappedElement

class unreal.ControlRigComponentMappedElement(component_reference: SoftComponentReference = Ellipsis, transform_index: int = 0, transform_name: Name = 'None', element_type: RigElementType = Ellipsis, element_name: Name = 'None', direction: ControlRigComponentMapDirection = Ellipsis, offset: Transform = Ellipsis, weight: float = 0.0, space: ControlRigComponentSpace = Ellipsis)

Bases: StructBase

Control Rig Component Mapped Element

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: ControlRigComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • component_reference (SoftComponentReference): [Read-Write] The component to map to the Control Rig

  • direction (ControlRigComponentMapDirection): [Read-Write] The direction (input / output) to be used for mapping an element

  • element_name (Name): [Read-Write] The name of the element to map to

  • element_type (RigElementType): [Read-Write] The type of element this is mapped to

  • offset (Transform): [Read-Write] The offset transform to apply

  • space (ControlRigComponentSpace): [Read-Write] space in which the mapping happens

  • transform_index (int32): [Read-Write] An optional index that can be used with components with multiple transforms (for example the InstancedStaticMeshComponent)

  • transform_name (Name): [Read-Write] An optional name that can be used with components that have sockets (for example the SkeletalMeshComponent)

  • weight (float): [Read-Write] defines how much the mapped element should be driven

property component_reference: SoftComponentReference

[Read-Write] The component to map to the Control Rig

Type:

(SoftComponentReference)

property direction: ControlRigComponentMapDirection

[Read-Write] The direction (input / output) to be used for mapping an element

Type:

(ControlRigComponentMapDirection)

property element_name: Name

[Read-Write] The name of the element to map to

Type:

(Name)

property element_type: RigElementType

[Read-Write] The type of element this is mapped to

Type:

(RigElementType)

property offset: Transform

[Read-Write] The offset transform to apply

Type:

(Transform)

property space: ControlRigComponentSpace

[Read-Write] space in which the mapping happens

Type:

(ControlRigComponentSpace)

property transform_index: int

[Read-Write] An optional index that can be used with components with multiple transforms (for example the InstancedStaticMeshComponent)

Type:

(int32)

property transform_name: Name

[Read-Write] An optional name that can be used with components that have sockets (for example the SkeletalMeshComponent)

Type:

(Name)

property weight: float

[Read-Write] defines how much the mapped element should be driven

Type:

(float)