Custom Animation XML Example

Each animation group corresponds to a dedicated folder in your Animation Library folder. Each folder stores a number of XML files that make up the animations of the group. Each XML file defines a single animation. An animation is created in the XML file using the single <Step> element.

For each animation/step, you can specify:

• whether or not to allow the user to modify the property values in the Animation Library workshop.
• whether or not to make the angle, axis, and distance properties of animated actors editable in the Animation Library workshop, when property values are not modifiable.
• whether to hide or to show the Start time and End time property values in the Animation Library workshop.

An animation/step can have one or several motions. Individual motions are pre-defined, and each motion has a set of pre-defined properties.

Here are examples of XML codes that you could write to create a custom animation called "Review", and to be able to mirror it.

The XML elements shown in the code example above are described here.

<Step>

Creates an animation. Parameters are as follows:

Name: Text displayed to identify the animation in the Animation Library workshop.

ReadOnly: Specifies whether or not to allow the user to modify the property values in the Animation Library workshop.

• "0": Allows the user to modify the property values.
• "1": Prevents the user from modifying the property values.

(Optional) MakeAngleAxisDistPtEditable: Specifies whether or not to make the angle, axis, distance, and point properties of animated actors editable in the Animation Library workshop, when ReadOnly is set to "1".

• "0": Prevents the user from modifying the angle, axis, distance, and point properties of animated actors.
• "1": Allows the user to modify the angle, axis, distance, and point properties of animated actors.

ShowStartEnd: For each motion of the animation, specifies whether to hide or to show the Start time and End time property values in the Animation Library workshop.

• "0": Hides Start time and End time.
• "1": Shows Start time and End time.

<Modifiables>

Introduces the various motions that make up the animation. Standalone, compulsory element.

<Motions>

Introduces the individual motions that make up the animation.

<Motion>

Creates an individual motion within the animation. Each motion has the following parameter:

Name: Text displayed to identify the motion in the Animation Library workshop.

(Optional) ApplyWhenMirrored: For each motion of the animation, specifies whether or not to ignore the original animation definition and to use the motion definition described in the mirrored XML.

• "0": Applies the original animation definition in the mirrored XML.
• "1": Ignores the original animation definition and uses the motion definition described in the mirrored XML.

(Optional) Defined: For the Motion.Color property of the Flash and SetColor motions, specifies whether or not to change the color of the selected actor during this step of the animation.

• "0": Sets the color to Undefined.
• "1": Takes the RGB values into account.

Note: If you do not specify a Defined parameter, the RGB values are taken into account.

<PropSet>

Introduces the property set of the motion.

<Motion.XXX>

Defines each property of the motion, using one or several parameters.

<Links>

(Optional) Defines a link type to other animations.

Note: If you do not use this XML element, there is no mirrored version of this animation.

<Mirror>

(Optional) Creates a mirror link type. Parameters are as follows:

FolderName: Name of the folder where the XML file describing the animation to mirror is located.

FileName: Name of the XML file describing the animation to mirror.

Note: Both the FolderName and FileName parameters are case-sensitive.