unreal.RigUnit_PoseAssetGetRigPose

class unreal.RigUnit_PoseAssetGetRigPose(pose_asset: PoseAsset = Ellipsis, poses: None = [], items: None = [], mode: PoseAssetGetPoseForItemsMode = Ellipsis, rig_pose: RigPose = [], success: bool = False)

Bases: RigUnit_PoseAssetBase

Returns a pose from a pose asset as a rig pose

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_PoseAsset.h

Editor Properties: (see get_editor_property/set_editor_property)

  • items (Array[RigElementKey]): [Read-Write] The optional list of items to apply the pose to. If this is empty the pose will be retrieved for all items.

  • mode (PoseAssetGetPoseForItemsMode): [Read-Write] The mode to use when retrieving the pose. NOTE: This is only used if the pose asset is additive.

  • pose_asset (PoseAsset): [Read-Write] The pose asset to retrieve data from

  • poses (Array[RigUnit_PoseAsset_PoseInfo]): [Read-Write] The list of poses to retrieve

  • rig_pose (RigPose): [Read-Write] The retrieved rig pose if successful

  • success (bool): [Read-Write] True if the transforms were retrieved successfully from the pose asset

property items: None

[Read-Write] The optional list of items to apply the pose to. If this is empty the pose will be retrieved for all items.

Type:

(Array[RigElementKey])

property mode: PoseAssetGetPoseForItemsMode

[Read-Write] The mode to use when retrieving the pose. NOTE: This is only used if the pose asset is additive.

Type:

(PoseAssetGetPoseForItemsMode)

property poses: None

[Read-Write] The list of poses to retrieve

Type:

(Array[RigUnit_PoseAsset_PoseInfo])

property rig_pose: RigPose

[Read-Only] The retrieved rig pose if successful

Type:

(RigPose)

property success: bool

[Read-Only] True if the transforms were retrieved successfully from the pose asset

Type:

(bool)