MakeRigIcon

MakeRigIcon

Introduced

4.0

Description

Creates a nurbs curve in one of 9 shapes. These shapes can be useful as animation controls. For example the biped rig's upvectors are pyramids, its hip and chest controls are squares, and the footroll controls are cubes.

Scripting Syntax

MakeRigIcon( Parent, [Type], [X], [Y], [Z], [Xlength], [Ylength], [Zlength], [Color], [Name], [XOffset], [YOffset], [ZOffset] )

Parameters

Parameter	Type	Description
Parent	String	The parent object of the rig icon. If empty will be the Scene Root.
Type	Integer	The type of icon. Default Value: 2 (cube) Possible Values: • 0: RightSquare • 1: TopSquare • 2: Cube • 3: CenteredCube • 4: Pyramid • 5: CenteredPyramid • 6: Diamond • 7: CubeWithPeak • 8: CenteredDiamond
X	Double	The X coordinate in global space. Default Value: 0.0
Y	Double	The Y coordinate in global space. Default Value: 0.0
Z	Double	The Z coordinate in global space. Default Value: 0.0
Xlength	Double	The X length. Default Value: 1.0
Ylength	Double	The Y length. Default Value: 1.0
Zlength	Double	The Z length. Default Value: 1.0
Color	Integer	the type of shadow rig to constrain to the spine. Default Value: 65 (dark green)
Name	String	The name of the icon object. If no name is used the default curve list name is used. Default Value: ""
XOffset	Double	The X offset in global space. Default Value: 0.0
YOffset	Double	The Y offset in global space. Default Value: 0.0
ZOffset	Double	The Z offset in global space. Default Value: 0.0

Return Value

Returns the X3DObject representing the created nurbs curves.

Examples

JScript Example

//
// Generates all the rigging icons beside each other
//

for (var icontype = 0; icontype < 9; icontype++)
{
   makeRigIcon(
       ActiveSceneRoot, 
       icontype, 
       icontype, 0, 0,  //XYZ position
       1, 1, 1,  //XYZ scale
       icontype*100,  //colour
       icontype, //name
       0,0,0     //XYZ offset
   );
}

See Also

Autodesk Softimage v7.5