animation_toolset.toolsets.controlrig.ControlRigTools¶
Tools for creating and editing Control Rig assets, including hierarchy management, graph operations, and node/pin manipulation.
44 tool(s).
animation_toolset.toolsets.controlrig.ControlRigTools.add_backward_solve_graph¶
Create a backward solve graph with InverseExecution event.
Args:
control_rig: The Control Rig to add the graph to.
name: Optional custom name (default: "Backward Solve").
Returns:
The newly created RigVMGraph with InverseExecution event.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"name": {
"default": null,
"type": "string"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.add_bone¶
Add a bone to the Control Rig hierarchy.
Args:
control_rig: The Control Rig to add the bone to.
name: Name for the new bone.
parent: Parent element in the hierarchy. None creates at root level.
transform: Initial world transform. Uses identity if None.
Only specified fields are applied; unset fields use identity.
Returns:
The RigElementKey for the newly created bone.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"name": {
"type": "string"
},
"parent": {
"default": null,
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"transform": {
"default": null,
"description": "Represents a 3D transformation with optional location, rotation, and scale.\nUnset fields mean \"identity\" when creating objects and \"don't change\" when modifying existing ones.",
"properties": {
"location": {
"description": "The world-space location.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"rotation": {
"description": "The world-space rotation.",
"properties": {
"pitch": {
"description": "Pitch (degrees) around Y axis",
"type": "number"
},
"roll": {
"description": "Roll (degrees) around X axis",
"type": "number"
},
"yaw": {
"description": "Yaw (degrees) around Z axis",
"type": "number"
}
},
"required": [
"pitch",
"yaw",
"roll"
],
"title": "Rotator",
"type": "object"
},
"scale": {
"description": "The scale.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"title": "ToolsetTransform",
"type": "object"
}
},
"required": [
"control_rig",
"name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.add_control¶
Add a control to the hierarchy.
Args:
control_rig: The Control Rig to add the control to.
name: Name for the new control.
parent: Parent element in the hierarchy. None creates at root level.
settings: Control settings (shape, color, limits). Uses defaults if None.
Returns:
The RigElementKey for the newly created control.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"name": {
"type": "string"
},
"parent": {
"default": null,
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"settings": {
"default": null,
"properties": {
"animationType": {
"enum": [
"AnimationControl",
"AnimationChannel",
"ProxyControl",
"VisualCue"
],
"title": "ERigControlAnimationType",
"type": "string"
},
"bDrawLimits": {
"description": "True if the limits should be drawn in debug.\nFor this to be enabled you need to have at least one min and max limit turned on.",
"type": "boolean"
},
"bGroupWithParentControl": {
"description": "If set to true the animation channel will be grouped with the parent control in sequencer",
"type": "boolean"
},
"bIsCurve": {
"description": "If Created from a Curve Container",
"type": "boolean"
},
"bIsTransientControl": {
"description": "If the control is transient and only visible in the control rig editor",
"type": "boolean"
},
"bRestrictSpaceSwitching": {
"description": "Allow to space switch only to the available spaces",
"type": "boolean"
},
"bShapeVisible": {
"description": "Set to true if the shape is currently visible in 3d",
"type": "boolean"
},
"bUsePreferredRotationOrder": {
"description": "Whether to use a specified rotation order or just use the default FRotator order and conversion functions",
"type": "boolean"
},
"controlEnum": {
"description": "If the control is integer it can use this enum to choose values",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Enum",
"type": "object"
},
"controlType": {
"enum": [
"Bool",
"Float",
"Integer",
"Vector2D",
"Position",
"Scale",
"Rotator",
"Transform",
"TransformNoScale",
"EulerTransform",
"ScaleFloat"
],
"title": "ERigControlType",
"type": "string"
},
"customization": {
"description": "The User interface customization used for a control\nThis will be used as the default content for the space picker and other widgets",
"properties": {
"availableSpaces": {
"items": {
"properties": {
"key": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"label": {
"type": "string"
}
},
"required": [
"key",
"label"
],
"title": "RigElementKeyWithLabel",
"type": "object"
},
"type": "array"
},
"removedSpaces": {
"items": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"type": "array"
}
},
"required": [
"availableSpaces",
"removedSpaces"
],
"title": "RigControlElementCustomization",
"type": "object"
},
"displayName": {
"type": "string"
},
"drivenControls": {
"description": "The list of driven controls for this proxy control.",
"items": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"type": "array"
},
"filteredChannels": {
"description": "Filtered Visible Transform channels. If this is empty everything is visible",
"items": {
"enum": [
"TranslationX",
"TranslationY",
"TranslationZ",
"Pitch",
"Yaw",
"Roll",
"ScaleX",
"ScaleY",
"ScaleZ"
],
"title": "ERigControlTransformChannel",
"type": "string"
},
"type": "array"
},
"limitEnabled": {
"description": "True if the control has limits.",
"items": {
"properties": {
"bMaximum": {
"type": "boolean"
},
"bMinimum": {
"type": "boolean"
}
},
"required": [
"bMinimum",
"bMaximum"
],
"title": "RigControlLimitEnabled",
"type": "object"
},
"type": "array"
},
"maximumValue": {
"description": "The maximum limit of the control's value",
"properties": {
"floatStorage": {
"properties": {
"bValid": {
"type": "boolean"
},
"float00": {
"type": "number"
},
"float00_2": {
"type": "number"
},
"float01": {
"type": "number"
},
"float01_2": {
"type": "number"
},
"float02": {
"type": "number"
},
"float02_2": {
"type": "number"
},
"float03": {
"type": "number"
},
"float03_2": {
"type": "number"
},
"float10": {
"type": "number"
},
"float10_2": {
"type": "number"
},
"float11": {
"type": "number"
},
"float11_2": {
"type": "number"
},
"float12": {
"type": "number"
},
"float12_2": {
"type": "number"
},
"float13": {
"type": "number"
},
"float13_2": {
"type": "number"
},
"float20": {
"type": "number"
},
"float20_2": {
"type": "number"
},
"float21": {
"type": "number"
},
"float21_2": {
"type": "number"
},
"float22": {
"type": "number"
},
"float22_2": {
"type": "number"
},
"float23": {
"type": "number"
},
"float23_2": {
"type": "number"
},
"float30": {
"type": "number"
},
"float30_2": {
"type": "number"
},
"float31": {
"type": "number"
},
"float31_2": {
"type": "number"
},
"float32": {
"type": "number"
},
"float32_2": {
"type": "number"
},
"float33": {
"type": "number"
},
"float33_2": {
"type": "number"
}
},
"required": [
"float00",
"float01",
"float02",
"float03",
"float10",
"float11",
"float12",
"float13",
"float20",
"float21",
"float22",
"float23",
"float30",
"float31",
"float32",
"float33",
"float00_2",
"float01_2",
"float02_2",
"float03_2",
"float10_2",
"float11_2",
"float12_2",
"float13_2",
"float20_2",
"float21_2",
"float22_2",
"float23_2",
"float30_2",
"float31_2",
"float32_2",
"float33_2",
"bValid"
],
"title": "RigControlValueStorage",
"type": "object"
}
},
"required": [
"floatStorage"
],
"title": "RigControlValue",
"type": "object"
},
"minimumValue": {
"description": "The minimum limit of the control's value",
"properties": {
"floatStorage": {
"properties": {
"bValid": {
"type": "boolean"
},
"float00": {
"type": "number"
},
"float00_2": {
"type": "number"
},
"float01": {
"type": "number"
},
"float01_2": {
"type": "number"
},
"float02": {
"type": "number"
},
"float02_2": {
"type": "number"
},
"float03": {
"type": "number"
},
"float03_2": {
"type": "number"
},
"float10": {
"type": "number"
},
"float10_2": {
"type": "number"
},
"float11": {
"type": "number"
},
"float11_2": {
"type": "number"
},
"float12": {
"type": "number"
},
"float12_2": {
"type": "number"
},
"float13": {
"type": "number"
},
"float13_2": {
"type": "number"
},
"float20": {
"type": "number"
},
"float20_2": {
"type": "number"
},
"float21": {
"type": "number"
},
"float21_2": {
"type": "number"
},
"float22": {
"type": "number"
},
"float22_2": {
"type": "number"
},
"float23": {
"type": "number"
},
"float23_2": {
"type": "number"
},
"float30": {
"type": "number"
},
"float30_2": {
"type": "number"
},
"float31": {
"type": "number"
},
"float31_2": {
"type": "number"
},
"float32": {
"type": "number"
},
"float32_2": {
"type": "number"
},
"float33": {
"type": "number"
},
"float33_2": {
"type": "number"
}
},
"required": [
"float00",
"float01",
"float02",
"float03",
"float10",
"float11",
"float12",
"float13",
"float20",
"float21",
"float22",
"float23",
"float30",
"float31",
"float32",
"float33",
"float00_2",
"float01_2",
"float02_2",
"float03_2",
"float10_2",
"float11_2",
"float12_2",
"float13_2",
"float20_2",
"float21_2",
"float22_2",
"float23_2",
"float30_2",
"float31_2",
"float32_2",
"float33_2",
"bValid"
],
"title": "RigControlValueStorage",
"type": "object"
}
},
"required": [
"floatStorage"
],
"title": "RigControlValue",
"type": "object"
},
"preferredRotationOrder": {
"description": "The euler rotation order this control prefers for animation, if we aren't using default UE rotator",
"enum": [
"XYZ",
"XZY",
"YXZ",
"YZX",
"ZXY",
"ZYX"
],
"title": "EEulerRotationOrder",
"type": "string"
},
"primaryAxis": {
"description": "the primary axis to use for float controls",
"enum": [
"X",
"Y",
"Z"
],
"title": "ERigControlAxis",
"type": "string"
},
"shapeColor": {
"properties": {
"a": {
"minimum": 0,
"type": "number"
},
"b": {
"minimum": 0,
"type": "number"
},
"g": {
"minimum": 0,
"type": "number"
},
"r": {
"minimum": 0,
"type": "number"
}
},
"required": [
"r",
"g",
"b",
"a"
],
"title": "LinearColor",
"type": "object"
},
"shapeName": {
"description": "This is optional UI setting - this doesn't mean this is always used, but it is optional for manipulation layer to use this",
"type": "string"
},
"shapeTransform": {
"description": "Transient storage for overrides when changing the shape transform",
"properties": {
"location": {
"description": "The world-space location.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"rotation": {
"description": "The world-space rotation.",
"properties": {
"pitch": {
"description": "Pitch (degrees) around Y axis",
"type": "number"
},
"roll": {
"description": "Roll (degrees) around X axis",
"type": "number"
},
"yaw": {
"description": "Yaw (degrees) around Z axis",
"type": "number"
}
},
"required": [
"pitch",
"yaw",
"roll"
],
"title": "Rotator",
"type": "object"
},
"scale": {
"description": "The scale.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"title": "ToolsetTransform",
"type": "object"
},
"shapeVisibility": {
"description": "Defines how the shape visibility should be changed",
"enum": [
"UserDefined",
"BasedOnSelection"
],
"title": "ERigControlVisibility",
"type": "string"
}
},
"required": [
"animationType",
"controlType",
"displayName",
"primaryAxis",
"bIsCurve",
"limitEnabled",
"bDrawLimits",
"minimumValue",
"maximumValue",
"bShapeVisible",
"shapeVisibility",
"shapeName",
"shapeColor",
"bIsTransientControl",
"controlEnum",
"customization",
"drivenControls",
"bGroupWithParentControl",
"bRestrictSpaceSwitching",
"filteredChannels",
"preferredRotationOrder",
"bUsePreferredRotationOrder",
"shapeTransform"
],
"title": "RigControlSettings",
"type": "object"
}
},
"required": [
"control_rig",
"name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.add_element¶
Add a bone or null element to the Control Rig hierarchy.
Args:
control_rig: The Control Rig to add the element to.
name: Name for the new element.
element_type: Type of element to create: "bone" or "null".
parent: Parent element in the hierarchy. None creates at root level.
transform: Initial world transform. Uses identity if None.
Only specified fields are applied; unset fields use identity.
Returns:
The RigElementKey for the newly created element.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"element_type": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"default": null,
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"transform": {
"default": null,
"description": "Represents a 3D transformation with optional location, rotation, and scale.\nUnset fields mean \"identity\" when creating objects and \"don't change\" when modifying existing ones.",
"properties": {
"location": {
"description": "The world-space location.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"rotation": {
"description": "The world-space rotation.",
"properties": {
"pitch": {
"description": "Pitch (degrees) around Y axis",
"type": "number"
},
"roll": {
"description": "Roll (degrees) around X axis",
"type": "number"
},
"yaw": {
"description": "Yaw (degrees) around Z axis",
"type": "number"
}
},
"required": [
"pitch",
"yaw",
"roll"
],
"title": "Rotator",
"type": "object"
},
"scale": {
"description": "The scale.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"title": "ToolsetTransform",
"type": "object"
}
},
"required": [
"control_rig",
"name",
"element_type"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.add_event_graph¶
Create a new graph with the specified event type.
Args:
control_rig: The Control Rig to add the graph to.
event_type: The event type to add (BACKWARD_SOLVE or INTERACTION).
name: Optional custom name for the graph.
Returns:
The newly created RigVMGraph with the event node.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"event_type": {
"enum": [
"FORWARD_SOLVE",
"BACKWARD_SOLVE",
"INTERACTION"
],
"title": "EventType",
"type": "string"
},
"name": {
"default": null,
"type": "string"
}
},
"required": [
"control_rig",
"event_type"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.add_event_node¶
Add an event node to the graph.
Args:
control_rig: The Control Rig containing the graph.
graph: The graph to add the event to.
event_type: The type of event node.
position: Position in the graph. Uses (200, 200) if None.
Returns:
The created event RigVMNode.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"event_type": {
"enum": [
"FORWARD_SOLVE",
"BACKWARD_SOLVE",
"INTERACTION"
],
"title": "EventType",
"type": "string"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
},
"position": {
"default": null,
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"title": "Vector2D",
"type": "object"
}
},
"required": [
"control_rig",
"graph",
"event_type"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMNode",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.add_graph¶
Create a new empty graph in the Control Rig.
Args:
control_rig: The Control Rig to add the graph to.
name: Name for the new graph.
Returns:
The newly created RigVMGraph.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"name": {
"type": "string"
}
},
"required": [
"control_rig",
"name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.add_interaction_graph¶
Create an interaction graph with InteractionExecution event.
Args:
control_rig: The Control Rig to add the graph to.
name: Optional custom name (default: "Interaction").
Returns:
The newly created RigVMGraph with InteractionExecution event.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"name": {
"default": null,
"type": "string"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.add_null¶
Add a null (locator) to the Control Rig hierarchy.
Args:
control_rig: The Control Rig to add the null to.
name: Name for the new null.
parent: Parent element in the hierarchy. None creates at root level.
transform: Initial world transform. Uses identity if None.
Only specified fields are applied; unset fields use identity.
Returns:
The RigElementKey for the newly created null.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"name": {
"type": "string"
},
"parent": {
"default": null,
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"transform": {
"default": null,
"description": "Represents a 3D transformation with optional location, rotation, and scale.\nUnset fields mean \"identity\" when creating objects and \"don't change\" when modifying existing ones.",
"properties": {
"location": {
"description": "The world-space location.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"rotation": {
"description": "The world-space rotation.",
"properties": {
"pitch": {
"description": "Pitch (degrees) around Y axis",
"type": "number"
},
"roll": {
"description": "Roll (degrees) around X axis",
"type": "number"
},
"yaw": {
"description": "Yaw (degrees) around Z axis",
"type": "number"
}
},
"required": [
"pitch",
"yaw",
"roll"
],
"title": "Rotator",
"type": "object"
},
"scale": {
"description": "The scale.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"title": "ToolsetTransform",
"type": "object"
}
},
"required": [
"control_rig",
"name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.add_variable¶
Add a member variable to the Control Rig.
Args:
control_rig: The Control Rig to add the variable to.
name: Variable name.
type_path: UE type path (e.g., "double", "float",
"/Script/CoreUObject.Vector").
is_public: Whether the variable is exposed publicly.
is_read_only: Whether the variable is read-only.
default_value: Default value as string.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"default_value": {
"type": "string"
},
"is_public": {
"default": true,
"type": "boolean"
},
"is_read_only": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"type_path": {
"type": "string"
}
},
"required": [
"control_rig",
"name",
"type_path",
"default_value"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.add_variable_node¶
Create a variable getter or setter node.
The variable must already exist (created via add_variable first).
Args:
control_rig: The Control Rig containing the graph.
graph: The graph to add the node to.
variable_name: Name of the variable to reference.
is_getter: True for getter node, False for setter node.
position: Position in the graph. Uses (0, 0) if None.
Returns:
The created variable RigVMNode.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
},
"is_getter": {
"default": true,
"type": "boolean"
},
"position": {
"default": null,
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"title": "Vector2D",
"type": "object"
},
"variable_name": {
"type": "string"
}
},
"required": [
"control_rig",
"graph",
"variable_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMNode",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.change_variable_type¶
Change the type of an existing variable.
Args:
control_rig: The Control Rig containing the variable.
name: Variable name.
new_type: New type path (e.g., "double", "float").
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"name": {
"type": "string"
},
"new_type": {
"type": "string"
}
},
"required": [
"control_rig",
"name",
"new_type"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.connect_pins¶
Connect two pins together.
Args:
control_rig: The Control Rig containing the graph.
graph: The graph containing the pins.
source_pin: The source (output) pin.
target_pin: The target (input) pin.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
},
"source_pin": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMPin",
"type": "object"
},
"target_pin": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMPin",
"type": "object"
}
},
"required": [
"control_rig",
"graph",
"source_pin",
"target_pin"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.create¶
Creates a new Control Rig at the given location.
Args:
path: The content browser path for the new Control Rig.
Returns:
The newly created ControlRigBlueprint.
Input schema
{
"properties": {
"path": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.create_node¶
Create a new RigUnit node in the graph.
Args:
control_rig: The Control Rig containing the graph.
graph: The graph to add the node to.
node_type: RigUnit struct name (e.g., "RigUnit_MathFloatAdd") or
full path (e.g., "/Script/ControlRig.RigUnit_MathFloatAdd").
position: Position in the graph editor. Uses (0, 0) if None.
node_name: Optional custom name for the node.
Returns:
The created RigVMNode.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
},
"node_name": {
"type": "string"
},
"node_type": {
"type": "string"
},
"position": {
"default": null,
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"title": "Vector2D",
"type": "object"
}
},
"required": [
"control_rig",
"graph",
"node_type",
"node_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMNode",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.delete_node¶
Delete a node from the graph.
Args:
control_rig: The Control Rig containing the graph.
graph: The graph containing the node.
node: The node to delete.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMNode",
"type": "object"
}
},
"required": [
"control_rig",
"graph",
"node"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.disconnect_pins¶
Disconnect two pins.
Args:
control_rig: The Control Rig containing the graph.
graph: The graph containing the pins.
source_pin: The source (output) pin.
target_pin: The target (input) pin.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
},
"source_pin": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMPin",
"type": "object"
},
"target_pin": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMPin",
"type": "object"
}
},
"required": [
"control_rig",
"graph",
"source_pin",
"target_pin"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_all_bones¶
Get all bones in the Control Rig hierarchy.
Args:
control_rig: The Control Rig to query.
Returns:
List of RigElementKeys for all bones.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_all_controls¶
Get all controls in the Control Rig hierarchy.
Args:
control_rig: The Control Rig to query.
Returns:
List of RigElementKeys for all controls.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_all_nulls¶
Get all nulls (locators) in the Control Rig hierarchy.
Args:
control_rig: The Control Rig to query.
Returns:
List of RigElementKeys for all nulls.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_backward_solve_graph¶
Get the backward solve graph.
The backward solve graph contains the InverseExecution event and runs
during IK operations.
Args:
control_rig: The Control Rig to query.
Returns:
The backward solve RigVMGraph.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_children¶
Get children of a hierarchy element.
Args:
control_rig: The Control Rig to query.
item: The element to get children of.
recursive: If True, returns all descendants recursively.
Returns:
List of child RigElementKeys.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"item": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"recursive": {
"default": false,
"type": "boolean"
}
},
"required": [
"control_rig",
"item"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_connected_pins¶
Get all pins connected to this pin.
Args:
control_rig: The Control Rig containing the pin.
pin: The pin to query.
Returns:
List of connected RigVMPin objects.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"pin": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMPin",
"type": "object"
}
},
"required": [
"control_rig",
"pin"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMPin",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_elements¶
Get hierarchy elements of the specified type.
Args:
control_rig: The Control Rig to query.
element_type: Type of elements to return, or None for all elements.
Returns:
List of RigElementKeys matching the specified type.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"element_type": {
"default": null,
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_event_graph¶
Get a graph containing the specified event type.
Args:
control_rig: The Control Rig to query.
event_type: The event type to search for.
Returns:
The RigVMGraph containing the specified event.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"event_type": {
"enum": [
"FORWARD_SOLVE",
"BACKWARD_SOLVE",
"INTERACTION"
],
"title": "EventType",
"type": "string"
}
},
"required": [
"control_rig",
"event_type"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_forward_solve_graph¶
Get the forward solve graph (main execution graph).
This graph contains the BeginExecution event and runs during normal
animation evaluation.
Args:
control_rig: The Control Rig to query.
Returns:
The forward solve RigVMGraph.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_global_transform¶
Get global transform of a hierarchy element.
Args:
control_rig: The Control Rig to query.
item: The element to get the transform for.
initial: If True, returns the initial (setup) transform.
Returns:
The element's global transform with translation, rotation (euler), and scale.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"initial": {
"default": false,
"type": "boolean"
},
"item": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
}
},
"required": [
"control_rig",
"item"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a 3D transformation with optional location, rotation, and scale.\nUnset fields mean \"identity\" when creating objects and \"don't change\" when modifying existing ones.",
"properties": {
"location": {
"description": "The world-space location.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"rotation": {
"description": "The world-space rotation.",
"properties": {
"pitch": {
"description": "Pitch (degrees) around Y axis",
"type": "number"
},
"roll": {
"description": "Roll (degrees) around X axis",
"type": "number"
},
"yaw": {
"description": "Yaw (degrees) around Z axis",
"type": "number"
}
},
"required": [
"pitch",
"yaw",
"roll"
],
"title": "Rotator",
"type": "object"
},
"scale": {
"description": "The scale.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"title": "ToolsetTransform",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_graph¶
Get a specific graph from the Control Rig by name.
Args:
control_rig: The Control Rig to query.
graph_name: Name of the graph (e.g., "RigVMModel").
Returns:
The RigVMGraph object.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"graph_name": {
"type": "string"
}
},
"required": [
"control_rig",
"graph_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_interaction_graph¶
Get the interaction graph.
The interaction graph contains the InteractionExecution event and runs
during user interaction with controls.
Args:
control_rig: The Control Rig to query.
Returns:
The interaction RigVMGraph.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_local_transform¶
Get local transform of a hierarchy element.
Args:
control_rig: The Control Rig to query.
item: The element to get the transform for.
initial: If True, returns the initial (setup) transform.
Returns:
The element's local transform relative to its parent,
with translation, rotation (euler), and scale.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"initial": {
"default": false,
"type": "boolean"
},
"item": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
}
},
"required": [
"control_rig",
"item"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a 3D transformation with optional location, rotation, and scale.\nUnset fields mean \"identity\" when creating objects and \"don't change\" when modifying existing ones.",
"properties": {
"location": {
"description": "The world-space location.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"rotation": {
"description": "The world-space rotation.",
"properties": {
"pitch": {
"description": "Pitch (degrees) around Y axis",
"type": "number"
},
"roll": {
"description": "Roll (degrees) around X axis",
"type": "number"
},
"yaw": {
"description": "Yaw (degrees) around Z axis",
"type": "number"
}
},
"required": [
"pitch",
"yaw",
"roll"
],
"title": "Rotator",
"type": "object"
},
"scale": {
"description": "The scale.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"title": "ToolsetTransform",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_node_position¶
Get the position of a node in the graph editor.
Args:
control_rig: The Control Rig containing the node.
node: The node to query.
Returns:
The node's position as Vector2D.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMNode",
"type": "object"
}
},
"required": [
"control_rig",
"node"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"title": "Vector2D",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_parent¶
Get the parent of a hierarchy element.
Args:
control_rig: The Control Rig to query.
item: The element to get the parent of.
Returns:
The parent's RigElementKey, or an invalid key if item is at root.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"item": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
}
},
"required": [
"control_rig",
"item"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_pin_value¶
Get the default value of a pin.
Args:
control_rig: The Control Rig containing the pin.
pin: The pin to query.
Returns:
The pin's default value as a string.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"pin": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMPin",
"type": "object"
}
},
"required": [
"control_rig",
"pin"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.get_variable¶
Get a specific variable by name.
Args:
control_rig: The Control Rig to query.
name: Variable name.
Returns:
The variable description.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"name": {
"type": "string"
}
},
"required": [
"control_rig",
"name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"bExposeToCinematics": {
"description": "Should this variable be exposed on spawn",
"type": "boolean"
},
"bExposedOnSpawn": {
"description": "Should this variable be exposed on spawn",
"type": "boolean"
},
"bPrivate": {
"description": "This property should soon become deprecated, since it does not make sense for blueprint independent assets\nIs this variable private",
"type": "boolean"
},
"bPublic": {
"description": "Is this variable public",
"type": "boolean"
},
"cPPType": {
"description": "The C++ data type of the variable",
"type": "string"
},
"cPPTypeObject": {
"description": "The Struct of the C++ data type of the variable (or nullptr)",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Object",
"type": "object"
},
"cPPTypeObjectPath": {
"type": "string"
},
"category": {
"description": "The category of the variable",
"type": "string"
},
"defaultValue": {
"description": "The default value of the variable",
"type": "string"
},
"guid": {
"description": "The guid of the variable",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"name": {
"description": "The name of the variable",
"type": "string"
},
"tooltip": {
"description": "The tooltip of the variable",
"type": "string"
}
},
"required": [
"guid",
"name",
"cPPType",
"cPPTypeObject",
"cPPTypeObjectPath",
"defaultValue",
"category",
"tooltip",
"bExposedOnSpawn",
"bExposeToCinematics",
"bPublic",
"bPrivate"
],
"title": "RigVMGraphVariableDescription",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.import_bones_from_asset¶
Import bones from the given skeletal mesh to the Control Rig hierarchy.
Args:
control_rig: The Control Rig to import bones into.
skeletal_mesh: The skeletal mesh to import bones from.
Returns:
List of RigElementKeys for the imported bones.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"skeletal_mesh": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.SkeletalMesh",
"type": "object"
}
},
"required": [
"control_rig",
"skeletal_mesh"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.list_graphs¶
List all graphs in the Control Rig.
Args:
control_rig: The Control Rig to query.
Returns:
List of RigVMGraph objects (excludes function library).
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.list_nodes¶
List all nodes in a graph.
Args:
control_rig: The Control Rig containing the graph.
graph: The graph to query.
Returns:
List of RigVMNode objects in the graph.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
}
},
"required": [
"control_rig",
"graph"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMNode",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.list_pins¶
List all pins on a node.
Args:
control_rig: The Control Rig containing the node.
node: The node to query.
Returns:
List of RigVMPin objects on the node.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMNode",
"type": "object"
}
},
"required": [
"control_rig",
"node"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMPin",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.list_variables¶
List all member variables in the Control Rig.
Args:
control_rig: The Control Rig to query.
Returns:
List of variable descriptions.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
}
},
"required": [
"control_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"bExposeToCinematics": {
"description": "Should this variable be exposed on spawn",
"type": "boolean"
},
"bExposedOnSpawn": {
"description": "Should this variable be exposed on spawn",
"type": "boolean"
},
"bPrivate": {
"description": "This property should soon become deprecated, since it does not make sense for blueprint independent assets\nIs this variable private",
"type": "boolean"
},
"bPublic": {
"description": "Is this variable public",
"type": "boolean"
},
"cPPType": {
"description": "The C++ data type of the variable",
"type": "string"
},
"cPPTypeObject": {
"description": "The Struct of the C++ data type of the variable (or nullptr)",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Object",
"type": "object"
},
"cPPTypeObjectPath": {
"type": "string"
},
"category": {
"description": "The category of the variable",
"type": "string"
},
"defaultValue": {
"description": "The default value of the variable",
"type": "string"
},
"guid": {
"description": "The guid of the variable",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"name": {
"description": "The name of the variable",
"type": "string"
},
"tooltip": {
"description": "The tooltip of the variable",
"type": "string"
}
},
"required": [
"guid",
"name",
"cPPType",
"cPPTypeObject",
"cPPTypeObjectPath",
"defaultValue",
"category",
"tooltip",
"bExposedOnSpawn",
"bExposeToCinematics",
"bPublic",
"bPrivate"
],
"title": "RigVMGraphVariableDescription",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.remove_variable¶
Remove a member variable from the Control Rig.
Args:
control_rig: The Control Rig to modify.
name: Variable name to remove.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"name": {
"type": "string"
}
},
"required": [
"control_rig",
"name"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.set_global_transform¶
Set global transform of a hierarchy element.
Args:
control_rig: The Control Rig to modify.
item: The element to set the transform for.
transform: The new global transform.
initial: If True, sets the initial (setup) transform.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"initial": {
"default": false,
"type": "boolean"
},
"item": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"transform": {
"description": "Represents a 3D transformation with optional location, rotation, and scale.\nUnset fields mean \"identity\" when creating objects and \"don't change\" when modifying existing ones.",
"properties": {
"location": {
"description": "The world-space location.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"rotation": {
"description": "The world-space rotation.",
"properties": {
"pitch": {
"description": "Pitch (degrees) around Y axis",
"type": "number"
},
"roll": {
"description": "Roll (degrees) around X axis",
"type": "number"
},
"yaw": {
"description": "Yaw (degrees) around Z axis",
"type": "number"
}
},
"required": [
"pitch",
"yaw",
"roll"
],
"title": "Rotator",
"type": "object"
},
"scale": {
"description": "The scale.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"title": "ToolsetTransform",
"type": "object"
}
},
"required": [
"control_rig",
"item",
"transform"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.set_local_transform¶
Set local transform of a hierarchy element.
Args:
control_rig: The Control Rig to modify.
item: The element to set the transform for.
transform: The new local transform.
initial: If True, sets the initial (setup) transform.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"initial": {
"default": false,
"type": "boolean"
},
"item": {
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"None",
"Bone",
"Null",
"Space",
"Control",
"Curve",
"Physics",
"Reference",
"Connector",
"Socket",
"All",
"First",
"Last",
"ToResetAfterConstructionEvent",
"TransformTypes"
],
"title": "ERigElementType",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "RigElementKey",
"type": "object"
},
"transform": {
"description": "Represents a 3D transformation with optional location, rotation, and scale.\nUnset fields mean \"identity\" when creating objects and \"don't change\" when modifying existing ones.",
"properties": {
"location": {
"description": "The world-space location.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
},
"rotation": {
"description": "The world-space rotation.",
"properties": {
"pitch": {
"description": "Pitch (degrees) around Y axis",
"type": "number"
},
"roll": {
"description": "Roll (degrees) around X axis",
"type": "number"
},
"yaw": {
"description": "Yaw (degrees) around Z axis",
"type": "number"
}
},
"required": [
"pitch",
"yaw",
"roll"
],
"title": "Rotator",
"type": "object"
},
"scale": {
"description": "The scale.",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
],
"title": "Vector",
"type": "object"
}
},
"title": "ToolsetTransform",
"type": "object"
}
},
"required": [
"control_rig",
"item",
"transform"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.set_node_position¶
Set the position of a node in the graph editor.
Args:
control_rig: The Control Rig containing the graph.
graph: The graph containing the node.
node: The node to move.
position: The new position.
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMNode",
"type": "object"
},
"position": {
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"title": "Vector2D",
"type": "object"
}
},
"required": [
"control_rig",
"graph",
"node",
"position"
],
"type": "object"
}
animation_toolset.toolsets.controlrig.ControlRigTools.set_pin_value¶
Set the default value of a pin.
Args:
control_rig: The Control Rig containing the graph.
graph: The graph containing the pin's node.
pin: The pin to modify.
value: The new value as a string. Format depends on pin type:
- float/double: "1.0"
- int: "42"
- bool: "true" or "false"
- Vector: "(X=1.0,Y=2.0,Z=3.0)"
- Rotator: "(Pitch=0.0,Yaw=90.0,Roll=0.0)"
- Transform: "(Rotation=(X=0,Y=0,Z=0,W=1),Translation=(X=0,Y=0,Z=0),Scale3D=(X=1,Y=1,Z=1))"
- Name/String: "MyValue"
- Enum: "EnumValue" (without type prefix)
Input schema
{
"properties": {
"control_rig": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/ControlRigDeveloper.ControlRigBlueprint",
"type": "object"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMGraph",
"type": "object"
},
"pin": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/RigVMDeveloper.RigVMPin",
"type": "object"
},
"value": {
"type": "string"
}
},
"required": [
"control_rig",
"graph",
"pin",
"value"
],
"type": "object"
}