Parts of the configuration file

The following diagram shows the Full Body view in the CharacterControlsConfig.xml file and highlights its main elements.

NoteThe CustomRigControlsConfig.xml file contains the same main elements.

Main Elements

Each view in the configuration file uses the following main elements:

Element	Description
<ResourcePath>	Identifies the directory that contains the image resources.
<View resource>	Encloses all of the elements for the view and identifies the background image.

Anchor points

The configuration file is built upon the concept of anchor points, 2D x and y coordinates that are used to define the location of other elements in the layout.

Attribute	Description
<name>	Provides a name for the anchor point.
<x>	The x coordinate for the anchor point.
<y>	The y coordinate for the anchor point.

You can attach a navigator resource or an IK effector to an anchor point.

Navigator resources

Navigator resources represent the buttons that allow you to open a different view in the layout .

Attribute	Description
<name>	Provides a name for the navigator resource.
<goto>	This number identifies the view that is connected to the navigator resource.
<layer>	This number corresponds to the layer that is assigned to the navigator resource. TipThe layering system allows you to layer different elements on top of each other in the layout.
<resource>	The name of the image that is used for the navigator resource.
<tooltip>	Annotation text for the navigator resource. This text displays when you hover over the navigator button in the layout.

IK effectors

Attribute	Description
<anchor>	Identifies the anchor point that defines the location of the IK effector.
<body_part>	Identifies the body part keying group for the IK effector. For example, LeftLeg, RightLeg, RightArm, or LeftArm. See Manipulation and keying modes.
<id>	The internal ID for the IK effector.
<layer>	This number corresponds to the layer that is assigned to the IK effector.
<resource>	The name of the image that is used for the IK effector.
<tooltip>	Annotation text for the IK effector. This text displays when you hover over the IK effector in the layout.

You can attach an effector handle to an IK effector. <Expander> elements have the following attributes:

Attribute	Description
<anchor>	Identifies the anchor point that defines the location of the effector handle.
<item_offset>	This number represents the offset between the extra effector handle and the first extra effector, in pixels.
<direction>	Indicates the direction in which the handle expands: up, down, right, or left.
<max_shown>	Sets the maximum number of extra effectors that can be added to the expander handle.
<resource>	The name of the image that is used for the effector handle.

FK effectors

FK effectors are procedural and are not image-based. Two anchor points are used to define the start and end of the effector.

TipYou can reuse anchor points by attaching your FK effector to the same anchor point as an IK effector. This way, when an IK effector moves, the FK effector moves with it. The following example reuses the ikRWrist0 anchor point, which is also used in the IK effector definition above.

Attribute	Description
<anchor1>	The anchor point that defines the location in the layout where the effector starts.
<anchor2>	The anchor point that defines the location in the layout where the effector ends.
<body_part>	The body part keying group for the FK effector. For example, LeftLeg, RightLeg, RightArm, LeftArm. See Manipulation and keying modes.
<id>	This number is the internal ID assigned to the FK effector.
<layer>	This number corresponds to the layer that is assigned to the FK effector.
<tooltip>	Annotation text for the FK effector. This text displays when you hover over the FK effector in the layout.

Buttons

The <Button> element is used in the CustomRigControlsConfig.xml file instead of the <IK> element, but it has many of the same attributes:

Attribute	Description
<anchor>	Identifies the anchor point that defines the location of the button.
<id>	The internal ID for the button.
<layer>	This number corresponds to the layer that is assigned to the button.
<resource>	The image used when a cell is not selected. See Cell status.
<resource_selected>	The image used when a cell is selected. See Cell status.
<resource_active>	The image used when a cell is assigned. See Cell status.
<tooltip>	Annotation text for the Button. This text displays when you hover over the button in the layout.

Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License