XSI_CustomPSet

Stores a custom property added to a Softimage object.

When this template is imported into or exported from SI|3D, it is converted to user data with the XSI_CustomPSet tag. Here is the format of the Softimage user data. Note that this user data will not have the same import or export behavior as the regular user data mechanism.

Field

Decription

int

Size of the user data.

char[] (Null terminated)

Name of the custom PSet.

int

Number of parameters.

[parameters]

Parameters

Field for each of the parameter

Description

 

This template corresponds to the CSLCustomPSet class.

Introduced

3.0

Template

XSI_CustomPSet <property-name> {
   <sPropagation>,
   <sType>, // New in 5.0
   <iNbParameters>,

   // For each parameter:
   <sParamName>, <sParamType>, <ParamValue>

   // For each parameter:
   XSI_CustomParamInfo <sParamName> {
       // ...
   }

   // For each animated parameter:
   SI_FCurve {
       // ...
   }

}

Members

Member name

Description

sPropagation

Specifies whether the property is either just for the object it is on only or for the object it is on plus all its children--this status is displayed in Softimage’s Explorer. If a custom parameter is on a group, it will be exported as BRANCH, since dotXSI does not export groups). Possible values are:

• BRANCH = property is shared by the object and all its children

• NODE = property is added only to the object

sType

The type of the custom property. This allows self-installing custom properties to be imported and exported. When a custom property is imported, the type can be used to recreate the custom property by calling AddProperty.

iNbParameters

Number of parameters in the custom property.

sParamName

Name of a custom parameter.

sParamType

Parameter type. Possible values are:

• Text

• Boolean

• Integer

• Small integer number

• Floating point number

Note: For more information on how dotXSI handles variant data type conversion, see How Does dotXSI Deal with Variant Types?.

ParamValue

Value for the parameter.

Example 

XSI_CustomPSet MyCustomProperty { 
   "NODE", 
   "MyCustomProperty", 
   1,
   "Param","Integer",21, 
   XSI_CustomParamInfo Param { 
       0,
       100,
       2053,
   }

   SI_FCurve { 
       "Scene_Root", 
       "Param", 
       "CUBIC", 
       1, 
       5, 
       16, 
       1.000000,0.000000,0.000000,0.000000,0.333333,0.000000,
       2.000000,0.000000,-0.333333,0.000000,0.333333,0.000000,
       3.000000,0.000000,-0.333333,0.000000,0.333333,0.000000,
       4.000000,0.000000,-0.333333,-0.166667,0.333333,0.166667,
       5.000000,1.000000,-0.333333,-0.166667,0.333333,0.166667,
       6.000000,1.000000,-0.333333,-0.333333,0.333333,0.333333,
       7.000000,3.000000,-0.333333,-0.500000,0.333333,0.500000,
       8.000000,4.000000,-0.333333,-0.833333,0.333333,0.833333,
       9.000000,8.000000,-0.333333,-1.500000,0.333333,1.500000,
       10.000000,13.000000,-0.333333,-1.666667,0.333333,1.666667,
       11.000000,18.000000,-0.333333,-1.333333,0.333333,1.333333,
       12.000000,21.000000,-0.333333,-0.500000,0.333333,0.500000,
       13.000000,21.000000,-0.333333,0.000000,4.000000,0.000000,
       25.000000,21.000000,-4.000000,0.000000,8.333333,0.000000,
       50.000000,21.000000,-8.333333,0.000000,16.666666,0.000000,
       100.000000,21.000000,-16.666666,0.000000,0.000000,0.000000,
   }

}

Autodesk Crosswalk v5.0