On this page
This feature is still under development. The current functionality is unfinished and subject to change, and may have thin or no documentation. Please bear this in mind when using it.

This page lists the metadata that can be added to a character’s base skeleton to create a guide skeleton. We refer to the joints on the guide skeleton as guide joints. See preparing skeletons for rigging for more information.

Tags

Tags are essentially labels that are added on guide joints to identify and group joints. For example, we could tag the shoulder, elbow, and hand joints on the left side of the skeleton with the string L_Arm, which groups these joints as a body part. This tag is then used by rig components downstream to identify groups of joints to apply the rig functionality to. In this way, tags are a way for the skeleton to communicate information to the rig components.

Tags are stored in the tags string array attribute on the guide joints, and are created using the Attribute Adjust Array SOP. In the network editor, “Attribute Adjust Tags” is an alias to the Attribute Adjust Array SOP.

Skeleton tags

Properties

Properties are information stored on guide joints that are picked up later by rig components to configure the controls they create. For example, if you want a character’s finger controls to have a box shape, you could set the control shape property for the finger joints in the guide skeleton. When the FK rig component downstream creates controls for the rig, it will pick up this property on the finger guide joints and create box shape controls.

Properties are stored in the properties dictionary attribute on the guide joints, and are created using the Attribute Adjust Dictionary SOP. The following properties can be set:

Property

Type

Description

scaleinheritance

int

The scale inheritance of the APEX joint.

rord

int

The rotation order of the APEX joint.

xord

int

The transformation order of the APEX joint.

promote

string

The transform components to promote on the APEX joint, for example, “t r s”.

shape

string

The control shape. You can specify any of the pre-shipped shapes listed in the APEX Configure Controls SOP Shape Override parameter, for example, circleplanes_wires or torusb.

shapetranslate

Vector3

The position of the control shape.

shaperotate

Vector3

The rotation of the control shape.

shapescale

Vector3

The scale of the control shape.

shapecolor

Vector3

The color of the control shape.

KineFX

Overview

Preparing character elements

Rigging with APEX graphs

Building rig graphs with APEX Script

Rigging with rig components

Animating in the viewport

SOP-based animation

Deformation

Animation retargeting

Pre-H20

Panes

Appendix