Description
Creates a 2D skeleton containing a root, one bone, and one effector. The skeleton becomes the current selection.
Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference. Normally you can get the output arguments via either XSIApplication.ExecuteCommand method (C#) or the ISIVTCollection (scripting languages), but this command already returns a value.
The only available workaround in this case is to create a VBScript custom command which returns both the output arguments and the return value in one array. For details, see What Happens when the Function Already Returns a Value?.
Scripting Syntax
Create2DSkeleton( Rx, Ry, Rz, Ex, Ey, Ez, Nx, Ny, Nz, [ViewType], [Bone], [Effector] )
Parameters
|
Parameter |
Type |
Description |
|
Rx |
Root x coordinate Default Value: 0 |
|
|
Ry |
Root y coordinate Default Value: 0 |
|
|
Rz |
Root z coordinate Default Value: 0 |
|
|
Ex |
Effector x coordinate Default Value: 1 |
|
|
Ey |
Effector y coordinate Default Value: 0 |
|
|
Ez |
Effector z coordinate Default Value: 0 |
|
|
Nx |
Skeleton plane normal x coordinate Default Value: 0 |
|
|
Ny |
Skeleton plane normal y coordinate Default Value: 0 |
|
|
Nz |
Skeleton plane normal z coordinate Default Value: 1 |
|
|
ViewType |
Type of view Default Value: 3 Possible Values: • 0: top • 1: front • 2: right • 3: other • 4: plane - Nx,Ny,Nz parameters specify the rotation of the plane in degrees |
|
|
Bone [out] |
Returns the bone object. |
|
|
Effector [out] |
Returns the effector object. |
Return Value
Returns the root (a ChainRoot object).
Examples
VBScript Example
dim root, bone, eff set root = Create2DSkeleton( -4.728, 0.000, 2.417, -1.343, 0.000, -2.778, 0.000, 1.000, 0.000, 0, bone, eff )
See Also
SOFTIMAGE|XSI v6.01