Namespaces | Classes | Typedefs | Enumerations | Functions | Variables

XSI Namespace Reference

The XSI namespace defines a region where all API classes are declared. More...

Namespaces

namespace   MATH

Classes

class   ActionDelta
  The ActionDelta object tracks changes made on a parameter that is part of a reference model. More...
class   ActionDeltaItem
  The ActionDeltaItem object tracks changes made on a parameter that is part of a reference model. More...
class   ActionSource
  The ActionSource class is a specialization of the Source class, representing sources for action and shape animation clips. More...
class   AnimationSourceItem
  An ActionSource contains a collection of animation source items, which you can get at using ActionSource::GetItems. More...
class   AnimationSource
  The AnimationSource object represents a special kind of DataSource, for example, ActionSource, Constraint, FCurve, Expression, or StaticSource. More...
class   Application
  The Application object represents the running instance of the Softimage application and it is the top most entity of the C++ API object hierarchy. More...
class   Argument
  The Argument object represents an argument (or parameter) of a Softimage Command. More...
class   ArgumentArray
  This object is owned by a Command object and holds a collection of Argument objects. More...
class   ArgumentHandler
  An argument handler is an object that helps determine the value that is passed to a Command. More...
class   ArrayParameter
  An ArrayParameter is a specialization of a Parameter. More...
class   CBitArray
  This class encapsulates an array of binary values represented as booleans, where true indicates a bit set to ON and false indicates a bit set to OFF. More...
class   CBoolArray
  The CBoolArray is an uni-dimensional array of bool values. More...
class   Camera
  The Camera object represents a Softimage camera in a scene. More...
class   CameraRig
  The CameraRig object is a specialized Null object that represents a hierarchy composed of a Camera and its X3DObject interest object. More...
class   ChainBone
  The ChainBone object is part of a skeleton chain. More...
class   ChainEffector
  The ChainEffector object is part of a skeleton chain. More...
class   ChainElement
  The ChainElement object represents a component of a skeleton chain. More...
class   ChainRoot
  The ChainRoot object represents the root of a skeleton chain. More...
class   Clip
  Clips are instances of animation and shape actions (ActionSource), audio and image sources (Source) and compound clips (ClipContainer). More...
class   ClipContainer
  A ClipContainer can represent either the Mixer or a compound Clip. More...
class   ClipEffect
  A ClipEffect represents the set of effects associated with a Clip. More...
class   ClipEffectItem
  A ClipEffectItem is an expression which is bound to a MappedItem of a Clip. More...
class   ClipRelation
  Clip relations are logical entities used to create a bi-directional constraint between two clips, the master and slave clip. More...
class   Cluster
  A cluster represents a set of components on a Geometry. More...
class   CClusterElementArray
  An array of cluster elements in a Cluster object. More...
class   ClusterProperty
  Represents a property of a cluster. More...
class   CClusterPropertyElementArray
  An array of cluster property elements in a ClusterProperty object. More...
class   CClusterPropertyBuilder
  Provides the services to accelerate the process of creating new cluster properties on a geometry. More...
struct   CColor
  This struct represents an RGBA color. More...
class   CColorArray
  The CColorArray is a one-dimensional, zero-based array of CColor objects. More...
class   CComAPIHandler
  The CComAPIHandler class implements a C++ wrapper for calling automation objects (scripting objects) or objects implemented using the Softimage Object Model (formerly called the COM API). More...
class   Command
  Represents a Softimage command (either built-in or custom). More...
class   CommandArray
  This object represents a collection of commands. More...
class   Constraint
  The Constraint object represents a constraint in the scene graph. More...
class   Context
  This is a general, flexible Context object that is used for callbacks. More...
class   ControlPoint
  The ControlPoint of a NurbsSurface or a NurbsCurve. More...
class   CControlPointRefArray
  An array of ControlPoint object references representing the NurbsCurve or NurbsSurface control points. More...
class   CustomOperator
  The CustomOperator object represents a custom operator (ie., a scripted or compiled operator) in the scene graph. More...
class   CustomProperty
  The CustomProperty class represents a custom parameter set property object. More...
class   CBaseDataArray
class   CDataArray
  This template class encapsulates the 1D data arrays passed to custom node plug-ins during a graph evaluation. More...
class   CDataArray< bool >
  This class is a specialization of a CDataArray class of type bool. More...
class   CDataArrayCustomType
  CDataArrayCustomType is used for storing binary data in a 1D element array of type CDataArrayCustomType::TData. More...
class   CDataArrayString
  CDataArrayString is used for storing wide character strings in a 1D element array. More...
class   CBaseDataArray2D
class   CDataArray2D
  This template class encapsulates 2D data arrays that are passed to custom node plug-ins during a graph evaluation. More...
class   CDataArray2D< bool >
  This class is a specialization of a CDataArray2D class of type bool. More...
class   CDataArray2DCustomType
  CDataArray2DCustomType is used for storing binary data in a 2D element array of type CDataArray2DCustomType::TData. More...
class   CDataArray2DString
  CDataArray2DString is used for storing strings in a 2D element array. More...
class   Delta
  The Delta object represents a 'diff' or list of modifications to a reference model. More...
class   Desktop
  The Desktop provides the services for creating and accessing UI objects in Softimage. More...
class   Dictionary
  The dictionary object contains application definitions such as Family objects. More...
class   Directed
  An object representing the interest of a Camera or Light. More...
class   CDoubleArray
  The CDoubleArray is an uni-dimensional array of doubles. More...
class   Edge
  The Edge object gives access to the geometry edges of an X3DObject's primitive. More...
class   CEdgeRefArray
  Array of Edge objects. More...
class   Envelope
  An envelope is an object or hierarchy that is assigned as a skin to a set of deformers such as IK chains. More...
class   EnvelopeWeight
  An envelope weight is a specialized kind of ClusterProperty used to store the weights for each point on an envelope. More...
class   EventInfo
  The EventInfo class contains the information on a particular event such as its mute value, event handler, etc. More...
class   Expression
  An expression string is a mathematical formula that controls any animatable parameter. More...
class   Facet
  A facet is a generic concept used to describe a Geometry's PolygonFace, NurbsSurface or NurbsCurve. More...
class   CFacetRefArray
  An array of Facet objects representing all segments of the underlying Geometry object. More...
class   Factory
  This class represents a Factory class and is used to create certain types of objects. More...
class   FCurve
  The FCurve (function curve) class provides access to a set of functions for getting and setting Softimage fcurve attributes, as well as creating, retrieving, modifying and deleting fcurve keys. More...
class   FCurveKey
  This class represents a key on a function curve (FCurve). More...
class   CFCurveKeyRefArray
  This class represents an array of keys on a function curve (FCurve). More...
class   FileReference
  The FileReference class represents a reference to a file on disk. More...
class   Filter
  The Filter object represents an instance of a Softimage filter. More...
class   CFloatArray
  The CFloatArray is an uni-dimensional array of floats. More...
class   Framebuffer
  The Framebuffer object controls the file output of a RenderChannel object. More...
class   Geometry
  The Geometry class gives access to a X3DObject's geometry. More...
class   CGeometryAccessor
  The mesh geometry accessor provides an optimized access to the data and cluster property values of a geometry mesh object. More...
class   GraphicDriver
  The GraphicDriver class encapsulates the graphic driver currently set for drawing hardware shaders. More...
class   CGraphicSequencer
  The CGraphicSequencer object offers several services to enable custom rendering passes in the OpenGL viewport. More...
class   GraphicSequencerContext
  This class represents the plug-in context for the Graphic Sequencer (CGraphicSequencer). More...
class   GridData
  This object represents a 2-dimensional array of data. More...
class   GridWidget
  The GridWidget object represents the user interface control that shows a GridData object inside a Property Page. More...
class   Group
  The Group class represents a collection of related objects. More...
class   HairPrimitive
  This class represents the primitive of an X3DObject used for simulating hair in Softimage and can be accessed with X3DObject::GetActivePrimitive. More...
class   CHardwareAttribute
  Represents an attribute defined by hardware shaders a.k.a real-time shaders. More...
class   CHardwareAttributeArray
  The CHardwareAttributeArray is an uni-dimensional array of CHardwareAttribute. More...
class   HardwareShaderContext
  This object is provided as the context object in the execution callback of a hardware shader. More...
class   HardwareSurface
  HardwareSurface class used for encapsulating a 2D shader texture surface. More...
class   ICEAttribute
  The ICEAttribute object represents an attribute data set (a collection of information used in the ICE system, such as Age, PointPosition, NbrPolygons, etc.). More...
class   CBaseICEAttributeDataArray
  Base class CICEAttributeDataArray class for the CICEAttributeDataArray and CICEAttributeDataArray2D template classes. More...
class   CICEAttributeDataArray
  This template class encapsulates ICEAttribute data as a 1D array. More...
class   CICEAttributeDataArray< bool >
  This class is a specialization of a CICEAttributeDataArray class of type bool. More...
class   CICEAttributeDataArrayCustomType
  This class is a specialization of CICEAttributeDataArray to give access to the ICEAttribute data as a 1D array of type siICENodeDataCustomType. More...
class   CICEAttributeDataArrayString
  This class is a specialization of CICEAttributeDataArray which allows access to the ICEAttribute data as a 1D array of type siICENodeDataString. More...
class   CICEAttributeDataArray2D
  This template class encapsulates ICEAttribute data as a 2D array. More...
class   CICEAttributeDataArray2DCustomType
  This class is a specialization of CICEAttributeDataArray to give access to the ICEAttribute data as a 2D array of type siICENodeDataCustomType. More...
class   CICEAttributeDataArray2DString
  This class is a specialization of CICEAttributeDataArray2D which allows access to the ICEAttribute data as a 2D array of type siICENodeDataString. More...
class   ICECompoundNode
  The ICECompoundNode object represents a node sub-graph. More...
class   ICEDataModifierNode
  The ICEDataModifierNode object represents a SetData node in an ICE graph. More...
class   ICEDataProviderNode
  The ICEDataProviderNode object represents a GetDataNode in an ICE graph. More...
class   CICEGeometry
  Provides a read-only API for accessing the data of a geometry object connected to a custom ICE node. More...
class   ICENode
  The ICENode object represents an effect node in the ICE graph. More...
class   ICENodeContainer
  The ICENodeContainer object represents the base class for containers in a node graph. More...
class   ICENodeContext
  ICENodeContext is used for accessing/handling custom node graph data. More...
class   ICENodeDef
  ICENodeDef objects are used for describing a unique custom ICENode object. More...
class   ICENodeInputPort
  A ICENodeInputPort object represents the input port of an ICENode. More...
class   ICENodeOutputPort
  A ICENodeOutputPort object represents the output port of an ICENode. More...
class   ICENodePort
  ICENodePort is the base class for ICENode ports such as ICENodeInputPort and ICENodeOutputPort. More...
class   CICEPortState
  CICEPortState is used for accessing the state of a custom ICENode input port from the cb_ICENode_BeginEvaluate BeginEvaluate callback. More...
class   ICETree
  The ICETree object represents a node graph and holds all the effect nodes together. More...
class   Image
  This class provides read-access to the representation of an image in memory. More...
class   ImageClip
  As of v4.0, this class is obsolete and is replaced by ImageClip2. More...
class   ImageClip2
  An ImageClip2 object is an instance of an image Source and is used as the container for applying composited image effects. More...
class   CBitsetHelper
class   CIndexSet
  CIndexSet encapsulates an index set for indexing CDataArray object types for the current evaluation. More...
class   InputPort
  An InputPort object represents an input port of an Operator. More...
class   Joint
  The Joint object represents a Kinematic Joint property of a ChainBone or ChainEffector object. More...
class   Kinematics
  The Kinematics object represents the kinematics property of an X3DObject object. More...
class   KinematicState
  The KinematicState represents the current pose of an X3DObject object whereas the base pose of an object is represented by the StaticKinematicState. More...
class   CKnotArray
  An array of knot values representing the NURBS curve or surface knots. More...
class   Layer
  The Layer is a self-contained collection of SceneItem objects. More...
class   Layout
  The Layout object represents an instance of a screen layout in Softimage and gives access to the views attached to that layout. More...
class   Library
  A library is a container of objects of the same type. More...
class   Light
  The Light object represents a Softimage light, such as a point light or a spot light. More...
class   LightRig
  The LightRig object is a specialized Rig object composed of a Light and a Null as its interest. More...
class   CLongArray
  The CLongArray is an uni-dimensional array of LONG values. More...
class   MappedItem
  A mapped item specifies the value driven by a specific clip instance (for example, an object's parameter or its geometry). More...
class   Material
  The Material object represents a material property of a SceneItem object. More...
class   MaterialLibrary
  The material library object is a specialized source library for storing and sharing materials. More...
class   CMatrix3f
  A class to represent a single precision floating point 3 by 3 matrix. More...
class   Menu
  Represents a custom menu in Softimage and provides the basic support for creating them. More...
class   MenuItem
  The MenuItem object represents an individual item on a custom menu. More...
class   CMeshBuilder
  CMeshBuilder allows you to create polygon meshes from an ordered array of vertex coordinates and polygon connections (polygon to vertices). More...
class   MetaShaderRendererDef
  Represents a custom renderer definition. More...
class   Mixer
  This represents the Animation Mixer, which is nested directly under the Model. More...
class   Model
  The Model object represents any Softimage model node, including referenced models, and even the Scene Root. More...
class   Null
  The Null object is a specialized X3DObject object and represents a point in space with no dimensions. More...
class   NurbsCurve
  The NurbsCurve object gives access to the geometry curves of an X3DObject's primitive. More...
class   CNurbsCurveRefArray
  An array of NurbsCurve objects representing the curve in a curve list. More...
class   NurbsCurveList
  A NurbsCurveList is a kind of Geometry and is a collection of NurbsCurve objects. More...
struct   CNurbsCurveData
  This structure represents a data description for a NurbsCurve. More...
class   CNurbsCurveDataArray
  The CNurbsCurveDataArray is an uni-dimensional array of CNurbsCurveData. More...
struct   CTrimCurveData
  This structure represents a data description for a TrimCurve. More...
class   CTrimCurveDataArray
  The CTrimCurveDataArray is an uni-dimensional array of CTrimCurveData. More...
struct   CNurbsSurfaceData
  This structure represents a data description for a NurbsSurface. More...
class   CNurbsSurfaceDataArray
  The CNurbsSurfaceDataArray is an uni-dimensional array of CNurbsSurfaceData objects. More...
class   NurbsSample
  The NurbsSample object gives access to the NurbsSurfaceMesh sample geometry. More...
class   CNurbsSampleRefArray
  An array of NurbsSample objects representing the sample points on a NurbsSurface. More...
class   NurbsSurface
  The NurbsSurface object gives access to the X3DObject's nurbs surface Geometry. More...
class   CNurbsSurfaceRefArray
  An array of NurbsSurface objects representing the surface in a nurbs surface mesh. More...
class   NurbsSurfaceMesh
  A NurbsSurfaceMesh is a kind of Geometry. More...
class   OGLLight
  The OGLLight object represents the OGL light properties of a Light object. More...
class   OGLMaterial
  This object represents the OpenGL properties of a material object. More...
class   OGLTexture
  The OGLTexture object represents the OGL texture properties of a material object. More...
class   Operator
  The Operator object represents an operator in the scene graph. More...
class   OperatorContext
  This class is provided as the context object in the Operator update callback for a Self-Installed CustomOperator object (see PluginRegistrar::RegisterOperator). More...
class   OutputPort
  An OutputPort object represents an output port of an Operator. More...
class   Override
  This class represents an Override override property. More...
class   CParameterRefArray
  An array of Parameters. More...
class   Parameter
  Represents a parameter value within the ProjectItem, for example, the angle parameter of the twist operator. More...
class   Particle
  Represents one particle in a particle cloud. More...
class   ParticleAttribute
  Represents a user-defined Particle attribute, which is a custom parameter for particles originating from a ParticleType. More...
class   ParticleCloud
  This class represents a Particle Cloud in a Softimage scene. More...
class   ParticleCloudPrimitive
  This class provides access to the collection of particles that make up a ParticleCloud. More...
class   ParticleType
  Represents a particle type. More...
class   Partition
  A Partition is a division of a Pass, which behaves like a Group. More...
class   Pass
  A render pass creates a picture layer of a scene that can be composited with any other pass to create a complete image. More...
class   PassContainer
  The PassContainer object represents the pass container object found in the scene. More...
class   PickBuffer
  This class provides access to a picking buffer returned from ToolContent::GetPickBuffer. More...
class   Plugin
  A Plugin object holds read-only information on a particular plug-in file registered in Softimage. More...
class   PluginItem
  The PluginItem class contains the information on each item of a plug-in. More...
class   PluginRegistrar
  This class provides functions for registering a PluginItem in Softimage. More...
class   Point
  A Point is a generic concept used to describe a Geometry's Vertex or ControlPoint. More...
class   CPointRefArray
  An array of Point objects that represent the points in the Geometry. More...
class   PointLocatorData
  A PointLocatorData object represents a collection of point locators. More...
class   PolygonFace
  The PolygonFace object gives access to the geometry polygons of an X3DObject's primitive. More...
class   CPolygonFaceRefArray
  An array of PolygonFace objects representing the polygons in a polygon mesh. More...
class   PolygonMesh
  A PolygonMesh is a kind of Geometry. More...
class   PolygonNode
  The PolygonNode object gives access to the X3DObject's polygon node geometry. More...
class   CPolygonNodeRefArray
  An array of PolygonNode objects representing the edge junction in a polygon. More...
class   Port
  A port is an input or output connection to another object. More...
class   PortGroup
  A portgroup is a group of Port objects on an Operator. More...
class   PPGEventContext
  This object is provided as the context object in the PPGEvent callback for a Plugin-based CustomProperty object (see PluginRegistrar::RegisterProperty). More...
class   PPGItem
  This object represents a component of the user interface of a Property Page. More...
class   PPGLayout
  The PPGLayout object represents the visual appearance of an object's state when it is inspected. More...
class   Preferences
  The Preferences object can be used to manage preferences in Softimage. More...
class   Primitive
  Represents the primitive object of a X3DObject, a primitive is the basic form that is the building block of modeling and animation. More...
class   ProgressBar
  A progress bar is a control that indicates the progress of a lengthy operation by displaying a colored bar inside a horizontal rectangle. More...
class   Project
  The Project object represents the active Softimage project. More...
class   ProjectItem
  The ProjectItem class represents the base content class in Softimage from which all other content objects derive. More...
class   Property
  The Property class represents the property of the following entities: More...
class   ProxyParameter
  A ProxyParameter is a kind of Parameter that can be created on a CustomProperty which is "linked" with the value of another Parameter somewhere else in the Scene. More...
class   CQuaternionf
  Implementation of a float quaternion q=a+bi+cj+dk. More...
class   CRef
  This class is used to reference Softimage objects. More...
class   CRefArray
  The CRefArray class holds generic CRef objects and acts as a base class for other specialized CRef array classes (CEdgeRefArray, CFacetRefArray, etc...). More...
class   RenderChannel
  A render channel is a container for rendered image data output. More...
class   Renderer
  This object is provided as the source object available from the RendererContext for a Plugin-based cus_render Custom Renderer object. More...
class   RendererImageFragment
  This abstract class needs to be implemented by the rendering engine to provide image fragments to Softimage. More...
class   RendererContext
  This object is provided as the context object in the Renderer callbacks for a Plugin-based cus_render Custom Renderer object. More...
class   CRenderHairAccessor
  This class provides access to the render hair information exposed by the hair primitive. More...
class   Rig
  Base class for object with an interest i.e. More...
class   CRigidBodyAccessor
  The rigid body accessor provides an optimized access to the data and property values of a rigid body dynamics object. More...
class   CRigidConstraintAccessor
  The rigid constraint accessor provides an optimized access to the data and property values of a rigid constraint object. More...
class   Sample
  A Sample is a generic concept used to describe a PolygonNode or NurbsSample. More...
class   CSampleRefArray
  Array of Sample objects that represent the samples in the Geometry. More...
class   Scene
  The Scene object represents a Softimage scene that is loaded in memory. More...
class   SceneItem
  The SceneItem object represents an object in the scene (that is, something with properties) in Softimage from which all other scene objects derive. More...
class   SceneRenderProperty
  This object represents a scene render property. More...
class   Schematic
  The Schematic class represents the Schematic UI view and gives access to SchematicNode objects. More...
class   SchematicNode
  The SchematicNode class represents a UI node as displayed in a Schematic view. More...
class   Segment
  A Segment is a generic concept used to describe a PolygonMesh's Edge. More...
class   CSegmentRefArray
  An array of Segment objects that represents all the segment sub-components in the Geometry. More...
class   Selection
  The selection object represents the global selection for the application. More...
class   Shader
  The Shader object represents a node in the render tree of an object. More...
class   ShaderArrayParamDef
  Represents a definition for a shader parameter (an instance a ShaderArrayParameter object). More...
class   ShaderArrayParameter
  Represents an array parameter for a Shader. More...
class   ShaderballOptions
  Represents the options for a shaderball view. More...
class   ShaderDef
  Represents a custom shader definition. More...
class   ShaderParamDef
  Represents the definition of a ShaderParameter object. More...
class   ShaderParamDefContainer
  Represents a set of ShaderParamDef, ShaderArrayParamDef, and/or ShaderStructParamDef objects. More...
class   ShaderParamDefOptions
  Represents the advanced options for a shader parameter definition (ShaderParamDef) object. More...
class   ShaderParameter
  Represents a shader parameter as a specialization of the Parameter interface on a Shader. More...
class   ShaderStructParamDef
  Represents the Structure specialization of a shader parameter definition. More...
class   ShapeClip
  A ShapeClip is an instance of a shape key (source) at a particular position along a shape track in the animation mixer. More...
class   ShapeKey
  A ShapeKey represents a special ClusterProperty which is used to store a specific geometry. More...
class   SimulationEnvironment
  The SimulationEnvironment object represents a construct which is used to define a simulation. More...
class   SIObject
  SIObject derives from CBase and acts as the base class for the Softimage Object Model library. More...
class   CSIObjectRefArray
  An array of SIObjects. More...
class   Source
  Sources are references to data which are instantiated. More...
class   StaticKinematicState
  The StaticKinematicState object represents the base pose of an object. More...
class   StaticSource
  The StaticSource object represents a constant value stored as an AnimationSourceItem. More...
class   CStatus
  Encapsulates status data types for error handling purpose. More...
class   CScriptErrorDescriptor
  This class extends the CStatus object with additional error details if a Script Error has occured. More...
class   CString
  Character strings in the Softimage SDK are represented with the CString class. More...
class   CStringArray
  The CStringArray is an uni-dimensional array of CString objects. More...
class   SubComponent
  Provides access to the subelements of an object's Geometry. More...
class   Texture
  Specific Shader object which is a member of the Texture Shaders family (siTextureShaderFamily). More...
class   TextureLayer
  The TextureLayer is an object which simplifies layering of shader effects on top of shaders and materials. More...
class   TextureLayerPort
  The TextureLayerPort is an object used to describe which specific shader and material parameters a TextureLayer affects. More...
class   CTime
  The CTime class is a utility class for manipulating time. More...
class   CTimeArray
  The CTimeArray is an uni-dimensional array of CTime. More...
class   TimeControl
  The TimeControl object represents the clip's Time Control property, which is used to specify the time reference for a given Clip object. More...
class   TimerEvent
  A TimerEvent represents a system timer and allows you to specify the interval and the delay time at which a timer elapses. More...
class   ToolContext
  ToolContext is used for accessing/handling tool data. More...
class   Track
  A Track represents the container of clips used to sequence clips in the ClipContainer. More...
class   Transition
  This object represents a transition between two clips. More...
class   Triangle
  Represents a triangle generated by a surface tesselation. More...
class   CTriangleRefArray
  An array of Triangle objects that represents all the triangles in the Geometry. More...
class   TriangleVertex
  A TriangleVertex represents a Point of a Triangle object. More...
class   CTriangleVertexRefArray
  An array of TriangleVertex objects that represents all points of a Triangle object. More...
class   UIObject
  The UIObject is the base class for Softimage UI objects such as UIPersistable and MenuItem. More...
class   UIPersistable
  The UIPersistable object is the base class for Softimage UI persistable objects such as the View and Layout objects. More...
class   UIToolkit
  Provides access to Softimage user interface tools such as the ProgressBar object and the MsgBox function. More...
class   UpdateContext
  This object represents the operator update context. More...
class   CUserDataArray
  A CUserDataArray is an uni-dimensional array used to store binary values. More...
class   UserDataBlob
  The UserDataBlob is a Property that can be attached to many different parts of a scene, for example Cameras, Lights, other X3DObjects and Clusters. More...
class   UserDataMap
  The UserDataMap is a Property that can be attached to any cluster. More...
class   CUtils
  This is an intrinsic object that provides general utility methods. More...
struct   CUV
  This structure represents a UV coordinate. More...
class   CUVArray
  The CUVArray is an uni-dimensional array of CUV. More...
class   UVProperty
  UVProperty is a kind of ClusterProperty object used for storing and accessing the UV information of a cluster. More...
class   CValue
  The CValue object provides the convenience of a loosely typed variable inside a strictly typed language like C++. More...
class   CValueArray
  The CValueArray is an uni-dimensional array of CValue. More...
class   ValueMap
  Represents a special container to hold key-value pairs, similar to an associative array. More...
class   Vertex
  The Vertex object gives access to the geometry vertices of an X3DObject's Primitive. More...
class   CVertexRefArray
  Represents an array of Vertex objects. More...
struct   CVertexColor
  This structure represents a vertex RGBA color. More...
class   CVertexColorArray
  The CVertexColorArray is an uni-dimensional array of CVertexColor objects. More...
class   View
  The View object represents an instance of a view in Softimage. More...
class   ViewContext
  The ViewContext object serves 2 functions for Custom Displays: More...
class   CValueChangeNotification
  Holds information about a value change Event.
class   CTimeChangeNotification
  Holds information about a time change Event.
class   CWindowNotification
  Holds information about a change in window position.
class   CObjectAddedNotification
class   CObjectRemovedNotification
class   X3DObject
  The X3DObject object represents a basic 3D object of a scene in Softimage. More...

Typedefs

typedef XSI::CDataArray< float >  CDataArrayFloat
typedef XSI::CDataArray< LONG >  CDataArrayLong
typedef XSI::CDataArray< bool >  CDataArrayBool
typedef XSI::CDataArray
< XSI::MATH::CVector2f
CDataArrayVector2f
typedef XSI::CDataArray
< XSI::MATH::CVector3f
CDataArrayVector3f
typedef XSI::CDataArray
< XSI::MATH::CVector4f
CDataArrayVector4f
typedef XSI::CDataArray
< XSI::MATH::CQuaternionf > 
CDataArrayQuaternionf
typedef XSI::CDataArray
< XSI::MATH::CRotationf > 
CDataArrayRotationf
typedef XSI::CDataArray
< XSI::MATH::CMatrix3f > 
CDataArrayMatrix3f
typedef XSI::CDataArray
< XSI::MATH::CMatrix4f
CDataArrayMatrix4f
typedef XSI::CDataArray
< XSI::MATH::CColor4f
CDataArrayColor4f
typedef XSI::CDataArray
< XSI::MATH::CShape
CDataArrayShape
typedef CDataArray2D< float >  CDataArray2DFloat
typedef CDataArray2D< LONG >  CDataArray2DLong
typedef CDataArray2D< bool >  CDataArray2DBool
typedef CDataArray2D
< XSI::MATH::CVector2f
CDataArray2DVector2f
typedef CDataArray2D
< XSI::MATH::CVector3f
CDataArray2DVector3f
typedef CDataArray2D
< XSI::MATH::CVector4f
CDataArray2DVector4f
typedef CDataArray2D
< XSI::MATH::CQuaternionf > 
CDataArray2DQuaternionf
typedef CDataArray2D
< XSI::MATH::CRotationf > 
CDataArray2DRotationf
typedef CDataArray2D
< XSI::MATH::CMatrix3f > 
CDataArray2DMatrix3f
typedef CDataArray2D
< XSI::MATH::CMatrix4f
CDataArray2DMatrix4f
typedef CDataArray2D
< XSI::MATH::CColor4f
CDataArray2DColor4f
typedef XSI::CDataArray2D
< XSI::MATH::CShape
CDataArray2DShape
typedef enum XSI::siErrorValueEnum  siErrorValueEnum
  Error constants.
typedef enum
XSI::siDefaultTimeFormat 
siDefaultTimeFormat
  Time format values which are used by siTimeFormatDefaultFrameFormat UserPreference.
typedef enum
XSI::siDisplayTimeFormat 
siDisplayTimeFormat
  Time format values which are used by siTimeDisplayFormatUserFormat UserPreference.
typedef enum XSI::siFilterMode  siFilterMode
  Different modes for SIFilter command.
typedef enum XSI::siDeltaMode  siDeltaMode
  Delta transformation modes for transformation commands (Translate, Rotate, Scale)
typedef enum
XSI::siTextureEffectsComputation 
siTextureEffectsComputation
  Texture effects bit flags, to be used in conjunction with Texture.GetTransformValues
typedef enum XSI::siRefMode  siRefMode
  Reference transformation modes for transformation commands (Translate, Rotate, Scale).
typedef enum XSI::siCenterMode  siCenterMode
  Center transformation modes for transformation commands.
typedef enum XSI::siAxesFilter  siAxesFilter
  Axes filters for transformation commands (Translate, Rotate, Scale).
typedef enum XSI::siUVWAxesFilter  siUVWAxesFilter
  Axes filters for transformation commands (TranslateUVW, RotateUVW, ScaleUVW)
typedef enum XSI::siTransformFilter  siTransformFilter
  Transformation type filters (Translation, Rotation, Scaling)
typedef enum XSI::siParameterFilter  siParameterFilter
  Parameter filter (Marked, Animated, Scaling, Rotation, Translation, Weight, etc..)
typedef enum
XSI::siPSetRelationship 
siPSetRelationship
  Parent-child parameter set relationships.
typedef enum XSI::siPropagationType  siPropagationType
  Property propagation types.
typedef enum XSI::siDupHierarchy  siDupHierarchy
  Hierarchy options for duplication commands.
typedef enum XSI::siDupHistory  siDupHistory
  History options for duplication commands.
typedef enum XSI::siDupParent  siDupParent
  Parenting options for duplication commands.
typedef enum XSI::siDupGroup  siDupGroup
  Grouping options for duplication commands.
typedef enum XSI::siDupProperty  siDupProperty
  Property options for duplication commands.
typedef enum XSI::siDupAnimation  siDupAnimation
  Animation options for duplication commands.
typedef enum XSI::siDupConstraint  siDupConstraint
  Constraint options for duplication commands.
typedef enum
XSI::siDupTextureSupport 
siDupTextureSupport
  Texture Support options for duplication commands.
typedef enum XSI::siDupSelection  siDupSelection
  Selection options for duplication commands.
typedef enum XSI::siDupTransform  siDupTransform
  Transform options for duplication commands.
typedef enum XSI::siKeyboardState  siKeyboardState
  Keyboard modifier states.
typedef enum XSI::siInspectMode  siInspectMode
  Inspection Dialog Modes.
typedef enum
XSI::siInspectBrowseMode 
siInspectBrowseMode
  Constants that define the way to browse the inspection history.
typedef enum XSI::siSourceType  siSourceType
  Animation Source Types.
typedef enum XSI::siBranchFlag  siBranchFlag
  The branch flag is used to determine whether we are referring to the object as a node or as a branch.
typedef enum XSI::siOperationMode  siOperationMode
  The operation mode is used to determine if we are in immediate mode or persistent mode.
typedef enum
XSI::siGeneratorInputsDisposalMode 
siGeneratorInputsDisposalMode
  This mode is used to determine if we should keep, hide or delete the inputs after a generator is applied.
typedef enum
XSI::siComponentVisibilityMode 
siComponentVisibilityMode
  This mode is used to determine if the command should only apply to visible components.
typedef enum
XSI::siActionWhenLocalMaterialsOverlap 
siActionWhenLocalMaterialsOverlap
  This indicates what to do when local materials overlap.
typedef enum
XSI::siSplitPolygonType 
siSplitPolygonType
  Split type for polygons.
typedef enum XSI::siSelectionUpdate  siSelectionUpdate
  Constants that define the different options for updating selection list when working with topology operators.
typedef enum XSI::siTxtCreationType  siTxtCreationType
  Texture creation type constants.
typedef enum
XSI::siTxtDefaultCreationType 
siTxtDefaultCreationType
  Default texture creation type constants.
typedef enum XSI::siTxtProjType  siTxtProjType
  Texture projection type constants.
typedef enum XSI::siTxtProjPlane  siTxtProjPlane
  Texture projection plane constants.
typedef enum
XSI::siTxtProjFitMethod 
siTxtProjFitMethod
  Texture support positioning constants.
typedef enum
XSI::siChangeUVInputActions 
siChangeUVInputActions
  Actions for the ChangeUVInput command.
typedef enum XSI::siAlignModes  siAlignModes
  Modes for the align command.
typedef enum XSI::siWeightPresets  siWeightPresets
  Presets for the PresetWeight command.
typedef enum XSI::siCutClipOptions  siCutClipOptions
  Cut options for the CutClip command.
typedef enum XSI::siEditClipOptions  siEditClipOptions
  Edit clip options for the EditClip command.
typedef enum XSI::siPresetLocation  siPresetLocation
  Preset locations.
typedef enum XSI::siVariantType  siVariantType
  The variant type determines the kind of value that can be stored in a parameter.
typedef enum
XSI::siParamClassification 
siParamClassification
  This determines the classification of a Parameter to give Softimage some hint about its purpose.
typedef enum XSI::siMaterialPorts  siMaterialPorts
  Port choice for the SIGetMaterialShader command.
typedef enum XSI::siShadingModel  siShadingModel
  Defines the material shading model.
typedef enum XSI::siShaderType  siShaderType
  Defines the shader type.
typedef enum
XSI::siShaderOutputType 
siShaderOutputType
  Defines the output shader parameter types.
typedef enum
XSI::siShaderParameterType 
siShaderParameterType
  These represent the shader parameter data types for instantated shaders.
typedef enum
XSI::siShaderParameterDataType 
siShaderParameterDataType
  Defines the Shader parameter type for a Parameter object belonging to Shader, Material, Light or Camera.
typedef enum
XSI::siShaderParameterConnectionType 
siShaderParameterConnectionType
typedef enum
XSI::siShaderReferenceFilterType 
siShaderReferenceFilterType
  Defines the types of filters when creating a shader parameter definition of type reference(siShaderParameterDataType::siShaderDataTypeReference).
typedef enum
XSI::siShaderballDimension 
siShaderballDimension
  Defines the flags for Shaderball Dimension used by the ShaderballOptions object.
typedef enum
XSI::siShaderPropertyFilterType 
siShaderPropertyFilterType
  Defines the types of filters when creating a shader parameter definition of type property look-up(siShaderParameterDataType::siShaderDataTypeProperty).
typedef enum XSI::siLightType  siLightType
  Defines the types of light.
typedef enum XSI::siCnxGroupType  siCnxGroupType
  Types of groups in connection sets.
typedef enum XSI::siCnxSetType  siCnxSetType
  Types of connection sets.
typedef enum XSI::siPartitionType  siPartitionType
  Types of Partitions.
typedef enum XSI::siLockLevel  siLockLevel
  Levels of lock.
typedef enum XSI::siLockType  siLockType
  Type of lock owner.
typedef enum XSI::siTags  siTags
  These are the different levels of tags.
typedef enum XSI::siGeometryType  siGeometryType
  Type of geometry.
typedef enum XSI::siBoundingVolume  siBoundingVolume
  Types of bounding volumes.
typedef enum XSI::siPortType  siPortType
  Enumerates the different kinds of ports.
typedef enum
XSI::siModificationType 
siModificationType
  Type of modification on a referenced model.
typedef enum
XSI::siModificationMixerType 
siModificationMixerType
  Type of mixer modification on a referenced model.
typedef enum XSI::siModelResolution  siModelResolution
  Resolution description of a file for a referenced model.
typedef enum XSI::siParameterScope  siParameterScope
  Type of parameters to gather from the input Object List.
typedef enum XSI::siSequenceType  siSequenceType
  Type of input objects for the Sequence feature.
typedef enum XSI::siSequenceMode  siSequenceMode
  Mode to use for the Sequence feature.
typedef enum XSI::siEffectInputType  siEffectInputType
  Type of input objects for clip effect features.
typedef enum XSI::siNeighborType  siNeighborType
  Types of neighboring for the deprecated Geometry_V1.
typedef enum XSI::siNavigDirection  siNavigDirection
  Modes for the SelectNeighborObj command.
typedef enum
XSI::siNavigationDirection 
siNavigationDirection
  Direction of the next Node.
typedef enum
XSI::siNavigationFilter 
siNavigationFilter
  Direction of the next Node.
typedef enum
XSI::siNavigationSubFilter 
siNavigationSubFilter
  Sub-type of node wanted.
typedef enum XSI::siViewType  siViewType
  Type of views.
typedef enum
XSI::si2DChainAlignType 
si2DChainAlignType
  Defines the types of alignment used for creating a 2D chain.
typedef enum XSI::siChainBoneType  siChainBoneType
  Type of chain bones.
typedef enum XSI::siConnectionType  siConnectionType
  Operator connection types.
typedef enum XSI::siAxisType  siAxisType
  Bitmask for types of axes.
typedef enum
XSI::siKnotParameterization 
siKnotParameterization
  Type of knot parameterization type for NurbsCurves.
typedef enum XSI::siMappingRuleType  siMappingRuleType
  Types of mapping rules.
typedef enum XSI::siNurbsDirection  siNurbsDirection
  Types of nurbs direction parameters.
typedef enum XSI::siNurbsFormat  siNurbsFormat
  Types of nurbs format.
typedef enum
XSI::siInstallationPath 
siInstallationPath
  Installation path directories.
typedef enum
XSI::siShapeInstanceMode 
siShapeInstanceMode
  Shape key instantiation mode.
typedef enum
XSI::siShapeReferenceMode 
siShapeReferenceMode
  Shape key reference mode.
typedef enum XSI::siShapeContent  siShapeContent
  Indicates which deforms will be stored in the created shape.
typedef enum
XSI::siConstructionMode 
siConstructionMode
  The construction mode indicates the purpose of the deformations.
typedef enum XSI::siResolutionPlane  siResolutionPlane
  Resolution Plane Type for Chain joints.
typedef enum
XSI::siTextureProjectionType 
siTextureProjectionType
  Texture creation type constants.
typedef enum XSI::siUVTextureType  siUVTextureType
  UV generation type used by the texture operator, used only if siTextureProjectionType:siTextureUV is specified as the projection type.
typedef enum XSI::siCapabilities  siCapabilities
  Determines the capabilities of a parameter.
typedef enum XSI::siFCurveType  siFCurveType
  Types of function curves (fcurves)
typedef enum
XSI::siFCurveExtrapolation 
siFCurveExtrapolation
  The extrapolation of an FCurve determines its shape before the first FCurveKey and after the last FCurveKey.
typedef enum
XSI::siFCurveKeyConstraint 
siFCurveKeyConstraint
  Function curve key constraints.
typedef siFCurveKeyConstraint  siFCurveKeyFlags
typedef enum
XSI::siFCurveKeyInterpolation 
siFCurveKeyInterpolation
  Specifies the interpolation type for a specific key on an fcurve.
typedef enum
XSI::siFCurveKeySelectionMode 
siFCurveKeySelectionMode
  Specifies the mode for changing the FCurveKey selection.
typedef enum
XSI::siFCurveInterpolation 
siFCurveInterpolation
  The interpolation of an FCurve determines how values are evaluated between its FCurveKeys.
typedef enum
XSI::siFCurveSmoothFilterType 
siFCurveSmoothFilterType
  Specifies the kind of filter used for smoothing function curves.
typedef enum
XSI::siUpdateContextState 
siUpdateContextState
  Information on the context in which a plug-in is being evaluated.
typedef enum XSI::siArgumentFlags  siArgumentFlags
  Information on the direction of an argument indicating how it is passed to or from a command.
typedef enum XSI::siCommandCategory  siCommandCategory
  Custom (v1.0) Commands can be defined from a pre-defined category.
typedef enum
XSI::siImportShareOptions 
siImportShareOptions
  Defines the option flags when importing a model or merging a scene.
typedef enum XSI::siEventID  siEventID
  This enumerator provides the identifiers for the Softimage events, they can be used for implementing C++ event handlers in order to identify the events fired by Softimage.
typedef enum
XSI::siSelectionChangeType 
siSelectionChangeType
  Specifies the type of operation performed to update the selection.
typedef enum XSI::siRenderFieldType  siRenderFieldType
  Specifies the render field setting.
typedef enum XSI::siRenderingType  siRenderType
  Specifies the type of rendering.
typedef enum
XSI::siRenderingErrorType 
siRenderingErrorType
  Specifies the type of rendering error.
typedef enum
XSI::siSubdivisionRuleType 
siSubdivisionRuleType
  Specifies the subdivision rule used for an approximated geometry selection.
typedef enum
XSI::siNavigateComponentType 
siNavigateComponentType
  Direction type for navigating geometry components.
typedef enum
XSI::siParticleRenderType 
siParticleRenderType
  Enumeration of particle render types.
typedef enum
XSI::siFCurveEditorAttribute 
siFCurveEditorAttribute
  Enumeration of the different attributes that are available on the FCurveEditor object.
typedef enum XSI::siSeverityType  siSeverityType
  Determines the severity types of a message implemented with the C++ API.
typedef enum
XSI::siCustomCompiledOpFlags 
siCustomCompiledOpFlags
  Information which is passed to the custom compiled operators through its Init and Term functions.
typedef enum XSI::siChannelAction  siChannelAction
  A device driver contains a set of channels that can be configured.
typedef enum XSI::siSelectMode  siSelectMode
  Specifies how to select objects in a hierarchy.
typedef enum
XSI::siTransientExplorerFilter 
siTransientExplorerFilter
  Specifies the filter to use in a transient explorer.
typedef enum XSI::siClassID  siClassID
  The class ID of Softimage objects.
typedef enum
XSI::siBlendInPresetModes 
siBlendInPresetModes
  This enumeration type specifies how the BlendInPresets command will apply the new shaders to the parameters selected by the command.
typedef enum
XSI::siBlendInTextureLayersModes 
siBlendInTextureLayersModes
  This enumeration type specifies how the texture-layer blending commands will apply the new shaders to the parameters selected by the command.
typedef enum
XSI::siShaderCnxPointType 
siShaderCnxPointType
  This enumeration type specifies what kind of shader port connections you are interested in when using the RemoveAllShadersFromCnxPoint command.
typedef enum XSI::siAddonItemType  siAddonItemType
  This enumeration type specifies the type of item supported by add-ons.
typedef enum
XSI::siGridWidgetColumnType 
siGridWidgetColumnType
  Types of Columns supported by siControlGrid (see siPPGControlTypeand GridData.SetColumnType)
typedef enum
XSI::siGridSelectionMode 
siGridSelectionMode
  Selection Mode for the cells of the GridWidget, see siUIGridSelectionMode in siPPGItemAttribute.
typedef enum
XSI::siTxtContourStretchingMethod 
siTxtContourStretchingMethod
  Polygon cluster contour stretching method used to generate texture coordinates as part of the GenerateUVSetByContourStretching and ModifyUVSetByContourStretching commands.
typedef enum XSI::siExplorerScope  siExplorerScope
  The list of scopes supported by the Scene Explorer.
typedef enum XSI::siTimeState  siTimeState
  States for the time change notification CTimeChangeNotificationfor Custom Displays.
typedef enum XSI::siDisplayCallback  siDisplayCallback
  Types of display callbacks defined for the Graphic Sequencer.
typedef enum XSI::siXGSClassType  siXGSClassType
  Type of object passed to an Open Graphic Sequencer callback.
typedef enum XSI::siXGSFlag  siXGSFlag
  Flags for Graphic Sequencer callbacks.
typedef enum XSI::siXGSPassFlag  siXGSPassFlag
  Pass flags for Graphic Sequencer callbacks.
typedef enum XSI::siXGSStateType  siXGSStateType
  XGS state types defined for the Graphic Sequencer.
typedef enum XSI::siViewMode  siViewMode
  Viewport display modes used by the CGraphicSequencer classfor the Graphic Sequencer.
typedef enum
XSI::siParticleAttributeType 
siParticleAttributeType
  The available types for user defined per particle ParticleAttribute.
typedef enum
XSI::siAssetStorageType 
siAssetStorageType
  This is the enumeration of the different ways an asset in Softimage can be stored.
typedef enum
XSI::siSourceStorageType 
siSourceStorageType
  This enum has been replaced by siAssetStorageType.
typedef enum XSI::siAssetStatus  siAssetStatus
  This is an enumeration of how an asset in Softimage can be treated when stored externally.
typedef enum XSI::siActionStatus  siActionStatus
  This enum has been replaced by siAssetStatus.
typedef enum XSI::siFilterType  siFilterType
  Specifies the different type of filters that are used for implementing and categorizing custom Filters.
typedef enum
XSI::siCommandCapabilities 
siCommandCapabilities
  Determines the capabilities of a command.
typedef enum XSI::siSeverity  siSeverity
  Determines the severity types of a message implemented in a scripting language.
typedef enum XSI::siMsgBoxFlags  siMsgBoxFlags
  Flags values supported by the XSIUIToolkit.MsgBox command.
typedef enum
XSI::siMsgButtonPressed 
siMsgButtonPressed
  Return values from XSIUIToolkit.MsgBox that indicates which button was pressed by the user.
typedef enum XSI::siViewState  siViewState
  Specifies the view state information of the View object, such as whether the view is closed, whether the view is minimized, and whether the view is in a normal state.
typedef enum XSI::siToolbarControl  siToolbarControl
  Types of toolbar controls to use when building a toolbar.
typedef enum
XSI::siTimeReferenceType 
siTimeReferenceType
  Specifies the type of time applicability of a ClipEffect on a Clip.
typedef enum XSI::siImageRatio  siImageRatio
  Specifies a reduction to apply to an image.
typedef enum
XSI::siTimeControlExtrapolationType 
siTimeControlExtrapolationType
  The siTimeControlExtrapolationType determines how a Clip contributes to the animation outside of the frames on which it is defined.
typedef enum XSI::siMenuItemStyle  siMenuItemStyle
  Specifies the style of a menu item.
typedef enum
XSI::siMenuAnchorPoints 
siMenuAnchorPoints
  Identifies the location of a custom menu.
typedef enum XSI::siPortFlags  siPortFlags
  This enum specifies the operator port flags.
typedef enum
XSI::siWindowChangeState 
siWindowChangeState
  This enum specifies what has changed during a CWindowNotification for the Custom Display Host.
typedef enum XSI::siFileType  siFileType
  This enum is used to determine the type of a file for the OnBeginFileExport, OnBeginFileImport, OnEndFileExport, OnEndFileImport, OnCustomFileExport, and OnCustomFileImport events.
typedef enum XSI::siClusterType  siClusterType
  This enum specifies the type of clusters in Softimage.
typedef enum
XSI::siClusterPropertyType 
siClusterPropertyType
  This enum specifies the type of cluster properties in Softimage.
typedef enum
XSI::siCurveIsopointManipMode 
siCurveIsopointManipMode
  This enum specifies the mode of manipulation of a curve isopoint in Softimage.
typedef enum
XSI::siCurveKnotTangentAlignment 
siCurveKnotTangentAlignment
  This enum specifies the type of alignment for a tangent of a curve knot in Softimage.
typedef enum XSI::siRBDEngine  siRBDEngine
  Specifies the rigid body dynamics engine used for simulation.
typedef enum
XSI::siKeyableAttributeType 
siKeyableAttributeType
  Keyable attribute types.
typedef enum
XSI::siClosestLocationMethod 
siClosestLocationMethod
  Indicates the method to use for finding closest locations on a geometry.
typedef enum
XSI::siNormalComputationMethod 
siNormalComputationMethod
  Indicates the method to use for computing normals on a geometry.
typedef enum
XSI::siLineIntersectionType 
siLineIntersectionType
  Type of line to use when intersecting a line with a geometry.
typedef enum XSI::siImageBitDepth  siImageBitDepth
  This enumeration lists the allowed bit depths for each channel of an image with the specified channel types.
typedef enum
XSI::siImageChannelType 
siImageChannelType
  This enum lists the allowed channel types in writable images and framebuffers.
typedef enum
XSI::siImageChannelFilter 
siImageChannelFilter
  This enumeration lists the allowed filters for user-selectable channel types in the UI.
typedef enum
XSI::siVolumeCenterMethod 
siVolumeCenterMethod
  Indicates the method to use for calculating the center of a bounding volume.
typedef enum
XSI::siBoundingCapsuleMethod 
siBoundingCapsuleMethod
  Indicates the method to use for calculating the long axis of a bounding cylinder.
typedef enum XSI::siSourcePathType  siSourcePathType
  Specifies the source path being set for the OnSourcePathChange event.
typedef enum XSI::siModelKind  siModelKind
  Describes whether Model is referenced, local (regular) or an instance.
typedef enum XSI::siViewport  siViewport
  Used as a convenient list of identifiers for the different viewports of the view manager.
typedef enum
XSI::siRenderRegionDisplayType 
siRenderRegionDisplayType
  This enumeration represents the list of display types for the render region.
typedef enum
XSI::siModificationDeltaType 
siModificationDeltaType
  Type of delta modification on a referenced model.
typedef enum
XSI::siNodePortDataInsertionLocation 
siNodePortDataInsertionLocation
  Specifies the relative location where new node ports will be added.
typedef enum XSI::siPPGEventID  siPPGEventID
  Defines the possible actions that trigger calling the PPGEvent callback function.
typedef enum
XSI::siRenderProcessType 
siRenderProcessType
  The process types that a rendering engine can perform.
typedef enum XSI::siRenderQueryType  siRenderQueryType
  Query codes that a rendering engine needs to respond to if it supports object archives and stand-ins, via registering itself with a siRenderProcessType::siRenderProcessExportObjectArchive process type, and multiple display bit depths.
typedef enum
XSI::siRenderQualityType 
siRenderQualityType
  Quality levels that a rendering engine's renderer properties can be set to, or queried for.
typedef enum
XSI::siRenderPropertyType 
siRenderPropertyType
  When a render engine registers, it provides a list of specific properties that Softimage should create for it.
typedef enum
XSI::siRenderShutterType 
siRenderShutterType
  Controls when the camera's shutter opens and closes when generating motion blur for render.
typedef enum
XSI::siRenderFrameSource 
siRenderFrameSource
  Controls how the render frame list is computed for passes.
typedef enum
XSI::siDragAndDropAction 
siDragAndDropAction
  Possible actions for the drag and drop notification.
typedef enum
XSI::siICEAttributeCategory 
siICEAttributeCategory
  Describes how the ICEAttribute data is defined.
typedef enum
XSI::siICENodeThreadingModel 
siICENodeThreadingModel
  Defines the threading models available for ICENode evaluation.
typedef enum XSI::siICEShapeType  siICEShapeType
  Defines the particle shape types for rendering.
typedef enum XSI::siRenderVerbosity  siRenderVerbosity
  This enum specifies the render verbosity settings used when rendering or exporting passes.
typedef enum
XSI::siTimeTransportSeekMode 
siTimeTransportSeekMode
  Softimage TimeTransport seek modes.
typedef enum XSI::siGraphicDriver  siGraphicDriver
  Enumerates the supported graphics drivers.
typedef enum
XSI::siHardwareSurfaceDimension 
siHardwareSurfaceDimension
  Defines the dimension of a hardware surface.
typedef enum XSI::siResourceSharing  siResourceSharing
  Defines the sharing capability of a resource.
typedef enum
XSI::siHardwareInputSemantic 
siHardwareInputSemantic
  Describes the standard vertex attribute hardware slot for a Realtime Shader.
typedef enum
XSI::siCollapseLayersPlottingType 
siCollapseLayersPlottingType
  Indicates the plotting type to use when collapsing animation layers.
typedef enum
XSI::siMaterialConflictAction 
siMaterialConflictAction
  This indicates the action to perform when there is a conflict with a material.
typedef enum
XSI::siHWShaderVersionID 
siHWShaderVersionID
  Declares the supported hardware shader versions.
typedef enum XSI::siXGSContextFlag  siXGSContextFlag
  Context flags for the Graphic Sequencer.
typedef enum XSI::siXGSRenderFlag  siXGSRenderFlag
  XGS render flags for the Graphic Sequencer.
typedef enum
XSI::siCustomDisplayFlags 
siCustomDisplayFlags
  Determines the behavior and look of a Custom Display.
typedef enum
XSI::siComponentDataType 
siComponentDataType
  Specifies the type of component data (vector3, boolean, color, etc.) on an ICEAttribute.
typedef enum
XSI::siComponentDataContext 
siComponentDataContext
  Specifies the context of component data (points, edges, etc.) on an ICEAttribute.
typedef enum
XSI::siComponentDataStructure 
siComponentDataStructure
  Specifies the structure of component data (single element or dynamic array) on an ICEAttribute.
typedef enum
XSI::siRenderChannelType 
siRenderChannelType
  Types of data allowed for render channels.
typedef enum XSI::siICENodeDataType  siICENodeDataType
  Defines the types of data that can be associated to a ICE node port connection.
typedef enum
XSI::siICENodeStructureType 
siICENodeStructureType
  Defines the way data are structured for ICE node connections: single data or dynamic array.
typedef enum
XSI::siICENodeContextType 
siICENodeContextType
  Defines the element set associated with the data for ICE node connections.
typedef enum
XSI::siAutoCompleteMode 
siAutoCompleteMode
  Determines the behavior of the auto-complete feature for a text editor widget control (see siPPGControlType::siControlTextEditor).
typedef enum
XSI::siTextEditorCapability 
siTextEditorCapability
  Determines the availability of the File menu functions for a text editor widget control (siPPGControlType::siControlTextEditor).
typedef enum XSI::siViewportFeature  siViewportFeature
  Defines the supported features for a custom viewport.
typedef enum
XSI::siTimeTransportPlaybackMode 
siTimeTransportPlaybackMode
  Softimage TimeTransport playback types.
typedef enum
XSI::siTimeTransportState 
siTimeTransportState
  Softimage TimeTransport states.
typedef enum
XSI::siToolCapabilities 
siToolCapabilities
  Various flags that affect tool behaviour.
typedef enum XSI::siToolCursor  siToolCursor
  ToolContext cursors.
typedef enum XSI::siAlignment  siAlignment
  ToolContext text/menu alignment.
typedef enum XSI::siSnapType  siSnapType
  ToolContext snapping type flags.
typedef enum XSI::siPickMode  siPickMode
  ToolContext picking mode flags.
typedef enum XSI::siPickType  siPickType
  ToolContext picking type flags.
typedef enum XSI::siPasteUVsMode  siPasteUVsMode
  This indicates which UVs indices to use when the UVs are copied from one object and pasted onto another object.
typedef enum XSI::siSetValueMode  siSetValueMode
  This indicates the mathematical mode when setting a new value to a current value.
typedef
XSI::CICEAttributeDataArray
< float > 
CICEAttributeDataArrayFloat
typedef
XSI::CICEAttributeDataArray
< LONG > 
CICEAttributeDataArrayLong
typedef
XSI::CICEAttributeDataArray
< bool > 
CICEAttributeDataArrayBool
typedef
XSI::CICEAttributeDataArray
< XSI::MATH::CVector2f
CICEAttributeDataArrayVector2f
typedef
XSI::CICEAttributeDataArray
< XSI::MATH::CVector3f
CICEAttributeDataArrayVector3f
typedef
XSI::CICEAttributeDataArray
< XSI::MATH::CVector4f
CICEAttributeDataArrayVector4f
typedef
XSI::CICEAttributeDataArray
< XSI::MATH::CQuaternionf > 
CICEAttributeDataArrayQuaternionf
typedef
XSI::CICEAttributeDataArray
< XSI::MATH::CRotationf > 
CICEAttributeDataArrayRotationf
typedef
XSI::CICEAttributeDataArray
< XSI::MATH::CMatrix3f > 
CICEAttributeDataArrayMatrix3f
typedef
XSI::CICEAttributeDataArray
< XSI::MATH::CMatrix4f
CICEAttributeDataArrayMatrix4f
typedef
XSI::CICEAttributeDataArray
< XSI::MATH::CColor4f
CICEAttributeDataArrayColor4f
typedef
XSI::CICEAttributeDataArray
< XSI::MATH::CShape
CICEAttributeDataArrayShape
typedef
XSI::CICEAttributeDataArray2D
< float > 
CICEAttributeDataArray2DFloat
typedef
XSI::CICEAttributeDataArray2D
< LONG > 
CICEAttributeDataArray2DLong
typedef
XSI::CICEAttributeDataArray2D
< bool > 
CICEAttributeDataArray2DBool
typedef
XSI::CICEAttributeDataArray2D
< XSI::MATH::CVector2f
CICEAttributeDataArray2DVector2f
typedef
XSI::CICEAttributeDataArray2D
< XSI::MATH::CVector3f
CICEAttributeDataArray2DVector3f
typedef
XSI::CICEAttributeDataArray2D
< XSI::MATH::CVector4f
CICEAttributeDataArray2DVector4f
typedef
XSI::CICEAttributeDataArray2D
< XSI::MATH::CQuaternionf > 
CICEAttributeDataArray2DQuaternionf
typedef
XSI::CICEAttributeDataArray2D
< XSI::MATH::CRotationf > 
CICEAttributeDataArray2DRotationf
typedef
XSI::CICEAttributeDataArray2D
< XSI::MATH::CMatrix3f > 
CICEAttributeDataArray2DMatrix3f
typedef
XSI::CICEAttributeDataArray2D
< XSI::MATH::CMatrix4f
CICEAttributeDataArray2DMatrix4f
typedef
XSI::CICEAttributeDataArray2D
< XSI::MATH::CColor4f
CICEAttributeDataArray2DColor4f
typedef
XSI::CICEAttributeDataArray2D
< XSI::MATH::CShape
CICEAttributeDataArray2DShape

Enumerations

enum   siErrorValueEnum { siErrCancelled = 0x4c7L }
 

Error constants.

More...
enum   siDefaultTimeFormat {
  siDefaultFILM24 = 7, siDefaultPAL25 = 8, siDefaultNTSC30 = 10, siDefaultUserTimeFormat = 11,
  siDefault30 = 19
}
 

Time format values which are used by siTimeFormatDefaultFrameFormat UserPreference.

More...
enum   siDisplayTimeFormat {
  siDisplayMilliSeconds = 2, siDisplayFILM24 = 7, siDisplayPAL25 = 8, siDisplayNTSCDF = 9,
  siDisplayNTSC30 = 10, siDisplaySampleRate = 12
}
 

Time format values which are used by siTimeDisplayFormatUserFormat UserPreference.

More...
enum   siFilterMode { siQuickSearch = 0, siSearchFamilies = 1, siSearchObjects = 2, siFullSearch = 3 }
 

Different modes for SIFilter command.

More...
enum   siDeltaMode { siAbsolute = 0, siRelative = 1 }
 

Delta transformation modes for transformation commands (Translate, Rotate, Scale)

More...
enum   siTextureEffectsComputation {
  siTextureComputeTransformation = 1, siTextureComputeCropping = 2, siTextureComputeUVRemap = 4, siTextureComputeFlip = 8,
  siTextureComputeRepeats = 16, siTextureComputeAlternate = 32, siTextureComputeWrapping = 64
}
 

Texture effects bit flags, to be used in conjunction with Texture.GetTransformValues

More...
enum   siRefMode {
  siGlobal = 1, siLocal = 2, siObjCtr = 3, siView = 4,
  siParent = 6, siPlane = 7, siPivot = 8, siAdd = 70,
  siGlobalCOG = 17, siLocalCOG = 18, siObjectCOG = 19, siViewCOG = 20,
  siParentCOG = 22, siPlaneCOG = 23, siPivotCOG = 24, siAddCOG = 86,
  siGlobalSym = 2049, siLocalSym = 2050, siObjectSym = 2051, siViewSym = 2052,
  siParentSym = 2054, siPlaneSym = 2055, siPivotSym = 2056, siAddSym = 2118,
  siGlobalSymCOG = 2065, siLocalSymCOG = 2066, siObjectSymCOG = 2067, siViewSymCOG = 2068,
  siParentSymCOG = 2070, siPlaneSymCOG = 2071, siPivotSymCOG = 2072, siAddSymCOG = 2134
}
 

Reference transformation modes for transformation commands (Translate, Rotate, Scale).

More...
enum   siCenterMode { siObj = 0, siCtr = 1 }
 

Center transformation modes for transformation commands.

More...
enum   siAxesFilter {
  siX = 1, siY = 2, siXY = 3, siZ = 4,
  siXZ = 5, siYZ = 6, siXYZ = 7
}
 

Axes filters for transformation commands (Translate, Rotate, Scale).

More...
enum   siUVWAxesFilter {
  siU = 1, siV = 2, siUV = 3, siW = 4,
  siUW = 5, siVW = 6, siUVW = 7
}
 

Axes filters for transformation commands (TranslateUVW, RotateUVW, ScaleUVW)

More...
enum   siTransformFilter {
  siScl = 1, siRot = 2, siTrn = 4, siSR = 8,
  siST = 16, siRT = 32, siSRT = 64
}
 

Transformation type filters (Translation, Rotation, Scaling)

More...
enum   siParameterFilter {
  siNoParam = 0, siMarkedParam = 1, siAnimatedParam = 3, siSelectedParam = 4,
  siScalingParam = 5, siRotationParam = 6, siTranslationParam = 7, siTransformParam = 8,
  siAllParam = 128
}
 

Parameter filter (Marked, Animated, Scaling, Rotation, Translation, Weight, etc..)

More...
enum   siPSetRelationship {
  siContainedPSet = 1, siSharedPSet = 2, siLocalPSet = 4, siObjectPSet = 8,
  siPortPSet = 16, siParameterPSet = 32
}
 

Parent-child parameter set relationships.

More...
enum   siPropagationType { siDefaultPropagation = 0, siBranchPropagation = 1, siNodePropagation = 2 }
 

Property propagation types.

More...
enum   siDupHierarchy { siNodeDuplicate = 0, siBranchDuplicate = 1, siDefaultDuplicate = 3 }
 

Hierarchy options for duplication commands.

More...
enum   siDupHistory { siCurrentHistory = 0, siOriginalHistory = 1, siDuplicateHistory = 2, siSharedHistory = 3 }
 

History options for duplication commands.

More...
enum   siDupParent { siNoParent = 0, siSharedParent = 1, siNewNullParent = 2 }
 

Parenting options for duplication commands.

More...
enum   siDupGroup { siNoGrouping = 0, siShareGrouping = 1 }
 

Grouping options for duplication commands.

More...
enum   siDupProperty { siDuplicateProperties = 0, siSharedProperties = 1, siNoProperties = 2 }
 

Property options for duplication commands.

More...
enum   siDupAnimation { siDuplicateAnimation = 0, siNoAnimation = 1, siDupAnimationCopySource = 2 }
 

Animation options for duplication commands.

More...
enum   siDupConstraint { siDuplicateConstraints = 0, siShareConstraints = 1, siNoConstraints = 2 }
 

Constraint options for duplication commands.

More...
enum   siDupTextureSupport { siDuplicateSelectedTextureSupports = 0, siDuplicateTextureSupports = 1, siShareTextureSupports = 2, siFreezeAllProjections = 3 }
 

Texture Support options for duplication commands.

More...
enum   siDupSelection { siSetSelection = 0, siNoSelection = 1, siAddToSelection = 2 }
 

Selection options for duplication commands.

More...
enum   siDupTransform { siGlobalXForm = 0, siApplyRepeatXForm = 1 }
 

Transform options for duplication commands.

More...
enum   siKeyboardState { siShiftMask = 1, siCtrlMask = 2, siAltMask = 4 }
 

Keyboard modifier states.

More...
enum   siInspectMode {
  siRecycle = 1, siFollow = 2, siLock = 3, siModal = 4,
  siLockAndForceNew = 5
}
 

Inspection Dialog Modes.

More...
enum   siInspectBrowseMode { siNext = 1, siPrevious = 2, siLast = 3, siFirst = 4 }
 

Constants that define the way to browse the inspection history.

More...
enum   siSourceType {
  siFCurveSource = 1, siExpressionSource = 2, siAnySource = 4, siMixerSource = 8,
  siConstraintSource = 16, siScriptedOperatorSource = 32, siShapeAnimationSource = 64
}
 

Animation Source Types.

More...
enum   siBranchFlag { siNode = 0, siBranch = 1, siUnspecified = 3, siNotSelected = 4 }
 

The branch flag is used to determine whether we are referring to the object as a node or as a branch.

More...
enum   siOperationMode { siPersistentOperation = 0, siImmediateOperation = 1 }
 

The operation mode is used to determine if we are in immediate mode or persistent mode.

More...
enum   siGeneratorInputsDisposalMode { siKeepGenOpInputs = 0, siHideGenOpInputs = 1, siDeleteGenOpInputs = 2 }
 

This mode is used to determine if we should keep, hide or delete the inputs after a generator is applied.

More...
enum   siComponentVisibilityMode { siIgnoreComponentVisibility = 0, siCheckComponentVisibility = 1 }
 

This mode is used to determine if the command should only apply to visible components.

More...
enum   siActionWhenLocalMaterialsOverlap {
  siPromptUser = 0, siRemoveFromSelectedClusters = 1, siRemoveFromExistingClusters = 2, siLetLocalMaterialsOverlap = 3,
  siJustReturnExistingClusters = 4
}
 

This indicates what to do when local materials overlap.

More...
enum   siSplitPolygonType { siByTheVertices = 0, siByTheEdgesMidPoints = 1, siCross = 2, siDiamond = 3 }
 

Split type for polygons.

More...
enum   siSelectionUpdate { siLeaveSelection = 0, siCleanSelection = 1, siUpdateSelection = 2 }
 

Constants that define the different options for updating selection list when working with topology operators.

More...
enum   siTxtCreationType {
  siTxtPlanarXY = 0, siTxtPlanarXZ = 1, siTxtPlanarYZ = 2, siTxtCylindrical = 3,
  siTxtSpherical = 4, siTxtSpatial = 5, siTxtCamera = 6, siTxtUV = 7,
  siTxtLollipop = 8, siTxtPureImplicit = 9, siTxtCubic = 10, siTxtUniqueUV = 11
}
 

Texture creation type constants.

More...
enum   siTxtDefaultCreationType {
  siTxtDefaultPlanarXY = 0, siTxtDefaultPlanarXZ = 1, siTxtDefaultPlanarYZ = 2, siTxtDefaultCylindrical = 3,
  siTxtDefaultSpherical = 4, siTxtDefaultSpatial = 5, siTxtDefaultCubic = 6, siTxtDefaultLollipop = 8
}
 

Default texture creation type constants.

More...
enum   siTxtProjType {
  siProjPlanar = 0, siProjCylindrical = 1, siProjSpherical = 2, siProjLollipop = 3,
  siProjSpatial = 4, siProjCubic = 5
}
 

Texture projection type constants.

More...
enum   siTxtProjPlane { siPlaneXY = 0, siPlaneXZ = 1, siPlaneYZ = 2 }
 

Texture projection plane constants.

More...
enum   siTxtProjFitMethod {
  siRelDefault = 0, siRelBestFit = 1, siRelObject = 2, siRelWorld = 3,
  siRelObjectPosObject = 4, siRelWorldPosObject = 5
}
 

Texture support positioning constants.

More...
enum   siChangeUVInputActions { siChangeUVInputActionSwim = 0, siChangeUVInputActionStick = 1, siChangeUVInputActionReproject = 2 }
 

Actions for the ChangeUVInput command.

More...
enum   siAlignModes {
  siAlignGMIN = 0, siAlignGMIDDLE = 1, siAlignGMAX = 2, siAlignFMIN = 3,
  siAlignFMIDDLE = 4, siAlignFMAX = 5
}
 

Modes for the align command.

More...
enum   siWeightPresets {
  siWeightEaseIn = 1, siWeightEaseOut = 2, siWeightLinearEaseIn = 3, siWeightLinearEaseOut = 4,
  siWeightExponentialIn = 5, siWeightExponentialOut = 6, siWeightGaussian = 7, siWeightGaussianReverse = 8,
  siWeightSquare = 9, siWeightSquareReverse = 10, siWeightOscillate = 11, siWeightConstant = 12,
  siWeightFlipX = 13, siWeightFlipY = 14
}
 

Presets for the PresetWeight command.

More...
enum   siCutClipOptions { siCut = 1, siTrimBefore = 2, siTrimAfter = 3 }
 

Cut options for the CutClip command.

More...
enum   siEditClipOptions {
  siClipNudge = 1, siClipSlip = 2, siClipTrim = 3, siClipScale = 4,
  siClipStartAt = 5, siClipEndAt = 6, siClipScaleTo = 7
}
 

Edit clip options for the EditClip command.

More...
enum   siPresetLocation {
  siDefaultLocation = 0, siFactory = 1, siUser = 2, siWorkgroup = 3,
  siProject = 4
}
 

Preset locations.

More...
enum   siVariantType {
  siEmpty = 0, siInt2 = 2, siInt4 = 3, siFloat = 4,
  siDouble = 5, siString = 8, siDispatch = 9, siBool = 11,
  siUnknown = 13, siByte = 16, siUByte = 17, siUInt2 = 18,
  siUInt4 = 19, siInt = 22, siUInt = 23, siWStr = 31
}
 

The variant type determines the kind of value that can be stored in a parameter.

More...
enum   siParamClassification {
  siClassifVisualization = 1, siClassifPositioning = 2, siClassifAppearance = 4, siClassifMetaData = 8,
  siClassifModel = 16, siClassifTopo = 16481, siClassifGeometry = 16449, siClassifUnknown = 32768
}
 

This determines the classification of a Parameter to give Softimage some hint about its purpose.

More...
enum   siMaterialPorts {
  siMaterialPortSurface = 1, siMaterialPortVolume = 2, siMaterialPortEnvironment = 3, siMaterialPortContour = 4,
  siMaterialPortDisplacement = 5, siMaterialPortShadow = 6, siMaterialPortPhoton = 7, siMaterialPortPhotonVol = 8,
  siMaterialPortBumpMap = 9
}
 

Port choice for the SIGetMaterialShader command.

More...
enum   siShadingModel {
  siUndefinedShadingModel = -1, siShadingModelConstant = 0, siShadingModelLambert = 1, siShadingModelBlinn = 2,
  siShadingModelPhong = 3, siShadingModelShadow = 4, siShadingModelColorVertex = 5
}
 

Defines the material shading model.

More...
enum   siShaderType { siShaderUnknown = 0, siShader = 1, siShaderCompound = 2, siShaderComment = 3 }
 

Defines the shader type.

More...
enum   siShaderOutputType {
  siUnknownOutputType = 0, siBooleanOutputType = 1, siIntegerOutputType = 2, siScalarOutputType = 3,
  siColorOutputType = 4, siVectorOutputType = 5, siTextureSpaceOutputType = 6, siTextureOutputType = 7,
  siStringOutputType = 8, siFilenameOutputType = 9, siLensOutputType = 10, siLightOutputType = 11,
  siMaterialOutputType = 12, siModelOutputType = 13, siLightmapOutputType = 20
}
 

Defines the output shader parameter types.

More...
enum   siShaderParameterType {
  siUnknownParameterType = 0, siArrayParameterType = 25, siBooleanParameterType = 1, siColorParameterType = 4,
  siColor3ParameterType = 29, siCustomParameterType = 28, siDataParameterType = 14, siGradientParameterType = 26,
  siIntegerParameterType = 2, siLensParameterType = 10, siLightParameterType = 11, siLightmapParameterType = 20,
  siMaterialParameterType = 12, siMatrixParameterType = 15, siMatrix3ParameterType = 24, siModelParameterType = 13,
  siProfileCurveParameterType = 21, siQuaternionParameterType = 27, siRealTimeParameterType = 16, siReferenceParameterType = 17,
  siScalarParameterType = 3, siShaderReferenceParameterType = 18, siStringParameterType = 8, siStructParameterType = 19,
  siTextureParameterType = 7, siTextureSpaceParameterType = 6, siVectorParameterType = 5, siVector2ParameterType = 22,
  siVector4ParameterType = 23
}
 

These represent the shader parameter data types for instantated shaders.

More...
enum   siShaderParameterDataType {
  siShaderDataTypeUnknown = -1, siShaderDataTypeBoolean = 0, siShaderDataTypeInteger = 1, siShaderDataTypeScalar = 2,
  siShaderDataTypeVector2 = 3, siShaderDataTypeVector3 = 4, siShaderDataTypeVector4 = 5, siShaderDataTypeQuaternion = 6,
  siShaderDataTypeMatrix33 = 7, siShaderDataTypeMatrix44 = 8, siShaderDataTypeColor3 = 9, siShaderDataTypeColor4 = 10,
  siShaderDataTypeString = 11, siShaderDataTypeProperty = 16, siShaderDataTypeProfileCurve = 17, siShaderDataTypeGradient = 18,
  siShaderDataTypeLightProfile = 19, siShaderDataTypeReference = 32, siShaderDataTypeImage = 33, siShaderDataTypeCustom = 48,
  siShaderDataTypeStructure = 64, siShaderDataTypeArray = 65
}
 

Defines the Shader parameter type for a Parameter object belonging to Shader, Material, Light or Camera.

More...
enum   siShaderParameterConnectionType { siShaderCnxUnknown = -1, siShaderCnxInput = 0, siShaderCnxOutput = 1 }
enum   siShaderReferenceFilterType {
  siUnknownReferenceFilter = 0, siObjectReferenceFilter = 1, siCameraReferenceFilter = 2, siLightReferenceFilter = 3,
  siMaterialReferenceFilter = 4, siShaderReferenceFilter = 5, siGeometryReferenceFilter = 6, siUserDataBlobReferenceFilter = 7
}
 

Defines the types of filters when creating a shader parameter definition of type reference(siShaderParameterDataType::siShaderDataTypeReference).

More...
enum   siShaderballDimension {
  siShaderballDimUndefined = 0, siShaderballDimParametric = 1, siShaderballDimSpatial = 2, siShaderballDimParticle = 4,
  siShaderballDimAll = 7
}
 

Defines the flags for Shaderball Dimension used by the ShaderballOptions object.

More...
enum   siShaderPropertyFilterType {
  siAnyPropertyFilter = 0, siAnyVertexMapPropertyFilter = 1, siUVPropertyFilter = 2, siCAVPropertyFilter = 3,
  siWeightMapPropertyFilter = 4, siTextureMapPropertyFilter = 5, siNormalPropertyFilter = 6
}
 

Defines the types of filters when creating a shader parameter definition of type property look-up(siShaderParameterDataType::siShaderDataTypeProperty).

More...
enum   siLightType {
  siLightPoint = 0, siLightInfinite = 1, siLightSpot = 2, siLightSun = 3,
  siUndefinedLightType = 4
}
 

Defines the types of light.

More...
enum   siCnxGroupType { siCreatedObjects = 1 }
 

Types of groups in connection sets.

More...
enum   siCnxSetType { siGroupLevel = 0, siPortLevel = 1 }
 

Types of connection sets.

More...
enum   siPartitionType { siUnknownPartition = 0, siObjectPartition = 1, siLightPartition = 2 }
 

Types of Partitions.

More...
enum   siLockLevel {
  siLockLevelNone = 0, siLockLevelConstruction = 1, siLockLevelAnimation = 2, siLockLevelManipulation = 4,
  siLockLevelNavigation = 8, siLockLevelAll = 0xffff
}
 

Levels of lock.

More...
enum   siLockType {
  siLockTypeNone = 0, siLockTypeSystem = 1, siLockTypeUser = 2, siLockTypeRefModel = 3,
  siLockTypeOverride = 4, siLockTypeAll = 0xffff
}
 

Type of lock owner.

More...
enum   siTags {
  siTagNone = 0, siTag1 = 1, siTag2 = 2, siTag3 = 4,
  siTag4 = 8, siTag5 = 16, siTag6 = 32, siTag7 = 64,
  siTag8 = 128, siTag9 = 256, siTag10 = 512, siTagAll = 0xffff
}
 

These are the different levels of tags.

More...
enum   siGeometryType { siNurbsSurfaceMesh = 0, siNurbsCurveList = 1, siPolygonMesh = 2, siPointCloud = 3 }
 

Type of geometry.

More...
enum   siBoundingVolume { siBoundingBox = 0 }
 

Types of bounding volumes.

More...
enum   siPortType { siPortInput = 0, siPortOutput = 1 }
 

Enumerates the different kinds of ports.

More...
enum   siModificationType {
  siModificationTypeNone = 0, siModificationTypeStaticPosition = 1, siModificationTypeFCurves = 2, siModificationTypeExpression = 4,
  siModificationTypeConstraints = 8, siModificationTypeAddProp = 16, siModificationTypeAnimMixer = 32, siModificationTypeGroup = 64,
  siModificationTypeInstance = 128, siModificationTypeOtherConnections = 256, siModificationTypeOperators = 512, siModificationTypeClusters = 1024,
  siModificationTypeClusterProperties = 2048, siModificationTypeAll = 65535
}
 

Type of modification on a referenced model.

More...
enum   siModificationMixerType {
  siModificationMixerNone = 0, siModificationMixerAnimation = 1, siModificationMixerShape = 2, siModificationMixerAudio = 4,
  siModificationMixerCache = 8, siModificationMixerTypeAll = 65535
}
 

Type of mixer modification on a referenced model.

More...
enum   siModelResolution { siModelResolutionOffLoaded = 0, siModelResolutionLowRes = 1, siModelResolutionMediumRes = 2, siModelResolutionHighRes = 3 }
 

Resolution description of a file for a referenced model.

More...
enum   siParameterScope { siInputParameters = 1, siAnimatedParameters = 2, siAllAnimatedParameters = 3 }
 

Type of parameters to gather from the input Object List.

More...
enum   siSequenceType { siMarkedParams = 1, siAnimParams = 2, siAllAnimParams = 3 }
 

Type of input objects for the Sequence feature.

More...
enum   siSequenceMode {
  siFCurves = 1, siFCurvesAnimationSources = 2, siFCurvesClips = 3, siAnimationSources = 4,
  siClips = 5
}
 

Mode to use for the Sequence feature.

More...
enum   siEffectInputType { siSelectedParams = 1, siAllParamsInClip = 2, siPoseOffsetClip = 3 }
 

Type of input objects for clip effect features.

More...
enum   siNeighborType {
  siAdjacent = 1, siGrow = 2, siNextCompo = 3, siPrevCompo = 4,
  siFirstCompo = 5, siLastCompo = 6
}
 

Types of neighboring for the deprecated Geometry_V1.

More...
enum   siNavigDirection {
  siNavigUp = 0, siNavigDown = 1, siNavigLeft = 2, siNavigRight = 3,
  siNavigFirst = 4, siNavigLast = 5
}
 

Modes for the SelectNeighborObj command.

More...
enum   siNavigationDirection {
  siParentNode = 1, siChildNode = 2, siNextNode = 3, siPreviousNode = 4,
  siFirstNode = 5, siLastNode = 6
}
 

Direction of the next Node.

More...
enum   siNavigationFilter {
  siNavigationFilterScene = 1, siNavigationFilter3DObject = 2, siNavigationFilterOperator = 3, siNavigationFilterPrimitive = 4,
  siNavigationFilterProperty = 5, siNavigationFilterCluster = 6, siNavigationFilterObjectSubElems = 7, siNavigationFilterGroup = 8,
  siNavigationFilterGenericComObject = 9, siNavigationFilterAll = 10, siNavigationFilterSame = 11
}
 

Direction of the next Node.

More...
enum   siNavigationSubFilter { siNavigationSubFilterAll = 0, siNavigationSubFilterSame = 1 }
 

Sub-type of node wanted.

More...
enum   siViewType {
  siNoView = 0, siViewUser = 1, siViewTop = 2, siViewLeft = 3,
  siViewRight = 4
}
 

Type of views.

More...
enum   si2DChainAlignType {
  si2DChainTop = 0, si2DChainFront = 1, si2DChainRight = 2, si2DChainNormalRadian = 3,
  si2DChainNormalDegree = 4
}
 

Defines the types of alignment used for creating a 2D chain.

More...
enum   siChainBoneType { siChainBoneUndefined = 0, siChainBonePin = 1, siChainBoneBallJoint = 2 }
 

Type of chain bones.

More...
enum   siConnectionType { siReadConnection = 1, siWriteConnection = 2, siReadWriteConnection = 3 }
 

Operator connection types.

More...
enum   siAxisType { siXAxis = 1, siYAxis = 2, siZAxis = 3 }
 

Bitmask for types of axes.

More...
enum   siKnotParameterization { siUniformParameterization = 0, siNonUniformParameterization = 1, siChordLengthParameterization = 2, siCentripetalParameterization = 3 }
 

Type of knot parameterization type for NurbsCurves.

More...
enum   siMappingRuleType { siConnectionMappingRule = 0, siValueMappingRule = 1 }
 

Types of mapping rules.

More...
enum   siNurbsDirection { siUDirection = 0, siVDirection = 1 }
 

Types of nurbs direction parameters.

More...
enum   siNurbsFormat { siSINurbs = 0, siIGESNurbs = 1 }
 

Types of nurbs format.

More...
enum   siInstallationPath {
  siProjectPath = 0, siUserPath = 1, siWorkgroupPath = 2, siFactoryPath = 3,
  siAddonPath = 4, siUserAddonPath = 5, siWorkgroupAddonPath = 6, siUnknownPath = 7,
  siCustomPath = 9
}
 

Installation path directories.

More...
enum   siShapeInstanceMode {
  siShapeInstanceOnlyMode = 0, siShapeMixedWeightMode = 1, siShapeTransitionMode = 2, siShapeTransitionCardinalMode = 3,
  siShapeBlendedWeightMode = 4
}
 

Shape key instantiation mode.

More...
enum   siShapeReferenceMode { siShapeLocalReferenceMode = 0, siShapeObjectReferenceMode = 1, siShapeAbsoluteReferenceMode = 2 }
 

Shape key reference mode.

More...
enum   siShapeContent { siShapeContentUseConstructionMode = 0, siShapeContentPrimaryShape = 1, siShapeContentSecondaryShape = 2, siShapeContentAllDeforms = 3 }
 

Indicates which deforms will be stored in the created shape.

More...
enum   siConstructionMode {
  siConstructionModeModeling = 0, siConstructionModePrimaryShape = 1, siConstructionModeAnimation = 2, siConstructionModeSecondaryShape = 3,
  siConstructionModeDefault = 4
}
 

The construction mode indicates the purpose of the deformations.

More...
enum   siResolutionPlane { siDefaultResolutionPlane = 0, siPreferredAxisPlane = 1, siUpVectorPlane = 2 }
 

Resolution Plane Type for Chain joints.

More...
enum   siTextureProjectionType {
  siTexturePlanarXY = 0, siTexturePlanarXZ = 1, siTexturePlanarYZ = 2, siTextureCylindrical = 3,
  siTextureSpherical = 4, siTextureSpatial = 5, siTextureCamera = 6, siTextureUV = 7,
  siTextureLollipop = 8, siTexturePureImplicit = 9
}
 

Texture creation type constants.

More...
enum   siUVTextureType {
  siUVTexturePlanarXY = 0, siUVTexturePlanarXZ = 1, siUVTexturePlanarYZ = 2, siUVTextureCylindrical = 3,
  siUVTextureSpherical = 4, siUVTextureSpatial = 5, siUVTextureLollipop = 6
}
 

UV generation type used by the texture operator, used only if siTextureProjectionType:siTextureUV is specified as the projection type.

More...
enum   siCapabilities {
  siAnimatable = 1, siReadOnly = 2, siPersistable = 4, siNotInspectable = 8,
  siSilent = 16, siNotPresetPersistable = 128, siTexturable = 256, siKeyable = 2048,
  siNonKeyableVisible = 4096
}
 

Determines the capabilities of a parameter.

More...
enum   siFCurveType {
  siUnknownFCurve = 0, siDefaultFCurve = 0, siBooleanFCurve = 10, siIntegerFCurve = 15,
  siStandardFCurve = 20, siRawDataFCurve = 30, siQuaternionFCurve = 40
}
 

Types of function curves (fcurves)

More...
enum   siFCurveExtrapolation { siConstantExtrapolation = 1, siLinearExtrapolation = 2, siPeriodicExtrapolation = 3, siPeriodicRelativeExtrapolation = 4 }
 

The extrapolation of an FCurve determines its shape before the first FCurveKey and after the last FCurveKey.

More...
enum   siFCurveKeyConstraint {
  siParameterConstraint = 1, siLeftRightValuesConstraint = 2, siG1ContinuousConstraint = 4, siLeftRightTangentDirectionConstraint = 8,
  siLeftRightTangentLengthConstraint = 16, siLockConstraint = 32, siHorizontalTangentConstraint = 64, siExtremumHorizontalTangentConstraint = 128,
  siZeroLengthTangentConstraint = 512, siSameLengthTangentConstraint = 1024, siNeighborTangentConstraint = 2048, siMirrorTangentConstraint = 4096,
  siAutoPlateauTangentConstraint = 8192, siAdjustedTangentConstraint = 8448
}
 

Function curve key constraints.

More...
enum   siFCurveKeyInterpolation { siDefaultKeyInterpolation = 0, siConstantKeyInterpolation = 1, siLinearKeyInterpolation = 2, siCubicKeyInterpolation = 3 }
 

Specifies the interpolation type for a specific key on an fcurve.

More...
enum   siFCurveKeySelectionMode { siSetKeySelection = 1, siAddToKeySelection = 2, siRemoveFromKeySelection = 3, siToggleKeySelection = 4 }
 

Specifies the mode for changing the FCurveKey selection.

More...
enum   siFCurveInterpolation { siDefaultInterpolation = 0, siConstantInterpolation = 1, siLinearInterpolation = 2, siCubicInterpolation = 3 }
 

The interpolation of an FCurve determines how values are evaluated between its FCurveKeys.

More...
enum   siFCurveSmoothFilterType { siFCurveAverageFilterType = 1, siFCurveGaussianFilterType = 2 }
 

Specifies the kind of filter used for smoothing function curves.

More...
enum   siUpdateContextState { siUpdateContextNormalEval = 0, siUpdateContextRenderEval = 1 }
 

Information on the context in which a plug-in is being evaluated.

More...
enum   siArgumentFlags { siArgumentInput = 2, siArgumentOutput = 4, siArgumentInputOutput = 6 }
 

Information on the direction of an argument indicating how it is passed to or from a command.

More...
enum   siCommandCategory {
  siImportCategory = 0, siExportCategory = 1, siSettingsCategory = 2, siHelpCategory = 3,
  siNoCategory = 4, siFCurveCategory = 5
}
 

Custom (v1.0) Commands can be defined from a pre-defined category.

More...
enum   siImportShareOptions {
  siImportShareOptionsNone = 0, siImportShareOptionsImageClips = 1, siImportShareOptionsMaterials = 2, siImportShareOptionsLayers = 4,
  siImportShareOptionsPartitions = 8, siImportShareOptionsAll = 0xffff
}
 

Defines the option flags when importing a model or merging a scene.

More...
enum   siEventID {
  siOnBeginNewScene = 542179328, siOnEndNewScene = 542179329, siOnBeginSceneOpen = 542179330, siOnEndSceneOpen = 542179331,
  siOnBeginSceneSave = 542179332, siOnEndSceneSave = 542179333, siOnBeginSceneSaveAs = 542179334, siOnEndSceneSaveAs = 542179335,
  siOnTerminate = 542179336, siOnSelectionChange = 542179337, siOnBeginFrame = 542179338, siOnEndFrame = 542179339,
  siOnBeginSequence = 542179340, siOnEndSequence = 542179341, siOnKeyUp = 542179342, siOnKeyDown = 542179343,
  siOnValueChange = 542179344, siOnTimeChange = 542179345, siOnWindowEvent = 542179346, siOnBeginFileExport = 542179347,
  siOnEndFileExport = 542179348, siOnBeginFileImport = 542179349, siOnEndFileImport = 542179350, siOnStartup = 542179351,
  siOnSourcePathChange = 542179352, siOnObjectAdded = 542179353, siOnObjectRemoved = 542179354, siOnTimer = 542179355,
  siOnBeginSceneSave2 = 542179356, siOnEndSceneSave2 = 542179357, siOnCloseScene = 542179358, siOnActivate = 542179359,
  siOnMaximize = 542179360, siOnMinimize = 542179361, siOnChangeProject = 542179362, siOnRefModelModSave = 542179363,
  siOnBeginRefModelModLoad = 542179364, siOnEndRefModelModLoad = 542179365, siOnCustomFileImport = 542179366, siOnCustomFileExport = 542179367,
  siOnDragAndDrop = 542179368, siOnBeginPassChange = 542179369, siOnEndPassChange = 542179370, siOnStartAnimation = 542179371,
  siOnStopAnimation = 542179372, siOnRefModelLoad = 542179373, siOnConnectShader = 542179374, siOnDisconnectShader = 542179375,
  siOnAddShaderPort = 542179376, siOnRemoveShaderPort = 542179377, siOnCreateShader = 542179378, siOnCreateShaderDef = 542179379,
  siOnCustomShaderExport = 542179380, siOnRenderAbort = 542179381, siOnEndCommand = 542181329, siOnBeginCommand = 542181331
}
 

This enumerator provides the identifiers for the Softimage events, they can be used for implementing C++ event handlers in order to identify the events fired by Softimage.

More...
enum   siSelectionChangeType { siAddedToSelection = 0, siRemovedFromSelection = 1 }
 

Specifies the type of operation performed to update the selection.

More...
enum   siRenderFieldType { siRenderFieldNone = 0, siRenderFieldOdd = 1, siRenderFieldEven = 2 }
 

Specifies the render field setting.

More...
enum   siRenderingType { siRenderSequence = 0, siRenderFramePreview = 1, siRenderEchoToMi = 2, siRenderExportArchive = 2 }
 

Specifies the type of rendering.

More...
enum   siRenderingErrorType { siRenderNoError = 0, siRenderAbort = 1, siRenderFailure = 2 }
 

Specifies the type of rendering error.

More...
enum   siSubdivisionRuleType { siCatmullClark = 0, siXSIDooSabin = 2, siLinearSubdivision = 3 }
 

Specifies the subdivision rule used for an approximated geometry selection.

More...
enum   siNavigateComponentType { siNextComponent = 0, siPreviousComponent = 1, siFirstComponent = 2, siLastComponent = 3 }
 

Direction type for navigating geometry components.

More...
enum   siParticleRenderType { siBillboardType = 0, siSphereType = 1, siBlobType = 2 }
 

Enumeration of particle render types.

More...
enum   siFCurveEditorAttribute { siRegionStartFrame = 0, siRegionEndFrame = 1, siRegionMin = 2, siRegionMax = 3 }
 

Enumeration of the different attributes that are available on the FCurveEditor object.

More...
enum   siSeverityType {
  siFatalMsg = 1, siErrorMsg = 2, siWarningMsg = 4, siInfoMsg = 8,
  siVerboseMsg = 16, siCommentMsg = 32
}
 

Determines the severity types of a message implemented with the C++ API.

More...
enum   siCustomCompiledOpFlags { siDLLLoadingUnloading = 1 }
 

Information which is passed to the custom compiled operators through its Init and Term functions.

More...
enum   siChannelAction { siChannelActionNone = 0, siChannelActionDrive = 1, siChannelActionCommand = 2, siChannelActionSpecial = 3 }
 

A device driver contains a set of channels that can be configured.

More...
enum   siSelectMode {
  siSelectDefault = 0, siSelectNode = 1, siSelectBranch = 2, siSelectTree = 3,
  siSelectModel = 4
}
 

Specifies how to select objects in a hierarchy.

More...
enum   siTransientExplorerFilter {
  siSEFilterAllNodes = 0, siSEFilterAllNodesNoParams = 1, siSEFilterGeometryOperators = 2, siSEFilterObjectsOnly = 3,
  siSEFilterAllProperties = 4, siSEFilterPropertiesAndPrimitives = 5, siSEFilterMaterialsAndShaders = 6, siSEFilterModelsOnly = 7,
  siSEFilterGroupsOnly = 8, siSEFilterImageClips = 9
}
 

Specifies the filter to use in a transient explorer.

More...
enum   siClassID {
  siObjectID = 0, siUnknownClassID = 0, siSIObjectID = 1, siOGLMaterialID = 2,
  siOGLTextureID = 3, siOGLLightID = 4, siApplicationID = 5, siArgumentID = 6,
  siCommandID = 7, siClipID = 8, siShapeClipID = 9, siSubComponentID = 10,
  siFacetID = 11, siNurbsSurfaceID = 12, siPointID = 13, siControlPointID = 14,
  siNurbsCurveControlPointID = 15, siNurbsCurveListControlPointID = 16, siNurbsSurfaceControlPointID = 17, siNurbsCurveID = 18,
  siSampleID = 19, siNurbsSampleID = 20, siPolygonNodeID = 21, siGeometryID = 22,
  siNurbsSurfaceMeshID = 23, siNurbsCurveListID = 24, siPolygonMeshID = 25, siSegmentID = 26,
  siConnectionPointID = 27, siConstructionHistoryID = 28, siDictionaryID = 29, siEventInfoID = 30,
  siFCurveID = 31, siNestedFCurveID = 32, siFCurveKeyID = 33, siFileBrowserID = 34,
  siImageID = 35, siMappedItemID = 36, siPortID = 37, siInputPortID = 38,
  siSelectionID = 39, siStaticSourceID = 40, siTriangleID = 41, siTriangleVertexID = 42,
  siUpdateContextID = 43, siParameterID = 44, siCompoundParameterID = 45, siProjectID = 46,
  siProjectItemID = 47, siActionSourceID = 48, siExpressionID = 49, siImageClipID = 50,
  siSceneID = 51, siShaderID = 52, siOperatorID = 53, siEnvelopeID = 54,
  siPrimitiveID = 55, siParticleCloudPrimitiveID = 56, siPropertyID = 57, siClusterPropertyID = 58,
  siConstraintID = 59, siConstraintWithUpVectorID = 60, siCustomPropertyID = 61, siJointID = 62,
  siKinematicsID = 63, siMaterialID = 64, siStaticKinematicStateID = 65, siSceneItemID = 66,
  siClusterID = 67, siGroupID = 68, siLayerID = 69, siPassID = 70,
  siUserGroupID = 71, siX3DObjectID = 72, siParticleCloudID = 73, siModelID = 74,
  siChainElementID = 75, siChainRootID = 76, siChainBoneID = 77, siChainEffectorID = 78,
  siDirectedID = 79, siCameraID = 80, siLightID = 81, siNullID = 82,
  siRigID = 83, siCameraRigID = 84, siLightRigID = 85, siKinematicStateID = 86,
  siTrackID = 87, siUserDataMapID = 88, siFxTreeID = 89, siFxOperatorID = 90,
  siTriangleCollectionID = 91, siTriangleVertexCollectionID = 92, siSampleCollectionID = 93, siPolygonNodeCollectionID = 94,
  siPointCollectionID = 95, siFacetCollectionID = 97, siVertexID = 98, siVertexCollectionID = 99,
  siEdgeID = 100, siEdgeCollectionID = 101, siPolygonFaceID = 102, siPolygonFaceCollectionID = 103,
  siDataSourceID = 104, siAnimationSourceID = 105, siOutputPortID = 106, siProxyParameterID = 107,
  siDeviceCollectionID = 108, siDeviceID = 109, siChannelID = 110, siKnotCollectionID = 111,
  siControlPointCollectionID = 112, siNurbsCurveCollectionID = 113, siNurbsSurfaceCollectionID = 114, siNurbsSampleCollectionID = 115,
  siTextureID = 116, siUserDataBlobID = 117, siParticleID = 118, siAddonID = 119,
  siPPGLayoutID = 120, siPPGItemID = 121, siPreferencesID = 122, siParticleTypeID = 123,
  siParticleAttributeID = 124, siGridDataID = 125, siTextureLayerID = 126, siTextureLayerPortID = 127,
  siCustomOperatorID = 128, siPortGroupID = 129, siDesktopID = 130, siLayoutID = 131,
  siUIObjectID = 132, siUIPersistableID = 133, siViewID = 134, siArrayParameterID = 135,
  siViewContextID = 137, siContextID = 138, siPPGEventContextID = 139, siClipEffectID = 140,
  siClipEffectItemID = 141, siShapeKeyID = 142, siSourceID = 143, siTimeControlID = 144,
  siTransitionID = 145, siAnimationSourceItemID = 146, siClipContainerID = 147, siArgumentHandlerID = 148,
  siMenuID = 149, siMenuItemID = 150, siPluginID = 151, siPluginItemID = 152,
  siPluginRegistrarID = 153, siFilterID = 154, siUIToolkitID = 155, siProgressBarID = 156,
  siParamDefID = 157, siFactoryID = 158, siCommandCollectionID = 159, siArgumentCollectionID = 160,
  siGraphicSequencerContextID = 161, siClipRelationID = 162, siMixerID = 163, siLibraryID = 164,
  siSimulationEnvironmentID = 165, siGridWidgetID = 166, siGeometryAccessorID = 167, siEnvelopeWeightID = 168,
  siMeshBuilderID = 169, siSegmentCollectionID = 170, siFileReferenceID = 171, siClusterPropertyBuilderID = 172,
  siMaterialLibraryID = 173, siHairPrimitiveID = 174, siRenderHairAccessorID = 175, siPointLocatorDataID = 176,
  siCollectionItemID = 177, siOperatorContextID = 178, siPointCloudID = 179, siRigidBodyAccessorID = 180,
  siRigidConstraintAccessorID = 181, siDeltaID = 182, siActionDeltaID = 183, siActionDeltaItemID = 184,
  siTimerEventID = 185, siPassContainerID = 186, siRenderChannelID = 187, siSceneRenderPropertyID = 188,
  siFramebufferID = 189, siRendererContextID = 190, siRendererID = 191, siTimeTransportID = 192,
  siTimeTransportContextID = 193, siICENodeID = 194, siICECompoundNodeID = 195, siICENodePortID = 196,
  siICETreeID = 197, siICENodeContainerID = 198, siICENodeInputPortID = 199, siICENodeOutputPortID = 200,
  siICEDataProviderNodeID = 201, siICEDataModifierNodeID = 202, siICENodeDefID = 203, siICENodeContextID = 204,
  siICEAttributeID = 205, siPartitionID = 206, siOverrideID = 207, siHardwareShaderContextID = 208,
  siValueMapID = 209, siShaderParamDefID = 210, siShaderParamDefOptionsID = 211, siShaderballOptionsID = 212,
  siShaderParamDefContainerID = 213, siMetaShaderRendererDefID = 214, siShaderDefID = 215, siShaderStructParamDefID = 216,
  siShaderArrayParamDefID = 217, siShaderParameterID = 218, siShaderArrayItemParameterID = 219, siShaderArrayParameterID = 220,
  siShaderCompoundParameterID = 221, siRenderTreeNodeID = 222, siShaderBaseID = 223, siShaderContainerID = 224,
  siShaderCompoundID = 225, siShaderCommentID = 226, siShaderDefManagerID = 227, siHardwareSurfaceID = 228,
  siGraphicDriverID = 229, siHairGeometryID = 230, siPointCloudGeometryID = 231, siSchematicNodeID = 232,
  siSchematicID = 233, siSchematicNodeCollectionID = 234, siUVPropertyID = 235, siToolContextID = 236,
  siPickBufferID = 237
}
 

The class ID of Softimage objects.

More...
enum   siBlendInPresetModes { siBlendInPreset = 0, siReplaceAndBlendInPreset = 1, siReplaceNoBlend = 2 }
 

This enumeration type specifies how the BlendInPresets command will apply the new shaders to the parameters selected by the command.

More...
enum   siBlendInTextureLayersModes { siBlendInTextureLayers = 0, siReplaceAndBlendInTextureLayers = 1, siReplaceAndNoBlendInTextureLayers = 2 }
 

This enumeration type specifies how the texture-layer blending commands will apply the new shaders to the parameters selected by the command.

More...
enum   siShaderCnxPointType { siShaderCnxPointNone = 0, siShaderCnxPointBasePorts = 1, siShaderCnxPointTextureLayerPorts = 2, siShaderCnxPointAll = 65535 }
 

This enumeration type specifies what kind of shader port connections you are interested in when using the RemoveAllShadersFromCnxPoint command.

More...
enum   siAddonItemType {
  siLayoutAddonItemType = 1, siToolbarAddonItemType = 2, siKeyMapAddonItemType = 3, siScriptCmdAddonItemType = 4,
  siPresetAddonItemType = 5, siSpdlAddonItemType = 6, siLibraryAddonItemType = 7, siOtherAddonItemType = 8,
  siEventAddonItemType = 9, siDeviceAddonItemType = 10, siShelfAddonItemType = 11, siPluginAddonItemType = 12,
  siHelpAddonItemType = 13, siViewAddonItemType = 14
}
 

This enumeration type specifies the type of item supported by add-ons.

More...
enum   siGridWidgetColumnType { siColumnStandard = 0, siColumnBool = 1, siColumnCombo = 2 }
 

Types of Columns supported by siControlGrid (see siPPGControlTypeand GridData.SetColumnType)

More...
enum   siGridSelectionMode { siSelectionCell = 0, siSelectionHeader = 1, siSelectionNone = 2 }
 

Selection Mode for the cells of the GridWidget, see siUIGridSelectionMode in siPPGItemAttribute.

More...
enum   siTxtContourStretchingMethod { siContourStretchingWalkingOnMesh = 0, siContourStretchingSpatialDistance = 1, siContourStretchingReqularQuads = 2, siContourStretchingProjectionOnSurface = 3 }
 

Polygon cluster contour stretching method used to generate texture coordinates as part of the GenerateUVSetByContourStretching and ModifyUVSetByContourStretching commands.

More...
enum   siExplorerScope {
  siExplorerScopeDefault = 0, siExplorerScopeProject = 1, siExplorerScopePreferences = 2, siExplorerScopeScene = 3,
  siExplorerScopeLayers = 4, siExplorerScopePasses = 5, siExplorerScopeEnvironments = 6, siExplorerScopeParTypes = 7,
  siExplorerScopeSelection = 8, siExplorerScopeCustom = 9, siExplorerScopeCurrentLayer = 10, siExplorerScopeCurrentPass = 11,
  siExplorerScopeCurrentEnvironment = 12, siExplorerScopeCurrentParType = 13, siExplorerScopeSourcesClips = 14, siExplorerScopeSourcesClipsAnimation = 15,
  siExplorerScopeSourcesClipsAudio = 16, siExplorerScopeSourcesClipsImages = 17, siExplorerScopeSourcesClipsMaterials = 18, siExplorerScopeSourcesClipsModels = 19,
  siExplorerScopeCommands = 20
}
 

The list of scopes supported by the Scene Explorer.

More...
enum   siTimeState {
  siTimeStateNull = 0, siTimeStateStop = 0x1, siTimeStatePreStop = 0x2, siTimeStatePlay = 0x4,
  siTimeStatePrePlay = 0x8, siTimeStateRecord = 0x10, siTimeStatePreRecord = 0x20, siTimeStateFast = 0x40,
  siTimeStatePreFast = 0x80, siTimeStatePreRoll = 0x100, siTimeStateStep = 0x200, siTimeStatePostStep = 0x400,
  siTimeStatePause = 0x800, siTimeStatePrePause = 0x1000, siTimeStateSeek = 0x2000, siTimeNotifyTime = 0x4000,
  siTimeNotifyScrub = 0x10000, siTimeNotifySeek = 0x20000, siTimeNotifyPortChange = 0x40000, siTimeNotifyFrameDrop = 0x80000
}
 

States for the time change notification CTimeChangeNotificationfor Custom Displays.

More...
enum   siDisplayCallback {
  siUndefined = 0, siPreBeginFrame = 1, siBeginFrame = 2, siPostBeginFrame = 3,
  siPrePass = 4, siPass = 5, siPostPass = 6, siPreEndFrame = 7,
  siEndFrame = 8, siPostEndFrame = 9, siRenderFrame = 10
}
 

Types of display callbacks defined for the Graphic Sequencer.

More...
enum   siXGSClassType { siXGSPluginManager = 0 }
 

Type of object passed to an Open Graphic Sequencer callback.

More...
enum   siXGSFlag { siInactive = 0, siActive = 1 }
 

Flags for Graphic Sequencer callbacks.

More...
enum   siXGSPassFlag { siInsertBefore = 0, siInsertAfter = 1, siInsertBeforeAll = 2, siInsertAfterAll = 3 }
 

Pass flags for Graphic Sequencer callbacks.

More...
enum   siXGSStateType {
  siXGSUnknown = 0, siXGSInteger = 1, siXGSFloat = 2, siXGSHandle = 3,
  siXGSVector4 = 4, siXGSMatrix4 = 5
}
 

XGS state types defined for the Graphic Sequencer.

More...
enum   siViewMode {
  siAll = 0, siBoundingBoxMode = 12, siWireframe = 13, siDepthCue = 14,
  siHiddenLineRemoval = 15, siConstant = 16, siShaded = 17, siTextured = 18,
  siTexturedDecal = 19, siCustom = 20, siRealtimePortMaterial = 21
}
 

Viewport display modes used by the CGraphicSequencer classfor the Graphic Sequencer.

More...
enum   siParticleAttributeType {
  siPAVector4 = 0, siPAVector3 = 1, siPAFloat = 2, siPAInt = 3,
  siPAULong = 4, siPAUShort = 5, siPABool = 6, siPAUndefined = 7
}
 

The available types for user defined per particle ParticleAttribute.

More...
enum   siAssetStorageType {
  siAssetStorageTypeInternal = 0, siAssetStorageTypeExternalDotXSIBin = 1, siAssetStorageTypeExternalDotXSIText = 2, siAssetStorageTypeExternalBin = 3,
  siAssetStorageTypeExternalXSIA = 4
}
 

This is the enumeration of the different ways an asset in Softimage can be stored.

More...
enum   siSourceStorageType { siSourceStorageTypeInternal = 0, siSourceStorageTypeExternalDotXSIBin = 1, siSourceStorageTypeExternalDotXSIText = 2, siSourceStorageTypeExternalBin = 3 }
 

This enum has been replaced by siAssetStorageType.

More...
enum   siAssetStatus { siAssetStatusOffloaded = 0, siAssetStatusPartiallyLoaded = 1, siAssetStatusLoaded = 2 }
 

This is an enumeration of how an asset in Softimage can be treated when stored externally.

More...
enum   siActionStatus { siActionStatusOffloaded = 0, siActionStatusPartiallyLoaded = 1, siActionStatusLoaded = 2 }
 

This enum has been replaced by siAssetStatus.

More...
enum   siFilterType {
  siFilterUndefined = 0, siFilterObject = 1, siFilter3DObject = 2, siFilterProperty = 3,
  siFilterSubComponentEdge = 4, siFilterSubComponentPoint = 5, siFilterSubComponentPolygon = 6, siFilterSubComponentKnot = 7
}
 

Specifies the different type of filters that are used for implementing and categorizing custom Filters.

More...
enum   siCommandCapabilities { siSupportsKeyAssignment = 8, siCannotBeUsedInBatch = 256, siNoLogging = 8388608, siAllowNotifications = 1073741824 }
 

Determines the capabilities of a command.

More...
enum   siSeverity {
  siFatal = 1, siError = 2, siWarning = 4, siInfo = 8,
  siVerbose = 16, siComment = 32
}
 

Determines the severity types of a message implemented in a scripting language.

More...
enum   siMsgBoxFlags {
  siMsgOkOnly = 0, siMsgOkCancel = 1, siMsgAbortRetryIgnore = 2, siMsgYesNoCancel = 3,
  siMsgYesNo = 4, siMsgRetryCancel = 5, siMsgCritical = 16, siMsgQuestion = 32,
  siMsgExclamation = 48, siMsgInformation = 64, siMsgDefaultButton1 = 0, siMsgDefaultButton2 = 256,
  siMsgDefaultButton3 = 512
}
 

Flags values supported by the XSIUIToolkit.MsgBox command.

More...
enum   siMsgButtonPressed {
  siMsgOk = 1, siMsgCancel = 2, siMsgAbort = 3, siMsgRetry = 4,
  siMsgIgnore = 5, siMsgYes = 6, siMsgNo = 7
}
 

Return values from XSIUIToolkit.MsgBox that indicates which button was pressed by the user.

More...
enum   siViewState { siNormal = 0, siClosed = 1, siMinimized = 2 }
 

Specifies the view state information of the View object, such as whether the view is closed, whether the view is minimized, and whether the view is in a normal state.

More...
enum   siToolbarControl {
  siTBCtrlBlankSeparator = 0, siTBCtrlGroupHeader = 1, siTBCtrlLineBreak = 2, siTBCtrlMenu = 3,
  siTBCtrlPreset = 4, siTBCtrlLineSeparator = 5
}
 

Types of toolbar controls to use when building a toolbar.

More...
enum   siTimeReferenceType { siOriginalClip = 0, siExtrapolatedClip = 1 }
 

Specifies the type of time applicability of a ClipEffect on a Clip.

More...
enum   siImageRatio {
  siImageRatio1x1 = 0, siImageRatio2x1 = 1, siImageRatio4x1 = 2, siImageRatio8x1 = 3,
  siImageRatio16x1 = 4, siImageRatioThumbnail = 5
}
 

Specifies a reduction to apply to an image.

More...
enum   siTimeControlExtrapolationType { siTimeControlExtrapolationNone = 0, siTimeControlExtrapolationHold = 1, siTimeControlExtrapolationCycle = 2, siTimeControlExtrapolationBounce = 3 }
 

The siTimeControlExtrapolationType determines how a Clip contributes to the animation outside of the frames on which it is defined.

More...
enum   siMenuItemStyle {
  siMenuItemUndefined = 0, siMenuItem = ( siMenuItemUndefined + 1 ), siMenuItemSubmenu = ( siMenuItem + 1 ), siMenuItemSeparator = ( siMenuItemSubmenu + 1 ),
  siMenuItemSection = ( siMenuItemSeparator + 1 )
}
 

Specifies the style of a menu item.

More...
enum   siMenuAnchorPoints {
  siMenuUndefinedID = 0, siMenuTbGetPrimitiveCurveID = 1, siMenuTbGetPrimitivePolygonMeshBasicID = ( siMenuTbGetPrimitiveCurveID + 1 ), siMenuTbGetPrimitivePolygonMeshHedronID = ( siMenuTbGetPrimitivePolygonMeshBasicID + 1 ),
  siMenuTbGetPrimitivePolygonMeshID = ( siMenuTbGetPrimitivePolygonMeshHedronID + 1 ), siMenuTbGetPrimitiveSurfaceID = ( siMenuTbGetPrimitivePolygonMeshID + 1 ), siMenuTbGetPrimitiveImplicitCurveID = ( siMenuTbGetPrimitiveSurfaceID + 1 ), siMenuTbGetPrimitiveImplicitID = ( siMenuTbGetPrimitiveImplicitCurveID + 1 ),
  siMenuTbGetPrimitiveControlObjectID = ( siMenuTbGetPrimitiveImplicitID + 1 ), siMenuTbGetPrimitiveModelID = ( siMenuTbGetPrimitiveControlObjectID + 1 ), siMenuTbGetPrimitiveID = ( siMenuTbGetPrimitiveModelID + 1 ), siMenuTbGetCameraID = ( siMenuTbGetPrimitiveID + 1 ),
  siMenuTbGetLightID = ( siMenuTbGetCameraID + 1 ), siMenuTbGetMaterialID = ( siMenuTbGetLightID + 1 ), siMenuTbGetMaterialBasicID = ( siMenuTbGetMaterialID + 1 ), siMenuTbGetMaterialSimpleID = ( siMenuTbGetMaterialBasicID + 1 ),
  siMenuTbGetMaterialRealTimeID = ( siMenuTbGetMaterialSimpleID + 1 ), siMenuTbGetPropertyID = ( siMenuTbGetMaterialRealTimeID + 1 ), siMenuTbGetPropertyTextureProjectionID = ( siMenuTbGetPropertyID + 1 ), siMenuTbGetPropertyTextureMapID = ( siMenuTbGetPropertyTextureProjectionID + 1 ),
  siMenuTbGetPropertyTextureID = ( siMenuTbGetPropertyTextureMapID + 1 ), siMenuTbGetPropertyUserDataMapID = ( siMenuTbGetPropertyTextureID + 1 ), siMenuTbGetPropertyMapPaintID = ( siMenuTbGetPropertyUserDataMapID + 1 ), siMenuTbGetPropertyPSetID = ( siMenuTbGetPropertyMapPaintID + 1 ),
  siMenuTbDeformSpatialID = ( siMenuTbGetPropertyPSetID + 1 ), siMenuTbDeformID = ( siMenuTbDeformSpatialID + 1 ), siMenuTbCreateSkeletonID = ( siMenuTbDeformID + 1 ), siMenuTbCreateSkeletonDrawID = ( siMenuTbCreateSkeletonID + 1 ),
  siMenuTbCreateSkeletonInspectID = ( siMenuTbCreateSkeletonDrawID + 1 ), siMenuTbModelCreateCurveID = 100, siMenuTbModelCreateSurfaceMeshID = ( siMenuTbModelCreateCurveID + 1 ), siMenuTbModelCreatePolygonMeshID = ( siMenuTbModelCreateSurfaceMeshID + 1 ),
  siMenuTbModelCreateModelID = ( siMenuTbModelCreatePolygonMeshID + 1 ), siMenuTbModelCreateTextID = ( siMenuTbModelCreateModelID + 1 ), siMenuTbModelModifyComponentID = ( siMenuTbModelCreateTextID + 1 ), siMenuTbModelModifyCurveID = ( siMenuTbModelModifyComponentID + 1 ),
  siMenuTbModelModifySurfaceMeshID = ( siMenuTbModelModifyCurveID + 1 ), siMenuTbModelModifyPolygonMeshID = ( siMenuTbModelModifySurfaceMeshID + 1 ), siMenuTbModelModifyModelID = ( siMenuTbModelModifyPolygonMeshID + 1 ), siMenuTbAnimateCreateParameterID = 200,
  siMenuTbAnimateCreateParameterCustomPSetID = ( siMenuTbAnimateCreateParameterID + 1 ), siMenuTbAnimateCreateParameterCustomParamID = ( siMenuTbAnimateCreateParameterCustomPSetID + 1 ), siMenuTbAnimateCreateParameterExpressionID = ( siMenuTbAnimateCreateParameterCustomParamID + 1 ), siMenuTbAnimateCreateParameterProxyID = ( siMenuTbAnimateCreateParameterExpressionID + 1 ),
  siMenuTbAnimateCreateCurveID = ( siMenuTbAnimateCreateParameterProxyID + 1 ), siMenuTbAnimateCreatePathID = ( siMenuTbAnimateCreateCurveID + 1 ), siMenuTbAnimateCreateCharacterID = ( siMenuTbAnimateCreatePathID + 1 ), siMenuTbAnimateDeformShapeID = ( siMenuTbAnimateCreateCharacterID + 1 ),
  siMenuTbAnimateDeformShapeKeyID = ( siMenuTbAnimateDeformShapeID + 1 ), siMenuTbAnimateDeformEnvelopeID = ( siMenuTbAnimateDeformShapeKeyID + 1 ), siMenuTbAnimateActionsStoreID = ( siMenuTbAnimateDeformEnvelopeID + 1 ), siMenuTbAnimateActionsApplyID = ( siMenuTbAnimateActionsStoreID + 1 ),
  siMenuTbAnimateActionsTemplatesID = ( siMenuTbAnimateActionsApplyID + 1 ), siMenuTbAnimateToolsPlotID = ( siMenuTbAnimateActionsTemplatesID + 1 ), siMenuTbAnimateToolsDevicesID = ( siMenuTbAnimateToolsPlotID + 1 ), siMenuTbAnimateToolsImportID = ( siMenuTbAnimateToolsDevicesID + 1 ),
  siMenuTbAnimateToolsExportID = ( siMenuTbAnimateToolsImportID + 1 ), siMenuTbAnimateToolsMotorID = ( siMenuTbAnimateToolsExportID + 1 ), siMenuTbRenderRegionID = 300, siMenuTbRenderPreviewID = ( siMenuTbRenderRegionID + 1 ),
  siMenuTbRenderRenderID = ( siMenuTbRenderPreviewID + 1 ), siMenuTbRenderExportMIID = ( siMenuTbRenderRenderID + 1 ), siMenuTbRenderPassEditID = ( siMenuTbRenderExportMIID + 1 ), siMenuTbRenderPassEditNewPassID = ( siMenuTbRenderPassEditID + 1 ),
  siMenuTbRenderPassPartitionID = ( siMenuTbRenderPassEditNewPassID + 1 ), siMenuTbRenderExportID = ( siMenuTbRenderPassPartitionID + 1 ), siMenuTbICEParticlesCreateID = 320, siMenuTbICEParticlesOnEmissionID = ( siMenuTbICEParticlesCreateID + 1 ),
  siMenuTbICEParticlesAfterEmissionID = ( siMenuTbICEParticlesOnEmissionID + 1 ), siMenuTbICEParticlesForceID = ( siMenuTbICEParticlesAfterEmissionID + 1 ), siMenuTbICEParticlesCollisionID = ( siMenuTbICEParticlesForceID + 1 ), siMenuTbICEParticlesSimulationID = ( siMenuTbICEParticlesCollisionID + 1 ),
  siMenuTbICEParticlesModelLibraryID = ( siMenuTbICEParticlesSimulationID + 1 ), siMenuTbICEDeformCreateID = 340, siMenuTbICEDeformSimulateID = ( siMenuTbICEDeformCreateID + 1 ), siMenuTbICEKinematicsEffectsID = 360,
  siMenuTbICEKinematicsConstrainID = ( siMenuTbICEKinematicsEffectsID + 1 ), siMenuTbGetForceID = 400, siMenuTbCreateParticlesID = ( siMenuTbGetForceID + 1 ), siMenuTbCreateParticlesFluidID = ( siMenuTbCreateParticlesID + 1 ),
  siMenuTbCreateParticlesExplosionID = ( siMenuTbCreateParticlesFluidID + 1 ), siMenuTbCreateParticlesNewPTypeID = ( siMenuTbCreateParticlesExplosionID + 1 ), siMenuTbCreateRigidBodyID = ( siMenuTbCreateParticlesNewPTypeID + 1 ), siMenuTbCreateRigidBodyConstraintID = ( siMenuTbCreateRigidBodyID + 1 ),
  siMenuTbCreateClothID = ( siMenuTbCreateRigidBodyConstraintID + 1 ), siMenuTbModifyParticlesID = ( siMenuTbCreateClothID + 1 ), siMenuTbModifyRigidBodyID = ( siMenuTbModifyParticlesID + 1 ), siMenuTbModifyEnvironmentID = ( siMenuTbModifyRigidBodyID + 1 ),
  siMenuTbCreateSoftBodyID = ( siMenuTbModifyEnvironmentID + 1 ), siMenuTbICECreateID = ( siMenuTbCreateSoftBodyID + 1 ), siMenuTbICEEditID = ( siMenuTbICECreateID + 1 ), siMenuMainFileSceneID = 1000,
  siMenuMainFileProjectID = ( siMenuMainFileSceneID + 1 ), siMenuMainFileExportID = ( siMenuMainFileProjectID + 1 ), siMenuMainFileImportID = ( siMenuMainFileExportID + 1 ), siMenuMainWindowID = ( siMenuMainFileImportID + 1 ),
  siMenuMainHelpID = ( siMenuMainWindowID + 1 ), siMenuMainApplicationID = ( siMenuMainHelpID + 1 ), siMenuMainApplicationPropertySetsID = ( siMenuMainApplicationID + 1 ), siMenuMainApplicationLayoutsID = ( siMenuMainApplicationPropertySetsID + 1 ),
  siMenuMainApplicationViewsID = ( siMenuMainApplicationLayoutsID + 1 ), siMenuMainApplicationToolbarsID = ( siMenuMainApplicationViewsID + 1 ), siMenuMainApplicationCommandsID = ( siMenuMainApplicationToolbarsID + 1 ), siMenuMainApplicationKeyMappingsID = ( siMenuMainApplicationCommandsID + 1 ),
  siMenuMainApplicationPreferencesID = ( siMenuMainApplicationKeyMappingsID + 1 ), siMenuMainTopLevelID = ( siMenuMainApplicationPreferencesID + 1 ), siMenuMainFileCrosswalkID = ( siMenuMainTopLevelID + 1 ), siMenuMCPSelectTopID = 2000,
  siMenuMCPSelectBottomID = ( siMenuMCPSelectTopID + 1 ), siMenuMCPSelectExploreBtnID = ( siMenuMCPSelectBottomID + 1 ), siMenuMCPSelectSelBtnContextID = ( siMenuMCPSelectExploreBtnID + 1 ), siMenuMCPTransformTopID = ( siMenuMCPSelectSelBtnContextID + 1 ),
  siMenuMCPTransformBottomID = ( siMenuMCPTransformTopID + 1 ), siMenuMCPSnapID = ( siMenuMCPTransformBottomID + 1 ), siMenuMCPConstrainID = ( siMenuMCPSnapID + 1 ), siMenuMCPEditID = ( siMenuMCPConstrainID + 1 ),
  siMenuMCPAnimationID = ( siMenuMCPEditID + 1 ), siMenuMCPPlaybackID = ( siMenuMCPAnimationID + 1 ), siMenuVMViewTypeID = 3000, siMenuVMCameraID = ( siMenuVMViewTypeID + 1 ),
  siMenuVMVisibilityID = ( siMenuVMCameraID + 1 ), siMenuVMDisplayID = ( siMenuVMVisibilityID + 1 ), siMenu3DViewClusterContextID = 3100, siMenu3DViewComponentContextID = ( siMenu3DViewClusterContextID + 1 ),
  siMenu3DViewComponentEditContextID = ( siMenu3DViewComponentContextID + 1 ), siMenu3DViewGeneralContextID = ( siMenu3DViewComponentEditContextID + 1 ), siMenu3DViewObjectContextID = ( siMenu3DViewGeneralContextID + 1 ), siMenu3DViewObjectEditContextID = ( siMenu3DViewObjectContextID + 1 ),
  siMenu3DViewObjectGroupContextID = ( siMenu3DViewObjectEditContextID + 1 ), siMenu3DViewObjectMeshContextID = ( siMenu3DViewObjectGroupContextID + 1 ), siMenu3DViewObjectSelectContextID = ( siMenu3DViewObjectMeshContextID + 1 ), siMenuSEGeneralContextID = 3200,
  siMenuSELayersContextID = ( siMenuSEGeneralContextID + 1 ), siMenuSEPassesContextID = ( siMenuSELayersContextID + 1 ), siMenuSEPartitionsContextID = ( siMenuSEPassesContextID + 1 ), siMenuSEObjectContextID = ( siMenuSEPartitionsContextID + 1 ),
  siMenuSEGroupContextID = ( siMenuSEObjectContextID + 1 ), siMenuSEAnimContextID = ( siMenuSEGroupContextID + 1 ), siMenuSEClusterContextID = ( siMenuSEAnimContextID + 1 ), siMenuSEOperatorContextID = ( siMenuSEClusterContextID + 1 ),
  siMenuSEConstraintContextID = ( siMenuSEOperatorContextID + 1 ), siMenuSEPreferenceContextID = ( siMenuSEConstraintContextID + 1 ), siMenuSEMaterialContextID = ( siMenuSEPreferenceContextID + 1 ), siMenuSEModelContextID = ( siMenuSEMaterialContextID + 1 ),
  siMenuPluginMgrPluginFileID = 3300, siMenuPluginMgrTreeFileID = ( siMenuPluginMgrPluginFileID + 1 ), siMenuPluginMgrContextPluginID = ( siMenuPluginMgrTreeFileID + 1 ), siMenuPluginMgrContextPluginLocationID = ( siMenuPluginMgrContextPluginID + 1 ),
  siMenuPluginMgrContextUserRootID = ( siMenuPluginMgrContextPluginLocationID + 1 ), siMenuPluginMgrContextFactoryRootID = ( siMenuPluginMgrContextUserRootID + 1 ), siMenuPluginMgrContextWorkgroupRootID = ( siMenuPluginMgrContextFactoryRootID + 1 ), siMenuPluginMgrContextAddonID = ( siMenuPluginMgrContextWorkgroupRootID + 1 ),
  siMenuPluginMgrContextCustomLocationID = ( siMenuPluginMgrContextAddonID + 1 ), siMenuPluginMgrSPDLFileID = ( siMenuPluginMgrContextCustomLocationID + 1 ), siMenuPluginMgrContextSPDLID = ( siMenuPluginMgrSPDLFileID + 1 ), siMenuPluginMgrContextSPDLLocationID = ( siMenuPluginMgrContextSPDLID + 1 ),
  siMenuPluginMgrContextPluginItemID = ( siMenuPluginMgrContextSPDLLocationID + 1 ), siMenuPluginMgrContextViewLocationID = ( siMenuPluginMgrContextPluginItemID + 1 ), siMenuPluginMgrContextViewID = ( siMenuPluginMgrContextViewLocationID + 1 ), siMenuPluginMgrContextToolbarLocationID = ( siMenuPluginMgrContextViewID + 1 ),
  siMenuPluginMgrContextToolbarID = ( siMenuPluginMgrContextToolbarLocationID + 1 ), siMenuWorkgroupMgrFileID = 3350, siMenuWorkgroupMgrContextID = ( siMenuWorkgroupMgrFileID + 1 ), siMenuScriptEditContextID = 3400,
  siMenuScriptHistoryContextID = 3401, siMenuPropertyPageContextID = 3600, siMenuPropertyPageAnimContextID = ( siMenuPropertyPageContextID + 1 ), siMenuShapeManagerEditID = 3700,
  siMenuShapeManagerCreateContextSingleSelectionID = ( siMenuShapeManagerEditID + 1 ), siMenuShapeManagerCreateContextMultiSelectionID = ( siMenuShapeManagerCreateContextSingleSelectionID + 1 ), siMenuShapeManagerAnimateContextSingleSelectionID = ( siMenuShapeManagerCreateContextMultiSelectionID + 1 ), siMenuShapeManagerAnimateContextMultiSelectionID = ( siMenuShapeManagerAnimateContextSingleSelectionID + 1 ),
  siMenuShapeManagerAnimateID = ( siMenuShapeManagerAnimateContextMultiSelectionID + 1 ), siMenuRenderRegionContextID = 3800, siMenuMaterialPanelMaterialID = 3900, siMenuTextureEditorToolsID = 4000,
  siMenuRenderTreeToolsID = 4100, siMenuICEViewToolsID = ( siMenuRenderTreeToolsID + 1 ), siMenuRTNodeContextID = ( siMenuICEViewToolsID + 1 ), siMenuICENodeContextID = ( siMenuRTNodeContextID + 1 ),
  siMenuICENodePortContextID = ( siMenuICENodeContextID + 1 ), siMenuRenderTreeTopLevelID = ( siMenuICENodePortContextID + 1 ), siMenuICEViewTopLevelID = ( siMenuRenderTreeTopLevelID + 1 ), siMenuTextEditorWidgetEditID = 4200,
  siMenuTextEditorContextID = ( siMenuTextEditorWidgetEditID + 1 ), siMenuTextureSpaceProjectionID = 4300, siMenuSchematicViewID = 4400, siMenuSchematicViewContextID = 4401,
  siMenuSchematicNodeContextID = 4402, siMenuSceneLayerManagerLayersID = 4500, siMenuSceneLayerManagerContextID = ( siMenuSceneLayerManagerLayersID + 1 ), siMenuWeightEditorFileID = 10000,
  siMenuWeightEditorEditID = 10001, siMenuWeightEditorViewID = 10002
}
 

Identifies the location of a custom menu.

More...
enum   siPortFlags { siDefaultPort = 0, siOptionalInputPort = 16, siCreatedOutputPort = 256, siBranchGroupPort = 1024 }
 

This enum specifies the operator port flags.

More...
enum   siWindowChangeState { siWindowSize = 1, siWindowPaint = 2, siWindowSetFocus = 3, siWindowLostFocus = 4 }
 

This enum specifies what has changed during a CWindowNotification for the Custom Display Host.

More...
enum   siFileType {
  siFileTypeDefault = 0, siFileTypeScene = 1, siFileTypeModel = 2, siFileTypeImage = 3,
  siFileTypeAudio = 4, siFileTypeSI3D = 5, siFileTypeScript = 6, siFileTypeFcurve = 7,
  siFileTypeExpression = 8, siFileTypeRenderPicture = 9, siFileTypeAction = 10, siFileTypeShader = 11,
  siFileTypeBackup = 12, siFileTypeMI = 13, siFileTypeIgnore = 14, siFileTypeSimulation = 15,
  siFileTypeReferencedModel = 16, siFileTypeQuery = 17, siFileTypeSynoptic = 18, siFileTypeDotXSI = 19,
  siFileTypeRenderMap = 20, siFileTypeAddon = 21, siFileTypeMatLib = 22, siFileTypeThumbnail = 23,
  siFileTypeMixer = 24, siFileTypeIges = 25, siFileTypeComposites = 26, siFileTypeDelta = 27,
  siFileTypeCache = 28, siFileTypeICECompounds = 29, siFileTypeRTCompounds = 30, siFileTypeCustom = 31,
  siFileTypeLast = 32
}
 

This enum is used to determine the type of a file for the OnBeginFileExport, OnBeginFileImport, OnEndFileExport, OnEndFileImport, OnCustomFileExport, and OnCustomFileImport events.

More...
enum   siClusterType { siClusterVertexType = 0, siClusterNodeType = 1, siClusterEdgeType = 2, siClusterPolygonType = 3 }
 

This enum specifies the type of clusters in Softimage.

More...
enum   siClusterPropertyType {
  siClusterPropertyEnvelopeWeightType = 0, siClusterPropertyShapeKeyType = 1, siClusterPropertyWeightMapType = 2, siClusterPropertyUVType = 3,
  siClusterPropertyVertexColorType = 4, siClusterPropertyUserNormalType = 5, siClusterPropertyUserMotionType = 6
}
 

This enum specifies the type of cluster properties in Softimage.

More...
enum   siCurveIsopointManipMode {
  siCurveIsopointPositionManipMode = 0, siCurveIsopointPositionAndTangentsManipMode = 1, siCurveIsopointFwdTangentManipMode = 2, siCurveIsopointBwdTangentManipMode = 3,
  siCurveIsopointFwdThenBwdTangentManipMode = 4, siCurveIsopointBwdThenFwdTangentManipMode = 5, siCurveIsopointCVManipMode = 6
}
 

This enum specifies the mode of manipulation of a curve isopoint in Softimage.

More...
enum   siCurveKnotTangentAlignment {
  siCurveKnotAlignFwdTangentWithBwd = 0, siCurveKnotAlignBwdTangentWithFwd = 1, siCurveKnotAlignFwdAndBwdTangentsTogether = 2, siCurveKnotLinearizeNextSegment = 3,
  siCurveKnotLinearizePrevSegment = 4, siCurveKnotLinearizeBothSegments = 5, siCurveKnotLinearizeInterSegments = 6, siCurveKnotMakeCorner = 7
}
 

This enum specifies the type of alignment for a tangent of a curve knot in Softimage.

More...
enum   siRBDEngine { siPhysXEngine = 0, siOpenDynamicsEngine = 1 }
 

Specifies the rigid body dynamics engine used for simulation.

More...
enum   siKeyableAttributeType { siKeyableAttributeClear = 0, siKeyableAttributeKeyable = 1, siKeyableAttributeNonKeyableVisible = 2 }
 

Keyable attribute types.

More...
enum   siClosestLocationMethod { siClosestVertexOrKnot = 0, siClosestSurface = 1, siClosestSmoothedSurface = 2, siClosestSurfaceRaycastIntersection = 3 }
 

Indicates the method to use for finding closest locations on a geometry.

More...
enum   siNormalComputationMethod { siInterpolatedVertexGeometricNormals = 0, siInterpolatedVertexAngleBasedGeometricNormals = 1, siInterpolatedShadingNormals = 2, siInterpolatedAngleBasedNodeShadingNormals = 3 }
 

Indicates the method to use for computing normals on a geometry.

More...
enum   siLineIntersectionType { siSemiLineIntersection = 0, siLineIntersection = 1, siSegmentIntersection = 2 }
 

Type of line to use when intersecting a line with a geometry.

More...
enum   siImageBitDepth {
  siImageBitDepthUnknown = -1, siImageBitDepthInteger1 = 0, siImageBitDepthInteger2 = 1, siImageBitDepthInteger4 = 2,
  siImageBitDepthInteger8 = 3, siImageBitDepthInteger16 = 4, siImageBitDepthInteger32 = 5, siImageBitDepthFloat16 = 20,
  siImageBitDepthFloat32 = 21
}
 

This enumeration lists the allowed bit depths for each channel of an image with the specified channel types.

More...
enum   siImageChannelType {
  siImageRGBAChannelType = 0, siImageRGBChannelType = 1, siImageAlphaChannelType = 2, siImageIntensityChannelType = 3,
  siImageRGBEChannelType = 4, siImageDepthChannelType = 5, siImageNormalChannelType = 6, siImageMotionChannelType = 7,
  siImageTagChannelType = 8
}
 

This enum lists the allowed channel types in writable images and framebuffers.

More...
enum   siImageChannelFilter {
  siImageRGBAChannelFilter = 1, siImageRGBChannelFilter = 2, siImageColorChannelFilter = 3, siImageAlphaChannelFilter = 4,
  siImageIntensityChannelFilter = 8, siImageRGBEChannelFilter = 16, siImageDepthChannelFilter = 32, siImageNormalChannelFilter = 64,
  siImageMotionChannelFilter = 128, siImageTagChannelFilter = 256, siImageChannelFilterAll = 511
}
 

This enumeration lists the allowed filters for user-selectable channel types in the UI.

More...
enum   siVolumeCenterMethod { siVolumeCenterMethodCOG = 0, siVolumeCenterMethodBBoxCenter = 1, siVolumeCenterMethodObjectCenter = 2 }
 

Indicates the method to use for calculating the center of a bounding volume.

More...
enum   siBoundingCapsuleMethod { siBoundingCapsuleMethodXAxis = 0, siBoundingCapsuleMethodYAxis = 1, siBoundingCapsuleMethodZAxis = 2, siBoundingCapsuleMethodBestAxis = 3 }
 

Indicates the method to use for calculating the long axis of a bounding cylinder.

More...
enum   siSourcePathType { siSourcePathImageSource = 0, siSourcePathWritableImageSource = 1, siSourcePathModelSource = 3 }
 

Specifies the source path being set for the OnSourcePathChange event.

More...
enum   siModelKind { siModelKind_Regular = 0, siModelKind_Reference = 1, siModelKind_Instance = 2 }
 

Describes whether Model is referenced, local (regular) or an instance.

More...
enum   siViewport {
  siViewportFocussed = -3, siViewportCurrent = -2, siViewportAll = -1, siViewportA = 0,
  siViewportB = 1, siViewportC = 2, siViewportD = 3
}
 

Used as a convenient list of identifiers for the different viewports of the view manager.

More...
enum   siRenderRegionDisplayType {
  siRenderRegionDisplayRGBA = 0, siRenderRegionDisplayRGB = 1, siRenderRegionDisplayAlpha = 2, siRenderRegionDisplayRed = 3,
  siRenderRegionDisplayGreen = 4, siRenderRegionDisplayBlue = 5
}
 

This enumeration represents the list of display types for the render region.

More...
enum   siModificationDeltaType {
  siModificationDeltaActiveResolution = 0, siModificationDeltaRemoveAnimation = 1, siModificationDeltaConstraint = 2, siModificationDeltaUpVectorConstraint = 3,
  siModificationDeltaOperator = 4, siModificationDeltaExpression = 5, siModificationDeltaStaticValue = 6, siModificationDeltaFCurve = 7,
  siModificationDeltaGroupRelation = 8, siModificationDeltaCluster = 9, siModificationDeltaClusterProperty = 10, siModificationDeltaProperty = 11
}
 

Type of delta modification on a referenced model.

More...
enum   siNodePortDataInsertionLocation { siNodePortDataInsertionLocationBegining = 0, siNodePortDataInsertionLocationEnd = ( siNodePortDataInsertionLocationBegining + 1 ), siNodePortDataInsertionLocationBefore = ( siNodePortDataInsertionLocationEnd + 1 ), siNodePortDataInsertionLocationAfter = ( siNodePortDataInsertionLocationBefore + 1 ) }
 

Specifies the relative location where new node ports will be added.

More...
enum   siPPGEventID {
  siUndefinedPPGEvent = 0, siOnInit = 1, siOnClosed = 2, siParameterChange = 3,
  siButtonClicked = 4, siTabChange = 5
}
 

Defines the possible actions that trigger calling the PPGEvent callback function.

More...
enum   siRenderProcessType { siRenderProcessRender = 0, siRenderProcessExportArchive = 1, siRenderProcessExportObjectArchive = 2, siRenderProcessGenerateRenderMap = 3 }
 

The process types that a rendering engine can perform.

More...
enum   siRenderQueryType {
  siRenderQueryArchiveIsValid = 0, siRenderQueryArchiveProxies = 1, siRenderQueryArchiveBBox = 2, siRenderQueryArchiveFrameRange = 3,
  siRenderQueryDisplayBitDepths = 4, siRenderQueryWantDirtyList = 5, siRenderQueryVersionString = 6
}
 

Query codes that a rendering engine needs to respond to if it supports object archives and stand-ins, via registering itself with a siRenderProcessType::siRenderProcessExportObjectArchive process type, and multiple display bit depths.

More...
enum   siRenderQualityType {
  siRenderQualityTypeLowest = 0, siRenderQualityTypeLow = 1, siRenderQualityTypeMedium = 2, siRenderQualityTypeHigh = 3,
  siRenderQualityTypeHighest = 4
}
 

Quality levels that a rendering engine's renderer properties can be set to, or queried for.

More...
enum   siRenderPropertyType { siRenderPropertyOptions = 0 }
 

When a render engine registers, it provides a list of specific properties that Softimage should create for it.

More...
enum   siRenderShutterType { siRenderShutterCenterOnFrame = 0, siRenderShutterEndOnFrame = 1, siRenderShutterStartOnFrame = 2 }
 

Controls when the camera's shutter opens and closes when generating motion blur for render.

More...
enum   siRenderFrameSource { siRenderFrameSourceFrameRange = 0, siRenderFrameSourceFrameSet = 1, siRenderFrameSourceTimeline = 2, siRenderFrameSourceGlobalOptions = 3 }
 

Controls how the render frame list is computed for passes.

More...
enum   siDragAndDropAction { siSourceDragAction = 0, siSourceDropAction = 0x1 }
 

Possible actions for the drag and drop notification.

More...
enum   siICEAttributeCategory { siICEAttributeCategoryUnknown = 0, siICEAttributeCategoryBuiltin = 1, siICEAttributeCategoryCustom = 2 }
 

Describes how the ICEAttribute data is defined.

More...
enum   siICENodeThreadingModel { siICENodeUnknownThreading = 0, siICENodeSingleThreading = 1, siICENodeMultiThreading = 2, siICENodeMultiEvaluationPhase = 3 }
 

Defines the threading models available for ICENode evaluation.

More...
enum   siICEShapeType {
  siICEShapeUnknown = -1, siICEShapePoint = 0, siICEShapeSegment = 1, siICEShapeDisc = 2,
  siICEShapeRectangle = 3, siICEShapeSphere = 4, siICEShapeBox = 5, siICEShapeCylinder = 6,
  siICEShapeCapsule = 7, siICEShapeCone = 8, siICEShapeBlob = 9, siICEShapeInstance = 128,
  siICEShapeReference = 129
}
 

Defines the particle shape types for rendering.

More...
enum   siRenderVerbosity { siRenderVerbosityOff = 0, siRenderVerbosityOn = 1, siRenderVerbosityDefault = 2 }
 

This enum specifies the render verbosity settings used when rendering or exporting passes.

More...
enum   siTimeTransportSeekMode { siTTScrubActive = 0, siTTScrubInactive = 1, siTTScrubJog = 2 }
 

Softimage TimeTransport seek modes.

More...
enum   siGraphicDriver {
  siNullGraphicDriver = 0, siOpenGL20 = 1, siOpenGL30 = 2, siDirectX9 = 3,
  siDirectX10 = 4
}
 

Enumerates the supported graphics drivers.

More...
enum   siHardwareSurfaceDimension {
  siDefaultDimension = 0, si1D = 1, si2D = 2, si3D = 3,
  siRectangle = 4, siCube = 5
}
 

Defines the dimension of a hardware surface.

More...
enum   siResourceSharing { siSharedResource = 0, siExclusiveResource = 1 }
 

Defines the sharing capability of a resource.

More...
enum   siHardwareInputSemantic {
  siHardwareSemanticPosition = 0, siHardwareSemanticNormal = 1, siHardwareSemanticColor0 = 2, siHardwareSemanticColor1 = 3,
  siHardwareSemanticTexcoord0 = 4, siHardwareSemanticTexcoord1 = 5, siHardwareSemanticTexcoord2 = 6, siHardwareSemanticTexcoord3 = 7,
  siHardwareSemanticTexcoord4 = 8, siHardwareSemanticTexcoord5 = 9, siHardwareSemanticTexcoord6 = 10, siHardwareSemanticTexcoord7 = 11,
  siHardwareSemanticTexcoord8 = 12, siHardwareSemanticTexcoord9 = 13, siHardwareSemanticTexcoord10 = 14, siHardwareSemanticTexcoord11 = 15,
  siHardwareSemanticTexcoord12 = 16, siHardwareSemanticTexcoord13 = 17, siHardwareSemanticTexcoord14 = 18, siHardwareSemanticTexcoord15 = 19,
  siHardwareSemanticAttr0 = 20, siHardwareSemanticAttr1 = 21, siHardwareSemanticAttr2 = 22, siHardwareSemanticAttr3 = 23,
  siHardwareSemanticAttr4 = 24, siHardwareSemanticAttr5 = 25, siHardwareSemanticAttr6 = 26, siHardwareSemanticAttr7 = 27,
  siHardwareSemanticAttr8 = 28, siHardwareSemanticAttr9 = 29, siHardwareSemanticAttr10 = 30, siHardwareSemanticAttr11 = 31,
  siHardwareSemanticAttr12 = 32, siHardwareSemanticAttr13 = 33, siHardwareSemanticAttr14 = 34, siHardwareSemanticAttr15 = 35,
  siHardwareSemanticFogcoord = 36, siHardwareSemanticPsize = 37, siHardwareSemanticTangent = 38, siHardwareSemanticBinormal = 39,
  siHardwareSemanticWeight = 40, siHardwareSemanticIndice = 41, siHardwareSemanticTessfactor = 42, siHardwareSemanticDepth = 43,
  siHardwareSemanticSample = 44, siHardwareSemanticMax = 45
}
 

Describes the standard vertex attribute hardware slot for a Realtime Shader.

More...
enum   siCollapseLayersPlottingType { siDefaultPlottingType = 0, siPreserveAnimation = 1, siPreserveTangentHandles = 2 }
 

Indicates the plotting type to use when collapsing animation layers.

More...
enum   siMaterialConflictAction { siDefaultAction = 0, siShareMaterial = 1, siCopyMaterial = 2 }
 

This indicates the action to perform when there is a conflict with a material.

More...
enum   siHWShaderVersionID { siHWShaderV1 = 4 }
 

Declares the supported hardware shader versions.

More...
enum   siXGSContextFlag { siXGSContextNormal = ( 1L << 1 ), siXGSContextCapture = ( 1L << 2 ), siXGSContextHWRender = ( 1L << 3 ) }
 

Context flags for the Graphic Sequencer.

More...
enum   siXGSRenderFlag {
  siRenderDefault = ( 1L << 1 ), siRenderUnsorted = ( 1L << 2 ), siRenderSorted = ( 1L << 3 ), siRenderSortedNear = ( 1L << 4 ),
  siRenderSortedCenter = ( 1L << 5 ), siRenderSortedFar = ( 1L << 6 ), siRenderSortFront = ( 1L << 7 ), siRenderSelected = ( 1L << 8 ),
  siTexEnvReplace = ( 1L << 9 ), siRenderNoRTSOverride = ( 1L << 10 )
}
 

XGS render flags for the Graphic Sequencer.

More...
enum   siCustomDisplayFlags { siSupportCommandMap = ( 1L << 1 ), siWindowNotifications = ( 1L << 2 ) }
 

Determines the behavior and look of a Custom Display.

More...
enum   siComponentDataType {
  siComponentDataTypeBool = ( 1L << 0 ), siComponentDataTypeLong = ( 1L << 1 ), siComponentDataTypeFloat = ( 1L << 2 ), siComponentDataTypeVector2 = ( 1L << 3 ),
  siComponentDataTypeVector3 = ( 1L << 4 ), siComponentDataTypeVector4 = ( 1L << 5 ), siComponentDataTypeQuaternion = ( 1L << 6 ), siComponentDataTypeMatrix33 = ( 1L << 7 ),
  siComponentDataTypeMatrix44 = ( 1L << 8 ), siComponentDataTypeColor4 = ( 1L << 9 ), siComponentDataTypeRotation3 = ( 1L << 14 ), siComponentDataTypeShape = ( 1L << 15 ),
  siComponentDataTypeIcon = ( 1L << 17 )
}
 

Specifies the type of component data (vector3, boolean, color, etc.) on an ICEAttribute.

More...
enum   siComponentDataContext {
  siComponentDataContextSingleton = ( 1L << 0 ), siComponentDataContextComponent0D = ( 1L << 1 ), siComponentDataContextComponent1D = ( 1L << 2 ), siComponentDataContextComponent2D = ( 1L << 3 ),
  siComponentDataContextComponent0D2D = ( 1L << 4 )
}
 

Specifies the context of component data (points, edges, etc.) on an ICEAttribute.

More...
enum   siComponentDataStructure { siComponentDataStructureSingle = ( 1L << 0 ), siComponentDataStructureDynamicArray = ( 1L << 1 ) }
 

Specifies the structure of component data (single element or dynamic array) on an ICEAttribute.

More...
enum   siRenderChannelType {
  siRenderChannelUnknownType = 0, siRenderChannelColorType = 1, siRenderChannelGrayscaleType = 2, siRenderChannelDepthType = 3,
  siRenderChannelNormalVectorType = 4, siRenderChannelVectorType = 5, siRenderChannelLabelType = 6, siRenderChannelCustomType = ( 1L << 31 )
}
 

Types of data allowed for render channels.

More...
enum   siICENodeDataType {
  siICENodeDataBool = ( 1L << 0 ), siICENodeDataLong = ( 1L << 1 ), siICENodeDataFloat = ( 1L << 2 ), siICENodeDataVector2 = ( 1L << 3 ),
  siICENodeDataVector3 = ( 1L << 4 ), siICENodeDataVector4 = ( 1L << 5 ), siICENodeDataQuaternion = ( 1L << 6 ), siICENodeDataMatrix33 = ( 1L << 7 ),
  siICENodeDataMatrix44 = ( 1L << 8 ), siICENodeDataColor4 = ( 1L << 9 ), siICENodeDataGeometry = ( 1L << 10 ), siICENodeDataLocation = ( 1L << 11 ),
  siICENodeDataExecute = ( 1L << 12 ), siICENodeDataReference = ( 1L << 13 ), siICENodeDataRotation = ( 1L << 14 ), siICENodeDataShape = ( 1L << 15 ),
  siICENodeDataCustomType = ( 1L << 16 ), siICENodeDataString = ( 1L << 17 ), siICENodeDataIcon = ( 1L << 18 ), siICENodeDataValue = ( ( ( ( ( ( ( ( ( ( ( ( ( ( siICENodeDataBool | siICENodeDataLong ) | siICENodeDataFloat ) | siICENodeDataVector2 ) | siICENodeDataVector3 ) | siICENodeDataVector4 ) | siICENodeDataQuaternion ) | siICENodeDataRotation ) | siICENodeDataMatrix33 ) | siICENodeDataMatrix44 ) | siICENodeDataColor4 ) | siICENodeDataShape ) | siICENodeDataIcon ) | siICENodeDataCustomType ) | siICENodeDataString ),
  siICENodeDataInterface = siICENodeDataGeometry, siICENodeDataMultiComp = ( ( ( ( ( ( ( siICENodeDataVector2 | siICENodeDataVector3 ) | siICENodeDataVector4 ) | siICENodeDataQuaternion ) | siICENodeDataRotation ) | siICENodeDataMatrix33 ) | siICENodeDataMatrix44 ) | siICENodeDataColor4 ), siICENodeDataArithmeticSupport = ( ( ( ( ( ( ( ( siICENodeDataLong | siICENodeDataFloat ) | siICENodeDataVector2 ) | siICENodeDataVector3 ) | siICENodeDataVector4 ) | siICENodeDataQuaternion ) | siICENodeDataRotation ) | siICENodeDataMatrix33 ) | siICENodeDataMatrix44 ), siICENodeDataAny = ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( siICENodeDataBool | siICENodeDataLong ) | siICENodeDataFloat ) | siICENodeDataVector2 ) | siICENodeDataVector3 ) | siICENodeDataVector4 ) | siICENodeDataQuaternion ) | siICENodeDataRotation ) | siICENodeDataMatrix33 ) | siICENodeDataMatrix44 ) | siICENodeDataColor4 ) | siICENodeDataShape ) | siICENodeDataGeometry ) | siICENodeDataLocation ) | siICENodeDataReference ) | siICENodeDataExecute ) | siICENodeDataCustomType ) | siICENodeDataString ) | siICENodeDataIcon )
}
 

Defines the types of data that can be associated to a ICE node port connection.

More...
enum   siICENodeStructureType { siICENodeStructureSingle = ( 1L << 0 ), siICENodeStructureArray = ( 1L << 1 ), siICENodeStructureAny = ( siICENodeStructureSingle | siICENodeStructureArray ) }
 

Defines the way data are structured for ICE node connections: single data or dynamic array.

More...
enum   siICENodeContextType {
  siICENodeContextSingleton = ( 1L << 0 ), siICENodeContextComponent0D = ( 1L << 1 ), siICENodeContextComponent1D = ( 1L << 2 ), siICENodeContextComponent2D = ( 1L << 3 ),
  siICENodeContextComponent0D2D = ( 1L << 4 ), siICENodeContextElementGenerator = ( 1L << 5 ), siICENodeContextSingletonOrComponent0D = ( siICENodeContextSingleton | siICENodeContextComponent0D ), siICENodeContextSingletonOrComponent1D = ( siICENodeContextSingleton | siICENodeContextComponent1D ),
  siICENodeContextSingletonOrComponent2D = ( siICENodeContextSingleton | siICENodeContextComponent2D ), siICENodeContextSingletonOrComponent0D2D = ( siICENodeContextSingleton | siICENodeContextComponent0D2D ), siICENodeContextSingletonOrElementGenerator = ( siICENodeContextSingleton | siICENodeContextElementGenerator ), siICENodeContextComponent0DOr1DOr2D = ( ( siICENodeContextComponent0D | siICENodeContextComponent1D ) | siICENodeContextComponent2D ),
  siICENodeContextNotSingleton = ( ( ( ( siICENodeContextComponent0D | siICENodeContextComponent1D ) | siICENodeContextComponent2D ) | siICENodeContextComponent0D2D ) | siICENodeContextElementGenerator ), siICENodeContextAny = ( ( ( ( ( siICENodeContextSingleton | siICENodeContextComponent0D ) | siICENodeContextComponent1D ) | siICENodeContextComponent2D ) | siICENodeContextComponent0D2D ) | siICENodeContextElementGenerator )
}
 

Defines the element set associated with the data for ICE node connections.

More...
enum   siAutoCompleteMode { siNone = 0, siKeywords = ( 1L << 1 ), siCommands = ( 1L << 2 ) }
 

Determines the behavior of the auto-complete feature for a text editor widget control (see siPPGControlType::siControlTextEditor).

More...
enum   siTextEditorCapability { siNoSaveLoad = 0, siCanSave = ( 1L << 1 ), siCanLoad = ( 1L << 2 ) }
 

Determines the availability of the File menu functions for a text editor widget control (siPPGControlType::siControlTextEditor).

More...
enum   siViewportFeature { siHardwareRendering = ( 1L << 0 ) }
 

Defines the supported features for a custom viewport.

More...
enum   siTimeTransportPlaybackMode { siTTPlaybackNormal = 0, siTTPlaybackSlideShow = 0x2 }
 

Softimage TimeTransport playback types.

More...
enum   siTimeTransportState {
  siTTStateStop = 0x1, siTTStatePlay = 0x4, siTTStateSeek = 0x2000, siTTStateTimeChange = 0x4000,
  siTTStateContextChange = 0x8000, siTTStateScrubChange = 0x10000, siTTStateSeekChange = 0x20000, siTTStateDeviceChange = 0x40000,
  siTTStateFrameDropChange = 0x80000
}
 

Softimage TimeTransport states.

More...
enum   siToolCapabilities { siToolAllowNotifications = 1 }
 

Various flags that affect tool behaviour.

More...
enum   siToolCursor {
  siArrowCursor = 0, siCrossCursor = 1, siHandCursor = 2, siPenCursor = 3,
  siDropperCursor = 4, siSelectCursor = 5, siTranslateCursor = 6, siRotateCursor = 7,
  siScaleCursor = 8, siZoomCursor = 9, siDragXYCursor = 10, siDragXCursor = 11,
  siDragYCursor = 12
}
 

ToolContext cursors.

More...
enum   siAlignment {
  siLeftAlign = 0, siCenterAlign = 1, siRightAlign = 2, siTopAlign = 0,
  siBottomAlign = 2
}
 

ToolContext text/menu alignment.

More...
enum   siSnapType {
  siSnapNone = 0L, siSnapPoint = 0x1L, siSnapKnot = 0x2L, siSnapCenter = 0x4L,
  siSnapMidPoint = 0x8L, siSnapBBox = 0x20L, siSnap0D = 0xffffL, siSnapEdge = 0x10000L,
  siSnapCurve = 0x20000L, siSnapUIsocurve = 0x40000L, siSnapVIsocurve = 0x80000L, siSnapBoundary = 0x100000L,
  siSnap1D = 0xff0000L, siSnapFace = 0x1000000L, siSnapSurface = 0x2000000L, siSnap2D = 0x3f000000L,
  siSnapGrid = 0x40000000L
}
 

ToolContext snapping type flags.

More...
enum   siPickMode { siPickSingleObject = 0, siPickSingleSubComponent = 1, siPickMultipleObjects = 2, siPickMultipleSubComponents = 3 }
 

ToolContext picking mode flags.

More...
enum   siPickType {
  siPickRectangle = 1, siPickRaycast = 2, siPickLasso = 3, siPickFreeform = 4,
  siPickRectangleRaycast = 6
}
 

ToolContext picking type flags.

More...
enum   siPasteUVsMode { siDefaultPasteUVsMode = 0, siPasteUVsUsingSourceIndices = 1, siPasteUVsUsingTargetIndices = 2 }
 

This indicates which UVs indices to use when the UVs are copied from one object and pasted onto another object.

More...
enum   siSetValueMode { siSetValueModeAbsolute = 0, siSetValueModeAdditive = 1, siSetValueModeAddPercentage = 2 }
 

This indicates the mathematical mode when setting a new value to a current value.

More...
enum   RotationRep { siQuaternionRot = 0, siEulerRot, siAxisAngleRot }
 

Defines the rotation representation.

More...

Functions

virtual  ~CBase ()
  Default destructor.
CString  GetClassIDName () const
  Returns the type of the API class in a text string,.
virtual siClassID  GetClassID () const =0
  Returns the type of the API class.
virtual bool  IsA (siClassID in_ClassID) const
  Returns true if a given class type is compatible with this API class.
bool  IsA (const CRef &in_ref) const
  Returns true if a given CRef object is compatible with this API class.
CStatus  SetObject (const CRef &in_obj)
  Sets this API class object with a reference object.
bool  IsValid () const
  Returns true if the object is valid.
void  ResetObject ()
  Resets this API class by deleting its CRef object.
  operator CRef & ()
  Converts from CBase to a CRef reference object.
bool  operator== (const CBase &in_obj) const
  Equality operator.
bool  operator!= (const CBase &in_obj) const
  Inequality operator.
const CRef GetRef () const
  Converts from CBase to a constant CRef reference object.
void  SetPtr (void *)
void  SetRef (const CRef &in_ref)
void  Clear ()
void *  GetPtr (void) const
SICPPSDK_INLINE  CLine (const CVector3 &in_point, const CVector3 &in_tangent)
  Construct a line through given point in given direction.
SICPPSDK_INLINE  CLine (const CLine &in_line)
  Copy constructor.
SICPPSDK_INLINE  ~CLine ()
  Default destructor.
SICPPSDK_INLINE CLine &  operator= (const CLine &in_line)
  Assignment operator.
SICPPSDK_INLINE bool  operator== (const CLine &in_line) const
  Equality operator tests the strict equality of this CLine with the specified line.
SICPPSDK_INLINE bool  operator!= (const CLine &in_line) const
  Inequality operator tests the strict inequality of this CLine with the specified line.
SICPPSDK_INLINE bool  EpsilonEquals (const CLine &in_line, double in_dEpsilon) const
  Tests the equality of this line with the specified line, with a tolerance of Epsilon.
SICPPSDK_INLINE bool  Equals (const CLine &in_line) const
  Tests the strict equality of this line with the specified line.
bool  Parallel (const CLine &in_line) const
  Tests whether two lines are parallel.
bool  Collinear (const CLine &in_line) const
  Tests whether two lines are collinear.
SICPPSDK_INLINE CVector3  Project (const CVector3 &in_point) const
  Return projection of given point on this line.
SICPPSDK_INLINE CVector3  GetClosestPoint (const CLine &in_line) const
  Return closest point on the the line to the given line.
SICPPSDK_INLINE double  GetDistance (const CVector3 &in_point) const
  Return distance fromt the line to the given point.
SICPPSDK_INLINE double  GetDistance (const CLine &in_line) const
  Return distance fromt the line to the given line.
SICPPSDK_INLINE CVector3  GetPosition (double in_param) const
  Return position on line for given parameter.
double  GetParameter (const CVector3 &in_point) const
  Return parameter on line closest to input point.
bool  Intersect (const CLine &in_line, CVector3 &out_point) const
  Return intersection of this line with the given line.
SICPPSDK_INLINE const CVector3 &  GetOrigin () const
  Return origin of the line.
SICPPSDK_INLINE const CVector3 &  GetTangent () const
  Return tangent direction of the line.
SICPPSDK_INLINE CLine &  SetOrigin (const CVector3 &in_point)
  Set origin of the line.
SICPPSDK_INLINE CLine &  SetTangent (const CVector3 &in_tangent)
  Set tangent direction of the line.
SICPPSDK_INLINE CLine &  Set (const CVector3 &in_point, const CVector3 &in_tangent)
  Set origin and tangent direction of the line.
SICPPSDK_INLINE CLine &  operator*= (const CMatrix3 &in_matrix3)
  Right-multiplies this line by the matrix m in place (this = this .
SICPPSDK_INLINE CLine &  operator*= (const CMatrix4 &in_matrix4)
  Right-multiplies this line by the matrix m in place (this = this .
SICPPSDK_INLINE CLine &  operator*= (const CTransformation &in_transformation)
  Right-multiplies this line by the transformation t in place (this = this .
SICPPSDK_INLINE CLine &  MulByMatrix3InPlace (const CMatrix3 &in_matrix3)
  Right-multiplies this line by the matrix m in place (this = this .
SICPPSDK_INLINE CLine &  MulByMatrix3 (const CLine &in_line, const CMatrix3 &in_matrix3)
  Right-multiplies the line l by the matrix m and store the result in this line (this = l .
SICPPSDK_INLINE CLine &  MulByMatrix4InPlace (const CMatrix4 &in_matrix4)
  Right-multiplies this line by the matrix m in place (this = this .
SICPPSDK_INLINE CLine &  MulByMatrix4 (const CLine &in_line, const CMatrix4 &in_matrix4)
  Right-multiplies the line l by the matrix m and store the result in this line (this = l .
SICPPSDK_INLINE CLine &  MulByTransformationInPlace (const CTransformation &in_transformation)
  Right-multiplies this line by the transformation t in place (this = this .
SICPPSDK_INLINE CLine &  MulByTransformation (const CLine &in_line, const CTransformation &in_transformation)
  Right-multiplies the line l by the transformation t and stores the result in this line (this = l .
static const double  PI (3.14159265358979323846)
static const float  PI2 ((float) PI *2.0f)
static const float  Invert2PI (0.5f/(float) PI)
static const float  MilliEPS (1.0e-03f)
static const float  MicroEPS (1.0e-06f)
static const float  NanoEPS (1.0e-09f)
static const float  PicoEPS (1.0e-012f)
double  DegreesToRadians (double in_dDegrees)
  Converts an angle in degrees to an angle in radians.
double  RadiansToDegrees (double in_dRadians)
  Converts an angle in radians to an angle in degrees.
CTransformation  MapObjectPoseToWorldSpace (const CTransformation &in_transfoObjectSpace, const CTransformation &in_transfoPose)
  Converts a Pose described in a given ObjectSpace to WorldSpace.
CVector3  MapObjectOrientationToWorldSpace (const CTransformation &in_transfoObjectSpace, const CVector3 &in_vector3Orientation)
  Converts an Orientation described in a given ObjectSpace to WorldSpace.
CVector3  MapObjectPositionToWorldSpace (const CTransformation &in_transfoObjectSpace, const CVector3 &in_vector3Position)
  Converts a Position described in a given ObjectSpace to WorldSpace.
CTransformation  MapWorldPoseToObjectSpace (const CTransformation &in_transfoObjectSpace, const CTransformation &in_transfoPose)
  Converts a Pose described in WorldSpace to a different ObjectSpace.
CVector3  MapWorldOrientationToObjectSpace (const CTransformation &in_transfoObjectSpace, const CVector3 &in_vector3Orientation)
  Converts an orientation described in WorldSpace to a different ObjectSpace.
CVector3  MapWorldPositionToObjectSpace (const CTransformation &in_transfoObjectSpace, const CVector3 &in_vector3Position)
  Converts a position described in WorldSpace to a position in a different ObjectSpace.
CTransformation  MapObjectPoseToObjectSpace (const CTransformation &in_transfoObjectSpace, const CTransformation &in_transfoSpace, const CTransformation &in_transfoPose)
  Converts a pose described in an ObjectSpace to a pose in a different ObjectSpace.
CVector3  MapObjectOrientationToObjectSpace (const CTransformation &in_transfoObjectSpace, const CTransformation &in_transfoSpace, const CVector3 &in_vector3Orientation)
  Converts an orientation described in an ObjectSpace to an orientation in a different ObjectSpace.
CVector3  MapObjectPositionToObjectSpace (const CTransformation &in_transfoObjectSpace, const CTransformation &in_transfoSpace, const CVector3 &in_vector3Position)
  Converts a position described in an ObjectSpace to a position in a different ObjectSpace.
SICPPSDK_INLINE void  LimitValue (float &io_fVal, float in_fMin, float in_fMax)
void  MatToEuler (const CMatrix3f &in_mat, CVector3f &io_vct, const short in_order)
void  EulerToMat (const CVector3f &in_vct, CMatrix3f &out_mat, const short in_order)
void  EulerToQuat (const CVector3f &in_vct, CQuaternionf &out_quat, const short in_order)
SICPPSDK_INLINE  CPlane (const CVector3 &in_point, const CVector3 &in_normal)
  Construct a plane through a point with the given normal.
SICPPSDK_INLINE  CPlane (const CVector3 &in_point, const CVector3 &in_tangentU, const CVector3 &in_tangentV)
  Construct a plane through a point with the given tangents.
SICPPSDK_INLINE  CPlane (const CPlane &in_plane)
  Copy constructor.
SICPPSDK_INLINE  ~CPlane ()
  Default destructor.
SICPPSDK_INLINE CPlane &  operator= (const CPlane &in_plane)
  Assignment operator.
SICPPSDK_INLINE bool  operator== (const CPlane &in_plane) const
  Equality operator tests the strict equality of this CPlane with the specified plane.
SICPPSDK_INLINE bool  operator!= (const CPlane &in_plane) const
  Inequality operator tests the strict inequality of this CPlane with the specified plane.
SICPPSDK_INLINE bool  EpsilonEquals (const CPlane &in_plane, double in_dEpsilon) const
  Tests the equality of this plane with the specified plane, with a tolerance of Epsilon.
SICPPSDK_INLINE bool  Equals (const CPlane &in_plane) const
  Tests the strict equality of this plane with the specified plane.
bool  Parallel (const CPlane &in_plane) const
  Tests whether two planes are parallel.
bool  Coplanar (const CPlane &in_plane) const
  Tests whether two planes are coplanar.
SICPPSDK_INLINE CVector3  GetPosition (double in_U, double inV) const
  Return position on plane for given parameters.
void  GetParameters (const CVector3 &in_point, double &out_U, double &out_V) const
  Return parameter on plane closest to input point.
SICPPSDK_INLINE CVector3  Reflect (const CVector3 &in_point) const
  Return reflection of this point across the plane.
SICPPSDK_INLINE CLine  ProjectLine (const CLine &in_line) const
  Return projection of line on the plane.
SICPPSDK_INLINE CLine  ReflectLine (const CLine &in_line) const
  Return reflection of line across the plane.
CMatrix4 &  GetMirrorTransform (CMatrix4 &out_matrix4) const
  Return CMatrix4 that transforms points across this plane.
SICPPSDK_INLINE const CVector3 &  GetNormal () const
  Return normal for the plane.
SICPPSDK_INLINE const CVector3 &  GetTangentU () const
  Return first tangent for the plane.
SICPPSDK_INLINE const CVector3 &  GetTangentV () const
  Return second tangent for the plane.
CPlane &  SetNormal (const CVector3 &in_normal)
  Set normal for the plane.
CPlane &  SetTangents (const CVector3 &in_U, const CVector3 &in_V)
  Set direction of the plane.
SICPPSDK_INLINE CPlane &  Set (const CVector3 &in_point, const CVector3 &in_U, const CVector3 &in_V)
  Set origin and tangents of the plane.
SICPPSDK_INLINE CPlane &  MulByMatrix3 (const CPlane &in_plane, const CMatrix3 &in_matrix3)
  Right-multiplies the plane l by the matrix m and store the result in this plane (this = l .
SICPPSDK_INLINE CPlane &  MulByMatrix4 (const CPlane &in_plane, const CMatrix4 &in_matrix4)
  Right-multiplies the plane l by the matrix m and store the result in this plane (this = l .
SICPPSDK_INLINE CPlane &  MulByTransformation (const CPlane &in_plane, const CTransformation &in_transformation)
  Right-multiplies the plane l by the transformation t and stores the result in this plane (this = l .
CRef  ConvertObject (void *in_pAuto)
  Converts an XSI Automation (XSI Object Model) object to a CRef object.
void *  ConvertObject (const CRef &in_obj)
  Converts a CRef object to an XSI Automation (XSI Object Model) object.
bool  HasClassID (CRef &, LONG)
bool  CanSubClass (CRef &, LONG)
SICPPSDK_INLINE  CRotationf ()
  Default constructor.
SICPPSDK_INLINE  CRotationf (const CRotationf &in_rotation)
  Copy constructor.
SICPPSDK_INLINE  CRotationf (const CVector3f &in_EulerAngles, const RotationOrder in_RotOrder=siXYZ)
  Constructor (from CVector3f of Euler angles).
SICPPSDK_INLINE  CRotationf (const float in_X, const float in_Y, const float in_Z, const RotationOrder in_RotOrder=siXYZ)
  Constructor (from XYZ Euler angles).
SICPPSDK_INLINE  CRotationf (const CQuaternionf &in_Quat)
  Constructor (from a quaternion).
SICPPSDK_INLINE  CRotationf (const CVector3f &in_Axis, const float in_Angle)
  Constructor (using axis angle representation).
SICPPSDK_INLINE  ~CRotationf ()
  Default destructor.
SICPPSDK_INLINE CRotationf &  operator= (const CRotationf &in_rotation)
  Assignment operator.
SICPPSDK_INLINE CVector3f  GetXYZAngles (const RotationOrder in_Order) const
  Returns the euler angles of the rotation as a CVector3f from a rotation order.
SICPPSDK_INLINE void  GetXYZAngles (float &io_X, float &io_Y, float &io_Z) const
  Returns the Euler angles's representation of the rotation.
SICPPSDK_INLINE CVector3f  GetXYZAngles () const
  Returns the Euler angles's representation of the rotation.
SICPPSDK_INLINE RotationOrder  GetOrder () const
  Returns the rotation order of this rotation for the Euler angles representation.
SICPPSDK_INLINE void  SetOrder (const RotationOrder in_rotOrder)
  Sets the rotation order for the Euler angles representation.
SICPPSDK_INLINE RotationRep  GetRepresentation () const
  Returns the rotation representation of this rotation.
SICPPSDK_INLINE void  SetRepresentation (const RotationRep in_rotRep, const RotationOrder in_order=siXYZ)
  Sets the rotation representation for this rotation.
SICPPSDK_INLINE CRotationf &  Set (const RotationOrder in_order, const bool in_bCompensate=false)
  Change the current rotation from a rotation order with the option of preserving the overall rotation matrix.
SICPPSDK_INLINE CRotationf &  Set (const CVector3f &in_EulerAngles, const RotationOrder in_Order=siXYZ)
  Sets the current rotation from Euler angles.
SICPPSDK_INLINE CRotationf &  Set (const float in_X, const float in_Y, const float in_Z, const RotationOrder in_Order=siXYZ)
  Sets the rotation from Euler angles.
SICPPSDK_INLINE CRotationf &  Set (const CQuaternionf &in_Quat)
  Sets the rotation from a quaternion.
SICPPSDK_INLINE CRotationf &  Mul (const CRotationf &in_rot)
  Multiplies this rotation with another one in place.
SICPPSDK_INLINE CRotationf &  Mul (const CRotationf &in_rot1, const CRotationf &in_rot2)
  Stores the result of the multiplication of two rotations.
SICPPSDK_INLINE CRotationf &  Mul (const float in_scalar)
  Multiply in-place this rotation with a scalar.
SICPPSDK_INLINE CRotationf &  LeftMul (const CRotationf &in_rot)
  Left multiply in-place this rotation with a rotation.
SICPPSDK_INLINE CRotationf &  Interpolate (const CRotationf &in_rot1, const CRotationf &in_rot2, const float in_u)
  Interpolate two rotations into this one for in_u between 0 and 1.
SICPPSDK_INLINE CRotationf &  Div (const CRotationf &in_rot1, const float in_scalar)
  Divides in-place this rotation with the specified rotation and scalar.
SICPPSDK_INLINE CRotationf &  Div (const float in_scalar)
  Divides in-place this rotation with a scalar.
SICPPSDK_INLINE CRotationf &  Div (const CRotationf &in_rot)
  Divides in-place by a rotation.
SICPPSDK_INLINE CRotationf &  Div (const CRotationf &in_rot1, const CRotationf &in_rot2)
  Divide in-place in_rot1 by in_rot2.
SICPPSDK_INLINE CRotationf &  Invert ()
  Inverts the rotation in place.
SICPPSDK_INLINE CRotationf &  Invert (const CRotationf &in_rot)
  Stores the invert of a rotation.
SICPPSDK_INLINE CQuaternionf  GetQuaternion () const
  Returns the quaternion representation of the rotation.
SICPPSDK_INLINE CRotationf &  operator= (const CQuaternionf &in_Quat)
  Sets the rotation from a quaternion.
SICPPSDK_INLINE CVector3f  GetAxisAngle (float &io_Angle) const
  Returns the axis angle representation of the rotation.
SICPPSDK_INLINE CRotationf &  Set (const CVector3f &in_Axis, const float in_Angle)
  Sets the rotation from an axis angle.
SICPPSDK_INLINE void  SetIdentity ()
  Sets the rotation to identity rotation.
SICPPSDK_INLINE bool  Equals (const CRotationf &in_rot) const
  Performs exact comparison of two quaternions.
SICPPSDK_INLINE bool  EpsilonEquals (const CRotationf &in_rot, const float in_fEpsilon) const
  Performs comparison between this rotation and in_rot within the specified epsilon value.
SICPPSDK_INLINE bool  operator== (const CRotationf &in_rot) const
  Performs exact comparison of two quaternions.
SICPPSDK_INLINE bool  operator!= (const CRotationf &in_rot) const
  Inequality operator tests the strict inequality of this rotation with the rotation in_rotation.
SICPPSDK_INLINE bool  operator< (const CRotationf &in_rot) const
  Less than operator.
bool  operator== (CStatus::Code lhs, const CStatus &rhs)
  The equality operator that takes a Code on the left side and a CStatus object on the right side.
bool  operator!= (CStatus::Code lhs, const CStatus &rhs)
  The inequality operator that takes a Code on the left side and a CStatus object on the right side.
CString  operator+ (const wchar_t *in_pwstr, const CString &in_refStr)
  Addition operator.
CString  operator+ (const wchar_t in_wchar, const CString &in_refStr)
  Addition operator.
CString  operator+ (const char *in_pstr, const CString &in_refStr)
  Addition operator.
CString  operator+ (const char in_char, const CString &in_refStr)
  Addition operator.
bool  operator== (const double lhs, const CTime &rhs)
  Equality operator (takes a CTime::Format on the left side and a CTime object on the right side).
bool  operator!= (const double lhs, const CTime &rhs)
  Inequality operator (takes a CTime::Format on the left side and a CTime object on the right side).
  ~CSelectionChangeNotification ()
  Default destructor.
const CRefArray GetSelectionList () const
  Returns a CRefArray holding the new selection list.

Variables

__pad0__
  X, Y, Z order.
CRef  m_ref
const wchar_t *  siBoundaryFilter
  Filters by boundaries (on active NURBS objects)
const wchar_t *  siCameraFilter
  Filters by cameras.
const wchar_t *  siChainElementFilter
  Filters by chain elements.
const wchar_t *  siClusterFilter
  Filters by clusters.
const wchar_t *  siConstraintFilter
  Filters by constraints.
const wchar_t *  siControlFilter
  Filters by control objects.
const wchar_t *  siCurveFilter
  Filters by curves.
const wchar_t *  siEdgeFilter
  Filters by edges (on active 3D objects)
const wchar_t *  siEffectorFilter
  Filters by chain effectors.
const wchar_t *  siGenericObjectFilter
  Filters by any object.
const wchar_t *  siGeometryFilter
  Filters by any type of geometric 3D object.
const wchar_t *  siGroupFilter
  Filters by groups.
const wchar_t *  siImplicitFilter
  Filters by implicit primitives.
const wchar_t *  siIsopointFilter
  Filters by isopoints (on active 3D objects)
const wchar_t *  siKnotFilter
  Filters by knots (on active 3D objects)
const wchar_t *  siLatticeFilter
  Filters by implicit lattices.
const wchar_t *  siLayerFilter
  Filters by layers.
const wchar_t *  siLightFilter
  Filters by lights.
const wchar_t *  siLightPartitionFilter
  Filters by light partitions.
const wchar_t *  siModelFilter
  Filters by models.
const wchar_t *  siNullFilter
  Filters by nulls.
const wchar_t *  siObjectFilter
  Filters by 3D objects only.
const wchar_t *  siObjectPartitionFilter
  Filters by object partitions.
const wchar_t *  siOperatorFilter
  Filters by operators.
const wchar_t *  siPointCloudFilter
  Filters by point clouds.
const wchar_t *  siPointFilter
  Filters by points.
const wchar_t *  siPolygonFilter
  Filters by polygons.
const wchar_t *  siPolyMeshFilter
  Filters by polygon meshes.
const wchar_t *  siPrimitiveFilter
  Filters by primitives.
const wchar_t *  siPropertyFilter
  Filters by properties.
const wchar_t *  siSceneFilter
  Filters by scenes.
const wchar_t *  siShaderFilter
  Filters by shaders.
const wchar_t *  siSkeletonJointFilter
  Filters by skeleton joint properties.
const wchar_t *  siSubComponentFilter
  Filters by subcomponents.
const wchar_t *  siSubSurfaceFilter
  Filters by subsurfaces (on active 3D objects)
const wchar_t *  siSurfaceCurveFilter
  Filters by surface curves (on active 3D objects)
const wchar_t *  siSurfaceMeshFilter
  Filters by surface meshes.
const wchar_t *  siTextureControlFilter
  Filters by texture controls.
const wchar_t *  siTrimCurveFilter
  Filters by trim curves (on active 3D objects)
const wchar_t *  siUIsolineFilter
  Filters by U isolines (on active 3D objects)
const wchar_t *  siVIsolineFilter
  Filters by V isolines (on active 3D objects)
const wchar_t *  siUKnotCurveFilter
  Filters by U knot curves (on active 3D objects)
const wchar_t *  siVKnotCurveFilter
  Filters by V knot curves (on active 3D objects)
const wchar_t *  siWaveFilter
  Filters by wave controls.
const wchar_t *  siConditionalObjectFilter
const wchar_t *  siAutoInspect
  TRUE to force the property dialogs to automatically pop up on object creation.
const wchar_t *  siCompensationFlag
  Toggle the Comp button in the Constrain panel.
const wchar_t *  siCustomCommandLibCache
  This preference enables or disables the custom command library cache.
const wchar_t *  siCustomOperatorLibCache
  This preference enables or disables the custom operator library cache.
const wchar_t *  siDisplayCallbackLibCache
  This preference enables or disables the custom display callback library cache.
const wchar_t *  siDisplayLibCache
  This preference enables or disables the custom view library cache.
const wchar_t *  siDisplayPassLibCache
  This preference enables or disables the custom display pass library cache.
const wchar_t *  siEventLibCache
  This preference enables or disables the event library cache.
const wchar_t *  siFilterLibCache
  This preference enables or disables the custom filter library cache.
const wchar_t *  siMenuLibCache
  This preference enables or disables the custom menu library cache.
const wchar_t *  siPropertyLibCache
  This preference enables or disables the custom property library cache.
const wchar_t *  siRTShaderLibCache
  This preference enables or disables the Realtime shader library cache.
const wchar_t *  siScrCommandLogEnabled
  Set to True to enable command execution logging in the scripting history window.
const wchar_t *  siScrCommandLogFileName
  Use this user preference to specify the name of the file to use for logging commands and messages.
const wchar_t *  siScrCommandLogMaxSize
  Use this user preference to get and set the maximum size for the scripting command/message log.
const wchar_t *  siScrCommandLogToFile
  Set to True to log the scripting command/message to a file.
const wchar_t *  siScrCommandLogUnlimitedSize
  Set to True to allow the scripting command/message log to be of an unlimited size.
const wchar_t *  siScrLanguage
  Use this user preference to get and set the preferred scripting language.
const wchar_t *  siScrMessageLogEnabled
  Set to True to enable message logging in the scripting history window.
const wchar_t *  siScrRealTimeMessagingEnabled
  Set to True to enable real-time message logging in the scripting history window.
const wchar_t *  siTimeDisplayFormatDisplayAsFrames
  Set to True to display time as frame.
const wchar_t *  siTimeDisplayFormatDisplayUserFormat
  Set to True to use the default frame format or false for a user selected format for display purposes.
const wchar_t *  siTimeDisplayFormatUserFormat
  Use this user preference to specify the user display frame format.
const wchar_t *  siTimeFormatDefaultFrameFormat
  Use this user preference to specify the default frame format.
const wchar_t *  siTimeFormatDefaultFrameRate
  Use this user preference to access the default frame rate.
const wchar_t *  siTransformAxisMode
  Set the Transformation Axis Mode.
const wchar_t *  siTransformRefMode
  Set the TransRefValues values for a list of possible values.
const wchar_t *  siUILayoutDefault
  Use this user preference to specify the default current layout that will be used when starting Softimage.
const wchar_t *  siAnimationKeyword
  Animation property sets.
const wchar_t *  siClusterKeyword
  Cluster property sets.
const wchar_t *  siConstraintKeyword
  Constraint property sets.
const wchar_t *  siControlObjectKeyword
  ControlObject property sets.
const wchar_t *  siConverterKeyword
  Converter property sets.
const wchar_t *  siCurrentKeyword
  Reuse keywords in property page dialog.
const wchar_t *  siCurveKeyword
  Curve property sets.
const wchar_t *  siCustomPSetKeyword
  CustomPSet property sets.
const wchar_t *  siDeformKeyword
  Deform property sets.
const wchar_t *  siDynamicsKeyword
  Dynamics property sets.
const wchar_t *  siExpressionsKeyword
  Expressions property sets.
const wchar_t *  siGeneralKeyword
  General property sets.
const wchar_t *  siGeneratorKeyword
  Generator property sets.
const wchar_t *  siGeometryKeyword
  Geometry property sets.
const wchar_t *  siHairKeyword
  Hair property sets.
const wchar_t *  siIKKeyword
  IK property sets.
const wchar_t *  siKinematicsKeyword
  Kinematics property sets.
const wchar_t *  siMeshKeyword
  Mesh property sets.
const wchar_t *  siMixerKeyword
  Mixer property sets.
const wchar_t *  siModelingKeyword
  Modeling property sets.
const wchar_t *  siOperatorsKeyword
  Operators property sets.
const wchar_t *  siParticleKeyword
  Particle property sets.
const wchar_t *  siPrimitiveKeyword
  Primitive property sets.
const wchar_t *  siProjectionKeyword
  Projection property sets.
const wchar_t *  siRenderingKeyword
  Rendering property sets.
const wchar_t *  siSimulationKeyword
  Simulation property sets.
const wchar_t *  siSurfaceKeyword
  Surface property sets.
const wchar_t *  siTopologyEditorKeyword
  Topology Editor property sets.
const wchar_t *  siTopologyKeyword
  Topology property sets.
const wchar_t *  siViewingKeyword
  Viewing property sets.
const wchar_t *  siBoundaryCluster
  boundary cluster
const wchar_t *  siEdgeCluster
  edge cluster
const wchar_t *  siFaceCluster
  face cluster
const wchar_t *  siIsoLineUCluster
  iso line U cluster
const wchar_t *  siIsoLineVCluster
  iso line V cluster
const wchar_t *  siIsoPointCluster
  iso point cluster
const wchar_t *  siKnotCluster
  knot cluster
const wchar_t *  siKnotCurveUCluster
  knot curve U cluster
const wchar_t *  siKnotCurveVCluster
  knot curve V cluster
const wchar_t *  siPolygonCluster
  polygon cluster
const wchar_t *  siPolygonNodeCluster
  polygon node cluster
const wchar_t *  siSampledPointCluster
  sampled point cluster
const wchar_t *  siSubCurveCluster
  subcurve cluster
const wchar_t *  siSubSurfaceCluster
  subsurface cluster
const wchar_t *  siSurfaceCurveCluster
  surface curve cluster
const wchar_t *  siTrimCurveCluster
  trim curve cluster
const wchar_t *  siVertexCluster
  vertex cluster
const wchar_t *  si0DComponentFamily
  0D Component family
const wchar_t *  si1DComponentFamily
  1D Component family
const wchar_t *  si2DComponentFamily
  2D Component family
const wchar_t *  si3DObjectFamily
  3D Object family
const wchar_t *  siAssignmentOperatorFamily
  Assignment operator family.
const wchar_t *  siCameraFamily
  Camera family.
const wchar_t *  siChainElementFamily
  Chain Element family.
const wchar_t *  siClusterableComponentFamily
  Clusterable Component family.
const wchar_t *  siClusterFamily
  Cluster family.
const wchar_t *  siConstraintFamily
  Constraint property family.
const wchar_t *  siContourContrastShaderFamily
  Contour Contrast shader family.
const wchar_t *  siContourShaderFamily
  Contour shader family.
const wchar_t *  siContourStoreShaderFamily
  Contour Store shader family.
const wchar_t *  siControlObjectFamily
  Control Object family.
const wchar_t *  siControlObjectNurbsTextureFamily
  Control Object Nurbs Texture family.
const wchar_t *  siControlObjectTextureFamily
  Control Object Texture family.
const wchar_t *  siControlObjectTextureProjectionFamily
  Control Object Texture Projection family.
const wchar_t *  siConverterOperatorFamily
  Converter operator family.
const wchar_t *  siCurveFamily
  Curve Geometry family.
const wchar_t *  siDeformOperatorFamily
  Deform operator family.
const wchar_t *  siDisplacementShaderFamily
  Displacement shader family.
const wchar_t *  siEnvironmentShaderFamily
  Environment shader family.
const wchar_t *  siFxOperatorFamily
  Fx Operator family.
const wchar_t *  siGeneratorOperatorFamily
  Generator operator family.
const wchar_t *  siGeometryFamily
  Geometry family.
const wchar_t *  siGeometryShaderFamily
  Geometry shader family.
const wchar_t *  siGroupFamily
  Group family.
const wchar_t *  siImageOperatorFamily
  Image Operator family.
const wchar_t *  siImplicitGeometryFamily
  Implicit Geometry family.
const wchar_t *  siKineInfoFamily
  KineInfo property family.
const wchar_t *  siLatticeFamily
  Lattice family.
const wchar_t *  siLensShaderFamily
  Lens shader family.
const wchar_t *  siLightPhotonShaderFamily
  Light Photon shader family.
const wchar_t *  siLightPrimitiveFamily
  Light Primitive family.
const wchar_t *  siLightShaderFamily
  Light shader family.
const wchar_t *  siMaterialFamily
  Material property family.
const wchar_t *  siMaterialShaderFamily
  Material shader family.
const wchar_t *  siMeshFamily
  Mesh Geometry family.
const wchar_t *  siNullPrimitiveFamily
  Null Primitive family.
const wchar_t *  siNurbsCurveListFamily
  Nurbs CurveList Geometry family.
const wchar_t *  siNurbsSurfaceMeshFamily
  Nurbs Surface Mesh Geometry family.
const wchar_t *  siOperatorFamily
  Operator family.
const wchar_t *  siOutputShaderFamily
  Output shader family.
const wchar_t *  siParticleControlObjectFamily
  Particle Control Object family.
const wchar_t *  siParticleFamily
  Particle family.
const wchar_t *  siPassFamily
  Pass family.
const wchar_t *  siPatchNetworkFamily
  Patch Network family.
const wchar_t *  siPhotonShaderFamily
  Photon shader family.
const wchar_t *  siPlanarObjectFamily
  Planar Object family.
const wchar_t *  siPointCloudFamily
  Point Cloud Geometry family.
const wchar_t *  siPropertyFamily
  Property family.
const wchar_t *  siRealTimeShaderFamily
  RealTime shader family.
const wchar_t *  siShaderFamily
  Shader family.
const wchar_t *  siShadowShaderFamily
  Shadow shader family.
const wchar_t *  siSubComponentFamily
  SubComponent family.
const wchar_t *  siSurfaceCurveFamily
  Surface Curve Geometry family.
const wchar_t *  siSurfaceFamily
  Surface Geometry family.
const wchar_t *  siTextureShaderFamily
  Texture shader family.
const wchar_t *  siTopologyOperatorFamily
  Topology operator family.
const wchar_t *  siVirtualComponentFamily
  Virtual Component family.
const wchar_t *  siVirtualCurveFamily
  Virtual Curve family.
const wchar_t *  siVolumeShaderFamily
  Volume shader family.
const wchar_t *  si2PntCnsType
  Two Points Constraint type.
const wchar_t *  si3DObjectType
  3D Object type
const wchar_t *  si3PntCnsType
  Three Points Constraint type.
const wchar_t *  siActionClipType
  Action Clip type (instanced action)
const wchar_t *  siActionType
  Action type.
const wchar_t *  siAddEdgeOpType
  AddEdge Operator type (add an edge between an existing point and an existing edge)
const wchar_t *  siAddMeshPntOpType
  Add Mesh Points Operator type.
const wchar_t *  siAddNurbsCrvPntOpType
  Add Nurbs Curve Points Operator type.
const wchar_t *  siAddNurbsSrfPntOpType
  Add Nurbs Surface Points Operator type.
const wchar_t *  siAddPntMiddleCrvType
  Add Point Inside Curve Operator type.
const wchar_t *  siAddPntMiddleSrfOpType
  Add Point Inside Surface Operator type.
const wchar_t *  siAmbientLightingType
  Ambient Lighting type.
const wchar_t *  siArcPrimType
  Implicit Arc Primitive type.
const wchar_t *  siAttractorCtrlType
  Attractor Control Object type (electric force)
const wchar_t *  siAutoCageAssignOpType
  Automatic Cage Assignment Operator type.
const wchar_t *  siAutoEnvAssignOpType
  Automatic Envelope Assignment Operator type.
const wchar_t *  siBallJointCnsType
  Ball Joint Constraint type.
const wchar_t *  siBasePathCnsType
  Base Path Constraint type.
const wchar_t *  siBendOpType
  Bend Operator type.
const wchar_t *  siBevelOpType
  Bevel Operator type (bevel geometry component)
const wchar_t *  siBirail2GenOpType
  Birail2Generators Operator Type.
const wchar_t *  siBirailOpType
  Birail Operator type (generates a surface from 2 curves and a profile)
const wchar_t *  siBlasterOpType
  Blaster Operator type.
const wchar_t *  siBlendCrvOpType
  Blend Curves Operator type (create a blended curve between two existing curves)
const wchar_t *  siBlendSrfOpType
  Blend Surfaces Operator type (blend surfaces)
const wchar_t *  siBooleanGenOpType
  Boolean Generator Operator type.
const wchar_t *  siBooleanSrfTopoOpType
  Boolean Surface Operator type.
const wchar_t *  siBPlaneCnsType
  Bounding Plane Constraint type.
const wchar_t *  siBridgeOpType
  Bridge Op Operator type (bridge polygon)
const wchar_t *  siBrushPropertiesType
  Brush Properties type.
const wchar_t *  siBulgeOpType
  Bulge Op Operator type.
const wchar_t *  siBVolCnsType
  Bounding Volume Constraint type.
const wchar_t *  siCageDeformOpType
  Cage Deform Operator type.
const wchar_t *  siCamDispType
  Camera Display type.
const wchar_t *  siCameraLensFlareType
  Camera Lens Flare type.
const wchar_t *  siCameraPrimType
  Camera Primitive type.
const wchar_t *  siCameraRootPrimType
  Camera Root primitive type.
const wchar_t *  siCameraTxtOpType
  CameraTxt Operator type (camera texture projection operator)
const wchar_t *  siCamVisType
  Camera Visibility type.
const wchar_t *  siCapOpType
  CapOp type.
const wchar_t *  siCenterOpType
  Center Operator type (center manipulation)
const wchar_t *  siChainBonePrimType
  Chain Bone Primitive type.
const wchar_t *  siChainEffPrimType
  Chain End Effector Primitive type.
const wchar_t *  siChainRootPrimType
  Chain Root Primitive type.
const wchar_t *  siCirclePrimType
  Implicit Circle Primitive type.
const wchar_t *  siCleanCrvOpType
  Clean Curve Operator type.
const wchar_t *  siCleanSrfOpType
  Clean Surface Operator type.
const wchar_t *  siClothOpType
  Cloth Operator type.
const wchar_t *  siClothPropType
  Cloth Property type.
const wchar_t *  siCloudPrimType
  Cloud Primitive type.
const wchar_t *  siClsColorType
  Cluster Color type.
const wchar_t *  siClsCtrOpType
  Cluster Center Operator type (cluster center deformation)
const wchar_t *  siClsKeyType
  Cluster Key type.
const wchar_t *  siClsKeyWgtMapOpType
  Cluster Key Weight Map Operator type.
const wchar_t *  siClsPoseType
  Cluster Pose type.
const wchar_t *  siClsShapeCombinerOpType
  Cluster Shape Combiner Operator type.
const wchar_t *  siClsUVSpaceTxtType
  Cluster Property UV Texture Projection type.
const wchar_t *  siCoBBoxSclOpType
  CoBBoxSclOp type.
const wchar_t *  siCollapseOpType
  Collapse Operator type (collapse geometry component)
const wchar_t *  siConePrimType
  Cone Primitive type.
const wchar_t *  siCoPoseFCrvOpType
  CoPoseFCurveOp type.
const wchar_t *  siCopyOpType
  Copy Operator type (geometry copy operator for instances)
const wchar_t *  siCopyShapeOpType
  copyshape operator type
const wchar_t *  siCopyUVWOpType
  CopyUVW Operator type.
const wchar_t *  siCreatePolyOpType
  Create Polygon Operator type.
const wchar_t *  siCrvCnsType
  Curve Constraint type.
const wchar_t *  siCrvCreationOpType
  Curve Creation Operator type.
const wchar_t *  siCrvCtrlOpType
  CrvControlOp type.
const wchar_t *  siCrvCutOpType
  CrvCutOp type.
const wchar_t *  siCrvDeformOpType
  Curve Deform Operator type.
const wchar_t *  siCrvListAggregatePrimType
  NURBS Curve List Aggregate Primitive type.
const wchar_t *  siCrvListPrimType
  NURBS Curve List Primitive type.
const wchar_t *  siCrvListToMeshOpType
  Curve To Mesh Converter Operator type (curve list to polygon mesh converter)
const wchar_t *  siCrvNetOpType
  Curve Net Operator type.
const wchar_t *  siCrvOpenCloseOpType
  Open/Close Curve Operator type (open or close a curve)
const wchar_t *  siCrvReparamOpType
  Reparameterize Curve Operator type.
const wchar_t *  siCrvShiftOpType
  Curve Shift Operator type.
const wchar_t *  siCubePrimType
  Cube Primitive type.
const wchar_t *  siCustomParamSet
  Custom Parameter Set type.
const wchar_t *  siCycleUVWType
  Cycleuvw Operator type.
const wchar_t *  siCylinderPrimType
  Cylinder Primitive type.
const wchar_t *  siDeformBySpineOp2Type
  Deform By Spine Operator type (alternate envelope by spine operator)
const wchar_t *  siDeformBySpineOpType
  Deform by spine operator type (envelope by spine)
const wchar_t *  siDeformOpType
  Base Deform Operator type.
const wchar_t *  siDeleteCompOpType
  Delete Component Operator type (delete geometry component)
const wchar_t *  siDelPntCrvOpType
  Delete Point From Curve Operator type.
const wchar_t *  siDGlowType
  DGlow type.
const wchar_t *  siDirCnsType
  Direction Constraint type.
const wchar_t *  siDiscPrimType
  Disc Primitive type.
const wchar_t *  siDisplayType
  Display type.
const wchar_t *  siDissolveCompOpType
  Dissolve Component Operator type (dissolve geometry component)
const wchar_t *  siDistanceOpType
  Distance Operator type.
const wchar_t *  siDistCnsType
  Distance Constraint type.
const wchar_t *  siDodecahedronPrimType
  Dodecahedron Primitive type.
const wchar_t *  siDragCtrlPrimType
  Drag Control Primitive type.
const wchar_t *  siEddyCtrlPrimType
  Eddy Control Primitive type.
const wchar_t *  siEditPolyOpType
  Edit Polygon Operator type.
const wchar_t *  siEmissionPropType
  Emission Property type.
const wchar_t *  siEnvelopOpType
  Envelope Operator type.
const wchar_t *  siEnvSelClsOpType
  Envelope Selection Clusters Operator type.
const wchar_t *  siEnvWgtType
  Envelope Weights type.
const wchar_t *  siExplosionOpType
  Explosion Operator type.
const wchar_t *  siExtendCrv2PntOpType
  Extend Curve To Point Operator type.
const wchar_t *  siExtendToCrvOpType
  Extend To Curve Operator type (extend the surface to the selected curve)
const wchar_t *  siExtractCrvOpType
  Extract Curve Operator type.
const wchar_t *  siExtractCrvSegOpType
  Extract Curve Segment Operator type (extract a curve from a segment of an existing curve)
const wchar_t *  siExtractPolyOpType
  Extract Polygons Operator type.
const wchar_t *  siExtractSubCrvOpType
  Extract Subcurve Operator type.
const wchar_t *  siExtrude2ProfsOpType
  Extrusion 2 Profiles Operator type (extrude 2 profiles)
const wchar_t *  siExtrudeCompAxisOpType
  Extrude Component Axis Operator type (extrude geometry component)
const wchar_t *  siExtrudeComponentOpType
  Extrude Component Operator type (extrude geometry component)
const wchar_t *  siExtrusionOpType
  Extrusion Operator type (extrude a curve to create a surface)
const wchar_t *  siFanType
  Fan Force Object type.
const wchar_t *  siFilletCrvOpType
  Fillet Curves Operator type (intersecting or not)
const wchar_t *  siFilletSrfOpType
  Fillet Surfaces Operator type.
const wchar_t *  siFillHoleOpType
  Fill Hole Operator type.
const wchar_t *  siFilterEdgeOpType
  Edge Filter Operator type.
const wchar_t *  siFilterPolyOpType
  Polygon Filter Operator type.
const wchar_t *  siFitCrvOpType
  Fit Curve Operator type (fit a new curve on to the selected curve)
const wchar_t *  siFitSrfOpType
  Fit Surface Operator type (fit a new surface on to the selected surface)
const wchar_t *  siFlipUVWOpType
  Flip UVW Operator type.
const wchar_t *  siFluidOpType
  Fluid Operator type.
const wchar_t *  siFoldOpType
  Fold Operator type.
const wchar_t *  siFourSidedOpType
  Four Sided Operator type.
const wchar_t *  siFurOpType
  Fur Operator type (fur generator operator)
const wchar_t *  siFurPrimType
  Fur Primitive type.
const wchar_t *  siFurPropType
  Fur Property type.
const wchar_t *  siFurSimOpType
  Fur Simulation Operator type.
const wchar_t *  siGeneratorOpType
  Base Generator Operator type.
const wchar_t *  siGeomApproxType
  Geometry Approximation type (tesselation)
const wchar_t *  siGeoShaderPrimType
  GeoShader Primitive Type.
const wchar_t *  siGeoTxtOpType
  GeoTxtOp type (copy geometry xyz to uvw texture operator)
const wchar_t *  siGlobalType
  Global Transform type.
const wchar_t *  siGravityCtrlType
  Gravity Force Control Object type.
const wchar_t *  siGridPrimType
  Grid Primitive type.
const wchar_t *  siGroup
  Group type (obsolete)
const wchar_t *  siGroupType
  Group type.
const wchar_t *  siHealOpType
  Heal Operator type.
const wchar_t *  siHealUVWOpType
  Heal UVW Operator type.
const wchar_t *  siIcosahedronPrimType
  Icosahedron Primitive type.
const wchar_t *  siImageClipType
  Image Clip type.
const wchar_t *  siImageCropOpType
  Image Crop Operator type.
const wchar_t *  siImageFXOpType
  Image FX Operator type.
const wchar_t *  siImageObjectType
  Image Object type.
const wchar_t *  siImageSourceOpType
  Image Source Operator type.
const wchar_t *  siImageSourceType
  Image Source type.
const wchar_t *  siInsertCrvKnotOpType
  Insert Curve Knot Operator type.
const wchar_t *  siInsSrfKnotOpType
  Insert Surface Knot Operator type (inserts a knot in a nurbs surface)
const wchar_t *  siIntersectSrfOpType
  Intersect Surfaces Operator type (extract a curve from the intersection of two surfaces)
const wchar_t *  siInvCrvOpType
  Inverse Curve Operator type (inverse curve direction)
const wchar_t *  siInvertPolyOpType
  Invert Polygon Operator type.
const wchar_t *  siInvisiblePolygonsClusterName
  Name of the InvisiblePolygons cluster.
const wchar_t *  siInvSrfOpType
  Inverse Normals Operator type (inverse normals direction)
const wchar_t *  siKineChainPropType
  Kinematic Chain Properties type.
const wchar_t *  siKineChainType
  Kinematic Chain type.
const wchar_t *  siKineCnsType
  Kinematic Constraint type.
const wchar_t *  siKineInfoType
  Kinematics Information type.
const wchar_t *  siKineJointType
  Kinematic Joint type.
const wchar_t *  siLatticeOpType
  Lattice Operator type.
const wchar_t *  siLatticePrimType
  Lattice Primitive type.
const wchar_t *  siLayersType
  Layers type.
const wchar_t *  siLightLensFlareType
  Light Lens Flare type.
const wchar_t *  siLightPrimType
  Light Primitive type.
const wchar_t *  siLineCnsType
  Line Constraint type.
const wchar_t *  siLocalType
  Local Transform type.
const wchar_t *  siLoftOpType
  Loft Generator Operator type.
const wchar_t *  siMapCompOpType
  Component Map Operator type.
const wchar_t *  siMarkHardEdgeVertexOpType
  Mark Hard Edge/Vertex Operator type.
const wchar_t *  siMaterialType
  Material type.
const wchar_t *  siMergeCrvOpType
  Merge Curves Operator type.
const wchar_t *  siMergeMeshOpType
  Merge Meshes Operator type.
const wchar_t *  siMergeSrfOpType
  Merge Surfaces Operator type.
const wchar_t *  siMeshLocalSubdivisionOpType
  Mesh Local Subdivision Operator type.
const wchar_t *  siMeshSubdivOpType
  Mesh Subdivision Operator type.
const wchar_t *  siMeshSubdivWithCenterOpType
  Mesh Subdivide With Center Operator type (mesh subdivision with center)
const wchar_t *  siMixerAnimClipType
  Mixer Animation Clip type.
const wchar_t *  siMixerAnimTrackType
  Mixer Animation Action Track type.
const wchar_t *  siMixerAudioClipType
  Mixer Audio Clip type.
const wchar_t *  siMixerAudioTrackType
  Mixer Audio Track type.
const wchar_t *  siMixerPropType
  Mixer Property type.
const wchar_t *  siMixerShapeClipType
  Mixer Shape Clip type.
const wchar_t *  siMixerShapeTrackType
  Mixer Shape Track type.
const wchar_t *  siMixerType
  Mixer type (property)
const wchar_t *  siModelClipType
  3D Model Clip type
const wchar_t *  siModelNullPrimType
  Model Null Primitive type.
const wchar_t *  siModelType
  3D Model type
const wchar_t *  siMotionBlurType
  Motion Blur type.
const wchar_t *  siMoveComponentOpType
  Move Component Operator type.
const wchar_t *  siNPntCnsType
  N Points Constraint type.
const wchar_t *  siNullPrimType
  Null Primitive type.
const wchar_t *  siNurbsToMeshOpType
  Nurbs To Mesh Operator type.
const wchar_t *  siObjClsCnsType
  Object To Cluster Constraint type.
const wchar_t *  siObstaclePropType
  Obstacle Property type.
const wchar_t *  siOctahedronPrimType
  Octahedron Primitive type.
const wchar_t *  siOffsetClsOpType
  Offset Cluster Operator type.
const wchar_t *  siOffsetCrvOpType
  Offset Curve Operator type.
const wchar_t *  siOffsetSrfOpType
  Offset Surface Operator type (offset a surface to create a new surface)
const wchar_t *  siOpenCloseSrfOpType
  Open/Close Surface Operator type (open or close a surface)
const wchar_t *  siOriCnsType
  Orientation Constraint type.
const wchar_t *  siOverrideType
  Override type.
const wchar_t *  siParDecayType
  Particle decay type.
const wchar_t *  siParObstExtSparksType
  ParObstExtSparks type.
const wchar_t *  siParticleEventType
  Particle Event type.
const wchar_t *  siParticlesOpType
  Particles Operator type.
const wchar_t *  siPathCnsType
  Path Constraint type.
const wchar_t *  siPinJointCnsType
  Pin Joint Constraint type.
const wchar_t *  siPlaneCnsType
  Plane Constraint type.
const wchar_t *  siPointCloudPrimType
  Point CloudPrimitive type.
const wchar_t *  siPolyMeshPNetOpType
  PolyMeshPNetOp type.
const wchar_t *  siPolyMeshType
  Polygon Mesh type.
const wchar_t *  siPosCnsType
  Position Constraint type.
const wchar_t *  siPoseCnsType
  Pose Constraint type.
const wchar_t *  siProjectCrvOpType
  Project Curve Operator type (project a curve on to a surface)
const wchar_t *  siProportionalOpType
  Proportional Modeling Operator type.
const wchar_t *  siPropVolumeOpType
  Proportional Volume Operator type.
const wchar_t *  siPushOpType
  Push Operator type.
const wchar_t *  siQStretchOpType
  QStretch Operator type (quick stretch)
const wchar_t *  siRandomizeOpType
  Randomize Operator type.
const wchar_t *  siRefPlaneType
  Reference Plane type.
const wchar_t *  siRelaxUVWOpType
  Relax UVW Operator type.
const wchar_t *  siRemoveCrvKnotOpType
  Remove Curve Knot Operator type.
const wchar_t *  siRemSrfKnotOpType
  Remove Surface Knot Operator type (removes a knot from a nurbs surface)
const wchar_t *  siRenderMapType
  Render Map type.
const wchar_t *  siRevolutionOpType
  Revolution Operator type.
const wchar_t *  siRotoscopeType
  Camera Rotoscopy type.
const wchar_t *  siSceneAmbienceType
  Scene Ambience type.
const wchar_t *  siSceneColorsType
  Scene Display Colors type.
const wchar_t *  siSclCnsType
  Scaling Constraint type.
const wchar_t *  siSCMFixerOpType
  SCM Fixer Operator type.
const wchar_t *  siSCMTopologyOpType
  SCM Topology Operator type.
const wchar_t *  siScriptedOpType
  Scripted Operator type (scripted operator host)
const wchar_t *  siSetEdgeCreaseValueOpType
  Set Edge Crease Value Operator type.
const wchar_t *  siShapeActionCompoundClipType
  Shape Action Compound Clip type (base compound clip)
const wchar_t *  siShapeActionType
  Shape Action type.
const wchar_t *  siVisemeActionType
  Viseme Action type.
const wchar_t *  siShearOpType
  Shear Operator type.
const wchar_t *  siShrinkWrapOpType
  Shrink Wrap Operator type.
const wchar_t *  siSkelCtrlOpPropType
  Skeleton Controller Operator type.
const wchar_t *  siSmoothEnvelopeWgtOpType
  Smooth Envelope Weight Operator type.
const wchar_t *  siSnapBoundOpType
  Snap Boundary Operator type.
const wchar_t *  siSnapCrvOpType
  Snap To Curves Operator type.
const wchar_t *  siSnipSrfOpType
  Snip Surface Operator type.
const wchar_t *  siSoftBodyOpType
  SoftBody Operator type.
const wchar_t *  siSpherePrimType
  Sphere Primitive type.
const wchar_t *  siSpineDefOp2Type
  Deform by Spine Operator 2 type (alternate operator)
const wchar_t *  siSpineDefOpType
  Deform by Spine Operator type.
const wchar_t *  siSpineWgtMapOp3Type
  Spine Weight Map Operator 3 type.
const wchar_t *  siSpineWgtMapOp4Type
  Deform by Spine Weight Map Operator 4 type.
const wchar_t *  siSpiralPrimType
  Implicit Spiral Primitive type.
const wchar_t *  siSplitEdgeOpType
  Split Edge Operator type (split some edges)
const wchar_t *  siSplitPolyOpType
  Split Polygon Operator type (split some polygons)
const wchar_t *  siSpotInterestPrimType
  Spot Interest Primitive type.
const wchar_t *  siSpotRootPrimType
  Spot Root Primitive type.
const wchar_t *  siSquarePrimType
  Implicit Square Primitive type.
const wchar_t *  siSrfCnsType
  Surface Constraint type.
const wchar_t *  siSrfCrvInverseOpType
  Surface Curve Inverse Operator type.
const wchar_t *  siSrfCrvShiftOpType
  Surface Curve Shift Operator type.
const wchar_t *  siSrfCtrlOpType
  SrfControlOp type.
const wchar_t *  siSrfDefOpType
  Surface Deform Operator type.
const wchar_t *  siSrfMeshPrimType
  NURBS Surface Mesh Primitive type.
const wchar_t *  siSrfPQOpType
  SurfacePQ Operator type.
const wchar_t *  siSrfReparamOpType
  Reparameterize Surface Operator type.
const wchar_t *  siSrfShiftOpType
  Surface Shift Operator type.
const wchar_t *  siSrfSubdivisionOpType
  Surface Subdivision Operator type.
const wchar_t *  siSrfUVCtrlOpType
  Surface UV Control Operator type (Nurbs UV control)
const wchar_t *  siStandInPrimType
  Stand-in Primitive type.
const wchar_t *  siStartOffsetOpType
  Start Offset Operator type.
const wchar_t *  siStitchCrvToCrvOpType
  Stitch Curve To Curve Operator type (stitch curves together)
const wchar_t *  siStitchCrvToSrfOpType
  Stitch Curve To Surface Operator type.
const wchar_t *  siStitchSrfOpType
  Stitch Surfaces Operator type (stitch surfaces and curves together)
const wchar_t *  siStrokeOpType
  Gap Stroke Operator type.
const wchar_t *  siSubCompType
  Subcomponents type.
const wchar_t *  siSubdivEdgeOpType
  Subdivide Edge Operator type.
const wchar_t *  siSubdivPolyOpType
  Subdivide Polygon Operator type.
const wchar_t *  siSwapSrfUVOpType
  Swap Surface UVs Operator type.
const wchar_t *  siSymmetrizePolygon
  Symmetrize Polygon Operator type.
const wchar_t *  siSymmetryCnsType
  Symmetry Constraint type.
const wchar_t *  siSymmetryMapOpType
  Symmetry Map Genrator Operator type.
const wchar_t *  siSymmetryMapType
  Symmetry Map type.
const wchar_t *  siSynopticViewType
  Synoptic View type.
const wchar_t *  siTaperOpType
  Taper Operator type.
const wchar_t *  siTetrahedronPrimType
  Tetrahedron Primitive type.
const wchar_t *  siTextToCrvListOpType
  Text To CurveList Operator type.
const wchar_t *  siTorusPrimType
  Torus Primitive type.
const wchar_t *  siTrajCnsType
  Trajectory Constraint type.
const wchar_t *  siTransformSetupType
  Transform Setup type.
const wchar_t *  siTurbulenceCtrlPrimType
  Turbulence Control Primitive type.
const wchar_t *  siTwistOpType
  Twist Operator type.
const wchar_t *  siTxtMapType
  Texture Map type.
const wchar_t *  siTxtOpType
  Texture Projection Operator type.
const wchar_t *  siTxtSupportType
  Texture Support type.
const wchar_t *  siUpVctCnsType
  Up Vector Constraint type.
const wchar_t *  siUserMotionType
  User Motion Property type.
const wchar_t *  siUserNormalType
  User Normal Property type.
const wchar_t *  siUVProjDefType
  UV Projection Definition type (definition of how to perform a texture projection)
const wchar_t *  siVertexcolorType
  Vertex Color type.
const wchar_t *  siVisibilityType
  Visibility type.
const wchar_t *  siVolumeDeformType
  Volume Deform type (implicit sphere volume)
const wchar_t *  siVolumicLightSceneType
  Volumic Light Scene Local Property Set type.
const wchar_t *  siVolumicLightType
  Volumic Light Effect type.
const wchar_t *  siVortexCtrlType
  Vortex Control Object type (magnetic force)
const wchar_t *  siVtxColPainterOpType
  Vertex Color Painter Operator type.
const wchar_t *  siVtxColPropOpType
  Vertex Color Property Generator Operator type.
const wchar_t *  siWaveCtrlType
  Wave Control Object type.
const wchar_t *  siWaveOpType
  Wave Operator type.
const wchar_t *  siWeldEdgesOpType
  Weld Edges Operator type (weld pair of edges together)
const wchar_t *  siWeldPntOpType
  Weld Points Operator type (weld two points together)
const wchar_t *  siWgtMapCnxOpType
  Weight Map Connection Operator type.
const wchar_t *  siWgtMapOpType
  Weight Map Generator Operator type.
const wchar_t *  siWgtMapsMixOpType
  Weight Maps Mixer Operator type.
const wchar_t *  siWgtMapType
  Weight Map type.
const wchar_t *  siWgtPainterOpType
  Weight Painter Operator type.
const wchar_t *  siWindType
  Wind Force Object type.
const wchar_t *  siWtStrokeOpType
  Weight Stroke Operator type.
const wchar_t *  siControlBitmap
const wchar_t *  siControlBoolean
const wchar_t *  siControlButton
const wchar_t *  siControlCheck
const wchar_t *  siControlCombo
const wchar_t *  siControlEdit
const wchar_t *  siControlFCurve
const wchar_t *  siControlFilePath
const wchar_t *  siControlFolder
const wchar_t *  siControlGrid
const wchar_t *  siControlIconList
const wchar_t *  siControlImageClip
const wchar_t *  siControlListBox
const wchar_t *  siControlNumber
const wchar_t *  siControlRadio
const wchar_t *  siControlRGB
const wchar_t *  siControlRGBA
const wchar_t *  siControlStatic
const wchar_t *  siControlString
const wchar_t *  siControlSynoptic
const wchar_t *  siControlTextEditor
const wchar_t *  siUIAlignCenter
const wchar_t *  siUIAlignLeft
const wchar_t *  siUIAlignRight
const wchar_t *  siUIAudioFile
const wchar_t *  siUICaption
const wchar_t *  siUIColumnCnt
const wchar_t *  siUIColumnGap
const wchar_t *  siUIContinue
const wchar_t *  siUICX
const wchar_t *  siUICY
const wchar_t *  siUIDecimals
const wchar_t *  siUIFCurveColorNonBijective
const wchar_t *  siUIFCurveGhosting
const wchar_t *  siUIFCurveGridSpaceX
const wchar_t *  siUIFCurveGridSpaceY
const wchar_t *  siUIFCurveLabelX
const wchar_t *  siUIFCurveLabelY
const wchar_t *  siUIFCurveNoGrid
const wchar_t *  siUIFCurveNoRulerX
const wchar_t *  siUIFCurveNoRulerY
const wchar_t *  siUIFCurveShowTimeCursor
const wchar_t *  siUIFCurveSnapX
const wchar_t *  siUIFCurveSnapY
const wchar_t *  siUIFCurveViewMaxX
const wchar_t *  siUIFCurveViewMaxY
const wchar_t *  siUIFCurveViewMinX
const wchar_t *  siUIFCurveViewMinY
const wchar_t *  siUIFileFilter
const wchar_t *  siUIFileMustExist
const wchar_t *  siUIFilePath
const wchar_t *  siUIImageFile
const wchar_t *  siUIInitialDir
const wchar_t *  siUILabel
const wchar_t *  siUILabelMinPixels
const wchar_t *  siUILabelPercentage
const wchar_t *  siUILineCnt
const wchar_t *  siUILineGap
const wchar_t *  siUILogarithmic
const wchar_t *  siUIMultiSelectionListBox
const wchar_t *  siUINoLabel
const wchar_t *  siUINoSlider
const wchar_t *  siUIOpenFile
const wchar_t *  siUISelectionColor
const wchar_t *  siUIShowClip
const wchar_t *  siUIShowFrame
const wchar_t *  siUIButtonDisable
const wchar_t *  siUIGridColumnWidths
const wchar_t *  siUIGridHideColumnHeader
const wchar_t *  siUIGridHideRowHeader
const wchar_t *  siUIGridLockColumnHeader
const wchar_t *  siUIGridLockRowHeader
const wchar_t *  siUIGridReadOnlyColumns
const wchar_t *  siUIGridSelectionMode
const wchar_t *  siUIGridShowColumns
const wchar_t *  siUIStyle
const wchar_t *  siUISubFolder
const wchar_t *  siUISyncSlider
const wchar_t *  siUIThumbWheel
const wchar_t *  siUITreadmill
const wchar_t *  siUIItems
const wchar_t *  siUIType
const wchar_t *  siUIUseSelectionIcon
const wchar_t *  siUIValueOnly
const wchar_t *  siUIWidthPercentage
const wchar_t *  siUILineNumbering
const wchar_t *  siUIFolding
const wchar_t *  siUIBackgroundColor
const wchar_t *  siUIForegroundColor
const wchar_t *  siUIFont
const wchar_t *  siUICommentColor
const wchar_t *  siUIPreprocessorColor
const wchar_t *  siUIMarginWidth
const wchar_t *  siUICommentFont
const wchar_t *  siUIFontSize
const wchar_t *  siUIKeywords
const wchar_t *  siUIHeight
const wchar_t *  siUIHorizontalScroll
const wchar_t *  siUIVerticalScroll
const wchar_t *  siUILineWrap
const wchar_t *  siUIKeywordFile
const wchar_t *  siUIAutoComplete
const wchar_t *  siUIToolbar
const wchar_t *  siUICapability
const wchar_t *  siUIDictionary
const wchar_t *  siUIHelpFile
const wchar_t *  siUIHelpID
  Reference to a topic in the Help file.Normally this is only used for internal objects.
const wchar_t *  siUILanguage
  See PPGLayout.Language
const wchar_t *  siUILogic
  See PPGLayout.Logic
const wchar_t *  siUILogicFile
const wchar_t *  siUILogicPrefix
const wchar_t *  siUIShowChildren
const wchar_t *  siArgHandlerAnimatableParameters
const wchar_t *  siArgHandlerCollection
const wchar_t *  siArgHandlerFrame
const wchar_t *  siArgHandlerFrameRate
const wchar_t *  siArgHandlerMarkedParameters
const wchar_t *  siArgHandlerSingleObj
const wchar_t *  siFilter3DObjectType
  Represents the filter objects that can be used with 3D objects.
const wchar_t *  siFilterObjectType
const wchar_t *  siFilterPropertyType
  Represents the filter objects that can be used with property objects.
const wchar_t *  siFilterSubComponentType
const wchar_t *  siClipAnimationType
const wchar_t *  siClipAnimCompoundType
const wchar_t *  siClipAudioType
  Represents clip objects which are instances of audio files.
const wchar_t *  siClipImageType
  Represents an ImageClip object.
const wchar_t *  siClipMixerType
  Represents clip objects which are the top-level container for all other clip objects.
const wchar_t *  siClipShapeCompoundType
const wchar_t *  siClipShapeType
const wchar_t *  siTrackAnimationType
const wchar_t *  siTrackAudioType
  Represents the track objects which organize audio Clip objects.
const wchar_t *  siTrackShapeType
  Represents the track objects which organize shape Clip objects.
const wchar_t *  siTransitionBridgeType
const wchar_t *  siTransitionCardinalType
const wchar_t *  siTransitionStandardType
const wchar_t *  siAnimCompoundAnimItem
  Represents a compound animation source stored in an ActionSource.
const wchar_t *  siConstraintAnimItem
  Represents an Constraint stored in an ActionSource.
const wchar_t *  siExpressionAnimItem
  Represents an Expression stored in an ActionSource.
const wchar_t *  siFCurveAnimItem
  Represents an FCurve stored in an ActionSource.
const wchar_t *  siShapeCompoundAnimItem
  Represents a shape compound source stored in an ActionSource.
const wchar_t *  siShapeKeyAnimItem
  Represents an ShapeKey stored in an ActionSource.
const wchar_t *  siStaticValueAnimItem
  Represents an StaticSource stored in an ActionSource.
const wchar_t *  siCompoundMappedItem
  Represents a compound item in a compound clip.
const wchar_t *  siConstraintMappedItem
const wchar_t *  siExpressionMappedItem
const wchar_t *  siFCurveMappedItem
const wchar_t *  siShapeCompoundMappedItem
  Represents a shape compound item in a compound clip.
const wchar_t *  siShapeKeyMappedItem
const wchar_t *  siStaticValueMappedItem
const wchar_t *  siSEFilterActionNodes
  Show only Action nodes.
const wchar_t *  siSEFilterAllNodeTypes
  Show All Node types.
const wchar_t *  siSEFilterAnimatableNodes
  Show only Animatable parameter nodes.
const wchar_t *  siSEFilterAnimatedNodes
  Show only Animated parameter nodes.
const wchar_t *  siSEFilterClusterNodes
  Show only Cluster nodes.
const wchar_t *  siSEFilterGroupNodes
  Show only Group nodes.
const wchar_t *  siSEFilterKeywordAll
  Show nodes with any keyword set.
const wchar_t *  siSEFilterKeywordAnimation
  Show nodes with Animation keyword set.
const wchar_t *  siSEFilterKeywordCustom
  Show nodes with Custom keyword set.
const wchar_t *  siSEFilterKeywordGeneral
  Show nodes with General keyword set.
const wchar_t *  siSEFilterKeywordKinematics
  Show nodes with Kinematics keyword set.
const wchar_t *  siSEFilterKeywordModeling
  Show nodes with Modeling keyword set.
const wchar_t *  siSEFilterKeywordRendering
  Show nodes with Rendering keyword set.
const wchar_t *  siSEFilterKeywordViewing
  Show nodes with Viewing keyword set.
const wchar_t *  siSEFilterMaterialNodes
  Show only Material nodes.
const wchar_t *  siSEFilterMiscellaneousNodes
  Show only Miscellaneous nodes.
const wchar_t *  siSEFilterModelNodes
  Show only Model nodes.
const wchar_t *  siSEFilterObjectNodes
  Show only Object nodes.
const wchar_t *  siSEFilterOperatorNodes
  Show only Operator nodes.
const wchar_t *  siSEFilterParameterNodes
  Show only regular Parameter (non-animatable) nodes.
const wchar_t *  siSEFilterPrimitiveNodes
  Show only Primitive nodes.
const wchar_t *  siSEFilterPropertyNodes
  Show only Property nodes.
const wchar_t *  siSEFilterSceneNodes
  Show only Scene nodes.
const wchar_t *  siSEFilterShaderNodes
  Show only Shader nodes.
const wchar_t *  siImageDataTypeRGBA
  Represents a four channel RGB color image, where the fourth channel is the alpha matte.
const wchar_t *  siImageDataTypeRGB
  Represents a three channel, RGBA color image.
const wchar_t *  siImageDataTypeRGBE
  Represents a four channel, RGB color image, where the fourth channel is an exponent.
const wchar_t *  siImageDataTypeAlpha
  Represents a single channel, alpha matte image.
const wchar_t *  siImageDataTypeIntensity
  Represents a single channel, grayscale intensity image.
const wchar_t *  siImageDataTypeDepth
  Represents a single channel, depth value image.
const wchar_t *  siImageDataTypeNormal
  Represents a three channel, vector image composed of normalized vectors.
const wchar_t *  siImageDataTypeMotion
  Represents a three channel, motion vector image.
const wchar_t *  siImageDataTypeVector
  Represents a three channel image composed of arbitrary vectors.
const wchar_t *  siImageDataTypePoint
  Represents a three channel image composed of arbitrary points in space.
const wchar_t *  siImageDataTypeLabel
  Represents a single channel, object label image.
const wchar_t *  siImageDataTypeBitMask
  Represents a single channel, single bit-mask image.
const wchar_t *  siATFilterPresetAll
  Display all nodes for the selected elements.
const wchar_t *  siATFilterPresetCustom
  Display any type of custom parameter set for the selected elements.
const wchar_t *  siATFilterPresetGeneral
  Display only the general properties for the selected elements.
const wchar_t *  siATFilterPresetModeling
  Display only the modeling properties for the selected elements.
const wchar_t *  siATFilterPresetAnimation
  Display only the animation properties for the selected elements.
const wchar_t *  siATFilterPresetKinematics
  Display only the kinematics properties for the selected elements.
const wchar_t *  siATFilterPresetRendering
  Display only the rendering properties for the selected elements.
const wchar_t *  siATFilterPresetViewing
  Display only the viewing properties for the selected elements.
const wchar_t *  siATFilterPresetLocalTransform
  Display only the local transform parameters for the selected elements.
const wchar_t *  siATFilterPresetPosition
  Display only the position parameters for the selected elements.
const wchar_t *  siATFilterPresetPositionX
  Display only the position in X parameters for the selected elements.
const wchar_t *  siATFilterPresetPositionY
  Display only the position in Y parameters for the selected elements.
const wchar_t *  siATFilterPresetPositionZ
  Display only the position in Z parameters for the selected elements.
const wchar_t *  siATFilterPresetRotation
  Display only the rotation parameters for the selected elements.
const wchar_t *  siATFilterPresetRotationX
  Display only the rotation in X parameters for the selected elements.
const wchar_t *  siATFilterPresetRotationY
  Display only the rotation in Y parameters for the selected elements.
const wchar_t *  siATFilterPresetRotationZ
  Display only the rotation in Z parameters for the selected elements.
const wchar_t *  siATFilterPresetScaling
  Display only the scaling parameters for the selected elements.
const wchar_t *  siATFilterPresetScalingX
  Display only the scaling in X parameters for the selected elements.
const wchar_t *  siATFilterPresetScalingY
  Display only the scaling in Y parameters for the selected elements.
const wchar_t *  siATFilterPresetScalingZ
  Display only the scaling in Z parameters for the selected elements.
const wchar_t *  siATFilterPresetColor
  Display only the color parameters for the selected elements.
const wchar_t *  siATFilterTaggedAll
  Filter all tagged parameters.
const wchar_t *  siATFilterTagged1
  Filter the tagged 1 parameters.
const wchar_t *  siATFilterTagged2
  Filter the tagged 2 parameters.
const wchar_t *  siATFilterTagged3
  Filter the tagged 3 parameters.
const wchar_t *  siATFilterTagged4
  Filter the tagged 4 parameters.
const wchar_t *  siATFilterTagged5
  Filter the tagged 5 parameters.
const wchar_t *  siATFilterTagged6
  Filter the tagged 6 parameters.
const wchar_t *  siATFilterTagged7
  Filter the tagged 7 parameters.
const wchar_t *  siATFilterTagged8
  Filter the tagged 8 parameters.
const wchar_t *  siATFilterTagged9
  Filter the tagged 9 parameters.
const wchar_t *  siATFilterTagged10
  Filter the tagged 10 parameters.
const wchar_t *  siReferenceFilterAttribute
const wchar_t *  siPropertyFilterAttribute
const wchar_t *  siCustomTypeNameAttribute
const wchar_t *  siShaderFamilyAttribute
  Type of filter for a shader's family.
const wchar_t *  siDefaultConnectionAttribute
const wchar_t *  siWritableImageAttribute
  Type of filter for a writable image.
const wchar_t *  siWritableImageTypeAttribute
  Type of filter for a writable image type.
const wchar_t *  siRenderTreeNodeColorRAttribute
  Type of filter to match the Red color for a RenderTree node.
const wchar_t *  siRenderTreeNodeColorGAttribute
  Type of filter to match the Green color for a RenderTree node.
const wchar_t *  siRenderTreeNodeColorBAttribute
  Type of filter to match the Blue color for a RenderTree node.
const wchar_t *  siHWShaderVersionAttribute
  Attribute used for defining the version of a hardware shader.
const wchar_t *  siShaderFamilyCntContrast
  mental ray Contour Contrast Shader
const wchar_t *  siShaderFamilyCntMat
  mental ray Contour Material
const wchar_t *  siShaderFamilyCntStore
  mental ray Contour Store Shader
const wchar_t *  siShaderFamilyData
  mental ray Data Blob
const wchar_t *  siShaderFamilyEnvironment
  mental ray Environment Shader (environment phenomenon in a material or camera)
const wchar_t *  siShaderFamilyGeometry
  mental ray Geometry Shader (geometry phenomenon)
const wchar_t *  siShaderFamilyLens
  mental ray Lens Shader (lens phenomenon in a camera)
const wchar_t *  siShaderFamilyLight
  mental ray Light Shader (light phenomenon)
const wchar_t *  siShaderFamilyLightmap
  mental ray Lightmap Shader
const wchar_t *  siShaderFamilyOutput
  mental ray Output Shader (output phenomenon in a camera)
const wchar_t *  siShaderFamilyPhenomMat
  mental ray Material Phenomenon
const wchar_t *  siShaderFamilyPhotonLight
  mental ray Photon Light Shader (photon emitter phenomenon in a light)
const wchar_t *  siShaderFamilyPhotonMat
  mental ray Photon Material Shader (photon phenomenon in a material)
const wchar_t *  siShaderFamilyPhotonVolume
  mental ray Photon Volume Shader (photon phenomenon in a material or camera)
const wchar_t *  siShaderFamilyShadowMat
  mental ray Shadow Material Shader (shadow phenomenon in a material)
const wchar_t *  siShaderFamilyState
  mental ray State Shader
const wchar_t *  siShaderFamilySurfaceMat
  mental ray Surface Material Shader (material phenomenon in a material)
const wchar_t *  siShaderFamilyTexture
  mental ray Texture Shader (texture phenomenon)
const wchar_t *  siShaderFamilyVolume
  mental ray Volume Shader (volume phenomenon in a material or camera)
const wchar_t *  siShaderFamilyRTShader
  Realtime Shader.
const wchar_t *  siMentalRayLightmapPortType
const wchar_t *  siMentalRayGeometryPortType
const wchar_t *  siMentalRayContourStorePortType
const wchar_t *  siMentalRayContourContrastPortType
const wchar_t *  siMentalRayPhenomenonMaterialPortType
const wchar_t *  siXGSRealTimePortType
const wchar_t *  siHWShaderPortType
const wchar_t *  siHardwareVertexPosition
const wchar_t *  siHardwareVertexNormal
const wchar_t *  siHardwareVertexColor
  Default vertex color name.
const wchar_t *  siHardwareVertexTangent
  Tangent.
const wchar_t *  siHardwareVertexBinormal
  Binormal.
const wchar_t *  siHardwareVertexTexCoord
  Texture projection.
const wchar_t *  siHardwareVertexWeightMap
  Weight map.
const wchar_t *  siHardwareVertexPointVelocity
  Point velocity.
const wchar_t *  siHardwareVertexOrientation
  Orientation.
const wchar_t *  siHardwareVertexAge
  Age.
const wchar_t *  siHardwareVertexRadius
  Radius.
const wchar_t *  siHardwareVertexID
  ID.
const wchar_t *  siHardwareVertexFog
  Fog.
const wchar_t *  siHardwareVertexWeight
  Weight.
const wchar_t *  siHardwareVertexIndice
  Index.
const wchar_t *  siHardwareVertexTessfactor
  Tesselation factor.
const wchar_t *  siHardwareVertexDepth
  Depth.
const wchar_t *  siHardwareVertexSample
  Sample.
const wchar_t *  siHardwareVertexAuto
  Let Softimage handle the creation of the attribute (useful for tangents and binormals).
const wchar_t *  siICERenderPropSuffixUWrap
  Constant Boolean ICE attribute to control texture U wrapping.
const wchar_t *  siICERenderPropSuffixVWrap
  Constant Boolean ICE attribute to control texture V wrapping.
const wchar_t *  siICERenderPropSuffixWWrap
  Constant Boolean ICE attribute to control texture W wrapping.
const wchar_t *  siICERenderPropSuffixTransform
  Constant Matrix44 ICE attribute to control texture matrix.
const wchar_t *  siICERenderPropSuffixIsHomogeneous
  Constant Boolean ICE attribute to control if coordinates are homogeneous.
const wchar_t *  siICERenderPropSuffixSmoothWhenSubd
  Constant Boolean ICE attribute to control if attributes are smoothed based on the subdivision ssurface algorithm.
static const char  kRevLogTable256 []
const LONG  kBitShift = 5
const LONG  kBitSize = 32
CVector3  m_vOrigin
CVector3  m_vTangent
CVector3  m_vNormal
CVector3  m_vTangentU
CVector3  m_vTangentV
siXZY = 1
  X, Z, Y order.
siYXZ = 2
  Y, X, Z order.
siYZX = 3
  Y, Z, X order.
siZXY = 4
  Z, X, Y order.
siZYX
  Z, Y, X order.
float  m_X
float  m_Y
float  m_Z
union {
   float   m_W
   float   m_Angle
   RotationOrder   m_rotOrder
}; 
unsigned char  m_rotRep
void *  m_pImpl

Detailed Description

The XSI namespace defines a region where all API classes are declared.

Namespaces are used to prevent global namespace pollution and name clashing.

All API classes defined in the C++ API are assigned to the XSI namespace. Members of the XSI namespace can be identified explicitly with the symbol XSI for code clarity. To simplify the code however, namespace members can be referenced without the namespace symbol by using the C++ using directive.

Example:
Demonstrates use of namespace
        // namespace qualification
        XSI::CSIObject myObj;

        // CSIObject referenced without explicit qualification
        using namespace XSI;
        CSIObject myObj;

Typedef Documentation

typedef XSI::CDataArray< float > CDataArrayFloat

Definition at line 1041 of file xsi_dataarray.h.

Definition at line 1042 of file xsi_dataarray.h.

Definition at line 1043 of file xsi_dataarray.h.

Definition at line 1044 of file xsi_dataarray.h.

Definition at line 1045 of file xsi_dataarray.h.

Definition at line 1046 of file xsi_dataarray.h.

typedef XSI::CDataArray< XSI::MATH::CQuaternionf > CDataArrayQuaternionf

Definition at line 1047 of file xsi_dataarray.h.

typedef XSI::CDataArray< XSI::MATH::CRotationf > CDataArrayRotationf

Definition at line 1048 of file xsi_dataarray.h.

typedef XSI::CDataArray< XSI::MATH::CMatrix3f > CDataArrayMatrix3f

Definition at line 1049 of file xsi_dataarray.h.

Definition at line 1050 of file xsi_dataarray.h.

Definition at line 1051 of file xsi_dataarray.h.

Definition at line 1052 of file xsi_dataarray.h.

typedef CDataArray2D< float > CDataArray2DFloat

Definition at line 1476 of file xsi_dataarray2D.h.

typedef CDataArray2D< LONG > CDataArray2DLong

Definition at line 1477 of file xsi_dataarray2D.h.

typedef CDataArray2D< bool > CDataArray2DBool

Definition at line 1478 of file xsi_dataarray2D.h.

Definition at line 1479 of file xsi_dataarray2D.h.

Definition at line 1480 of file xsi_dataarray2D.h.

Definition at line 1481 of file xsi_dataarray2D.h.

typedef CDataArray2D< XSI::MATH::CQuaternionf > CDataArray2DQuaternionf

Definition at line 1482 of file xsi_dataarray2D.h.

typedef CDataArray2D< XSI::MATH::CRotationf > CDataArray2DRotationf

Definition at line 1483 of file xsi_dataarray2D.h.

typedef CDataArray2D< XSI::MATH::CMatrix3f > CDataArray2DMatrix3f

Definition at line 1484 of file xsi_dataarray2D.h.

Definition at line 1485 of file xsi_dataarray2D.h.

Definition at line 1486 of file xsi_dataarray2D.h.

Definition at line 1487 of file xsi_dataarray2D.h.

Error constants.

To use with Err object.

See also:
RemoveKey RemoveKeyOnKeyable RemoveKeyOnMarkedKeyable

Time format values which are used by siTimeFormatDefaultFrameFormat UserPreference.

See also:
SetValue

Time format values which are used by siTimeDisplayFormatUserFormat UserPreference.

See also:
SetValue

Different modes for SIFilter command.

See also:
SIFilter

Delta transformation modes for transformation commands (Translate, Rotate, Scale)

See also:
Translate Rotate Scale TranslateUVW RotateUVW ScaleUVW

Texture effects bit flags, to be used in conjunction with Texture.GetTransformValues

typedef enum XSI::siRefMode siRefMode

Reference transformation modes for transformation commands (Translate, Rotate, Scale).


Note: "COG" indicates an additional translation about the Centre-Of-Geometry. "Sym" indicates a symmetrical translation. These indicators can also be used in combination.

Center transformation modes for transformation commands.

Axes filters for transformation commands (Translate, Rotate, Scale).


Note: This flag is only used for absolute transformations.

Axes filters for transformation commands (TranslateUVW, RotateUVW, ScaleUVW)

Transformation type filters (Translation, Rotation, Scaling)

Parameter filter (Marked, Animated, Scaling, Rotation, Translation, Weight, etc..)

Parent-child parameter set relationships.

Property propagation types.

Hierarchy options for duplication commands.

History options for duplication commands.

Parenting options for duplication commands.

Grouping options for duplication commands.

Property options for duplication commands.

Animation options for duplication commands.

Constraint options for duplication commands.

Texture Support options for duplication commands.

Selection options for duplication commands.

Transform options for duplication commands.

Keyboard modifier states.

Inspection Dialog Modes.

Constants that define the way to browse the inspection history.

Animation Source Types.

The branch flag is used to determine whether we are referring to the object as a node or as a branch.

The operation mode is used to determine if we are in immediate mode or persistent mode.

This mode is used to determine if we should keep, hide or delete the inputs after a generator is applied.

This mode is used to determine if the command should only apply to visible components.

This indicates what to do when local materials overlap.

Split type for polygons.

Constants that define the different options for updating selection list when working with topology operators.

Texture creation type constants.

To use with the texturing commands.

Default texture creation type constants.

To use with the texturing commands.

Texture projection type constants.

To use with the texturing commands.

Texture projection plane constants.

To use with the texturing commands.

Texture support positioning constants.

To use with the texturing commands.

Actions for the ChangeUVInput command.

Modes for the align command.

Presets for the PresetWeight command.

Cut options for the CutClip command.

Edit clip options for the EditClip command.

Preset locations.

The variant type determines the kind of value that can be stored in a parameter.


Note: Only a subset of these types are fully supported and recommended for use: these are siString, siBool, siDouble, siFloat, siInt4, siInt2, siUInt4, siUInt2, siByte, and siUByte. (See DataTypes for more information).

This determines the classification of a Parameter to give Softimage some hint about its purpose.

In most cases it is acceptable to use the default, siClassifUnknown.

Port choice for the SIGetMaterialShader command.

Defines the material shading model.

Defines the shader type.

Defines the output shader parameter types.

These represent the shader parameter data types for instantated shaders.


Note: For shader parameter definitions, the siShaderParameterDataType values are used instead.

Defines the Shader parameter type for a Parameter object belonging to Shader, Material, Light or Camera.

Shader parameter types only apply to parameters that support the siCapabilities::siTexturable capability. This can be tested using the Parameter.Capabilities property. The output type of a shader can be checked using the Shader.OutputType property.
Note: Each data type, apart from siShaderParameterDataType::siShaderDataTypeUnknown, has also an equivalent string name that can be used to create shader parameter definitions using type strings, instead of this enum. Custom port types can't be registered using those built-in string names. The string names are shown in brackets after each type's description.

Defines the types of filters when creating a shader parameter definition of type reference(siShaderParameterDataType::siShaderDataTypeReference).

When you call the SetAttribute method, pass siShaderParameterAttribute::siReferenceFilterAttribute in the first parameter and one of these values in the second parameter.

Defines the flags for Shaderball Dimension used by the ShaderballOptions object.

Defines the types of filters when creating a shader parameter definition of type property look-up(siShaderParameterDataType::siShaderDataTypeProperty).

When you call the SetAttribute method, pass siShaderParameterAttribute::siPropertyFilterAttribute in the first parameter and one of these values in the second parameter.

Defines the types of light.

Types of groups in connection sets.

Types of connection sets.

Types of Partitions.

Levels of lock.

Each level is a bit field.

Type of lock owner.

The lock owner type indicated who or why an object is locked, Users can modify only the locks of type siLockTypeUser.

typedef enum XSI::siTags siTags

These are the different levels of tags.

Type of geometry.

Types of bounding volumes.

Enumerates the different kinds of ports.

Type of modification on a referenced model.

This is a bit field, so many values can be combined.

Type of mixer modification on a referenced model.

This is a bit field, so many values can be combined.

Resolution description of a file for a referenced model.


Used by the AddModelSource, SetResolutionOfRefModels, and SIAddModelSource commands.

Type of parameters to gather from the input Object List.


Note: This enum replaces the obsolete siSequenceType enum as of v6.0.

Type of input objects for the Sequence feature.

Mode to use for the Sequence feature.

Type of input objects for clip effect features.

Types of neighboring for the deprecated Geometry_V1.

Modes for the SelectNeighborObj command.

Direction of the next Node.

Direction of the next Node.

Sub-type of node wanted.

Type of views.

This type is obsolete, you must use si2DChainAlignType instead.

Defines the types of alignment used for creating a 2D chain.


Note: Use this enum instead of the obsolete siViewType enum.

Type of chain bones.

Operator connection types.

Bitmask for types of axes.

Type of knot parameterization type for NurbsCurves.

Types of mapping rules.

Types of nurbs direction parameters.

Types of nurbs format.

Installation path directories.

Shape key instantiation mode.

Shape key reference mode.

Indicates which deforms will be stored in the created shape.

The construction mode indicates the purpose of the deformations.

Resolution Plane Type for Chain joints.

Texture creation type constants.

To use with the texturing commands.

UV generation type used by the texture operator, used only if siTextureProjectionType:siTextureUV is specified as the projection type.

Determines the capabilities of a parameter.

They can be combined by adding them: for example, to have a parameter animatable (1) and persistable (4), use 5.

Types of function curves (fcurves)

The extrapolation of an FCurve determines its shape before the first FCurveKey and after the last FCurveKey.

Extrapolation extends the curve's ends based on the position of these two keys.

Function curve key constraints.

The last seven tangent constraints apply only to standard function curves. FCurve key constraints can be set and retrieved via the FCurveKey.Constraint property.
The constraints are not mutally exclusive for example if you have the siParameterConstraint set and clear the siLockConstraint you will also clear the siParameterConstraint. You cannot set constraints on a raw function curve. They will be ignored.

Definition at line 1147 of file xsi_decl.h.

Specifies the interpolation type for a specific key on an fcurve.

The interpolation determines how the value is evaluated between FCurveKeys.

Specifies the mode for changing the FCurveKey selection.

The interpolation of an FCurve determines how values are evaluated between its FCurveKeys.

This is very similar to the siFCurveKeyInterpolation enum.

Specifies the kind of filter used for smoothing function curves.

Information on the context in which a plug-in is being evaluated.

Information on the direction of an argument indicating how it is passed to or from a command.


Note: Output and InOut arguments are not supported by some script languages, including JScript. For this reason only siArgumentInput is supported on custom Commands.

Custom (v1.0) Commands can be defined from a pre-defined category.

Each category specifies the base arguments of a command and the location of the menu item for that command in Softimage. Softimage automatically installs a menu item for each command created for a specific category.
You can retrieve the type of category specified using either SIObject.Categories or Command.Category but you cannot define custom categories for this type of command. For that you need to use the alternative and more powerful, way to create custom commands and add them to Menus: via the self-installing plug-in APIs.

Defines the option flags when importing a model or merging a scene.

typedef enum XSI::siEventID siEventID

This enumerator provides the identifiers for the Softimage events, they can be used for implementing C++ event handlers in order to identify the events fired by Softimage.

Specifies the type of operation performed to update the selection.

Specifies the render field setting.

Specifies the type of rendering.

Specifies the type of rendering error.

Specifies the subdivision rule used for an approximated geometry selection.

Direction type for navigating geometry components.

Enumeration of particle render types.

Enumeration of the different attributes that are available on the FCurveEditor object.

Determines the severity types of a message implemented with the C++ API.

They can be combined.

Information which is passed to the custom compiled operators through its Init and Term functions.

A device driver contains a set of channels that can be configured.

This enumeration is the type of action to perform for a channel.

Specifies how to select objects in a hierarchy.

Specifies the filter to use in a transient explorer.

typedef enum XSI::siClassID siClassID

The class ID of Softimage objects.

This enumerator is used by the C++ API to manage references between the object model and C++. For example, the CRef::IsA function uses the class ID to determine whether or not the class type is compatible with the underlying reference object.

This enumeration type specifies how the BlendInPresets command will apply the new shaders to the parameters selected by the command.

This enumeration type specifies how the texture-layer blending commands will apply the new shaders to the parameters selected by the command.

This enumeration type specifies what kind of shader port connections you are interested in when using the RemoveAllShadersFromCnxPoint command.

This enumeration type specifies the type of item supported by add-ons.

Depending on which type you use with the Addon.AddItem method, you need to supply only a name, or a path and file name, or you may be able to use either as indicated below.

Types of Columns supported by siControlGrid (see siPPGControlTypeand GridData.SetColumnType)

Selection Mode for the cells of the GridWidget, see siUIGridSelectionMode in siPPGItemAttribute.

Polygon cluster contour stretching method used to generate texture coordinates as part of the GenerateUVSetByContourStretching and ModifyUVSetByContourStretching commands.

The list of scopes supported by the Scene Explorer.

States for the time change notification CTimeChangeNotificationfor Custom Displays.

Types of display callbacks defined for the Graphic Sequencer.

Type of object passed to an Open Graphic Sequencer callback.

typedef enum XSI::siXGSFlag siXGSFlag

Flags for Graphic Sequencer callbacks.

Pass flags for Graphic Sequencer callbacks.

XGS state types defined for the Graphic Sequencer.

Viewport display modes used by the CGraphicSequencer classfor the Graphic Sequencer.

The available types for user defined per particle ParticleAttribute.

This is the enumeration of the different ways an asset in Softimage can be stored.

Assets can be either ActionSource objects or deltas.
Note: This enum replaces the obsolete siSourceStorageType enum.

This enum has been replaced by siAssetStorageType.

This is an enumeration of how an asset in Softimage can be treated when stored externally.

Assets can be either ActionSource objects or deltas.
Note: This enum replaces the obsolete siActionStatus enum.

This enum has been replaced by siAssetStatus.

Specifies the different type of filters that are used for implementing and categorizing custom Filters.

Custom filters of types siFilter3DObject, siFilterSubComponentEdge, siFilterSubComponentPoint, siFilterSubComponentPolygon and siFilterProperty are automatically added to the Main Command Panel filter menus and integrated with the selection tool.

Determines the capabilities of a command.

Determines the severity types of a message implemented in a scripting language.

They can be combined.

Flags values supported by the XSIUIToolkit.MsgBox command.

These are identical the arguments supported by the VBScript MsgBox() and Win32 ::MessageBox() functions.

Return values from XSIUIToolkit.MsgBox that indicates which button was pressed by the user.

Specifies the view state information of the View object, such as whether the view is closed, whether the view is minimized, and whether the view is in a normal state.

Types of toolbar controls to use when building a toolbar.

Toolbar controls help you to tweak the appearance of your toolbar by adding some cosmetic features, such as separators and line breaks.

Specifies the type of time applicability of a ClipEffect on a Clip.

Specifies a reduction to apply to an image.

For example a 800x400 image reduced by a 4x1 ratio will have a resolution of 200x100.

The siTimeControlExtrapolationType determines how a Clip contributes to the animation outside of the frames on which it is defined.

Specifies the style of a menu item.

Identifies the location of a custom menu.

This enum specifies the operator port flags.

These flags are used to determine the behaviour and characteristics of the port.

This enum specifies what has changed during a CWindowNotification for the Custom Display Host.

This enum is used to determine the type of a file for the OnBeginFileExport, OnBeginFileImport, OnEndFileExport, OnEndFileImport, OnCustomFileExport, and OnCustomFileImport events.

This enum specifies the type of clusters in Softimage.

This enum specifies the type of cluster properties in Softimage.

This enum specifies the mode of manipulation of a curve isopoint in Softimage.

This enum specifies the type of alignment for a tangent of a curve knot in Softimage.

Specifies the rigid body dynamics engine used for simulation.

There can be only one rigid body dynamics engine per SimulationEnvironment.

Keyable attribute types.

Indicates the method to use for finding closest locations on a geometry.

Indicates the method to use for computing normals on a geometry.

These only apply to PolygonMesh objects (for NurbsSurfaceMesh the normal is always the exact surface normal).

Type of line to use when intersecting a line with a geometry.

This enumeration lists the allowed bit depths for each channel of an image with the specified channel types.

Not all bit depths are allowed for all channel types.

This enum lists the allowed channel types in writable images and framebuffers.

This enumeration lists the allowed filters for user-selectable channel types in the UI.

Indicates the method to use for calculating the center of a bounding volume.

Indicates the method to use for calculating the long axis of a bounding cylinder.

Specifies the source path being set for the OnSourcePathChange event.

Describes whether Model is referenced, local (regular) or an instance.

Used as a convenient list of identifiers for the different viewports of the view manager.

The first three are special identifiers for commands and methods that use the enumeration and do not refer to a specific viewport.

This enumeration represents the list of display types for the render region.

These display types affect any framebuffer being viewed.

Type of delta modification on a referenced model.

Specifies the relative location where new node ports will be added.

Defines the possible actions that trigger calling the PPGEvent callback function.

The process types that a rendering engine can perform.

These types are used both when a render engine is registered, to indicate to Softimage which process type it can perform, and when the render engine's Process callback is called to indicate which type of processing Softimage wants it to perform at that point.

Query codes that a rendering engine needs to respond to if it supports object archives and stand-ins, via registering itself with a siRenderProcessType::siRenderProcessExportObjectArchive process type, and multiple display bit depths.


These query codes are used in conjunction with the renderer query callback and have no meaning outside of it since the query results are returned through specific context attributes.

Quality levels that a rendering engine's renderer properties can be set to, or queried for.


These quality levels are used in conjunction with the renderer quality callback and have no meaning outside of it since the quality levels are used through a specific context attribute.

When a render engine registers, it provides a list of specific properties that Softimage should create for it.


Note: At this time, only the render options property is supported.

Controls when the camera's shutter opens and closes when generating motion blur for render.

Controls how the render frame list is computed for passes.

This enum can also be used for scene render options, but siRenderFrameSourceGlobalOptions is an invalid value.

Possible actions for the drag and drop notification.

Describes how the ICEAttribute data is defined.

Defines the threading models available for ICENode evaluation.

Defines the particle shape types for rendering.

This enum specifies the render verbosity settings used when rendering or exporting passes.

Softimage TimeTransport seek modes.

Enumerates the supported graphics drivers.

Defines the dimension of a hardware surface.

Defines the sharing capability of a resource.

Describes the standard vertex attribute hardware slot for a Realtime Shader.

Indicates the plotting type to use when collapsing animation layers.

This indicates the action to perform when there is a conflict with a material.

Declares the supported hardware shader versions.

Context flags for the Graphic Sequencer.

XGS render flags for the Graphic Sequencer.

Determines the behavior and look of a Custom Display.

Specifies the type of component data (vector3, boolean, color, etc.) on an ICEAttribute.

Specifies the context of component data (points, edges, etc.) on an ICEAttribute.

Specifies the structure of component data (single element or dynamic array) on an ICEAttribute.

Types of data allowed for render channels.

All channel types, apart from the custom type, are interpreted by Softimage for display viewing.

Defines the types of data that can be associated to a ICE node port connection.

Defines the way data are structured for ICE node connections: single data or dynamic array.

Defines the element set associated with the data for ICE node connections.

In other words, which elements will be evaluated.

Determines the behavior of the auto-complete feature for a text editor widget control (see siPPGControlType::siControlTextEditor).

Determines the availability of the File menu functions for a text editor widget control (siPPGControlType::siControlTextEditor).

By default, if you display the toolbar (explicitly set the siPPGItemAttribute::siUIToolbar attribute to true), every function (entry) in the menu will be enabled. However, you can disable the loading and saving functions by setting the siPPGItemAttribute::siUICapability attribute to one of these values.
Note: Using these values does not affect the Edit menu at all nor does it change the availability of the rest of the File menu functions (Recent Files, Preferences, and Print).

Defines the supported features for a custom viewport.

Softimage TimeTransport playback types.

Softimage TimeTransport states.

Various flags that affect tool behaviour.

ToolContext cursors.

ToolContext text/menu alignment.

ToolContext snapping type flags.

ToolContext picking mode flags.

ToolContext picking type flags.

This indicates which UVs indices to use when the UVs are copied from one object and pasted onto another object.

This indicates the mathematical mode when setting a new value to a current value.

Definition at line 617 of file xsi_iceattributedataarray.h.

Definition at line 618 of file xsi_iceattributedataarray.h.

Definition at line 619 of file xsi_iceattributedataarray.h.

Definition at line 620 of file xsi_iceattributedataarray.h.

Definition at line 621 of file xsi_iceattributedataarray.h.

Definition at line 622 of file xsi_iceattributedataarray.h.

Definition at line 623 of file xsi_iceattributedataarray.h.

Definition at line 624 of file xsi_iceattributedataarray.h.

Definition at line 625 of file xsi_iceattributedataarray.h.

Definition at line 626 of file xsi_iceattributedataarray.h.

Definition at line 627 of file xsi_iceattributedataarray.h.

Definition at line 628 of file xsi_iceattributedataarray.h.

Definition at line 438 of file xsi_iceattributedataarray2D.h.

Definition at line 439 of file xsi_iceattributedataarray2D.h.

Definition at line 440 of file xsi_iceattributedataarray2D.h.

Definition at line 441 of file xsi_iceattributedataarray2D.h.

Definition at line 442 of file xsi_iceattributedataarray2D.h.

Definition at line 443 of file xsi_iceattributedataarray2D.h.

Definition at line 444 of file xsi_iceattributedataarray2D.h.

Definition at line 445 of file xsi_iceattributedataarray2D.h.

Definition at line 446 of file xsi_iceattributedataarray2D.h.

Definition at line 447 of file xsi_iceattributedataarray2D.h.

Definition at line 448 of file xsi_iceattributedataarray2D.h.

Definition at line 449 of file xsi_iceattributedataarray2D.h.


Enumeration Type Documentation

Error constants.

To use with Err object.

See also:
RemoveKey RemoveKeyOnKeyable RemoveKeyOnMarkedKeyable
Enumerator:
siErrCancelled 

Command was cancelled.

Definition at line 39 of file xsi_decl.h.

Time format values which are used by siTimeFormatDefaultFrameFormat UserPreference.

See also:
SetValue
Enumerator:
siDefaultFILM24 

FILM 24 frames per second.

siDefaultPAL25 

PAL 25 frames per second.

siDefaultNTSC30 

NTSC 29.97 frames per second.

siDefaultUserTimeFormat 

User ticks per second.

siDefault30 

HDTV 30 frames per seconde interlaced.

Definition at line 47 of file xsi_decl.h.

Time format values which are used by siTimeDisplayFormatUserFormat UserPreference.

See also:
SetValue
Enumerator:
siDisplayMilliSeconds 

Used for display format, to show the milliseconds equivalent of a frame rate.

siDisplayFILM24 

FILM 24 frames per second.

siDisplayPAL25 

PAL 25 frames per second.

siDisplayNTSCDF 

NTSC Drop Frame display format.

siDisplayNTSC30 

NTSC 29.97 frames per second (non-drop frame).

siDisplaySampleRate 

Corresponds to the audio sample rate.

Definition at line 59 of file xsi_decl.h.

Different modes for SIFilter command.

See also:
SIFilter
Enumerator:
siQuickSearch 

Look up filter from installed filters.

siSearchFamilies 

Look up filter name in registered families.

siSearchObjects 

Look up filter name in registered objects (not implemented)

siFullSearch 

siSearchFamilies and siSearchObjects

Definition at line 72 of file xsi_decl.h.

Delta transformation modes for transformation commands (Translate, Rotate, Scale)

See also:
Translate Rotate Scale TranslateUVW RotateUVW ScaleUVW
Enumerator:
siAbsolute 

Transformation moves the object to an absolute position.

siRelative 

Transformation moves the object a relative distance.

Definition at line 83 of file xsi_decl.h.

Texture effects bit flags, to be used in conjunction with Texture.GetTransformValues

Enumerator:
siTextureComputeTransformation 

Uses the transformation of the Texture projection definition.

siTextureComputeCropping 

Uses the Image effect applied to the image clip.

siTextureComputeUVRemap 

Remaps the UVW domains using the data stored into the Advanced tab of the texture shader.

siTextureComputeFlip 

Uses the Flip information on the image clipto swap the UV values.

siTextureComputeRepeats 

Uses the repeat information of the texture shader.This flag applies to polygon mesh objects only.

Artifacts may appear if the texture ends in the middle of a polygon.

siTextureComputeAlternate 

Only applies if the Repeat is on.

Uses the alternate flag stored on the texture shader. This flag applies to polygon mesh objects only.

siTextureComputeWrapping 

Uses the flags stored on the Texture projection definition.This flag applies to polygon mesh objects only.

Artifacts may appear if the texture ends in the middle of a polygon.

Definition at line 90 of file xsi_decl.h.

enum siRefMode

Reference transformation modes for transformation commands (Translate, Rotate, Scale).


Note: "COG" indicates an additional translation about the Centre-Of-Geometry. "Sym" indicates a symmetrical translation. These indicators can also be used in combination.

Enumerator:
siGlobal 

Global (world) relative movement or position.

siLocal 

Local movement relative to center of each object/component.

siObjCtr 

By Reference movement relative to center of referenced object or an absolute position where 0,0,0 is the center of the referenced object.

This corresponds to Ref mode on the MCP panel.

siView 

By Reference movement relative to the view.

siParent 

Object/Parent movement is relative to the center of the parent (for an object) or the object (for a component).

siPlane 

By Reference movement relative to the active reference plane.

This corresponds to Plane mode on the MCP panel.

siPivot 

Object/Pivot movement is relative to the object's pivot.

If the object has not pivot or neutral pose, siPivot is the same as siParent.

siAdd 

Additive rotation when manipulating (rotation only)

siGlobalCOG 

Global + COG.

siLocalCOG 

Local + COG.

siObjectCOG 

Object + COG.

siViewCOG 

View + COG.

siParentCOG 

Parent + COG.

siPlaneCOG 

Plane + COG.

siPivotCOG 

Pivot + COG.

siAddCOG 

Add + COG.

siGlobalSym 

Global + Sym.

siLocalSym 

Local + Sym.

siObjectSym 

Object + Sym.

siViewSym 

View + Sym.

siParentSym 

Parent + Sym.

siPlaneSym 

Plane + Sym.

siPivotSym 

Pivot + Sym.

siAddSym 

Add + Sym.

siGlobalSymCOG 

Global + Sym + COG.

siLocalSymCOG 

Local + Sym + COG.

siObjectSymCOG 

Object + Sym + COG.

siViewSymCOG 

View + Sym + COG.

siParentSymCOG 

Parent + Sym + COG.

siPlaneSymCOG 

Plane + Sym + COG.

siPivotSymCOG 

Pivot + Sym + COG.

siAddSymCOG 

Add + Sym + COG.

Definition at line 102 of file xsi_decl.h.

    {   siGlobal    = 1,        
    siLocal = 2,        
    siObjCtr    = 3,        
    siView  = 4,        
    siParent    = 6,        
    siPlane = 7,        
    siPivot = 8,        
    siAdd   = 70,       
    siGlobalCOG = 17,       
    siLocalCOG  = 18,       
    siObjectCOG = 19,       
    siViewCOG   = 20,       
    siParentCOG = 22,       
    siPlaneCOG  = 23,       
    siPivotCOG  = 24,       
    siAddCOG    = 86,       
    siGlobalSym = 2049,     
    siLocalSym  = 2050,     
    siObjectSym = 2051,     
    siViewSym   = 2052,     
    siParentSym = 2054,     
    siPlaneSym  = 2055,     
    siPivotSym  = 2056,     
    siAddSym    = 2118,     
    siGlobalSymCOG  = 2065,     
    siLocalSymCOG   = 2066,     
    siObjectSymCOG  = 2067,     
    siViewSymCOG    = 2068,     
    siParentSymCOG  = 2070,     
    siPlaneSymCOG   = 2071,     
    siPivotSymCOG   = 2072,     
    siAddSymCOG = 2134      
    }   siRefMode;

Center transformation modes for transformation commands.

Enumerator:
siObj 

Object/component will be translated.

siCtr 

Center of the object will be translated.

Definition at line 139 of file xsi_decl.h.

    {   siObj   = 0,        
    siCtr   = 1     
    }   siCenterMode;

Axes filters for transformation commands (Translate, Rotate, Scale).


Note: This flag is only used for absolute transformations.

Enumerator:
siX 

Filter in X.

siY 

Filter in Y.

siXY 

Filter in X & Y.

siZ 

Filter in Z.

siXZ 

Filter in X & Z.

siYZ 

Filter in Y & Z.

siXYZ 

Filter in X & Y & Z.

Definition at line 146 of file xsi_decl.h.

    {   siX = 1,        
    siY = 2,        
    siXY    = 3,        
    siZ = 4,        
    siXZ    = 5,        
    siYZ    = 6,        
    siXYZ   = 7     
    }   siAxesFilter;

Axes filters for transformation commands (TranslateUVW, RotateUVW, ScaleUVW)

Enumerator:
siU 

Filter in U.

siV 

Filter in V.

siUV 

Filter in U & V.

siW 

Filter in W.

siUW 

Filter in U & W.

siVW 

Filter in V & W.

siUVW 

Filter in U & V & W.

Definition at line 158 of file xsi_decl.h.

    {   siU = 1,        
    siV = 2,        
    siUV    = 3,        
    siW = 4,        
    siUW    = 5,        
    siVW    = 6,        
    siUVW   = 7     
    }   siUVWAxesFilter;

Transformation type filters (Translation, Rotation, Scaling)

Enumerator:
siScl 

Scaling.

siRot 

Rotation.

siTrn 

Translation.

siSR 

Scaling & Rotation.

siST 

Scaling & Translation.

siRT 

Rotation & Translation.

siSRT 

Scaling & Rotation & Translation.

Definition at line 170 of file xsi_decl.h.

    {   siScl   = 1,        
    siRot   = 2,        
    siTrn   = 4,        
    siSR    = 8,        
    siST    = 16,       
    siRT    = 32,       
    siSRT   = 64        
    }   siTransformFilter;

Parameter filter (Marked, Animated, Scaling, Rotation, Translation, Weight, etc..)

Enumerator:
siNoParam 

No Parameter.

siMarkedParam 

Marked Parameters.

siAnimatedParam 

Animated Parameters.

siSelectedParam 

Selected Parameters.

siScalingParam 

Scaling Parameters.

siRotationParam 

Rotation Parameters.

siTranslationParam 

Translation Parameters.

siTransformParam 

All Transform Parameters.

siAllParam 

All Parameters.

Definition at line 182 of file xsi_decl.h.

Parent-child parameter set relationships.

Enumerator:
siContainedPSet 

Child is contained as part of parent (for example, Kinematics)

siSharedPSet 

Child is an inherited PSet.

siLocalPSet 

Child is a local PSet.

siObjectPSet 

Child is a member of the parent (for example, Object in Group)

siPortPSet 

Child is connected to the parent PSet (for example, Shader/Operator)

siParameterPSet 

Child is a leaf component part of the parent (for example, Object.Name).

(not implemented)

Definition at line 196 of file xsi_decl.h.

Property propagation types.

Enumerator:
siDefaultPropagation 

Based on propagation of selection type.

siBranchPropagation 

Branch propagation.

siNodePropagation 

Node propagation.

Definition at line 207 of file xsi_decl.h.

Hierarchy options for duplication commands.

Enumerator:
siNodeDuplicate 

duplicate node only

siBranchDuplicate 

duplicate branch

siDefaultDuplicate 

duplicate based on selection type

Definition at line 215 of file xsi_decl.h.

History options for duplication commands.

Enumerator:
siCurrentHistory 

Duplicate final resulting geometry of the source object.

siOriginalHistory 

Duplicate the original geometry of the source object (not implemented)

siDuplicateHistory 

Duplicate whole construction history if the source object.

siSharedHistory 

Share the construction history of the source object such that changes to the source object effect the copied object (same as instance)

Definition at line 223 of file xsi_decl.h.

Parenting options for duplication commands.

Enumerator:
siNoParent 

Parent the copied object under the scene root.

siSharedParent 

Share the parent of the source object.

siNewNullParent 

Create a null to act as the parent of this object.

Definition at line 232 of file xsi_decl.h.

enum siDupGroup

Grouping options for duplication commands.

Enumerator:
siNoGrouping 

Ignore grouping.

siShareGrouping 

Add duplicate to the same groups as the source (not implemented)

Definition at line 240 of file xsi_decl.h.

Property options for duplication commands.

Enumerator:
siDuplicateProperties 

Copy properties from the source.

siSharedProperties 

Share properties with the source (not implemented)

siNoProperties 

Ignore properties.

Definition at line 247 of file xsi_decl.h.

Animation options for duplication commands.

Enumerator:
siDuplicateAnimation 

Copy animation from the source and share the mixer source.

siNoAnimation 

Ignore animation.

siDupAnimationCopySource 

Copy animation from the source and copy the mixer source.

Definition at line 255 of file xsi_decl.h.

Constraint options for duplication commands.

Enumerator:
siDuplicateConstraints 

Copy constraints from the source.

siShareConstraints 

Share constraints with the source (not implemented)

siNoConstraints 

Ignore constraints.

Definition at line 263 of file xsi_decl.h.

Texture Support options for duplication commands.

Enumerator:
siDuplicateSelectedTextureSupports 

Projection definition is linked to a duplicated texture support object if the object was selected for duplication, shared otherwise.

siDuplicateTextureSupports 

Texture support object is duplicated for each projection.

siShareTextureSupports 

Texture support object is shared by the duplicated projections.

siFreezeAllProjections 

Duplicated projections are frozen and disconnected from the texture support object.

Definition at line 271 of file xsi_decl.h.

Selection options for duplication commands.

Enumerator:
siSetSelection 

Set the current selection to the copied object.

siNoSelection 

Do not change the current selection.

siAddToSelection 

Extend the current selection to include the copied object.

Definition at line 280 of file xsi_decl.h.

Transform options for duplication commands.

Enumerator:
siGlobalXForm 

Apply same global transform as source object.

siApplyRepeatXForm 

Apply and repeat transform argument on duplicated objects.

Definition at line 288 of file xsi_decl.h.

Keyboard modifier states.

Enumerator:
siShiftMask 

SHIFT key bit mask.

siCtrlMask 

CTRL key bit mask.

siAltMask 

ALT key bit mask.

Definition at line 295 of file xsi_decl.h.

Inspection Dialog Modes.

Enumerator:
siRecycle 

Recycle dialog.

siFollow 

Recycle dialog if object is of the same family.

siLock 

Prevent dialog from being recycled.

siModal 

Pop up a modal dialog.

siLockAndForceNew 

Force a new dialog to open and prevent dialog from being recycled.

Definition at line 303 of file xsi_decl.h.

Constants that define the way to browse the inspection history.

Enumerator:
siNext 

Browse to the next inspection in the history ( newer )

siPrevious 

Browse to the previous inspection in the history ( older )

siLast 

Browse to the last inspection in the history ( newest )

siFirst 

Browse to the first inspection in the history ( oldest )

Definition at line 313 of file xsi_decl.h.

Animation Source Types.

Enumerator:
siFCurveSource 

Include fcurves.

siExpressionSource 

Include expressions.

siAnySource 

Any source.

siMixerSource 

Mixer source.

siConstraintSource 

Constraint source.

siScriptedOperatorSource 

Scripted operator source.

siShapeAnimationSource 

Shape animation source.

Definition at line 322 of file xsi_decl.h.

The branch flag is used to determine whether we are referring to the object as a node or as a branch.

Enumerator:
siNode 

Node.

siBranch 

Branch.

siUnspecified 

Unspecified.

siNotSelected 

Not selected.

Definition at line 334 of file xsi_decl.h.

The operation mode is used to determine if we are in immediate mode or persistent mode.

Enumerator:
siPersistentOperation 

Persistent Operation.

siImmediateOperation 

Immediate Operation.

Definition at line 343 of file xsi_decl.h.

This mode is used to determine if we should keep, hide or delete the inputs after a generator is applied.

Enumerator:
siKeepGenOpInputs 

Keep the inputs.

siHideGenOpInputs 

Hide the inputs.

siDeleteGenOpInputs 

Delete the inputs.

Definition at line 350 of file xsi_decl.h.

This mode is used to determine if the command should only apply to visible components.

Enumerator:
siIgnoreComponentVisibility 

Ignore Visibility.

siCheckComponentVisibility 

Check Visibility.

Definition at line 358 of file xsi_decl.h.

This indicates what to do when local materials overlap.

Enumerator:
siPromptUser 

Prompt the user that local materials overlap (used by ApplyShader only)

siRemoveFromSelectedClusters 

Remove the common elements from the selected clusters.

siRemoveFromExistingClusters 

Remove the common elements from the existing clusters.

siLetLocalMaterialsOverlap 

Let the local materials overlap (used by ApplyShader only)

siJustReturnExistingClusters 

Return the existing clusters overlapping with the selected ones (used by ClusterNonOverlapEnforcement only)

Definition at line 365 of file xsi_decl.h.

Split type for polygons.

Enumerator:
siByTheVertices 

Split along the vertices.

siByTheEdgesMidPoints 

Add edges from the geometric center of a polygon to the midpoint of each edge.

siCross 

Draw edges from the midpoint of a polygon to each of its vertices.

siDiamond 

Draw edges connecting the midpoints of a polygon's edges.

Definition at line 375 of file xsi_decl.h.

Constants that define the different options for updating selection list when working with topology operators.

Enumerator:
siLeaveSelection 

Leave selection.

siCleanSelection 

Clean selection.

siUpdateSelection 

Update selection.

Definition at line 384 of file xsi_decl.h.

Texture creation type constants.

To use with the texturing commands.

Enumerator:
siTxtPlanarXY 

XY Planar projection.

siTxtPlanarXZ 

XZ Planar projection.

siTxtPlanarYZ 

YZ Planar projection.

siTxtCylindrical 

Cylindrical projection.

siTxtSpherical 

Spherical projection.

siTxtSpatial 

Spatial projection.

siTxtCamera 

Camera projection.

siTxtUV 

UV projection.

siTxtLollipop 

Lollipop projection.

siTxtPureImplicit 

Purely implicit projection.

siTxtCubic 

Cubic projection.

siTxtUniqueUV 

Unique UV projection.

Definition at line 392 of file xsi_decl.h.

Default texture creation type constants.

To use with the texturing commands.

Enumerator:
siTxtDefaultPlanarXY 

XY Planar projection.

siTxtDefaultPlanarXZ 

XZ Planar projection.

siTxtDefaultPlanarYZ 

YZ Planar projection.

siTxtDefaultCylindrical 

Cylindrical projection.

siTxtDefaultSpherical 

Spherical projection.

siTxtDefaultSpatial 

Spatial projection.

siTxtDefaultCubic 

Cubic projection.

siTxtDefaultLollipop 

Lollipop projection.

Definition at line 409 of file xsi_decl.h.

Texture projection type constants.

To use with the texturing commands.

Enumerator:
siProjPlanar 

Planar projection.

siProjCylindrical 

Cylindrical projection.

siProjSpherical 

Spherical projection.

siProjLollipop 

Lollipop projection.

siProjSpatial 

Spatial projection.

siProjCubic 

Cubic projection.

Definition at line 422 of file xsi_decl.h.

Texture projection plane constants.

To use with the texturing commands.

Enumerator:
siPlaneXY 

XY Plane.

siPlaneXZ 

XZ Plane.

siPlaneYZ 

YZ Plane.

Definition at line 433 of file xsi_decl.h.

Texture support positioning constants.

To use with the texturing commands.

Enumerator:
siRelDefault 

Perform default behavior for input: siRelBestFit for subcomponents, siRelObject for objects.

siRelBestFit 

Choose the best fit for the projection.

siRelObject 

Align relative to the object's coordinate system.

siRelWorld 

Align relative to the world's coordinate system.

siRelObjectPosObject 

Align relative to the object's coordinate system, and position/scale relative to the object's bounding box.

siRelWorldPosObject 

Align relative to the world's coordinate system, and position/scale relative to the object's bounding box.

Definition at line 441 of file xsi_decl.h.

Actions for the ChangeUVInput command.

Enumerator:
siChangeUVInputActionSwim 

Cause the UV to swim (move to top of operator stack).

siChangeUVInputActionStick 

If the UV operator is swimming (top of operator stack), cause the operator to stick (top of modeling).

siChangeUVInputActionReproject 

If the UV operator is sticking (modeling region), force the operator to the top of the modeling stack.

Definition at line 452 of file xsi_decl.h.

Modes for the align command.

Enumerator:
siAlignGMIN 

Global minimum bounding value of the whole selection.

siAlignGMIDDLE 

Global center bounding value of the whole selection.

siAlignGMAX 

Global maximum bounding value of the whole selection.

siAlignFMIN 

Minimum bounding value of the first selected object.

siAlignFMIDDLE 

Center bounding value of the first selected object.

siAlignFMAX 

Maximum bounding value of the first selected object.

Definition at line 460 of file xsi_decl.h.

Presets for the PresetWeight command.

Enumerator:
siWeightEaseIn 

Ease-in preset.

siWeightEaseOut 

Ease-out preset.

siWeightLinearEaseIn 

Linear ease-in preset.

siWeightLinearEaseOut 

Linear ease-out preset.

siWeightExponentialIn 

Exponential-in preset.

siWeightExponentialOut 

Exponential-out presett.

siWeightGaussian 

Gaussian preset.

siWeightGaussianReverse 

Reverse gaussian preset.

siWeightSquare 

Square preset.

siWeightSquareReverse 

Reverse square preset.

siWeightOscillate 

Oscillation preset.

siWeightConstant 

Constant preset.

siWeightFlipX 

Flip X of weight curve.

siWeightFlipY 

Flip Y of weight curve.

Definition at line 471 of file xsi_decl.h.

Cut options for the CutClip command.

Enumerator:
siCut 

Splits the clip in two distincts clips.

siTrimBefore 

Trims the clip keeping the tail.

siTrimAfter 

Trims the clip keeping the head.

Definition at line 490 of file xsi_decl.h.

Edit clip options for the EditClip command.

Enumerator:
siClipNudge 

Nudge clip.

siClipSlip 

Slip clip.

siClipTrim 

Trim clip.

siClipScale 

Scale clip.

siClipStartAt 

Start clip at frame.

siClipEndAt 

End clip at frame.

siClipScaleTo 

Scale clip to frame.

Definition at line 498 of file xsi_decl.h.

Preset locations.

Enumerator:
siDefaultLocation 

Default location.

siFactory 

Factory.

siUser 

User.

siWorkgroup 

Workgroup.

siProject 

Project.

Definition at line 510 of file xsi_decl.h.

The variant type determines the kind of value that can be stored in a parameter.


Note: Only a subset of these types are fully supported and recommended for use: these are siString, siBool, siDouble, siFloat, siInt4, siInt2, siUInt4, siUInt2, siByte, and siUByte. (See DataTypes for more information).

Enumerator:
siEmpty 

no type

siInt2 

2 bytes signed integer number (-32768..32767)

siInt4 

4 bytes signed integer number (-2147483648..2147483647) (See Long)

siFloat 

Float: single precision real number (-3.402823466e+38F..3.402823466e+38F)

siDouble 

Double: double precision real number (-1.7976931348623158e+308..1.7976931348623158e+308)

siString 

Text represented as a BSTR.

See String.

siDispatch 

dispatch object.

This is an object which exposes methods and properties to scripting. This is the variant type of all objects in the Object Model.

siBool 

Boolean

siUnknown 

Pointer to a COM object.

This object cannot be manipulated from scripting and such an object is not normally exposed in the Object Model.

siByte 

byte (-128..127)

siUByte 

unsigned byte (0..255)

siUInt2 

2 bytes unsigned integer number (0..65535)

siUInt4 

4 bytes unsigned integer number (0..4294967295)

siInt 

signed machine integer.

This variant type is not supported, use siInt4 instead.

siUInt 

unsigned machine integer.

This variant type is not supported, use siUInt4 instead.

siWStr 

Null-terminated wide character string.

This variant type is rarely encountered because siString is the recommended representation for all Softimage strings.

Definition at line 520 of file xsi_decl.h.

    {   siEmpty = 0,        
    siInt2  = 2,        
    siInt4  = 3,        
    siFloat = 4,        
    siDouble    = 5,        
    siString    = 8,        
    siDispatch  = 9,        
    siBool  = 11,       
    siUnknown   = 13,       
    siByte  = 16,       
    siUByte = 17,       
    siUInt2 = 18,       
    siUInt4 = 19,       
    siInt   = 22,       
    siUInt  = 23,       
    siWStr  = 31        
    }   siVariantType;

This determines the classification of a Parameter to give Softimage some hint about its purpose.

In most cases it is acceptable to use the default, siClassifUnknown.

Enumerator:
siClassifVisualization 

Parameter affects the UI visualization of an object (ex: level of detail)

siClassifPositioning 

Parameter affects the location, size and position of an object (ex: scaling)

siClassifAppearance 

Parameter affects the visual appearance of the default representation of an object (ex: color)

siClassifMetaData 
siClassifModel 
siClassifTopo 
siClassifGeometry 
siClassifUnknown 

Default classification for normal parameters.

Definition at line 541 of file xsi_decl.h.

Port choice for the SIGetMaterialShader command.

Enumerator:
siMaterialPortSurface 

Surface shader port.

siMaterialPortVolume 

Volume shader port.

siMaterialPortEnvironment 

Environment shader port.

siMaterialPortContour 

Contour shader port.

siMaterialPortDisplacement 

Displacement shader port.

siMaterialPortShadow 

Shadow shader port.

siMaterialPortPhoton 

Photon shader port.

siMaterialPortPhotonVol 

Photon volume shader port.

siMaterialPortBumpMap 

Bump map shader port.

Definition at line 554 of file xsi_decl.h.

Defines the material shading model.

Enumerator:
siUndefinedShadingModel 

Undefined shading model.

siShadingModelConstant 

Constant shading.

siShadingModelLambert 

Lambert shading.

siShadingModelBlinn 

Blinn shading.

siShadingModelPhong 

Phong shading.

siShadingModelShadow 

Shadow shading.

siShadingModelColorVertex 

Color vertex shading.

Definition at line 568 of file xsi_decl.h.

Defines the shader type.

Enumerator:
siShaderUnknown 

Unknown shader.

siShader 

Normal shader.

siShaderCompound 

Shader Compound.

siShaderComment 

Shader Comment.

Definition at line 580 of file xsi_decl.h.

Defines the output shader parameter types.

Enumerator:
siUnknownOutputType 

See siUnknownParameterType.

siBooleanOutputType 

See siBooleanParameterType.

siIntegerOutputType 

See siIntegerParameterType.

siScalarOutputType 

See siScalarParameterType.

siColorOutputType 

See siColorParameterType.

siVectorOutputType 

See siVectorParameterType.

siTextureSpaceOutputType 

See siTextureSpaceParameterType.

siTextureOutputType 

See siTextureParameterType.

siStringOutputType 

See siStringParameterType.

siFilenameOutputType 

See siStringParameterType (remapped to string)

siLensOutputType 

See siLensParameterType.

siLightOutputType 

See siLightParameterType.

siMaterialOutputType 

See siMaterialParameterType.

siModelOutputType 

See siModelParameterType.

siLightmapOutputType 

See siLightmapParameterType.

Definition at line 589 of file xsi_decl.h.

These represent the shader parameter data types for instantated shaders.


Note: For shader parameter definitions, the siShaderParameterDataType values are used instead.

Enumerator:
siUnknownParameterType 

Unknown parameter type.

siArrayParameterType 

Array shader parameter type.

siBooleanParameterType 

Boolean shader parameter type.

siColorParameterType 

Color RGBA shader parameter type.

siColor3ParameterType 

Color RGB shader parameter type.

siCustomParameterType 

Custom shader parameter type.

siDataParameterType 

Data shader parameter type.

siGradientParameterType 

Gradient shader parameter type.

siIntegerParameterType 

Integer shader parameter type.

siLensParameterType 

Lens shader parameter type.

siLightParameterType 

Light shader parameter type.

siLightmapParameterType 

Lightmap shader parameter type.

siMaterialParameterType 

Material shader parameter type.

siMatrixParameterType 

Transform matrix 4x4 shader parameter type.

siMatrix3ParameterType 

Transform matrix 3x3 shader parameter type.

siModelParameterType 

Model parameter type, maps shader output type that can write to geometry shader.

siProfileCurveParameterType 

Profile curve parameter type.

siQuaternionParameterType 

Quaterninon shader parameter type.

siRealTimeParameterType 

Realtime shader parameter type.

siReferenceParameterType 

Reference shader parameter type, input type only.

siScalarParameterType 

Scalar shader parameter type; Float

siShaderReferenceParameterType 

Shader reference shader parameter type.

siStringParameterType 

String shader parameter type.

siStructParameterType 

Struct shader parameter type.

siTextureParameterType 

Texture shader parameter type; normally a ImageClip object (in the object model) or ImageClip2 class (in the C++ API).

siTextureSpaceParameterType 

Texturespace shader parameter type; ; such as a vertexcolor, UV texture, weightmap ClusterProperty object or a texture map Property.

siVectorParameterType 

Vector3d shader parameter type.

siVector2ParameterType 

Vector2d shader parameter type.

siVector4ParameterType 

Vector4d shader parameter type.

Definition at line 609 of file xsi_decl.h.

Defines the Shader parameter type for a Parameter object belonging to Shader, Material, Light or Camera.

Shader parameter types only apply to parameters that support the siCapabilities::siTexturable capability. This can be tested using the Parameter.Capabilities property. The output type of a shader can be checked using the Shader.OutputType property.
Note: Each data type, apart from siShaderParameterDataType::siShaderDataTypeUnknown, has also an equivalent string name that can be used to create shader parameter definitions using type strings, instead of this enum. Custom port types can't be registered using those built-in string names. The string names are shown in brackets after each type's description.

Enumerator:
siShaderDataTypeUnknown 

Not a known type.

siShaderDataTypeBoolean 

A boolean value ["boolean"].

siShaderDataTypeInteger 

A signed integer value ["integer"].

siShaderDataTypeScalar 

A scalar (floating point) value ["scalar"].

siShaderDataTypeVector2 

A 2-scalar component vector value ["vector2"].

siShaderDataTypeVector3 

A 3-scalar component vector value ["vector3"].

siShaderDataTypeVector4 

A 4-scalar component vector value ["vector4"].

siShaderDataTypeQuaternion 

A 4-scalar component quaternion value ["quaternion"].

siShaderDataTypeMatrix33 

A 9-scalar component matrix value ["matrix33"].

siShaderDataTypeMatrix44 

A 16-scalar component matrix value ["matrix44"].

siShaderDataTypeColor3 

A 3-scalar component color value (red, green, and blue) ["color3"].

siShaderDataTypeColor4 

A 4-scalar component color value (red, green, blue, and alpha) ["color4"].

siShaderDataTypeString 

A string value ["string"].

siShaderDataTypeProperty 
siShaderDataTypeProfileCurve 

A profile curve (scalar fcurve) ["fcurve"].

siShaderDataTypeGradient 

A color gradient ["gradient"].

siShaderDataTypeLightProfile 

A light profile parameter ["lightprofile"].

siShaderDataTypeReference 
siShaderDataTypeImage 

An image input (texture map) ["image"].

siShaderDataTypeCustom 
siShaderDataTypeStructure 

A strucure container ["structure"].

siShaderDataTypeArray 

An array container ["array"].

Definition at line 643 of file xsi_decl.h.

Enumerator:
siShaderCnxUnknown 
siShaderCnxInput 
siShaderCnxOutput 

Definition at line 669 of file xsi_decl.h.

Defines the types of filters when creating a shader parameter definition of type reference(siShaderParameterDataType::siShaderDataTypeReference).

When you call the SetAttribute method, pass siShaderParameterAttribute::siReferenceFilterAttribute in the first parameter and one of these values in the second parameter.

Enumerator:
siUnknownReferenceFilter 

Unknown filter.

siObjectReferenceFilter 

Any X3DObject.

siCameraReferenceFilter 

Any camera primitive.

siLightReferenceFilter 

Any light primitive.

siMaterialReferenceFilter 

Any material.

siShaderReferenceFilter 

Any shader.

siGeometryReferenceFilter 

Any geometric primitive.

siUserDataBlobReferenceFilter 

Any userdata blob.

Definition at line 678 of file xsi_decl.h.

Defines the flags for Shaderball Dimension used by the ShaderballOptions object.

Enumerator:
siShaderballDimUndefined 

Undefined.

siShaderballDimParametric 

Supports Parametric Shaderballs.

siShaderballDimSpatial 

Supports Spatial Shaderballs.

siShaderballDimParticle 

Supports Particle Shaderballs.

siShaderballDimAll 

Supports all dimensions.

Definition at line 691 of file xsi_decl.h.

Defines the types of filters when creating a shader parameter definition of type property look-up(siShaderParameterDataType::siShaderDataTypeProperty).

When you call the SetAttribute method, pass siShaderParameterAttribute::siPropertyFilterAttribute in the first parameter and one of these values in the second parameter.

Enumerator:
siAnyPropertyFilter 

Any property.

siAnyVertexMapPropertyFilter 

Any vertex map property.

siUVPropertyFilter 

Texture projection property.

siCAVPropertyFilter 

Color-at-Vertices property.

siWeightMapPropertyFilter 

Weightmap property.

siTextureMapPropertyFilter 

Texture map property.

siNormalPropertyFilter 

Normal property.

Definition at line 701 of file xsi_decl.h.

Defines the types of light.

Enumerator:
siLightPoint 

Point light.

siLightInfinite 

Infinite light.

siLightSpot 

Spot light.

siLightSun 

Sun light.

siUndefinedLightType 

Undefined light.

Definition at line 713 of file xsi_decl.h.

Types of groups in connection sets.

Enumerator:
siCreatedObjects 

Created objects group.

Definition at line 723 of file xsi_decl.h.

Types of connection sets.

Enumerator:
siGroupLevel 

Group level specifies objects containing the components that will be connected to the an operator's group of ports.

siPortLevel 

Port level specifies objects that will be directly connected to the operator ports.

Definition at line 729 of file xsi_decl.h.

Types of Partitions.

Enumerator:
siUnknownPartition 

Unknown partition.

siObjectPartition 

Object partition.

siLightPartition 

Light partition.

Definition at line 736 of file xsi_decl.h.

Levels of lock.

Each level is a bit field.

Enumerator:
siLockLevelNone 

Not locked.

siLockLevelConstruction 

Cannot change the hierarchy and topology.

siLockLevelAnimation 

Cannot animate.

siLockLevelManipulation 

Cannot change the values.

siLockLevelNavigation 

Cannot navigate (not supported)

siLockLevelAll 

All levels.

Definition at line 744 of file xsi_decl.h.

enum siLockType

Type of lock owner.

The lock owner type indicated who or why an object is locked, Users can modify only the locks of type siLockTypeUser.

Enumerator:
siLockTypeNone 

Not locked.

siLockTypeSystem 

Locked by the system.

siLockTypeUser 

Locked by a user.

siLockTypeRefModel 

Locked by a referenced model.

siLockTypeOverride 

Locked by an override.

siLockTypeAll 

All owners (not used)

Definition at line 755 of file xsi_decl.h.

enum siTags

These are the different levels of tags.

Enumerator:
siTagNone 

Not tagged.

siTag1 

User-defined tag 1.

siTag2 

User-defined tag 2.

siTag3 

User-defined tag 3.

siTag4 

User-defined tag 4.

siTag5 

User-defined tag 5.

siTag6 

User-defined tag 6.

siTag7 

User-defined tag 7.

siTag8 

User-defined tag 8.

siTag9 

User-defined tag 9.

siTag10 

User-defined tag 10.

siTagAll 

All tags.

Definition at line 766 of file xsi_decl.h.

    {   siTagNone   = 0,        
    siTag1  = 1,        
    siTag2  = 2,        
    siTag3  = 4,        
    siTag4  = 8,        
    siTag5  = 16,       
    siTag6  = 32,       
    siTag7  = 64,       
    siTag8  = 128,      
    siTag9  = 256,      
    siTag10 = 512,      
    siTagAll    = 0xffff        
    }   siTags;

Type of geometry.

Enumerator:
siNurbsSurfaceMesh 

Nurbs surface.

siNurbsCurveList 

Nurbs curve.

siPolygonMesh 

Mesh surface.

siPointCloud 

Point cloud.

Definition at line 783 of file xsi_decl.h.

Types of bounding volumes.

Enumerator:
siBoundingBox 

Bounding box.

Definition at line 792 of file xsi_decl.h.

enum siPortType

Enumerates the different kinds of ports.

Enumerator:
siPortInput 

Input port.

siPortOutput 

Output port.

Definition at line 798 of file xsi_decl.h.

Type of modification on a referenced model.

This is a bit field, so many values can be combined.

Enumerator:
siModificationTypeNone 

None.

siModificationTypeStaticPosition 

Static Posistion.

siModificationTypeFCurves 

Animation FCurves.

siModificationTypeExpression 

Expressions.

siModificationTypeConstraints 

Constraints.

siModificationTypeAddProp 

Adding properties.

siModificationTypeAnimMixer 

Adding Animation mixer.

siModificationTypeGroup 

Groups.

siModificationTypeInstance 

Instances.

siModificationTypeOtherConnections 

Other connections.

siModificationTypeOperators 

Operators.

siModificationTypeClusters 

Clusters.

siModificationTypeClusterProperties 

Cluster Properties.

siModificationTypeAll 

All types.

Definition at line 805 of file xsi_decl.h.

Type of mixer modification on a referenced model.

This is a bit field, so many values can be combined.

Enumerator:
siModificationMixerNone 

None.

siModificationMixerAnimation 

Animation tracks.

siModificationMixerShape 

Shape tracks.

siModificationMixerAudio 

Audio tracks.

siModificationMixerCache 

Cache tracks.

siModificationMixerTypeAll 

All types.

Definition at line 824 of file xsi_decl.h.

Resolution description of a file for a referenced model.


Used by the AddModelSource, SetResolutionOfRefModels, and SIAddModelSource commands.

Enumerator:
siModelResolutionOffLoaded 

Model not loaded.

siModelResolutionLowRes 

Low resolution.

siModelResolutionMediumRes 

Medium resolution.

siModelResolutionHighRes 

High resolution.

Definition at line 835 of file xsi_decl.h.

Type of parameters to gather from the input Object List.


Note: This enum replaces the obsolete siSequenceType enum as of v6.0.

Enumerator:
siInputParameters 

Use the input parameters directly from the Object List.

siAnimatedParameters 

Use only the parameters of the Object List that are animated.

siAllAnimatedParameters 

Ignore Object List and use all animated parameters in the scene (ie., every animated parameter on each object in the scene)

Definition at line 844 of file xsi_decl.h.

Type of input objects for the Sequence feature.

Enumerator:
siMarkedParams 

Marked parameters of selected objects(s)

siAnimParams 

Animated parameters of selected objects(s)

siAllAnimParams 

All animated parameters of all objects in scene.

Definition at line 852 of file xsi_decl.h.

Mode to use for the Sequence feature.

Enumerator:
siFCurves 

Process fcurves.

siFCurvesAnimationSources 

Process fcurves and animation sources.

siFCurvesClips 

Process fcurves and clips.

siAnimationSources 

Process animation sources.

siClips 

Process clips.

Definition at line 860 of file xsi_decl.h.

Type of input objects for clip effect features.

Enumerator:
siSelectedParams 

Marked parameters of selected objects(s)

siAllParamsInClip 

Single clip - operate on all parameters.

siPoseOffsetClip 

Single clip - operate on pose offset.

Definition at line 870 of file xsi_decl.h.

Types of neighboring for the deprecated Geometry_V1.

Enumerator:
siAdjacent 

Adjacent neighboring.

siGrow 

Grow neighboring.

siNextCompo 

Next component.

siPrevCompo 

Prev component.

siFirstCompo 

First component.

siLastCompo 

Last component.

Definition at line 878 of file xsi_decl.h.

Modes for the SelectNeighborObj command.

Enumerator:
siNavigUp 

Navigate up.

siNavigDown 

Navigate down.

siNavigLeft 

Navigate left.

siNavigRight 

Navigate right.

siNavigFirst 

Navigate to first item.

siNavigLast 

Navigate to last item.

Definition at line 889 of file xsi_decl.h.

Direction of the next Node.

Enumerator:
siParentNode 

Ask for parent of the current node.

siChildNode 

Ask for parent of the current node.

siNextNode 

Ask for next sibling of the current node.

siPreviousNode 

Ask for previous sibling of the current node.

siFirstNode 

Ask for first sibling of the current node.

siLastNode 

Ask for last sibling of the current node.

Definition at line 900 of file xsi_decl.h.

Direction of the next Node.

Enumerator:
siNavigationFilterScene 

Scene.

siNavigationFilter3DObject 

3D Object

siNavigationFilterOperator 

Operator.

siNavigationFilterPrimitive 

Primitive.

siNavigationFilterProperty 

Container or attribute.

siNavigationFilterCluster 

Cluster.

siNavigationFilterObjectSubElems 

Subcomponent.

siNavigationFilterGroup 

Group.

siNavigationFilterGenericComObject 

Any COM Object.

siNavigationFilterAll 

All types.

siNavigationFilterSame 

Same type.

Definition at line 911 of file xsi_decl.h.

Sub-type of node wanted.

Enumerator:
siNavigationSubFilterAll 

All types.

siNavigationSubFilterSame 

Same type.

Definition at line 927 of file xsi_decl.h.

enum siViewType

Type of views.

This type is obsolete, you must use si2DChainAlignType instead.

Enumerator:
siNoView 

No viewport.

siViewUser 

User viewport.

siViewTop 

Top viewport.

siViewLeft 

Left viewport.

siViewRight 

Right viewport.

Definition at line 934 of file xsi_decl.h.

Defines the types of alignment used for creating a 2D chain.


Note: Use this enum instead of the obsolete siViewType enum.

Enumerator:
si2DChainTop 

Align with top viewport.

si2DChainFront 

Align with front viewport.

si2DChainRight 

Align with right viewport.

si2DChainNormalRadian 

Align with plane normal, value must be specified in radian units.

si2DChainNormalDegree 

Align with plane normal, value must be specified in degree units.

Definition at line 944 of file xsi_decl.h.

Type of chain bones.

Enumerator:
siChainBoneUndefined 

Undefined type.

siChainBonePin 

Pin bone.

siChainBoneBallJoint 

Ball joint bone.

Definition at line 954 of file xsi_decl.h.

Operator connection types.

Enumerator:
siReadConnection 

Read only.

siWriteConnection 

Write only.

siReadWriteConnection 

Read/write.

Definition at line 962 of file xsi_decl.h.

enum siAxisType

Bitmask for types of axes.

Enumerator:
siXAxis 

X axis.

siYAxis 

Y axis.

siZAxis 

Z axis.

Definition at line 970 of file xsi_decl.h.

    {   siXAxis = 1,        
    siYAxis = 2,        
    siZAxis = 3     
    }   siAxisType;

Type of knot parameterization type for NurbsCurves.

Enumerator:
siUniformParameterization 

Uniform.

siNonUniformParameterization 

Non-uniform.

siChordLengthParameterization 

Chord_length.

siCentripetalParameterization 

Centripetal.

Definition at line 978 of file xsi_decl.h.

Types of mapping rules.

Enumerator:
siConnectionMappingRule 

Connection mapping rule.

siValueMappingRule 

Value mapping rule.

Definition at line 987 of file xsi_decl.h.

Types of nurbs direction parameters.

Enumerator:
siUDirection 

Nurbs direction in U.

siVDirection 

Nurbs direction in V.

Definition at line 994 of file xsi_decl.h.

Types of nurbs format.

Enumerator:
siSINurbs 

Softimage Nurbs format.

siIGESNurbs 

IGES Nurbs format.

Definition at line 1001 of file xsi_decl.h.

Installation path directories.

Enumerator:
siProjectPath 

Project directory path.

siUserPath 

User directory path.

siWorkgroupPath 

Workgroup directory path.

See XSIApplication.Workgroups.

siFactoryPath 

Factory directory path.

siAddonPath 

Add-on directory path.

siUserAddonPath 

User Add-on directory path.

siWorkgroupAddonPath 

Workgroup Add-on directory path.

siUnknownPath 

Unknown installation path.

siCustomPath 

The custom plug-in directory path.

This value maps to the XSI_PLUGINS environment variable which may contain multiple folders.

Definition at line 1008 of file xsi_decl.h.

Shape key instantiation mode.

Enumerator:
siShapeInstanceOnlyMode 

Only instance the action.

siShapeMixedWeightMode 

Instance in mixed weight mode.

siShapeTransitionMode 

Instance in transition mode.

siShapeTransitionCardinalMode 

Instance in transition cardinal mode.

siShapeBlendedWeightMode 

Instance in mixed weight mode without keying the weight.

Definition at line 1022 of file xsi_decl.h.

Shape key reference mode.

Enumerator:
siShapeLocalReferenceMode 

Shapes are relative to reference frame of the control vertices.

siShapeObjectReferenceMode 

Shapes are relative to the primitive reference frame.

siShapeAbsoluteReferenceMode 

Shapes are absolute.

Definition at line 1032 of file xsi_decl.h.

Indicates which deforms will be stored in the created shape.

Enumerator:
siShapeContentUseConstructionMode 
siShapeContentPrimaryShape 

Store the primary shape deformations.

siShapeContentSecondaryShape 

Store the secondary shape deformations.

siShapeContentAllDeforms 

Store all except for modeling deforms.

Definition at line 1040 of file xsi_decl.h.

The construction mode indicates the purpose of the deformations.

Enumerator:
siConstructionModeModeling 

The deformations are used to model the geometry.

siConstructionModePrimaryShape 

The deformations are used to author shapes based on the base geometry.

siConstructionModeAnimation 

The deformations are used to animate the geometry.

siConstructionModeSecondaryShape 

The deformations are used to author shapes based on the animated geometry.

siConstructionModeDefault 

Use the current user preference.

Definition at line 1049 of file xsi_decl.h.

Resolution Plane Type for Chain joints.

Enumerator:
siDefaultResolutionPlane 

Default resolution plane.

siPreferredAxisPlane 

Preferred axis plane.

siUpVectorPlane 

Up-vector plane.

Definition at line 1059 of file xsi_decl.h.

Texture creation type constants.

To use with the texturing commands.

Enumerator:
siTexturePlanarXY 

XY Planar projection.

siTexturePlanarXZ 

XZ Planar projection.

siTexturePlanarYZ 

YZ Planar projection.

siTextureCylindrical 

Cylindrical projection.

siTextureSpherical 

Spherical projection.

siTextureSpatial 

Spatial projection.

siTextureCamera 

Camera projection.

siTextureUV 

UV projection.

siTextureLollipop 

Lollipop projection.

siTexturePureImplicit 

Purely implicit projection.

Definition at line 1067 of file xsi_decl.h.

UV generation type used by the texture operator, used only if siTextureProjectionType:siTextureUV is specified as the projection type.

Enumerator:
siUVTexturePlanarXY 

XY Planar projection.

siUVTexturePlanarXZ 

XZ Planar projection.

siUVTexturePlanarYZ 

YZ Planar projection.

siUVTextureCylindrical 

Cylindrical projection.

siUVTextureSpherical 

Spherical projection.

siUVTextureSpatial 

Spatial projection.

siUVTextureLollipop 

Lollipop projection.

Definition at line 1082 of file xsi_decl.h.

Determines the capabilities of a parameter.

They can be combined by adding them: for example, to have a parameter animatable (1) and persistable (4), use 5.

Enumerator:
siAnimatable 

Animatable.

siReadOnly 

Cannot be written to.

siPersistable 

Is saved with its parameter set.

siNotInspectable 

Does not show up in the UI.

siSilent 

For internal use only.

Do not use.

siNotPresetPersistable 

Will not be saved in presets.

siTexturable 

Parameter supports connection to rendering node.

siKeyable 

Parameter is visible in 'Keying Panel' and keyable.

siNonKeyableVisible 

Parameter is only visible in 'Keying Panel'.

Definition at line 1094 of file xsi_decl.h.

Types of function curves (fcurves)

Enumerator:
siUnknownFCurve 

Unknown fcurve type.

siDefaultFCurve 

Use the fcurve type associated with parameter type.

siBooleanFCurve 

Boolean fcurve mapping a double parameter to {0, 1}.

siIntegerFCurve 

Integer fcurve.

siStandardFCurve 

FCurve mapping a double parameter to a double value.

siRawDataFCurve 

Raw data fcurve.

siQuaternionFCurve 

Quaternion fcurve.

Definition at line 1108 of file xsi_decl.h.

The extrapolation of an FCurve determines its shape before the first FCurveKey and after the last FCurveKey.

Extrapolation extends the curve's ends based on the position of these two keys.

Enumerator:
siConstantExtrapolation 

Constant extrapolation.

siLinearExtrapolation 

Linear extrapolation.

siPeriodicExtrapolation 

Periodic extrapolation.

siPeriodicRelativeExtrapolation 

Constant extrapolation relative to an offset.

Definition at line 1120 of file xsi_decl.h.

Function curve key constraints.

The last seven tangent constraints apply only to standard function curves. FCurve key constraints can be set and retrieved via the FCurveKey.Constraint property.
The constraints are not mutally exclusive for example if you have the siParameterConstraint set and clear the siLockConstraint you will also clear the siParameterConstraint. You cannot set constraints on a raw function curve. They will be ignored.

Enumerator:
siParameterConstraint 

If on, the parameter (or key time) is locked.

siLeftRightValuesConstraint 

If on, the left and right key values are locked.

siG1ContinuousConstraint 

If on, the left and right tangent orientations are the same.

siLeftRightTangentDirectionConstraint 

If on, the left and right tangent directions are locked.

siLeftRightTangentLengthConstraint 

If on, the left and right tangent lengths are locked.

siLockConstraint 

If on, the parameter, values, and tangents are locked.

siHorizontalTangentConstraint 

If on, the tangents are considered horizontal.

siExtremumHorizontalTangentConstraint 

If on, the tangents are considered as horizontal when the key is a local extremum.

siZeroLengthTangentConstraint 

If on, the left and right tangent lengths are constrained to be zero.

siSameLengthTangentConstraint 

If on, the left and right tangent lengths are the same.

siNeighborTangentConstraint 

If on, the left and right tangent point at the previous and next keys.

siMirrorTangentConstraint 

If on, the left and right tangents are mirrored.

siAutoPlateauTangentConstraint 

If on, the left and right tangents are automatically adjusted and plateaued based on neighbouring keys.

siAdjustedTangentConstraint 

If on, the tangents are adjusted automatically when neighbouring keys are created or moved.

Definition at line 1129 of file xsi_decl.h.

Specifies the interpolation type for a specific key on an fcurve.

The interpolation determines how the value is evaluated between FCurveKeys.

Enumerator:
siDefaultKeyInterpolation 

Existing function.

siConstantKeyInterpolation 

Constant function.

siLinearKeyInterpolation 

Linear function.

siCubicKeyInterpolation 

Bezier cubic function.

Definition at line 1150 of file xsi_decl.h.

Specifies the mode for changing the FCurveKey selection.

Enumerator:
siSetKeySelection 

Set specified keys as new key selection (clears current key selection first)

siAddToKeySelection 

Add specified keys to current key selection.

siRemoveFromKeySelection 

Remove keys from current key selection.

siToggleKeySelection 

Toggle key selection state.

Definition at line 1159 of file xsi_decl.h.

The interpolation of an FCurve determines how values are evaluated between its FCurveKeys.

This is very similar to the siFCurveKeyInterpolation enum.

Enumerator:
siDefaultInterpolation 

Existing function.

siConstantInterpolation 

Constant function.

siLinearInterpolation 

Linear function.

siCubicInterpolation 

Bezier cubic function.

Definition at line 1168 of file xsi_decl.h.

Specifies the kind of filter used for smoothing function curves.

Enumerator:
siFCurveAverageFilterType 

Moving Average filter.

Use this filter to smooth the function curve by applying a moving average. The weights of the averages are uniformly distributed.

siFCurveGaussianFilterType 

Gaussian filter.

Use this filter to smooth the function curve by applying a moving average. The weights of the averages are distributed as a bell curve. This usually gives better results than the average filter.

Definition at line 1177 of file xsi_decl.h.

Information on the context in which a plug-in is being evaluated.

Enumerator:
siUpdateContextNormalEval 

Normal evaluation.

siUpdateContextRenderEval 

Evaluation during a render pass.

Definition at line 1186 of file xsi_decl.h.

Information on the direction of an argument indicating how it is passed to or from a command.


Note: Output and InOut arguments are not supported by some script languages, including JScript. For this reason only siArgumentInput is supported on custom Commands.

Enumerator:
siArgumentInput 

The parameter is passed as input to the command.

siArgumentOutput 

The parameter is used to return information from the command.

siArgumentInputOutput 

The parameter is used to pass information both to and from a command.

Definition at line 1193 of file xsi_decl.h.

Custom (v1.0) Commands can be defined from a pre-defined category.

Each category specifies the base arguments of a command and the location of the menu item for that command in Softimage. Softimage automatically installs a menu item for each command created for a specific category.
You can retrieve the type of category specified using either SIObject.Categories or Command.Category but you cannot define custom categories for this type of command. For that you need to use the alternative and more powerful, way to create custom commands and add them to Menus: via the self-installing plug-in APIs.

Enumerator:
siImportCategory 
siExportCategory 
siSettingsCategory 
siHelpCategory 
siNoCategory 
siFCurveCategory 

Definition at line 1201 of file xsi_decl.h.

Defines the option flags when importing a model or merging a scene.

Enumerator:
siImportShareOptionsNone 
siImportShareOptionsImageClips 
siImportShareOptionsMaterials 
siImportShareOptionsLayers 
siImportShareOptionsPartitions 
siImportShareOptionsAll 

Definition at line 1212 of file xsi_decl.h.

enum siEventID

This enumerator provides the identifiers for the Softimage events, they can be used for implementing C++ event handlers in order to identify the events fired by Softimage.

Enumerator:
siOnBeginNewScene 

OnBeginNewScene event identifier.

Fired when a new scene is created.

siOnEndNewScene 

OnEndNewScene event identifier.

Fired when a new scene is created.

siOnBeginSceneOpen 

OnBeginSceneOpen event identifier.

Fired after a user clicks OK in the Load Scene dialog box. See the list of available Context Attributes for this event.

siOnEndSceneOpen 

OnEndSceneOpen event identifier.

Fired after the scene is loaded. See the list of available Context Attributes for this event.

siOnBeginSceneSave 

OnBeginSceneSave event identifier.

Fired when a scene is saved.

siOnEndSceneSave 

OnEndSceneSave event identifier.

Fired when a scene is saved.

siOnBeginSceneSaveAs 

OnBeginSceneSaveAs event identifier.

Fired when a scene is saved using File > Save As. Fired after the scene is loaded. See the list of available Context Attributes for this event.

siOnEndSceneSaveAs 

OnEndSceneSaveAs event identifier.

Fired when a scene is saved using File > Save As. See the list of available Context Attributes for this event.

siOnTerminate 

OnTerminate event identifier.

Fired when Softimage exits.

siOnSelectionChange 

OnSelectionChange event identifier.

Fired when the selection lists change. See the list of available Context Attributes for this event. This event is supported only by the Custom Display Host.

siOnBeginFrame 

OnBeginFrame event identifier.

Fired when a frame is rendered. See the list of available Context Attributes for this event.

siOnEndFrame 

OnEndFrame event identifier.

Fired when a frame is rendered. See the list of available Context Attributes for this event.

siOnBeginSequence 

OnBeginSequence event identifier.

Fired before the first OnBeginFrame event when a sequence is rendered. See the list of available Context Attributes for this event.

siOnEndSequence 

OnEndSequence event identifier.

Fired after the last OnEndFrame event when a sequence is rendered. See the list of available Context Attributes for this event.

siOnKeyUp 

OnKeyUp event identifier.

Fired when a user releases a key. OnKeyUp is not fired if the window with the focus handles keyboard events. See the list of available Context Attributes for this event.

siOnKeyDown 

OnKeyDown event identifier.

Fired when a user presses a key. OnKeyDown is not fired if the window with the focus handles keyboard events. See the list of available Context Attributes for this event.

siOnValueChange 

OnValueChange event identifier.

Fired when a parameter value or scene object is changed. See the list of available Context Attributes for this event.Note: This event is a regular Softimage event but is also supported by the Custom Display Host.

siOnTimeChange 

OnTimeChange event identifier.

Fired when the time line changes. See the list of available Context Attributes for this event.

siOnWindowEvent 

OnWindowEvent event identifier.

Fired when a custom display changes position or get refreshed. This event is supported only by the Custom Display Host.

siOnBeginFileExport 

OnBeginFileExport event identifier.

This event occurs at the beginning of a file export. See the list of available Context Attributes for this event.

siOnEndFileExport 

OnEndFileExport event identifier.

This event occurs at the end of a file export. See the list of available Context Attributes for this event.

siOnBeginFileImport 

OnBeginFileImport event identifier.

This event occurs at the beginning of a file import. See the list of available Context Attributes for this event.

siOnEndFileImport 

OnEndFileImport event identifier.

This event occurs at the end of a file import. See the list of available Context Attributes for this event.

siOnStartup 

OnStartup event identifier.

Fired when Softimage starts.

siOnSourcePathChange 

OnSourcePathChange event identifier.

Fired when a Softimage source path is changed. See the list of available Context Attributes for this event.

siOnObjectAdded 

OnObjectAdded event identifier.

Fired when an object has been added to the scene. See the list of available Context Attributes for this event.Note: Prior to v6.5 this was only available for the Custom Display Host.

siOnObjectRemoved 

OnObjectRemoved event identifier.

Fired when an object has been removed from the scene. See the list of available Context Attributes for this event.Note: Prior to v6.5 this was only available for the Custom Display Host.

siOnTimer 

OnTimer event identifier.

Fired when a timer elapses.

siOnBeginSceneSave2 

OnBeginSceneSave2 event identifier.

Same as siOnBeginSceneSave except this version allows you to pass in the full path name of the scene via Context Attributes.

siOnEndSceneSave2 

OnEndSceneSave2 event identifier.

Same as siOnEndSceneSave except this version allows you to pass in the full path name of the scene via Context Attributes.

siOnCloseScene 

OnCloseScene event identifier.

Fired when a scene is closing. This event occurs before a new scene or a new project is created, or before a scene is loaded.

siOnActivate 

OnActivate event identifier.

Fired when the Softimage application is activated or deactivated. The Softimage application is activated when a window belonging to a different application than Softimage is about to be deactivated. This results typically from a user action such as changing the focus or closing the window. See the list of available Context Attributes for this event.

siOnMaximize 

OnMaximize event identifier.

Fired when the Softimage application window is maximized. The Maximize action activates the application which therefore triggers an siOnActivate event with a state set to true.

siOnMinimize 

OnMinimize event identifier.

Fired when the Softimage application window is minimized. The Minimize action de-activates the application which therefore triggers an siOnActivate event with a state set to false.

siOnChangeProject 

OnChangeProject event identifier.

Fired when the project changes in Softimage. This can occur when one of the following actions takes place: - a new project is created - a project is activated - a new scene is loaded - during a crash recovery operation Note: The event is not fired when a project gets closed due to Softimage terminating. See the list of available Context Attributes for this event.

siOnRefModelModSave 

OnRefModelPreModSave event identifier.

Fired just before saving the modification of the current reference model resolution.

siOnBeginRefModelModLoad 

OnRefModelPostLoad event identifier.

Fired just before loading the modification of the current reference model resolution.

siOnEndRefModelModLoad 

siOnRefModelPostLoadAfterMod event identifier.

Fired just after loading the modification of the current reference model resolution.

siOnCustomFileImport 

OnCustomFileImport event identifier.

Fired when importing an asset with a custom file-extension. See the list of available Context Attributes for this event.

siOnCustomFileExport 

OnCustomFileExport event identifier.

Fired when exporting an asset with a custom file-extension. See the list of available Context Attributes for this event.

siOnDragAndDrop 

OnDragAndDrop event identifier.

Fired when a source is dragged over or dropped in a view and no default Softimage handlers dealt with it. See the list of available Context Attributes for this event.

siOnBeginPassChange 

OnBeginPassChange event identifier.

Fired before a renderpass is changed. See the list of available Context Attributes for this event.

siOnEndPassChange 

OnEndPassChange event identifier.

Fired after a renderpass has been changed. See the list of available Context Attributes for this event.

siOnStartAnimation 

OnStartAnimation event identifier.

Fired when animation playback has been started with the timeline play button or animation scrubbing has been started. The event can also be fired when one of these commands has been executed: PlayBackwards, PlayBackwardsFromEnd, PlayForwards, PlayForwardsFromStart, PlayFrame, PlayRealTime, or PlayRealTimeFromStart. Note: This event has no specific attributes.

siOnStopAnimation 

siOnStopAnimation event identifier.

Fired after animation playback has been stopped with the timeline play button or animation scrubbing has been stopped. The event can also be fired after one of these commands has been executed: PlaybackStop, PlayBackwards, PlayBackwardsFromEnd, PlayForwards, PlayForwardsFromStart, PlayFrame, PlayRealTime, or PlayRealTimeFromStart. Note: This event has no specific attributes.

siOnRefModelLoad 

OnRefModelLoad event identifier.

Fired before the current resolution gets loaded for a referenced model

siOnConnectShader 

OnConnectShader event identifier.

Fired after a shader port is connected. See the list of available Context Attributes for this event.

siOnDisconnectShader 

OnDisconnectShader event identifier.

Fired after a shader port is disconnected. See the list of available Context Attributes for this event.

siOnAddShaderPort 

OnAddShaderPort event identifier.

Not implemented.

siOnRemoveShaderPort 

OnRemoveShaderPort event identifier.

Not implemented.

siOnCreateShader 

OnCreateShader event identifier.

Fired after a shader is created. See the list of available Context Attributes for this event.

siOnCreateShaderDef 

OnCreateShaderDef event identifier.

Fired after a shader definition is created. See the list of available Context Attributes for this event.

siOnCustomShaderExport 

siOnCustomShaderExport event identifier.

Fired when exporting a shader or shader tree in the RenderTree with a custom file-extension. See the list of available Context Attributes for this event.

siOnRenderAbort 

OnRenderAbort event identifier.

Fired when a render sequence has been aborted by the user. The event can also be sent when a render region job is re-executed as a result of a scene change.

siOnEndCommand 

OnEndCommand event identifier.

Fired when a Command terminates. This event is fired for top-level commands only, sub-commands executed while a top-level command is running will not trigger this event. See the list of available Context Attributes for this event.

siOnBeginCommand 

OnBeginCommand event identifier.

Fired before a Command is executed. This event is fired for top-level commands only, sub-commands executed while a top-level command is running will not trigger this event. See the list of available Context Attributes for this event.

Definition at line 1223 of file xsi_decl.h.

    {   siOnBeginNewScene   = 542179328,        
    siOnEndNewScene = 542179329,        
    siOnBeginSceneOpen  = 542179330,        
    siOnEndSceneOpen    = 542179331,        
    siOnBeginSceneSave  = 542179332,        
    siOnEndSceneSave    = 542179333,        
    siOnBeginSceneSaveAs    = 542179334,        
    siOnEndSceneSaveAs  = 542179335,        
    siOnTerminate   = 542179336,        
    siOnSelectionChange = 542179337,        
    siOnBeginFrame  = 542179338,        
    siOnEndFrame    = 542179339,        
    siOnBeginSequence   = 542179340,        
    siOnEndSequence = 542179341,        
    siOnKeyUp   = 542179342,        
    siOnKeyDown = 542179343,        
    siOnValueChange = 542179344,        
    siOnTimeChange  = 542179345,        
    siOnWindowEvent = 542179346,        
    siOnBeginFileExport = 542179347,        
    siOnEndFileExport   = 542179348,        
    siOnBeginFileImport = 542179349,        
    siOnEndFileImport   = 542179350,        
    siOnStartup = 542179351,        
    siOnSourcePathChange    = 542179352,        
    siOnObjectAdded = 542179353,        
    siOnObjectRemoved   = 542179354,        
    siOnTimer   = 542179355,        
    siOnBeginSceneSave2 = 542179356,        
    siOnEndSceneSave2   = 542179357,        
    siOnCloseScene  = 542179358,        
    siOnActivate    = 542179359,        
    siOnMaximize    = 542179360,        
    siOnMinimize    = 542179361,        
    siOnChangeProject   = 542179362,        
    siOnRefModelModSave = 542179363,        
    siOnBeginRefModelModLoad    = 542179364,        
    siOnEndRefModelModLoad  = 542179365,        
    siOnCustomFileImport    = 542179366,        
    siOnCustomFileExport    = 542179367,        
    siOnDragAndDrop = 542179368,        
    siOnBeginPassChange = 542179369,        
    siOnEndPassChange   = 542179370,        
    siOnStartAnimation  = 542179371,        
    siOnStopAnimation   = 542179372,        
    siOnRefModelLoad    = 542179373,        
    siOnConnectShader   = 542179374,        
    siOnDisconnectShader    = 542179375,        
    siOnAddShaderPort   = 542179376,        
    siOnRemoveShaderPort    = 542179377,        
    siOnCreateShader    = 542179378,        
    siOnCreateShaderDef = 542179379,        
    siOnCustomShaderExport  = 542179380,        
    siOnRenderAbort = 542179381,        
    siOnEndCommand  = 542181329,        
    siOnBeginCommand    = 542181331     
    }   siEventID;

Specifies the type of operation performed to update the selection.

Enumerator:
siAddedToSelection 

One or more objects added to selection.

siRemovedFromSelection 

One or more objects removed from selection.

Definition at line 1284 of file xsi_decl.h.

Specifies the render field setting.

Enumerator:
siRenderFieldNone 

No field setting.

siRenderFieldOdd 

Odd field setting.

siRenderFieldEven 

Even field setting.

Definition at line 1291 of file xsi_decl.h.

Specifies the type of rendering.

Enumerator:
siRenderSequence 

Render sequence.

siRenderFramePreview 

Frame preview or render region rendering.

siRenderEchoToMi 
siRenderExportArchive 

Definition at line 1299 of file xsi_decl.h.

Specifies the type of rendering error.

Enumerator:
siRenderNoError 

No rendering error.

siRenderAbort 
siRenderFailure 

Definition at line 1308 of file xsi_decl.h.

Specifies the subdivision rule used for an approximated geometry selection.

Enumerator:
siCatmullClark 

Catmull-Clark subdivision rule.

siXSIDooSabin 

XSI-Doo-Sabin subdivision rule.

siLinearSubdivision 

Linear subdivision rule.

Definition at line 1316 of file xsi_decl.h.

Direction type for navigating geometry components.

Enumerator:
siNextComponent 

next component

siPreviousComponent 

previous component

siFirstComponent 

first component

siLastComponent 

last component

Definition at line 1324 of file xsi_decl.h.

Enumeration of particle render types.

Enumerator:
siBillboardType 

Billboard render type.

siSphereType 

Sphere render type.

siBlobType 

Blob render type.

Definition at line 1333 of file xsi_decl.h.

Enumeration of the different attributes that are available on the FCurveEditor object.

Enumerator:
siRegionStartFrame 

If a region has been selected this returns the start frame.

If no region has been selected then 0.0 is returned.

siRegionEndFrame 

End frame of the region selection, or 0.0 if no region has been selected.

siRegionMin 

Minimum value of the keys in the region, or 0.0 if no region has been selected.

siRegionMax 

Maximum value of the keys in the region, or 0.0 if no region has been selected.

Definition at line 1341 of file xsi_decl.h.

Determines the severity types of a message implemented with the C++ API.

They can be combined.

Enumerator:
siFatalMsg 

Fatal error has occurred; possibly leading to an unstable system state.

Displayed as Message Box and in History window.

siErrorMsg 

An error has occurred; possibly leading data loss.

Displayed in History window and Status Bar.

siWarningMsg 

An error has occurred but is recoverable.

Displayed in History window and Status Bar.

siInfoMsg 

Log an information message.

Displayed in History window and Status Bar.

siVerboseMsg 

Log a diagnostic information message.

Displayed in History window.

siCommentMsg 

Log an information message without a prefix to describe its type.

Definition at line 1350 of file xsi_decl.h.

Information which is passed to the custom compiled operators through its Init and Term functions.

Enumerator:
siDLLLoadingUnloading 

Flag passed to the operator in the Init or Term to notify that the DLL is Offloading/Reloading .

Definition at line 1361 of file xsi_decl.h.

A device driver contains a set of channels that can be configured.

This enumeration is the type of action to perform for a channel.

Enumerator:
siChannelActionNone 

Nothing to do with the channel.

siChannelActionDrive 

Drive a parameter of a scene object.

If you choose this type of action, you can set the Channel.Target property to any valid expression (for example, "current.kine.local.posx").

siChannelActionCommand 

Fire a command.

If you choose this type of action, you can set the Channel.Target property to the name of the command to launch through this channel. This can be either a native Softimage command or a custom command.

siChannelActionSpecial 

Other action (Special).

If you choose this type of action, you can set the Channel.Target property to any of these special keywords:TIMELINE (drives the timeline)TIME_START (goes to the first frame)TIME_END (goes to the last frame)TIME_STEP_FORWARD (goes to the next frame)TIME_STEP_BACK (goes to the previous frame)TIME_STOP (stops the playback)TIME_PLAY_NORMAL (real time playback from current frame)TIME_PLAY_FRAME (real time playback from first frame)TIME_PLAY_SLIDE (plays all frames from current frame on)TIME_SPECIFY,<frame>ACTIVATE,<driver_ID> (enables a device driver)DEACTIVATE,<driver_ID> (disables a device driver)

Definition at line 1367 of file xsi_decl.h.

Specifies how to select objects in a hierarchy.

Enumerator:
siSelectDefault 

Select the object as is.

siSelectNode 

Select the object in node.

siSelectBranch 

Select the object and its children.

siSelectTree 

Select the entire hierarchy of objects.

siSelectModel 

Select the model and the hierarchy of objects.

If that model is the scene root then this is the same as siSelectTree.

Definition at line 1376 of file xsi_decl.h.

Specifies the filter to use in a transient explorer.

Enumerator:
siSEFilterAllNodes 

Display all nodes.

siSEFilterAllNodesNoParams 

Display all nodes without leaf nodes.

siSEFilterGeometryOperators 

Display the operators and primitives.

siSEFilterObjectsOnly 

Display the objects.

siSEFilterAllProperties 

Display all the properties.

siSEFilterPropertiesAndPrimitives 

Display all the properties and primitives.

siSEFilterMaterialsAndShaders 

Display all the materials and shaders.

siSEFilterModelsOnly 

Display only the models.

siSEFilterGroupsOnly 

Display only the groups.

siSEFilterImageClips 

Display only the image clips.

Definition at line 1386 of file xsi_decl.h.

enum siClassID

The class ID of Softimage objects.

This enumerator is used by the C++ API to manage references between the object model and C++. For example, the CRef::IsA function uses the class ID to determine whether or not the class type is compatible with the underlying reference object.

Enumerator:
siObjectID 

Generic object id.

siUnknownClassID 

Unknown object id.

siSIObjectID 

SIObject object id.

siOGLMaterialID 

OGLMaterial object id.

siOGLTextureID 

OGLTexture object id.

siOGLLightID 

OGLLight object id.

siApplicationID 

Application object id.

siArgumentID 

Argument object id.

siCommandID 

Command object id.

siClipID 

Clip object id.

siShapeClipID 

ShapeClip object id.

siSubComponentID 

SubComponent object id.

siFacetID 

Facet object id.

siNurbsSurfaceID 

NurbsSurfaceFace object id.

siPointID 

Point object id.

siControlPointID 

ControlPoint object id.

siNurbsCurveControlPointID 

NurbsCurveControlPoint object id.

siNurbsCurveListControlPointID 

NurbsCurveListControlPoint object id.

siNurbsSurfaceControlPointID 

NurbsSurfaceControlPoint object id.

siNurbsCurveID 

NurbsCurve object id.

siSampleID 

Sample object id.

siNurbsSampleID 

NurbsSample object id.

siPolygonNodeID 

PolygonNode object id.

siGeometryID 

Geometry object id.

siNurbsSurfaceMeshID 

NurbsSurfaceMesh object id.

siNurbsCurveListID 

NurbsCurveList object id.

siPolygonMeshID 

PolygonMesh object id.

siSegmentID 

Segment object id.

siConnectionPointID 

ConnectionPoint object id.

siConstructionHistoryID 

ConstructionHistory object id.

siDictionaryID 

Dictionary object id.

siEventInfoID 

EventInfo object id.

siFCurveID 

FCurve object id.

siNestedFCurveID 

NestedFCurve object id.

siFCurveKeyID 

FCurveKey object id.

siFileBrowserID 

FileBrowser object id.

siImageID 

Image object id.

siMappedItemID 

MappedItem object id.

siPortID 

Port object id.

siInputPortID 

InputPort object id.

siSelectionID 

Selection object id.

siStaticSourceID 

StaticSource object id.

siTriangleID 

Triangle object id.

siTriangleVertexID 

TriangleVertex object id.

siUpdateContextID 

UpdateContext object id.

siParameterID 

Parameter object id.

siCompoundParameterID 

CompoundParameter object id.

siProjectID 

Project object id.

siProjectItemID 

ProjectItem object id.

siActionSourceID 

ActionSource object id.

siExpressionID 

Expression object id.

siImageClipID 

ImageClip object id.

siSceneID 

Scene object id.

siShaderID 

Shader object id.

siOperatorID 

Operator object id.

siEnvelopeID 

Envelope object id.

siPrimitiveID 

Primitive object id.

siParticleCloudPrimitiveID 

ParticleCloudPrimitive object id.

siPropertyID 

Property object id.

siClusterPropertyID 

ClusterProperty object id.

siConstraintID 

Constraint object id.

siConstraintWithUpVectorID 

ConstraintWithUpVector object id.

siCustomPropertyID 

CustomProperty object id.

siJointID 

Joint object id.

siKinematicsID 

Kinematics object id.

siMaterialID 

Material object id.

siStaticKinematicStateID 

StaticKinematicState object id.

siSceneItemID 

SceneItem object id.

siClusterID 

Cluster object id.

siGroupID 

Group object id.

siLayerID 

Layer object id.

siPassID 

Pass object id.

siUserGroupID 

UserGroup object id.

siX3DObjectID 

X3DObject object id.

siParticleCloudID 

ParticleCloud object id.

siModelID 

Model object id.

siChainElementID 

ChainElement object id.

siChainRootID 

ChainRoot object id.

siChainBoneID 

ChainBone object id.

siChainEffectorID 

ChainEffector object id.

siDirectedID 

Directed object id.

siCameraID 

Camera object id.

siLightID 

Light object id.

siNullID 

Null object id.

siRigID 

Rig object id.

siCameraRigID 

CameraRig object id.

siLightRigID 

LightRigobject id.

siKinematicStateID 

KinematicState object id.

siTrackID 

Track object id.

siUserDataMapID 

UserDataMap object id.

siFxTreeID 

FxTree object id.

siFxOperatorID 

FxOperator object id.

siTriangleCollectionID 

TriangleCollection object id.

siTriangleVertexCollectionID 

TriangleVertexCollection object id.

siSampleCollectionID 

SampleCollection object id.

siPolygonNodeCollectionID 

PolygonNodeCollection object id.

siPointCollectionID 

PointCollection object id.

siFacetCollectionID 

FacetCollection object id.

siVertexID 

Vertex object id.

siVertexCollectionID 

VertexCollection object id.

siEdgeID 

Edge object id.

siEdgeCollectionID 

EdgeCollection object id.

siPolygonFaceID 

PolygonFace object id.

siPolygonFaceCollectionID 

PolygonFaceCollection object id.

siDataSourceID 

DataSource object id.

siAnimationSourceID 

AnimationSource object id.

siOutputPortID 

OuptputPort object id.

siProxyParameterID 

Proxy Parameter object id.

siDeviceCollectionID 

Device collection object id.

siDeviceID 

Device object id.

siChannelID 

Channel object id.

siKnotCollectionID 

KnotCollection object id.

siControlPointCollectionID 

ControlPointCollection object id.

siNurbsCurveCollectionID 

NurbsCurveCollection object id.

siNurbsSurfaceCollectionID 

NurbsSurfaceCollection object id.

siNurbsSampleCollectionID 

NurbsSampleCollection object id.

siTextureID 

Texture object id.

siUserDataBlobID 

UserDataBlob object id.

siParticleID 

Particle object id.

siAddonID 

Addon object id.

siPPGLayoutID 

PPGLayout object id.

siPPGItemID 

PPGItem object id.

siPreferencesID 

Preferences object id.

siParticleTypeID 

ParticleType object id.

siParticleAttributeID 

ParticleAttribute object id.

siGridDataID 

GridData object id.

siTextureLayerID 

TextureLayer object id.

siTextureLayerPortID 

TextureLayerPort object id.

siCustomOperatorID 

CustomOperator object id.

siPortGroupID 

PortGroup object id.

siDesktopID 

Desktop object id.

siLayoutID 

Layout object id.

siUIObjectID 

UIObject object id.

siUIPersistableID 

UIPersistable object id.

siViewID 

View object id.

siArrayParameterID 

ArrayParameter object id.

siViewContextID 

X3DObject object id.

siContextID 

Context object id.

siPPGEventContextID 

PPGEventContext id.

siClipEffectID 

ClipEffect object id.

siClipEffectItemID 

ClipEffectItem object id.

siShapeKeyID 

ShapeKey object id.

siSourceID 

Source object id.

siTimeControlID 

TimeControl object id.

siTransitionID 

Transition object id.

siAnimationSourceItemID 

AnimationSourceItem object id.

siClipContainerID 

ClipContainer object id.

siArgumentHandlerID 

Argument Handler object id.

siMenuID 

Menu object id.

siMenuItemID 

MenuItem object id.

siPluginID 

Plugin object id.

siPluginItemID 

PluginItem object id.

siPluginRegistrarID 

PluginRegistrar object id.

siFilterID 

Filter object id.

siUIToolkitID 

UIToolkit object id.

siProgressBarID 

ProgressBar object id.

siParamDefID 

ParamDef object id.

siFactoryID 

Factory object id.

siCommandCollectionID 

Command object id.

siArgumentCollectionID 

Argument Collection id.

siGraphicSequencerContextID 

Graphic Sequencer Core id.

siClipRelationID 

ClipRelation object id.

siMixerID 

Mixer object id.

siLibraryID 

Library id.

siSimulationEnvironmentID 

SimulationEnvironment object id.

siGridWidgetID 

GridWidget object id.

siGeometryAccessorID 

Geometry accessor object id.

siEnvelopeWeightID 

EnvelopeWeight property object id.

siMeshBuilderID 

MeshBuilder object id.

siSegmentCollectionID 
siFileReferenceID 

X3DObject object id.

siClusterPropertyBuilderID 

ClusterPropertyBuilder object id.

siMaterialLibraryID 

MaterialLibrary id.

siHairPrimitiveID 

HairPrimitive object id.

siRenderHairAccessorID 

RenderHairAccessor object id.

siPointLocatorDataID 

PointLocatorData object id.

siCollectionItemID 

CollectionItem object id.

siOperatorContextID 

Operator context object id.

siPointCloudID 

PointCloud object id.

siRigidBodyAccessorID 

RigidBodyAccessor object id.

siRigidConstraintAccessorID 

RigidConstraintAccessor object id.

siDeltaID 

Delta object id.

siActionDeltaID 

ActionDelta object id.

siActionDeltaItemID 

ActionDeltaItem object id.

siTimerEventID 

TimerEvent object id.

siPassContainerID 

PassContainer object id.

siRenderChannelID 

RenderChannel object id.

siSceneRenderPropertyID 

SceneRenderProperty object id.

siFramebufferID 

Framebuffer object id.

siRendererContextID 

RendererContext object id.

siRendererID 

Renderer object id.

siTimeTransportID 

Do not use.

siTimeTransportContextID 

Do not use.

siICENodeID 

ICENode object id.

siICECompoundNodeID 

ICECompoundNode object id.

siICENodePortID 

ICENodePort object id.

siICETreeID 

ICETree object id.

siICENodeContainerID 

ICENodeContainer object id.

siICENodeInputPortID 

ICENodeInputPort object id.

siICENodeOutputPortID 

ICENodeOutputPort object id.

siICEDataProviderNodeID 

ICEDataProviderNode object id.

siICEDataModifierNodeID 

ICEDataModifierNode object id.

siICENodeDefID 

ICENodeDef object id.

siICENodeContextID 

ICENodeContext object id.

siICEAttributeID 

ICEAttribute object id.

siPartitionID 

Partition object id.

siOverrideID 

Override object id.

siHardwareShaderContextID 

Hardware Shader Context Object id.

siValueMapID 

ValueMap object id.

siShaderParamDefID 

ShaderParamDef object id.

siShaderParamDefOptionsID 

ShaderParamDefOptions object id.

siShaderballOptionsID 

ShaderballOptions object id.

siShaderParamDefContainerID 

ShaderParamDefContainer object id.

siMetaShaderRendererDefID 

MetaShaderRendererDef object id.

siShaderDefID 

ShaderDef object id.

siShaderStructParamDefID 

ShaderStructParamDef object id.

siShaderArrayParamDefID 

ShaderArrayParamDef object id.

siShaderParameterID 

ShaderParameter object id.

siShaderArrayItemParameterID 

ShaderArrayItemParameter object id.

siShaderArrayParameterID 

ShaderArrayParameter object id.

siShaderCompoundParameterID 

ShaderCompoundParameter object id.

siRenderTreeNodeID 

RenderTreeNode object id.

siShaderBaseID 

ShaderBase object id.

siShaderContainerID 

ShaderContainer object id.

siShaderCompoundID 

ShaderCompound object id.

siShaderCommentID 

ShaderComment object id.

siShaderDefManagerID 

ShaderDefManager object id.

siHardwareSurfaceID 

HardwareSurface object id.

siGraphicDriverID 

Graphic Driver object id.

siHairGeometryID 

HairGeometry object id.

siPointCloudGeometryID 

PointCloudGeometry object id.

siSchematicNodeID 

SchematicNode object id.

siSchematicID 

Schematic object id.

siSchematicNodeCollectionID 

SchematicNodeCollection object id.

siUVPropertyID 

UVProperty property object id.

siToolContextID 

ToolContext object id.

siPickBufferID 

PickBuffer object id.

Definition at line 1401 of file xsi_decl.h.

    {   siObjectID  = 0,        
    siUnknownClassID    = 0,        
    siSIObjectID    = 1,        
    siOGLMaterialID = 2,        
    siOGLTextureID  = 3,        
    siOGLLightID    = 4,        
    siApplicationID = 5,        
    siArgumentID    = 6,        
    siCommandID = 7,        
    siClipID    = 8,        
    siShapeClipID   = 9,        
    siSubComponentID    = 10,       
    siFacetID   = 11,       
    siNurbsSurfaceID    = 12,       
    siPointID   = 13,       
    siControlPointID    = 14,       
    siNurbsCurveControlPointID  = 15,       
    siNurbsCurveListControlPointID  = 16,       
    siNurbsSurfaceControlPointID    = 17,       
    siNurbsCurveID  = 18,       
    siSampleID  = 19,       
    siNurbsSampleID = 20,       
    siPolygonNodeID = 21,       
    siGeometryID    = 22,       
    siNurbsSurfaceMeshID    = 23,       
    siNurbsCurveListID  = 24,       
    siPolygonMeshID = 25,       
    siSegmentID = 26,       
    siConnectionPointID = 27,       
    siConstructionHistoryID = 28,       
    siDictionaryID  = 29,       
    siEventInfoID   = 30,       
    siFCurveID  = 31,       
    siNestedFCurveID    = 32,       
    siFCurveKeyID   = 33,       
    siFileBrowserID = 34,       
    siImageID   = 35,       
    siMappedItemID  = 36,       
    siPortID    = 37,       
    siInputPortID   = 38,       
    siSelectionID   = 39,       
    siStaticSourceID    = 40,       
    siTriangleID    = 41,       
    siTriangleVertexID  = 42,       
    siUpdateContextID   = 43,       
    siParameterID   = 44,       
    siCompoundParameterID   = 45,       
    siProjectID = 46,       
    siProjectItemID = 47,       
    siActionSourceID    = 48,       
    siExpressionID  = 49,       
    siImageClipID   = 50,       
    siSceneID   = 51,       
    siShaderID  = 52,       
    siOperatorID    = 53,       
    siEnvelopeID    = 54,       
    siPrimitiveID   = 55,       
    siParticleCloudPrimitiveID  = 56,       
    siPropertyID    = 57,       
    siClusterPropertyID = 58,       
    siConstraintID  = 59,       
    siConstraintWithUpVectorID  = 60,       
    siCustomPropertyID  = 61,       
    siJointID   = 62,       
    siKinematicsID  = 63,       
    siMaterialID    = 64,       
    siStaticKinematicStateID    = 65,       
    siSceneItemID   = 66,       
    siClusterID = 67,       
    siGroupID   = 68,       
    siLayerID   = 69,       
    siPassID    = 70,       
    siUserGroupID   = 71,       
    siX3DObjectID   = 72,       
    siParticleCloudID   = 73,       
    siModelID   = 74,       
    siChainElementID    = 75,       
    siChainRootID   = 76,       
    siChainBoneID   = 77,       
    siChainEffectorID   = 78,       
    siDirectedID    = 79,       
    siCameraID  = 80,       
    siLightID   = 81,       
    siNullID    = 82,       
    siRigID = 83,       
    siCameraRigID   = 84,       
    siLightRigID    = 85,       
    siKinematicStateID  = 86,       
    siTrackID   = 87,       
    siUserDataMapID = 88,       
    siFxTreeID  = 89,       
    siFxOperatorID  = 90,       
    siTriangleCollectionID  = 91,       
    siTriangleVertexCollectionID    = 92,       
    siSampleCollectionID    = 93,       
    siPolygonNodeCollectionID   = 94,       
    siPointCollectionID = 95,       
    siFacetCollectionID = 97,       
    siVertexID  = 98,       
    siVertexCollectionID    = 99,       
    siEdgeID    = 100,      
    siEdgeCollectionID  = 101,      
    siPolygonFaceID = 102,      
    siPolygonFaceCollectionID   = 103,      
    siDataSourceID  = 104,      
    siAnimationSourceID = 105,      
    siOutputPortID  = 106,      
    siProxyParameterID  = 107,      
    siDeviceCollectionID    = 108,      
    siDeviceID  = 109,      
    siChannelID = 110,      
    siKnotCollectionID  = 111,      
    siControlPointCollectionID  = 112,      
    siNurbsCurveCollectionID    = 113,      
    siNurbsSurfaceCollectionID  = 114,      
    siNurbsSampleCollectionID   = 115,      
    siTextureID = 116,      
    siUserDataBlobID    = 117,      
    siParticleID    = 118,      
    siAddonID   = 119,      
    siPPGLayoutID   = 120,      
    siPPGItemID = 121,      
    siPreferencesID = 122,      
    siParticleTypeID    = 123,      
    siParticleAttributeID   = 124,      
    siGridDataID    = 125,      
    siTextureLayerID    = 126,      
    siTextureLayerPortID    = 127,      
    siCustomOperatorID  = 128,      
    siPortGroupID   = 129,      
    siDesktopID = 130,      
    siLayoutID  = 131,      
    siUIObjectID    = 132,      
    siUIPersistableID   = 133,      
    siViewID    = 134,      
    siArrayParameterID  = 135,      
    siViewContextID = 137,      
    siContextID = 138,      
    siPPGEventContextID = 139,      
    siClipEffectID  = 140,      
    siClipEffectItemID  = 141,      
    siShapeKeyID    = 142,      
    siSourceID  = 143,      
    siTimeControlID = 144,      
    siTransitionID  = 145,      
    siAnimationSourceItemID = 146,      
    siClipContainerID   = 147,      
    siArgumentHandlerID = 148,      
    siMenuID    = 149,      
    siMenuItemID    = 150,      
    siPluginID  = 151,      
    siPluginItemID  = 152,      
    siPluginRegistrarID = 153,      
    siFilterID  = 154,      
    siUIToolkitID   = 155,      
    siProgressBarID = 156,      
    siParamDefID    = 157,      
    siFactoryID = 158,      
    siCommandCollectionID   = 159,      
    siArgumentCollectionID  = 160,      
    siGraphicSequencerContextID = 161,      
    siClipRelationID    = 162,      
    siMixerID   = 163,      
    siLibraryID = 164,      
    siSimulationEnvironmentID   = 165,      
    siGridWidgetID  = 166,      
    siGeometryAccessorID    = 167,      
    siEnvelopeWeightID  = 168,      
    siMeshBuilderID = 169,      
    siSegmentCollectionID   = 170,
    siFileReferenceID   = 171,      
    siClusterPropertyBuilderID  = 172,      
    siMaterialLibraryID = 173,      
    siHairPrimitiveID   = 174,      
    siRenderHairAccessorID  = 175,      
    siPointLocatorDataID    = 176,      
    siCollectionItemID  = 177,      
    siOperatorContextID = 178,      
    siPointCloudID  = 179,      
    siRigidBodyAccessorID   = 180,      
    siRigidConstraintAccessorID = 181,      
    siDeltaID   = 182,      
    siActionDeltaID = 183,      
    siActionDeltaItemID = 184,      
    siTimerEventID  = 185,      
    siPassContainerID   = 186,      
    siRenderChannelID   = 187,      
    siSceneRenderPropertyID = 188,      
    siFramebufferID = 189,      
    siRendererContextID = 190,      
    siRendererID    = 191,      
    siTimeTransportID   = 192,      
    siTimeTransportContextID    = 193,      
    siICENodeID = 194,      
    siICECompoundNodeID = 195,      
    siICENodePortID = 196,      
    siICETreeID = 197,      
    siICENodeContainerID    = 198,      
    siICENodeInputPortID    = 199,      
    siICENodeOutputPortID   = 200,      
    siICEDataProviderNodeID = 201,      
    siICEDataModifierNodeID = 202,      
    siICENodeDefID  = 203,      
    siICENodeContextID  = 204,      
    siICEAttributeID    = 205,      
    siPartitionID   = 206,      
    siOverrideID    = 207,      
    siHardwareShaderContextID   = 208,      
    siValueMapID    = 209,      
    siShaderParamDefID  = 210,      
    siShaderParamDefOptionsID   = 211,      
    siShaderballOptionsID   = 212,      
    siShaderParamDefContainerID = 213,      
    siMetaShaderRendererDefID   = 214,      
    siShaderDefID   = 215,      
    siShaderStructParamDefID    = 216,      
    siShaderArrayParamDefID = 217,      
    siShaderParameterID = 218,      
    siShaderArrayItemParameterID    = 219,      
    siShaderArrayParameterID    = 220,      
    siShaderCompoundParameterID = 221,      
    siRenderTreeNodeID  = 222,      
    siShaderBaseID  = 223,      
    siShaderContainerID = 224,      
    siShaderCompoundID  = 225,      
    siShaderCommentID   = 226,      
    siShaderDefManagerID    = 227,      
    siHardwareSurfaceID = 228,      
    siGraphicDriverID   = 229,      
    siHairGeometryID    = 230,      
    siPointCloudGeometryID  = 231,      
    siSchematicNodeID   = 232,      
    siSchematicID   = 233,      
    siSchematicNodeCollectionID = 234,      
    siUVPropertyID  = 235,      
    siToolContextID = 236,      
    siPickBufferID  = 237       
    }   siClassID;

This enumeration type specifies how the BlendInPresets command will apply the new shaders to the parameters selected by the command.

Enumerator:
siBlendInPreset 

Blend the new shaders in with any existing shaders on the ports, or the parameter value if there are no shaders.

siReplaceAndBlendInPreset 

Remove any existing shaders from the parameters, and blend with the parameter value.

siReplaceNoBlend 

Remove any existing shaders and connect the new shaders directly to the parameters, without blending.

Definition at line 1643 of file xsi_decl.h.

This enumeration type specifies how the texture-layer blending commands will apply the new shaders to the parameters selected by the command.

Enumerator:
siBlendInTextureLayers 

Blend the new shaders in with any existing shaders on the ports, or the parameter value if there are no shaders.

siReplaceAndBlendInTextureLayers 

Remove any existing shaders and layers from the parameters, and blend with the parameter value.

siReplaceAndNoBlendInTextureLayers 

Remove any existing shaders and layers and connect the new shaders directly to the parameters, without blending.

Definition at line 1651 of file xsi_decl.h.

This enumeration type specifies what kind of shader port connections you are interested in when using the RemoveAllShadersFromCnxPoint command.

Enumerator:
siShaderCnxPointNone 

Reference none of the connections on a parameter.

(not normally used)

siShaderCnxPointBasePorts 

Reference only regular shader connections (not including texture layer port connections).

"Regular connections" refers to connections of one shader to another.

siShaderCnxPointTextureLayerPorts 

Reference texture layer port connections only.

siShaderCnxPointAll 

Reference all types of shader connections, including both regular and texture layer port connections.

Definition at line 1659 of file xsi_decl.h.

This enumeration type specifies the type of item supported by add-ons.

Depending on which type you use with the Addon.AddItem method, you need to supply only a name, or a path and file name, or you may be able to use either as indicated below.

Enumerator:
siLayoutAddonItemType 
siToolbarAddonItemType 
siKeyMapAddonItemType 
siScriptCmdAddonItemType 
siPresetAddonItemType 
siSpdlAddonItemType 
siLibraryAddonItemType 
siOtherAddonItemType 
siEventAddonItemType 
siDeviceAddonItemType 
siShelfAddonItemType 
siPluginAddonItemType 
siHelpAddonItemType 
siViewAddonItemType 

Definition at line 1668 of file xsi_decl.h.

Types of Columns supported by siControlGrid (see siPPGControlTypeand GridData.SetColumnType)

Enumerator:
siColumnStandard 

A column of text.

Numeric values are shown in decimal format without a slider.

siColumnBool 

A check mark is shown if the value of the zero is non-zero.

siColumnCombo 

The value of the cell is chosen from a drop down list.

Definition at line 1687 of file xsi_decl.h.

Selection Mode for the cells of the GridWidget, see siUIGridSelectionMode in siPPGItemAttribute.

Enumerator:
siSelectionCell 

Individual cells are selectable (Default behavior)

siSelectionHeader 

Entire columns or rows are selected by clicking in the header cells.

siSelectionNone 

Nothing can be selected.

Definition at line 1695 of file xsi_decl.h.

Polygon cluster contour stretching method used to generate texture coordinates as part of the GenerateUVSetByContourStretching and ModifyUVSetByContourStretching commands.

Enumerator:
siContourStretchingWalkingOnMesh 

Texture coordinates obtained by accumulated distance from contours while walking along mesh edges.

siContourStretchingSpatialDistance 

Texture coordinates obtained by accumulated spatial distance from contours to the mesh vertices.

siContourStretchingReqularQuads 

Texture coordinates obtained by accumulated distances along grid lines obtained from contours.

siContourStretchingProjectionOnSurface 

Texture coordinates obtained by projection on a parameteric surface built from contours.

Definition at line 1703 of file xsi_decl.h.

The list of scopes supported by the Scene Explorer.

Enumerator:
siExplorerScopeDefault 

Default scope.

siExplorerScopeProject 

Project (Content Container) scope.

siExplorerScopePreferences 

Preferences scope.

siExplorerScopeScene 

Scene scope.

siExplorerScopeLayers 

Layers scope.

siExplorerScopePasses 

Passes scope.

siExplorerScopeEnvironments 

Environments scope.

siExplorerScopeParTypes 

The Particle Types scope is no longer supported.

siExplorerScopeSelection 

Selection scope.

siExplorerScopeCustom 

Custom scope.

siExplorerScopeCurrentLayer 

Current Layer scope.

siExplorerScopeCurrentPass 

Current Pass scope.

siExplorerScopeCurrentEnvironment 

The Current Environment scope is no longer supported.

siExplorerScopeCurrentParType 

Current Particle Type scope.

siExplorerScopeSourcesClips 

Sources and Clips scope.

siExplorerScopeSourcesClipsAnimation 

Sources and Clips (Animation Only) scope.

siExplorerScopeSourcesClipsAudio 

Sources and Clips (Audio Only) scope.

siExplorerScopeSourcesClipsImages 

Sources and Clips (Images Only) scope.

siExplorerScopeSourcesClipsMaterials 

Sources and Clips (Materials Only) scope.

siExplorerScopeSourcesClipsModels 

The Sources and Clips (Models Only) scope is no longer supported.

siExplorerScopeCommands 

The Commands scope is no longer supported.

Definition at line 1712 of file xsi_decl.h.

States for the time change notification CTimeChangeNotificationfor Custom Displays.

Enumerator:
siTimeStateNull 

Null state.

siTimeStateStop 

Stop state.

siTimeStatePreStop 

Pre-Stop state.

siTimeStatePlay 

Play state.

siTimeStatePrePlay 

Pre-Play state.

siTimeStateRecord 

Record state.

siTimeStatePreRecord 

Pre-Record state.

siTimeStateFast 

Fast state.

siTimeStatePreFast 

Pre-Fast state.

siTimeStatePreRoll 

Pre-Roll state.

siTimeStateStep 

Step state.

siTimeStatePostStep 

Post-Step state.

siTimeStatePause 

Pause state.

siTimeStatePrePause 

Pre-Pause state.

siTimeStateSeek 

Seek state.

siTimeNotifyTime 

Time notification.

siTimeNotifyScrub 

Scrub notification.

siTimeNotifySeek 

Seek notification.

siTimeNotifyPortChange 

Port Change notification.

siTimeNotifyFrameDrop 

Frame Drop notification.

Definition at line 1738 of file xsi_decl.h.

Types of display callbacks defined for the Graphic Sequencer.

Enumerator:
siUndefined 

Undefined.

siPreBeginFrame 

Fired just before a new frame begins.

siBeginFrame 

Fired when a new frame begins.

siPostBeginFrame 

Fired after the frame has begun.

siPrePass 

Fired before each XGS display pass.

siPass 

Fired XGS display pass callback.

siPostPass 

Fired after each XGS display pass.

siPreEndFrame 

Fired just before the frame ends.

siEndFrame 

Fired when the frame ends.

siPostEndFrame 

Fired after the frame has ended.

siRenderFrame 

Fired after MentalRay renders a frame, or after a render region is finished rendering a frame.

Definition at line 1763 of file xsi_decl.h.

Type of object passed to an Open Graphic Sequencer callback.

Enumerator:
siXGSPluginManager 

The Open Graphic Sequencer plug-in manager.

Definition at line 1779 of file xsi_decl.h.

enum siXGSFlag

Flags for Graphic Sequencer callbacks.

Enumerator:
siInactive 

Callback is inactive.

siActive 

Callback is active.

Definition at line 1785 of file xsi_decl.h.

    {   siInactive  = 0,        
    siActive    = 1     
    }   siXGSFlag;

Pass flags for Graphic Sequencer callbacks.

Enumerator:
siInsertBefore 

Insert before a callback.

siInsertAfter 

Insert after a callback.

siInsertBeforeAll 

Insert before all callbacks.

siInsertAfterAll 

Insert after all callbacks.

Definition at line 1792 of file xsi_decl.h.

XGS state types defined for the Graphic Sequencer.

Enumerator:
siXGSUnknown 

Unknown type.

siXGSInteger 

Integer state type.

siXGSFloat 

Float state type.

siXGSHandle 

Handle state type.

siXGSVector4 

Vector4 state type.

siXGSMatrix4 

Matrix4 state type.

Definition at line 1801 of file xsi_decl.h.

enum siViewMode

Viewport display modes used by the CGraphicSequencer classfor the Graphic Sequencer.

Enumerator:
siAll 

All modes.

siBoundingBoxMode 

Bounding box.

siWireframe 

Wireframe.

siDepthCue 

Depth Cue.

siHiddenLineRemoval 

Hidden Line Removal.

siConstant 

Constant.

siShaded 

Shaded.

siTextured 

Textured.

siTexturedDecal 

Textured Decal.

siCustom 

Custom view.

siRealtimePortMaterial 

Realtime.

Definition at line 1812 of file xsi_decl.h.

The available types for user defined per particle ParticleAttribute.

Enumerator:
siPAVector4 

Type of vector containing 4 double-precision floating-point values.

siPAVector3 

Type of vector containing 3 double-precision floating-point values.

siPAFloat 

Floating-point type.

siPAInt 

Integer type.

siPAULong 

ULONG integer type.

siPAUShort 

Unsigned short integer type.

siPABool 

Boolean type.

siPAUndefined 

Error type returned when requesting the type for an undefined attribute.

Definition at line 1828 of file xsi_decl.h.

This is the enumeration of the different ways an asset in Softimage can be stored.

Assets can be either ActionSource objects or deltas.
Note: This enum replaces the obsolete siSourceStorageType enum.

Enumerator:
siAssetStorageTypeInternal 

The asset is saved in the scene file.

siAssetStorageTypeExternalDotXSIBin 

The asset is saved in a dotXSI file (.xsi) of type binary.

siAssetStorageTypeExternalDotXSIText 

The source is saved in a dotXSI file (.xsi) of type text.

siAssetStorageTypeExternalBin 

The asset is saved in a binary native Softimage file (.eani).

siAssetStorageTypeExternalXSIA 

The asset is saved in a delta file (.xsia).

Definition at line 1841 of file xsi_decl.h.

This enum has been replaced by siAssetStorageType.

Enumerator:
siSourceStorageTypeInternal 

The source is saved in the scene file.

siSourceStorageTypeExternalDotXSIBin 

The source is saved in a dotXSI file (.eani) of type binary.

siSourceStorageTypeExternalDotXSIText 

The source is saved in a dotXSI file (.xsi) of type text.

siSourceStorageTypeExternalBin 

The asset is saved in a binary native Softimage file (.eani).

Definition at line 1851 of file xsi_decl.h.

This is an enumeration of how an asset in Softimage can be treated when stored externally.

Assets can be either ActionSource objects or deltas.
Note: This enum replaces the obsolete siActionStatus enum.

Enumerator:
siAssetStatusOffloaded 

The asset is offloaded on disk.

siAssetStatusPartiallyLoaded 

The asset contains portions that are offloaded.

See ActionSource.PartialOffload

siAssetStatusLoaded 

The asset is loaded.

Definition at line 1860 of file xsi_decl.h.

This enum has been replaced by siAssetStatus.

Enumerator:
siActionStatusOffloaded 

The action source is offloaded on disk.

siActionStatusPartiallyLoaded 

The action source contains section that are offloaded.

See method ActionSource.PartialOffload

siActionStatusLoaded 

The action source is loaded.

Definition at line 1868 of file xsi_decl.h.

Specifies the different type of filters that are used for implementing and categorizing custom Filters.

Custom filters of types siFilter3DObject, siFilterSubComponentEdge, siFilterSubComponentPoint, siFilterSubComponentPolygon and siFilterProperty are automatically added to the Main Command Panel filter menus and integrated with the selection tool.

Enumerator:
siFilterUndefined 

Undefined filter type.

siFilterObject 

Represents generic filters that are not object-specific.

siFilter3DObject 

Kind of filter used with 3D objects.

siFilterProperty 

Kind of filter used with property objects.

siFilterSubComponentEdge 

Kind of filter used with the edge sub components of a geometry.

siFilterSubComponentPoint 

Kind of filter used with the point sub components of a geometry.

siFilterSubComponentPolygon 

Kind of filter used with the polygon sub components of a geometry.

siFilterSubComponentKnot 

Kind of filter used with the knot sub components of a geometry.

Definition at line 1876 of file xsi_decl.h.

Determines the capabilities of a command.

Enumerator:
siSupportsKeyAssignment 
siCannotBeUsedInBatch 
siNoLogging 
siAllowNotifications 

Definition at line 1889 of file xsi_decl.h.

enum siSeverity

Determines the severity types of a message implemented in a scripting language.

They can be combined.

Enumerator:
siFatal 

Fatal error has occurred; possibly leading to an unstable system state.

Displayed as Message Box and in History window.

siError 

An error has occurred; possibly leading data loss.

Displayed in History window and Status Bar.

siWarning 

An error has occurred but is recoverable.

Displayed in History window and Status Bar.

siInfo 

Log an information message.

Displayed in History window and Status Bar.

siVerbose 

Log a diagnostic information message.

Displayed in History window.

siComment 

Log an information message without adding a prefix to describe its type.

Definition at line 1898 of file xsi_decl.h.

    {   siFatal = 1,        
    siError = 2,        
    siWarning   = 4,        
    siInfo  = 8,        
    siVerbose   = 16,       
    siComment   = 32        
    }   siSeverity;

Flags values supported by the XSIUIToolkit.MsgBox command.

These are identical the arguments supported by the VBScript MsgBox() and Win32 ::MessageBox() functions.

Enumerator:
siMsgOkOnly 

Display OK button only.

siMsgOkCancel 

Display OK and Cancel buttons.

siMsgAbortRetryIgnore 

Display Abort, Retry, and Ignore buttons.

siMsgYesNoCancel 

Display Yes, No, and Cancel buttons.

siMsgYesNo 

Display Yes and No buttons.

siMsgRetryCancel 

Display Retry and Cancel buttons.

siMsgCritical 

Display Critical Message icon.

siMsgQuestion 

Display Query icon.

siMsgExclamation 

Display Warning Message icon.

siMsgInformation 

Display Information Message icon.

siMsgDefaultButton1 

First button is default.

siMsgDefaultButton2 

Second button is default.

siMsgDefaultButton3 

Third button is default.

Definition at line 1909 of file xsi_decl.h.

Return values from XSIUIToolkit.MsgBox that indicates which button was pressed by the user.

Enumerator:
siMsgOk 

OK.

siMsgCancel 

Cancel.

siMsgAbort 

Abort.

siMsgRetry 

Retry.

siMsgIgnore 

Ignore.

siMsgYes 

Yes.

siMsgNo 

No.

Definition at line 1927 of file xsi_decl.h.

Specifies the view state information of the View object, such as whether the view is closed, whether the view is minimized, and whether the view is in a normal state.

Enumerator:
siNormal 

Normal.

siClosed 

Closed.

siMinimized 

Minimized.

Definition at line 1939 of file xsi_decl.h.

Types of toolbar controls to use when building a toolbar.

Toolbar controls help you to tweak the appearance of your toolbar by adding some cosmetic features, such as separators and line breaks.

Enumerator:
siTBCtrlBlankSeparator 

Blank separator.

siTBCtrlGroupHeader 

Group header.

siTBCtrlLineBreak 

Line break.

siTBCtrlMenu 

Cascading command menu button.

siTBCtrlPreset 

Cascading command preset menu button.

siTBCtrlLineSeparator 

Line separator.

Definition at line 1947 of file xsi_decl.h.

Specifies the type of time applicability of a ClipEffect on a Clip.

Enumerator:
siOriginalClip 

The effect will repeat itself over time.

siExtrapolatedClip 

the effect spans over extrapolation.

Definition at line 1958 of file xsi_decl.h.

Specifies a reduction to apply to an image.

For example a 800x400 image reduced by a 4x1 ratio will have a resolution of 200x100.

Enumerator:
siImageRatio1x1 

Full resolution issue.

siImageRatio2x1 

Image reduced to 1/2 resolution (e.g.

1/4 the memory consumption).

siImageRatio4x1 

Image reduced to 1/4 resolution.

siImageRatio8x1 

Image reduced to 1/8 resolution.

siImageRatio16x1 

Image reduced to 1/16 resolution.

siImageRatioThumbnail 

Image reduced to Thumbnail resolution.

Definition at line 1965 of file xsi_decl.h.

The siTimeControlExtrapolationType determines how a Clip contributes to the animation outside of the frames on which it is defined.

Enumerator:
siTimeControlExtrapolationNone 

Results in no extrapolation.

Use this to delete an extrapolation.

siTimeControlExtrapolationHold 

Results in the first or last values being held for the number of frames specified by TimeControl.ExtrapolationBeforeValue or TimeControl.ExtrapolationAfterValue.

siTimeControlExtrapolationCycle 

Repeats the clip for the number of times specified by TimeControl.ExtrapolationBeforeValue or TimeControl.ExtrapolationAfterValue.

siTimeControlExtrapolationBounce 

Repeats the clip forward, then backward, and so on for the number of times specified by TimeControl.ExtrapolationBeforeValue or TimeControl.ExtrapolationAfterValue.

Definition at line 1976 of file xsi_decl.h.

Specifies the style of a menu item.

Enumerator:
siMenuItemUndefined 

Undefined menu item style.

siMenuItem 

Regular menu item.

siMenuItemSubmenu 

Defines item as a submenu.

siMenuItemSeparator 

Defines item as a separator.

siMenuItemSection 

Defines item as a colored section separator with a label.

Definition at line 1985 of file xsi_decl.h.

Identifies the location of a custom menu.

Enumerator:
siMenuUndefinedID 

Undefined menu id.

siMenuTbGetPrimitiveCurveID 

Get > Primitive > Curve menu.

siMenuTbGetPrimitivePolygonMeshBasicID 

Basic section (Cone, Cube, ..., Torus) in the Get > Primitive > Polygon Mesh menu.

siMenuTbGetPrimitivePolygonMeshHedronID 

Hedron section (Dodecahedron, Icosahedron, ..., Rhombicosidodecahedron) in the Get > Primitive > Polygon Mesh menu.

siMenuTbGetPrimitivePolygonMeshID 

Get > Primitive > Polygon Mesh menu.

siMenuTbGetPrimitiveSurfaceID 

Get > Primitive > Surface menu.

siMenuTbGetPrimitiveImplicitCurveID 

Curve section (Arc, Circle, ..., Square) in the Get > Primitive > Implicit menu.

siMenuTbGetPrimitiveImplicitID 

Get > Primitive > Implicit menu.

siMenuTbGetPrimitiveControlObjectID 

Get > Primitive > Control Object menu.

siMenuTbGetPrimitiveModelID 

Get > Primitive > Model menu .

siMenuTbGetPrimitiveID 

Get > Primitive menu.

siMenuTbGetCameraID 

Get > Primitive > Camera menu.

siMenuTbGetLightID 

Get > Primitive > Light menu.

siMenuTbGetMaterialID 

Get > Material menu.

siMenuTbGetMaterialBasicID 

Basic (Phong, Lambert, ..., Toon) section in the Get > Material menu.

siMenuTbGetMaterialSimpleID 

Simple section in the Get > Material menu.

siMenuTbGetMaterialRealTimeID 

Realtime section (OGL Combined,...) in the Get > Material menu.

siMenuTbGetPropertyID 

Get > Property menu.

siMenuTbGetPropertyTextureProjectionID 

Get > Property > Texture Projection menu.

siMenuTbGetPropertyTextureMapID 

Get > Property > Texture Map menu.

siMenuTbGetPropertyTextureID 

Texture section in the Get > Property menu.

siMenuTbGetPropertyUserDataMapID 

Get > Property > User Data Map menu.

siMenuTbGetPropertyMapPaintID 

Get > Property > Map Paint Tools menu.

siMenuTbGetPropertyPSetID 

Property section (Ultimapper, TextProp, ..., Tangent) in the Get > Property menu.

siMenuTbDeformSpatialID 

Spatial section (Bend, Bulge, ..., Fold) in the Modify > Deform menu.

siMenuTbDeformID 

dify > Deform menu.

siMenuTbCreateSkeletonID 

Create > Skeleton menu.

siMenuTbCreateSkeletonDrawID 

Draw section (2D Chain, 3D Chain) in the Create > Skeleton menu.

siMenuTbCreateSkeletonInspectID 

Inspect section (Inspect Chain Properties) in the Create > Skeleton menu.

siMenuTbModelCreateCurveID 

Create > Curve menu (Model toolbar).

siMenuTbModelCreateSurfaceMeshID 

Create > Surf.

Mesh menu.

siMenuTbModelCreatePolygonMeshID 

Create > Poly.

Mesh menu.

siMenuTbModelCreateModelID 

Create > Model menu.

siMenuTbModelCreateTextID 

Create > Text menu.

siMenuTbModelModifyComponentID 

Modify > Component menu.

siMenuTbModelModifyCurveID 

Modify > Curve menu.

siMenuTbModelModifySurfaceMeshID 

Modify > Surf.

Mesh menu.

siMenuTbModelModifyPolygonMeshID 

Modify > Poly.

Mesh menu.

siMenuTbModelModifyModelID 

Modify > Model menu.

siMenuTbAnimateCreateParameterID 

Create > Parameter menu.

siMenuTbAnimateCreateParameterCustomPSetID 

Custom Property Wizard section in the Create > Parameter menu.

siMenuTbAnimateCreateParameterCustomParamID 

Custom Parameter section in the Create > Parameter menu.

siMenuTbAnimateCreateParameterExpressionID 

Expression section in the Create > Parameter menu.

siMenuTbAnimateCreateParameterProxyID 

Proxy Parameter section in the Create > Parameter menu.

siMenuTbAnimateCreateCurveID 

Create > Curve menu (Animate toolbar).

siMenuTbAnimateCreatePathID 

Create > Path menu.

siMenuTbAnimateCreateCharacterID 

Create > Character menu.

siMenuTbAnimateDeformShapeID 

Deform > Shape menu.

siMenuTbAnimateDeformShapeKeyID 

Shape Key section in the Deform > Shape menu.

siMenuTbAnimateDeformEnvelopeID 

Deform > Envelope menu.

siMenuTbAnimateActionsStoreID 

Actions > Store menu.

siMenuTbAnimateActionsApplyID 

Actions > Apply menu.

siMenuTbAnimateActionsTemplatesID 

Actions > Templates menu.

siMenuTbAnimateToolsPlotID 

Tools > Plot menu.

siMenuTbAnimateToolsDevicesID 

Tools > Devices menu.

siMenuTbAnimateToolsImportID 

Import section in the Tools > Import/Export menu.

siMenuTbAnimateToolsExportID 

Export section in the Tools > Import/Export menu.

siMenuTbAnimateToolsMotorID 

MOTOR section in the Tools > Import/Export menu.

siMenuTbRenderRegionID 

Render > Region menu.

siMenuTbRenderPreviewID 

Obsolete - menu no longer exists.

siMenuTbRenderRenderID 

Render > Render menu.

siMenuTbRenderExportMIID 

Obsolete - renamed siMenuTbRenderExportID.

siMenuTbRenderPassEditID 

Render > Pass > Edit menu.

siMenuTbRenderPassEditNewPassID 

Render > Pass > Edit > New Pass menu.

siMenuTbRenderPassPartitionID 

Render > Pass > Partition menu.

siMenuTbRenderExportID 

Render > Export menu.

siMenuTbICEParticlesCreateID 

Menu the ICE module toolbar.

siMenuTbICEParticlesOnEmissionID 

Menu the ICE module toolbar.

siMenuTbICEParticlesAfterEmissionID 

Menu the ICE module toolbar.

siMenuTbICEParticlesForceID 

Menu the ICE module toolbar.

siMenuTbICEParticlesCollisionID 

Menu the ICE module toolbar.

siMenuTbICEParticlesSimulationID 

Menu the ICE module toolbar.

siMenuTbICEParticlesModelLibraryID 

Menu the ICE module toolbar.

siMenuTbICEDeformCreateID 

Menu the ICE module toolbar.

siMenuTbICEDeformSimulateID 

Menu the ICE module toolbar.

siMenuTbICEKinematicsEffectsID 

Menu the ICE module toolbar.

siMenuTbICEKinematicsConstrainID 

Menu the ICE module toolbar.

siMenuTbGetForceID 

Get > Force menu (Simulate toolbar).

siMenuTbCreateParticlesID 

Create > Particles menu (Simulate toolbar).

siMenuTbCreateParticlesFluidID 

Create > Particles > Fluid menu (Simulate toolbar).

siMenuTbCreateParticlesExplosionID 

Create > Particles > Explosion menu (Simulate toolbar).

siMenuTbCreateParticlesNewPTypeID 

Create > Particles > New Particle Type menu (Simulate toolbar).

siMenuTbCreateRigidBodyID 

Create > Rigid Body menu (Simulate toolbar).

siMenuTbCreateRigidBodyConstraintID 

Create > Rigid Body > Rigid Constraint menu (Simulate toolbar).

siMenuTbCreateClothID 

Create > Cloth menu (Simulate toolbar).

siMenuTbModifyParticlesID 

Modify > Particles menu (Simulate toolbar).

siMenuTbModifyRigidBodyID 

Modify > Rigid Body menu (Simulate toolbar).

siMenuTbModifyEnvironmentID 

Modify > Environment menu (Simulate toolbar).

siMenuTbCreateSoftBodyID 

Create > Soft Body menu (Simulate toolbar).

siMenuTbICECreateID 

ICE > Particles > Create menu (ICE toolbar).

siMenuTbICEEditID 

ICE > Particles > Simulation menu (ICE toolbar).

siMenuMainFileSceneID 

Scene section in the File menu on the main menu bar.

siMenuMainFileProjectID 

Project section in the File menu on the main menu bar.

siMenuMainFileExportID 

File > Export menu on the main menu bar.

siMenuMainFileImportID 

File > Import menu on the main menu bar.

siMenuMainWindowID 

Windows menu on the main menu bar.

siMenuMainHelpID 

Help menu on the main menu bar.

siMenuMainApplicationID 

Do not use.

The Application menu was removed in Softimage v5.0. Existing menus that use this anchor point are added to the View menu on the main menu bar.

siMenuMainApplicationPropertySetsID 

Do not use.

The Application menu was removed in Softimage v5.0. Existing menus that use this anchor point are added to the View menu on the main menu bar.

siMenuMainApplicationLayoutsID 

Do not use.

The Application menu was removed in Softimage v5.0. Existing menus that use this anchor point are added to the View > Layouts menu on the main menu bar.

siMenuMainApplicationViewsID 

Do not use.

The Application menu was removed in Softimage v5.0. Existing menus that use this anchor point are added to the View menu on the main menu bar.

siMenuMainApplicationToolbarsID 

Do not use.

The Application menu was removed in Softimage v5.0. Existing menus that use this anchor point are added to the View menu on the main menu bar.

siMenuMainApplicationCommandsID 

Do not use.

The Application menu was removed in Softimage v5.0. Existing menus that use this anchor point are added to the View menu on the main menu bar.

siMenuMainApplicationKeyMappingsID 

Do not use.

The Application menu was removed in Softimage v5.0. Existing menus that use this anchor point are added to the View menu on the main menu bar.

siMenuMainApplicationPreferencesID 

Do not use.

The Application menu was removed in Softimage v5.0. Existing menus that use this anchor point are added to the Preferences section of the File menu on the main menu bar.

siMenuMainTopLevelID 

The main menu bar.

Menus registered with this identifier are added to the Softimage main menu bar as top-level menus.

siMenuMainFileCrosswalkID 

File > Crosswalk menu on the main menu bar.

siMenuMCPSelectTopID 

Top of Select menu in the MCP.

siMenuMCPSelectBottomID 

Bottom of Select menu in the MCP.

siMenuMCPSelectExploreBtnID 

Explore menu in the MCP.

siMenuMCPSelectSelBtnContextID 

Context menu displayed when a user right-clicks the Selection button in the MCP.

siMenuMCPTransformTopID 

Top of Transform menu in the MCP.

siMenuMCPTransformBottomID 

Bottom of Transform menu in the MCP.

siMenuMCPSnapID 

Snap menu in the MCP.

siMenuMCPConstrainID 

Constrain menu in the MCP.

siMenuMCPEditID 

Edit menu in the MCP.

siMenuMCPAnimationID 

Animation menu in the MCP.

siMenuMCPPlaybackID 

Playback menu in the MCP.

siMenuVMViewTypeID 

View type menu in the View Manager.

See View Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuVMCameraID 

Camera menu in the View Manager.

See View Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuVMVisibilityID 

Visibility menu in the View Manager.

See View Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuVMDisplayID 

Display menu in the View Manager.

See View Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenu3DViewClusterContextID 

Context menu for a cluster in a 3D view.

siMenu3DViewComponentContextID 

Context menu for subcomponents (such as points, edges, and polygons) in a 3D view.

siMenu3DViewComponentEditContextID 

Edit section of the context menu for subcomponents in a 3D view.

siMenu3DViewGeneralContextID 

Context menu displayed when a user right-clicks a blank area of a 3D view.

siMenu3DViewObjectContextID 

Context menu for an object in a 3D view.

siMenu3DViewObjectEditContextID 

Edit section of the context menu for an object in a 3D view.

siMenu3DViewObjectGroupContextID 

Group section of the context menu for an object in a 3D view.

siMenu3DViewObjectMeshContextID 

Mesh section of the context menu for an object in a 3D view.

siMenu3DViewObjectSelectContextID 

Select section of the context menu for an object in a 3D view.

siMenuSEGeneralContextID 

Context menu displayed when a user right-clicks an object (such as a Property, Parameter, or Primtive) that does not have a specific context menu.

siMenuSELayersContextID 

Context menu displayed for Layer objects in the Scene Explorer.

siMenuSEPassesContextID 

Context menu displayed for Pass objects in the Scene Explorer.

siMenuSEPartitionsContextID 

Context menu displayed for Partition objects in the Scene Explorer.

siMenuSEObjectContextID 

Context menu displayed for 3D objects in the Scene Explorer.

siMenuSEGroupContextID 

Context menu displayed for Groups in the Scene Explorer.

siMenuSEAnimContextID 

Context menu displayed for animated parameters in the Scene Explorer.

siMenuSEClusterContextID 

Context menu displayed for clusters in the Scene Explorer.

siMenuSEOperatorContextID 

Context menu displayed for operators in the Scene Explorer.

siMenuSEConstraintContextID 

Context menu displayed for constraints in the Scene Explorer.

siMenuSEPreferenceContextID 

Context menu displayed for preferences in the Scene Explorer.

siMenuSEMaterialContextID 

Context menu displayed for Materials in the Scene Explorer.

siMenuSEModelContextID 

Context menu displayed for Models in the Scene Explorer.

siMenuPluginMgrPluginFileID 

File menu on the Plug-ins and Items tabs of the Plug-in Manager.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrTreeFileID 

File menu on the Tree tab of the Plug-in Manager.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextPluginID 

Context menu for plug-ins listed on the Tree and Plug-ins tabs of the Plugin Manager.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextPluginLocationID 

Context menu in the Plug-in Manager for an add-on or other location where plug-ins can be stored.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextUserRootID 

Context menu for the User Root node in the plug-in tree.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextFactoryRootID 

Context menu for the Factory Root node in the plug-in tree.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextWorkgroupRootID 

Context menu for the Workgroup Root node in the plug-in tree.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextAddonID 

Context menu for the add-ons listed in the plug-in tree.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextCustomLocationID 

Context menu for the Root node of a custom folder in the plug-in tree.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrSPDLFileID 

File menu on the SPDLs tab of the Plug-in Manager.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextSPDLID 

Context menu for the plug-ins listed on the SPDLs tab of the Plugin Manager.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextSPDLLocationID 

Context menu for the SPDLs Root node in the plug-in tree.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextPluginItemID 

Context menu for the plug-ins listed on the Items tab of the Plugin Manager.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextViewLocationID 

Context menu for the Views Root node in the plug-in tree.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextViewID 

Context menu for view plug-ins listed in the plug-in tree.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextToolbarLocationID 

Context menu for the Toolbars Root node in the plug-in tree.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuPluginMgrContextToolbarID 

Context menu for the toolbar plug-ins listed in the plug-in tree.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuWorkgroupMgrFileID 

File menu on the Workgroups tab of the Plug-in Manager.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuWorkgroupMgrContextID 

Context menu for a selected workgroup.

See Plug-in Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuScriptEditContextID 

Context menu for the editing pane of a script editor or a text editor.

See Script Editor Attributes for a list of attributes you can use with this custom menu hook.

siMenuScriptHistoryContextID 

Context menu for the history pane of a script editor.

See Script History Attributes for a list of attributes you can use with this custom menu hook.

siMenuPropertyPageContextID 

Context menu for the top area of a Property Page.

siMenuPropertyPageAnimContextID 

Context menu displayed for animatable parameters in a Property Page.

siMenuShapeManagerEditID 

Edit menu in the Shape Manager.

See Shape Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuShapeManagerCreateContextSingleSelectionID 

Context menu for the Create tab of the Shape Manager when a single shape is selected.

See Shape Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuShapeManagerCreateContextMultiSelectionID 

Context menu for the Create tab of the Shape Manager when multiple shapes are selected.

See Shape Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuShapeManagerAnimateContextSingleSelectionID 

Context menu for the Animate tab of the Shape Manager when only a single shape is selected.

See Shape Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuShapeManagerAnimateContextMultiSelectionID 

Context menu for the Animate tab of the Shape Manager when multiple shapes are selected.

See Shape Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuShapeManagerAnimateID 

Animate menu in the Shape Manager.

See Shape Manager Attributes for a list of attributes you can use with this custom menu hook.

siMenuRenderRegionContextID 

Context menu for the Render Region.

siMenuMaterialPanelMaterialID 

Material menu in the Material Panel.

siMenuTextureEditorToolsID 

Tools menu in the Texture Editor.

See Texture Editor Attributes for a list of attributes you can use with this custom menu hook.

siMenuRenderTreeToolsID 

Tools menu in the RenderTree.

See Render Tree Attributes for a list of attributes you can use with this custom menu hook.

siMenuICEViewToolsID 

Tools menu in the ICE view.

See ICE Tree Attributes for a list of attributes you can use with this custom menu hook.

siMenuRTNodeContextID 

Context menu displayed for shader/materials in the RenderTree.

See Render Tree Attributes for a list of attributes you can use with this custom menu hook.

siMenuICENodeContextID 

Context menu displayed for ICE Nodes in the ICE view.

See ICE Tree Attributes for a list of attributes you can use with this custom menu hook.

siMenuICENodePortContextID 

Context menu displayed for ICE Node Ports in the ICE view.

See ICE Tree Attributes for a list of attributes you can use with this custom menu hook.

siMenuRenderTreeTopLevelID 

The RenderTree main toolbar.

Menus registered with this identifier are added to the RenderTree toolbar as top-level menus. See Render Tree Attributes for a list of attributes you can use with this custom menu hook.

siMenuICEViewTopLevelID 

The ICE view main toolbar.

Menus registered with this identifier are added to the ICE view toolbar as top-level menus. See ICE Tree Attributes for a list of attributes you can use with this custom menu hook.

siMenuTextEditorWidgetEditID 

Edit menu in the Text Editor Widget.

See Text Editor Attributes for a list of attributes you can use with this custom menu hook.

siMenuTextEditorContextID 

Context menu in the edit pane of a Text Editor Widget.

See Text Editor Attributes for a list of attributes you can use with this custom menu hook.

siMenuTextureSpaceProjectionID 

Texture Space > New > Texture Projection menu.

siMenuSchematicViewID 

View menu in the Schematic.

siMenuSchematicViewContextID 

Context menu for the Schematic when clicking in the background.

siMenuSchematicNodeContextID 

Context menu displayed for nodes in the Schematic.

siMenuSceneLayerManagerLayersID 

Layers menu in the Scene Layer Manager.

siMenuSceneLayerManagerContextID 

Context menu displayed for layer rows in the Scene Layer Manager.

siMenuWeightEditorFileID 

File menu in the Weight Editor.

See Weight Editor Attributes for a list of attributes you can use with this custom menu hook.

siMenuWeightEditorEditID 

Edit menu in the Weight Editor.

See Weight Editor Attributes for a list of attributes you can use with this custom menu hook.

siMenuWeightEditorViewID 

View menu in the Weight Editor.

See Weight Editor Attributes for a list of attributes you can use with this custom menu hook.

Definition at line 1995 of file xsi_decl.h.

    {   siMenuUndefinedID   = 0,        
    siMenuTbGetPrimitiveCurveID = 1,        
    siMenuTbGetPrimitivePolygonMeshBasicID  = ( siMenuTbGetPrimitiveCurveID + 1 ) ,     
    siMenuTbGetPrimitivePolygonMeshHedronID = ( siMenuTbGetPrimitivePolygonMeshBasicID + 1 ) ,      
    siMenuTbGetPrimitivePolygonMeshID   = ( siMenuTbGetPrimitivePolygonMeshHedronID + 1 ) ,     
    siMenuTbGetPrimitiveSurfaceID   = ( siMenuTbGetPrimitivePolygonMeshID + 1 ) ,       
    siMenuTbGetPrimitiveImplicitCurveID = ( siMenuTbGetPrimitiveSurfaceID + 1 ) ,       
    siMenuTbGetPrimitiveImplicitID  = ( siMenuTbGetPrimitiveImplicitCurveID + 1 ) ,     
    siMenuTbGetPrimitiveControlObjectID = ( siMenuTbGetPrimitiveImplicitID + 1 ) ,      
    siMenuTbGetPrimitiveModelID = ( siMenuTbGetPrimitiveControlObjectID + 1 ) ,     
    siMenuTbGetPrimitiveID  = ( siMenuTbGetPrimitiveModelID + 1 ) ,     
    siMenuTbGetCameraID = ( siMenuTbGetPrimitiveID + 1 ) ,      
    siMenuTbGetLightID  = ( siMenuTbGetCameraID + 1 ) ,     
    siMenuTbGetMaterialID   = ( siMenuTbGetLightID + 1 ) ,      
    siMenuTbGetMaterialBasicID  = ( siMenuTbGetMaterialID + 1 ) ,       
    siMenuTbGetMaterialSimpleID = ( siMenuTbGetMaterialBasicID + 1 ) ,      
    siMenuTbGetMaterialRealTimeID   = ( siMenuTbGetMaterialSimpleID + 1 ) ,     
    siMenuTbGetPropertyID   = ( siMenuTbGetMaterialRealTimeID + 1 ) ,       
    siMenuTbGetPropertyTextureProjectionID  = ( siMenuTbGetPropertyID + 1 ) ,       
    siMenuTbGetPropertyTextureMapID = ( siMenuTbGetPropertyTextureProjectionID + 1 ) ,      
    siMenuTbGetPropertyTextureID    = ( siMenuTbGetPropertyTextureMapID + 1 ) ,     
    siMenuTbGetPropertyUserDataMapID    = ( siMenuTbGetPropertyTextureID + 1 ) ,        
    siMenuTbGetPropertyMapPaintID   = ( siMenuTbGetPropertyUserDataMapID + 1 ) ,        
    siMenuTbGetPropertyPSetID   = ( siMenuTbGetPropertyMapPaintID + 1 ) ,       
    siMenuTbDeformSpatialID = ( siMenuTbGetPropertyPSetID + 1 ) ,       
    siMenuTbDeformID    = ( siMenuTbDeformSpatialID + 1 ) ,     
    siMenuTbCreateSkeletonID    = ( siMenuTbDeformID + 1 ) ,        
    siMenuTbCreateSkeletonDrawID    = ( siMenuTbCreateSkeletonID + 1 ) ,        
    siMenuTbCreateSkeletonInspectID = ( siMenuTbCreateSkeletonDrawID + 1 ) ,        
    siMenuTbModelCreateCurveID  = 100,      
    siMenuTbModelCreateSurfaceMeshID    = ( siMenuTbModelCreateCurveID + 1 ) ,      
    siMenuTbModelCreatePolygonMeshID    = ( siMenuTbModelCreateSurfaceMeshID + 1 ) ,        
    siMenuTbModelCreateModelID  = ( siMenuTbModelCreatePolygonMeshID + 1 ) ,        
    siMenuTbModelCreateTextID   = ( siMenuTbModelCreateModelID + 1 ) ,      
    siMenuTbModelModifyComponentID  = ( siMenuTbModelCreateTextID + 1 ) ,       
    siMenuTbModelModifyCurveID  = ( siMenuTbModelModifyComponentID + 1 ) ,      
    siMenuTbModelModifySurfaceMeshID    = ( siMenuTbModelModifyCurveID + 1 ) ,      
    siMenuTbModelModifyPolygonMeshID    = ( siMenuTbModelModifySurfaceMeshID + 1 ) ,        
    siMenuTbModelModifyModelID  = ( siMenuTbModelModifyPolygonMeshID + 1 ) ,        
    siMenuTbAnimateCreateParameterID    = 200,      
    siMenuTbAnimateCreateParameterCustomPSetID  = ( siMenuTbAnimateCreateParameterID + 1 ) ,        
    siMenuTbAnimateCreateParameterCustomParamID = ( siMenuTbAnimateCreateParameterCustomPSetID + 1 ) ,      
    siMenuTbAnimateCreateParameterExpressionID  = ( siMenuTbAnimateCreateParameterCustomParamID + 1 ) ,     
    siMenuTbAnimateCreateParameterProxyID   = ( siMenuTbAnimateCreateParameterExpressionID + 1 ) ,      
    siMenuTbAnimateCreateCurveID    = ( siMenuTbAnimateCreateParameterProxyID + 1 ) ,       
    siMenuTbAnimateCreatePathID = ( siMenuTbAnimateCreateCurveID + 1 ) ,        
    siMenuTbAnimateCreateCharacterID    = ( siMenuTbAnimateCreatePathID + 1 ) ,     
    siMenuTbAnimateDeformShapeID    = ( siMenuTbAnimateCreateCharacterID + 1 ) ,        
    siMenuTbAnimateDeformShapeKeyID = ( siMenuTbAnimateDeformShapeID + 1 ) ,        
    siMenuTbAnimateDeformEnvelopeID = ( siMenuTbAnimateDeformShapeKeyID + 1 ) ,     
    siMenuTbAnimateActionsStoreID   = ( siMenuTbAnimateDeformEnvelopeID + 1 ) ,     
    siMenuTbAnimateActionsApplyID   = ( siMenuTbAnimateActionsStoreID + 1 ) ,       
    siMenuTbAnimateActionsTemplatesID   = ( siMenuTbAnimateActionsApplyID + 1 ) ,       
    siMenuTbAnimateToolsPlotID  = ( siMenuTbAnimateActionsTemplatesID + 1 ) ,       
    siMenuTbAnimateToolsDevicesID   = ( siMenuTbAnimateToolsPlotID + 1 ) ,      
    siMenuTbAnimateToolsImportID    = ( siMenuTbAnimateToolsDevicesID + 1 ) ,       
    siMenuTbAnimateToolsExportID    = ( siMenuTbAnimateToolsImportID + 1 ) ,        
    siMenuTbAnimateToolsMotorID = ( siMenuTbAnimateToolsExportID + 1 ) ,        
    siMenuTbRenderRegionID  = 300,      
    siMenuTbRenderPreviewID = ( siMenuTbRenderRegionID + 1 ) ,      
    siMenuTbRenderRenderID  = ( siMenuTbRenderPreviewID + 1 ) ,     
    siMenuTbRenderExportMIID    = ( siMenuTbRenderRenderID + 1 ) ,      
    siMenuTbRenderPassEditID    = ( siMenuTbRenderExportMIID + 1 ) ,        
    siMenuTbRenderPassEditNewPassID = ( siMenuTbRenderPassEditID + 1 ) ,        
    siMenuTbRenderPassPartitionID   = ( siMenuTbRenderPassEditNewPassID + 1 ) ,     
    siMenuTbRenderExportID  = ( siMenuTbRenderPassPartitionID + 1 ) ,       
    siMenuTbICEParticlesCreateID    = 320,      
    siMenuTbICEParticlesOnEmissionID    = ( siMenuTbICEParticlesCreateID + 1 ) ,        
    siMenuTbICEParticlesAfterEmissionID = ( siMenuTbICEParticlesOnEmissionID + 1 ) ,        
    siMenuTbICEParticlesForceID = ( siMenuTbICEParticlesAfterEmissionID + 1 ) ,     
    siMenuTbICEParticlesCollisionID = ( siMenuTbICEParticlesForceID + 1 ) ,     
    siMenuTbICEParticlesSimulationID    = ( siMenuTbICEParticlesCollisionID + 1 ) ,     
    siMenuTbICEParticlesModelLibraryID  = ( siMenuTbICEParticlesSimulationID + 1 ) ,        
    siMenuTbICEDeformCreateID   = 340,      
    siMenuTbICEDeformSimulateID = ( siMenuTbICEDeformCreateID + 1 ) ,       
    siMenuTbICEKinematicsEffectsID  = 360,      
    siMenuTbICEKinematicsConstrainID    = ( siMenuTbICEKinematicsEffectsID + 1 ) ,      
    siMenuTbGetForceID  = 400,      
    siMenuTbCreateParticlesID   = ( siMenuTbGetForceID + 1 ) ,      
    siMenuTbCreateParticlesFluidID  = ( siMenuTbCreateParticlesID + 1 ) ,       
    siMenuTbCreateParticlesExplosionID  = ( siMenuTbCreateParticlesFluidID + 1 ) ,      
    siMenuTbCreateParticlesNewPTypeID   = ( siMenuTbCreateParticlesExplosionID + 1 ) ,      
    siMenuTbCreateRigidBodyID   = ( siMenuTbCreateParticlesNewPTypeID + 1 ) ,       
    siMenuTbCreateRigidBodyConstraintID = ( siMenuTbCreateRigidBodyID + 1 ) ,       
    siMenuTbCreateClothID   = ( siMenuTbCreateRigidBodyConstraintID + 1 ) ,     
    siMenuTbModifyParticlesID   = ( siMenuTbCreateClothID + 1 ) ,       
    siMenuTbModifyRigidBodyID   = ( siMenuTbModifyParticlesID + 1 ) ,       
    siMenuTbModifyEnvironmentID = ( siMenuTbModifyRigidBodyID + 1 ) ,       
    siMenuTbCreateSoftBodyID    = ( siMenuTbModifyEnvironmentID + 1 ) ,     
    siMenuTbICECreateID = ( siMenuTbCreateSoftBodyID + 1 ) ,        
    siMenuTbICEEditID   = ( siMenuTbICECreateID + 1 ) ,     
    siMenuMainFileSceneID   = 1000,     
    siMenuMainFileProjectID = ( siMenuMainFileSceneID + 1 ) ,       
    siMenuMainFileExportID  = ( siMenuMainFileProjectID + 1 ) ,     
    siMenuMainFileImportID  = ( siMenuMainFileExportID + 1 ) ,      
    siMenuMainWindowID  = ( siMenuMainFileImportID + 1 ) ,      
    siMenuMainHelpID    = ( siMenuMainWindowID + 1 ) ,      
    siMenuMainApplicationID = ( siMenuMainHelpID + 1 ) ,        
    siMenuMainApplicationPropertySetsID = ( siMenuMainApplicationID + 1 ) ,     
    siMenuMainApplicationLayoutsID  = ( siMenuMainApplicationPropertySetsID + 1 ) ,     
    siMenuMainApplicationViewsID    = ( siMenuMainApplicationLayoutsID + 1 ) ,      
    siMenuMainApplicationToolbarsID = ( siMenuMainApplicationViewsID + 1 ) ,        
    siMenuMainApplicationCommandsID = ( siMenuMainApplicationToolbarsID + 1 ) ,     
    siMenuMainApplicationKeyMappingsID  = ( siMenuMainApplicationCommandsID + 1 ) ,     
    siMenuMainApplicationPreferencesID  = ( siMenuMainApplicationKeyMappingsID + 1 ) ,      
    siMenuMainTopLevelID    = ( siMenuMainApplicationPreferencesID + 1 ) ,      
    siMenuMainFileCrosswalkID   = ( siMenuMainTopLevelID + 1 ) ,        
    siMenuMCPSelectTopID    = 2000,     
    siMenuMCPSelectBottomID = ( siMenuMCPSelectTopID + 1 ) ,        
    siMenuMCPSelectExploreBtnID = ( siMenuMCPSelectBottomID + 1 ) ,     
    siMenuMCPSelectSelBtnContextID  = ( siMenuMCPSelectExploreBtnID + 1 ) ,     
    siMenuMCPTransformTopID = ( siMenuMCPSelectSelBtnContextID + 1 ) ,      
    siMenuMCPTransformBottomID  = ( siMenuMCPTransformTopID + 1 ) ,     
    siMenuMCPSnapID = ( siMenuMCPTransformBottomID + 1 ) ,      
    siMenuMCPConstrainID    = ( siMenuMCPSnapID + 1 ) ,     
    siMenuMCPEditID = ( siMenuMCPConstrainID + 1 ) ,        
    siMenuMCPAnimationID    = ( siMenuMCPEditID + 1 ) ,     
    siMenuMCPPlaybackID = ( siMenuMCPAnimationID + 1 ) ,        
    siMenuVMViewTypeID  = 3000,     
    siMenuVMCameraID    = ( siMenuVMViewTypeID + 1 ) ,      
    siMenuVMVisibilityID    = ( siMenuVMCameraID + 1 ) ,        
    siMenuVMDisplayID   = ( siMenuVMVisibilityID + 1 ) ,        
    siMenu3DViewClusterContextID    = 3100,     
    siMenu3DViewComponentContextID  = ( siMenu3DViewClusterContextID + 1 ) ,        
    siMenu3DViewComponentEditContextID  = ( siMenu3DViewComponentContextID + 1 ) ,      
    siMenu3DViewGeneralContextID    = ( siMenu3DViewComponentEditContextID + 1 ) ,      
    siMenu3DViewObjectContextID = ( siMenu3DViewGeneralContextID + 1 ) ,        
    siMenu3DViewObjectEditContextID = ( siMenu3DViewObjectContextID + 1 ) ,     
    siMenu3DViewObjectGroupContextID    = ( siMenu3DViewObjectEditContextID + 1 ) ,     
    siMenu3DViewObjectMeshContextID = ( siMenu3DViewObjectGroupContextID + 1 ) ,        
    siMenu3DViewObjectSelectContextID   = ( siMenu3DViewObjectMeshContextID + 1 ) ,     
    siMenuSEGeneralContextID    = 3200,     
    siMenuSELayersContextID = ( siMenuSEGeneralContextID + 1 ) ,        
    siMenuSEPassesContextID = ( siMenuSELayersContextID + 1 ) ,     
    siMenuSEPartitionsContextID = ( siMenuSEPassesContextID + 1 ) ,     
    siMenuSEObjectContextID = ( siMenuSEPartitionsContextID + 1 ) ,     
    siMenuSEGroupContextID  = ( siMenuSEObjectContextID + 1 ) ,     
    siMenuSEAnimContextID   = ( siMenuSEGroupContextID + 1 ) ,      
    siMenuSEClusterContextID    = ( siMenuSEAnimContextID + 1 ) ,       
    siMenuSEOperatorContextID   = ( siMenuSEClusterContextID + 1 ) ,        
    siMenuSEConstraintContextID = ( siMenuSEOperatorContextID + 1 ) ,       
    siMenuSEPreferenceContextID = ( siMenuSEConstraintContextID + 1 ) ,     
    siMenuSEMaterialContextID   = ( siMenuSEPreferenceContextID + 1 ) ,     
    siMenuSEModelContextID  = ( siMenuSEMaterialContextID + 1 ) ,       
    siMenuPluginMgrPluginFileID = 3300,     
    siMenuPluginMgrTreeFileID   = ( siMenuPluginMgrPluginFileID + 1 ) ,     
    siMenuPluginMgrContextPluginID  = ( siMenuPluginMgrTreeFileID + 1 ) ,       
    siMenuPluginMgrContextPluginLocationID  = ( siMenuPluginMgrContextPluginID + 1 ) ,      
    siMenuPluginMgrContextUserRootID    = ( siMenuPluginMgrContextPluginLocationID + 1 ) ,      
    siMenuPluginMgrContextFactoryRootID = ( siMenuPluginMgrContextUserRootID + 1 ) ,        
    siMenuPluginMgrContextWorkgroupRootID   = ( siMenuPluginMgrContextFactoryRootID + 1 ) ,     
    siMenuPluginMgrContextAddonID   = ( siMenuPluginMgrContextWorkgroupRootID + 1 ) ,       
    siMenuPluginMgrContextCustomLocationID  = ( siMenuPluginMgrContextAddonID + 1 ) ,       
    siMenuPluginMgrSPDLFileID   = ( siMenuPluginMgrContextCustomLocationID + 1 ) ,      
    siMenuPluginMgrContextSPDLID    = ( siMenuPluginMgrSPDLFileID + 1 ) ,       
    siMenuPluginMgrContextSPDLLocationID    = ( siMenuPluginMgrContextSPDLID + 1 ) ,        
    siMenuPluginMgrContextPluginItemID  = ( siMenuPluginMgrContextSPDLLocationID + 1 ) ,        
    siMenuPluginMgrContextViewLocationID    = ( siMenuPluginMgrContextPluginItemID + 1 ) ,      
    siMenuPluginMgrContextViewID    = ( siMenuPluginMgrContextViewLocationID + 1 ) ,        
    siMenuPluginMgrContextToolbarLocationID = ( siMenuPluginMgrContextViewID + 1 ) ,        
    siMenuPluginMgrContextToolbarID = ( siMenuPluginMgrContextToolbarLocationID + 1 ) ,     
    siMenuWorkgroupMgrFileID    = 3350,     
    siMenuWorkgroupMgrContextID = ( siMenuWorkgroupMgrFileID + 1 ) ,        
    siMenuScriptEditContextID   = 3400,     
    siMenuScriptHistoryContextID    = 3401,     
    siMenuPropertyPageContextID = 3600,     
    siMenuPropertyPageAnimContextID = ( siMenuPropertyPageContextID + 1 ) ,     
    siMenuShapeManagerEditID    = 3700,     
    siMenuShapeManagerCreateContextSingleSelectionID    = ( siMenuShapeManagerEditID + 1 ) ,        
    siMenuShapeManagerCreateContextMultiSelectionID = ( siMenuShapeManagerCreateContextSingleSelectionID + 1 ) ,        
    siMenuShapeManagerAnimateContextSingleSelectionID   = ( siMenuShapeManagerCreateContextMultiSelectionID + 1 ) ,     
    siMenuShapeManagerAnimateContextMultiSelectionID    = ( siMenuShapeManagerAnimateContextSingleSelectionID + 1 ) ,       
    siMenuShapeManagerAnimateID = ( siMenuShapeManagerAnimateContextMultiSelectionID + 1 ) ,        
    siMenuRenderRegionContextID = 3800,     
    siMenuMaterialPanelMaterialID   = 3900,     
    siMenuTextureEditorToolsID  = 4000,     
    siMenuRenderTreeToolsID = 4100,     
    siMenuICEViewToolsID    = ( siMenuRenderTreeToolsID + 1 ) ,     
    siMenuRTNodeContextID   = ( siMenuICEViewToolsID + 1 ) ,        
    siMenuICENodeContextID  = ( siMenuRTNodeContextID + 1 ) ,       
    siMenuICENodePortContextID  = ( siMenuICENodeContextID + 1 ) ,      
    siMenuRenderTreeTopLevelID  = ( siMenuICENodePortContextID + 1 ) ,      
    siMenuICEViewTopLevelID = ( siMenuRenderTreeTopLevelID + 1 ) ,      
    siMenuTextEditorWidgetEditID    = 4200,     
    siMenuTextEditorContextID   = ( siMenuTextEditorWidgetEditID + 1 ) ,        
    siMenuTextureSpaceProjectionID  = 4300,     
    siMenuSchematicViewID   = 4400,     
    siMenuSchematicViewContextID    = 4401,     
    siMenuSchematicNodeContextID    = 4402,     
    siMenuSceneLayerManagerLayersID = 4500,     
    siMenuSceneLayerManagerContextID    = ( siMenuSceneLayerManagerLayersID + 1 ) ,     
    siMenuWeightEditorFileID    = 10000,        
    siMenuWeightEditorEditID    = 10001,        
    siMenuWeightEditorViewID    = 10002     
    }   siMenuAnchorPoints;

This enum specifies the operator port flags.

These flags are used to determine the behaviour and characteristics of the port.

Enumerator:
siDefaultPort 

The port is a regular port and must be connected.

siOptionalInputPort 

The port is optional as does not need to be connected.

siCreatedOutputPort 

The object connected to the output port is created when the operator is connected (not implemented for custom operators).

siBranchGroupPort 

The port can be connected to a group of a hierarchy of objects.

Definition at line 2194 of file xsi_decl.h.

This enum specifies what has changed during a CWindowNotification for the Custom Display Host.

Enumerator:
siWindowSize 

The size or position of the window has changed.

siWindowPaint 

The window is being repainted.

siWindowSetFocus 

The window is getting the focus.

siWindowLostFocus 

The window lost the focus.

Definition at line 2203 of file xsi_decl.h.

enum siFileType

This enum is used to determine the type of a file for the OnBeginFileExport, OnBeginFileImport, OnEndFileExport, OnEndFileImport, OnCustomFileExport, and OnCustomFileImport events.

Enumerator:
siFileTypeDefault 

Unknown type.

siFileTypeScene 

Scene.

siFileTypeModel 

Model.

siFileTypeImage 

Image.

siFileTypeAudio 

Audio.

siFileTypeSI3D 

SI3D scenes.

siFileTypeScript 

Script.

siFileTypeFcurve 

Animation file.

siFileTypeExpression 

Expression.

siFileTypeRenderPicture 

Rendered Pictures.

siFileTypeAction 

Action files (.eani).

siFileTypeShader 

Shader file.

siFileTypeBackup 

Scene Backup.

siFileTypeMI 

Mental Image (.mi) file.

siFileTypeIgnore 

Internal info.

siFileTypeSimulation 

Simulation cache.

siFileTypeReferencedModel 

Referenced model.

siFileTypeQuery 

Query.

siFileTypeSynoptic 

Synoptic.

siFileTypeDotXSI 

dotXSI.

siFileTypeRenderMap 

Render Map.

siFileTypeAddon 

Addon.

siFileTypeMatLib 

Material Library.

siFileTypeThumbnail 

Thumbnail.

siFileTypeMixer 

Mixer (.mixer).

siFileTypeIges 

IGES.

siFileTypeComposites 
siFileTypeDelta 

Model Delta.

siFileTypeCache 

Cache file.

siFileTypeICECompounds 

ICE Compound file.

siFileTypeRTCompounds 

RT Compound file.

siFileTypeCustom 

Custom.

siFileTypeLast 

Number of items total.

Definition at line 2212 of file xsi_decl.h.

This enum specifies the type of clusters in Softimage.

Enumerator:
siClusterVertexType 

Vertex cluster type.

siClusterNodeType 

Node cluster type.

siClusterEdgeType 

Edge cluster type.

siClusterPolygonType 

Polygon cluster type.

Definition at line 2250 of file xsi_decl.h.

This enum specifies the type of cluster properties in Softimage.

Enumerator:
siClusterPropertyEnvelopeWeightType 

Vertex cluster property envelope weight type.

siClusterPropertyShapeKeyType 

Vertex cluster property Shape Key type.

siClusterPropertyWeightMapType 

Vertex cluster property Weight Map type.

siClusterPropertyUVType 

Node cluster property UV type.

siClusterPropertyVertexColorType 

Node cluster property vertex color type.

siClusterPropertyUserNormalType 

Node cluster property user normal type.

siClusterPropertyUserMotionType 

Vertex cluster property User Motion type.

Definition at line 2259 of file xsi_decl.h.

This enum specifies the mode of manipulation of a curve isopoint in Softimage.

Enumerator:
siCurveIsopointPositionManipMode 
siCurveIsopointPositionAndTangentsManipMode 
siCurveIsopointFwdTangentManipMode 
siCurveIsopointBwdTangentManipMode 
siCurveIsopointFwdThenBwdTangentManipMode 
siCurveIsopointBwdThenFwdTangentManipMode 
siCurveIsopointCVManipMode 

Definition at line 2271 of file xsi_decl.h.

This enum specifies the type of alignment for a tangent of a curve knot in Softimage.

Enumerator:
siCurveKnotAlignFwdTangentWithBwd 

Align the forward tangent with the backward tangent.

siCurveKnotAlignBwdTangentWithFwd 

Align the backward tangent with the forward tangent.

siCurveKnotAlignFwdAndBwdTangentsTogether 

Rotate the forward and backward tangents by the same angle so they become aligned.

siCurveKnotLinearizeNextSegment 

Align all the control points between this bezier knot and the next one so the curve segment becomes a line.

siCurveKnotLinearizePrevSegment 

Align all the control points between this bezier knot and the previous one so the curve segment becomes a line.

siCurveKnotLinearizeBothSegments 

Equivalent of doing siCurveKnotLinearizePrevSegment and siCurveKnotLinearizeNextSegment.

siCurveKnotLinearizeInterSegments 

Align all the control points between consecutive knots.

siCurveKnotMakeCorner 

Rotate both tangents enough to cause a significant discontinuity but with minimum curve distortion.

Definition at line 2283 of file xsi_decl.h.

Specifies the rigid body dynamics engine used for simulation.

There can be only one rigid body dynamics engine per SimulationEnvironment.

Enumerator:
siPhysXEngine 

PhyX by NVIDIA engine.

siOpenDynamicsEngine 

ODE engine.

Definition at line 2296 of file xsi_decl.h.

Keyable attribute types.

Enumerator:
siKeyableAttributeClear 

Clear the keyable/non-keyable visible capabilities.

siKeyableAttributeKeyable 

Set the keyable capability.

siKeyableAttributeNonKeyableVisible 

Set the non-keyable visible capability.

Definition at line 2303 of file xsi_decl.h.

Indicates the method to use for finding closest locations on a geometry.

Enumerator:
siClosestVertexOrKnot 
siClosestSurface 
siClosestSmoothedSurface 
siClosestSurfaceRaycastIntersection 

Finds the surface intersection through raycasting.

Definition at line 2311 of file xsi_decl.h.

Indicates the method to use for computing normals on a geometry.

These only apply to PolygonMesh objects (for NurbsSurfaceMesh the normal is always the exact surface normal).

Enumerator:
siInterpolatedVertexGeometricNormals 
siInterpolatedVertexAngleBasedGeometricNormals 
siInterpolatedShadingNormals 
siInterpolatedAngleBasedNodeShadingNormals 

Definition at line 2320 of file xsi_decl.h.

Type of line to use when intersecting a line with a geometry.

Enumerator:
siSemiLineIntersection 

Finds the intersection of a semi line with a geometry.

siLineIntersection 

Finds the intersection of an infinite line with a geometry.

siSegmentIntersection 

Finds the intersection of a line segment with a geometry.

Definition at line 2329 of file xsi_decl.h.

This enumeration lists the allowed bit depths for each channel of an image with the specified channel types.

Not all bit depths are allowed for all channel types.

Enumerator:
siImageBitDepthUnknown 

Unknown image bit depth.

Only returned if an error occured.

siImageBitDepthInteger1 

Integer, 1 bit per channel.

siImageBitDepthInteger2 

Integer, 2 bits per channel.

siImageBitDepthInteger4 

Integer, 4 bits per channel.

siImageBitDepthInteger8 

Integer, 8 bits per channel.

siImageBitDepthInteger16 

Integer, 16 bits per channel.

siImageBitDepthInteger32 

Integer, 32 bits per channel.

siImageBitDepthFloat16 

Floating point, 16 bits per channel (half float).

siImageBitDepthFloat32 

Floating point, 32 bits per channel (full float).

Definition at line 2337 of file xsi_decl.h.

This enum lists the allowed channel types in writable images and framebuffers.

Enumerator:
siImageRGBAChannelType 

Combined color and alpha type.

siImageRGBChannelType 

Color only type.

siImageAlphaChannelType 

Alpha only type.

siImageIntensityChannelType 

RGB intensity type.

siImageRGBEChannelType 

Color with fourth channel as exponent type.

siImageDepthChannelType 

Depth value type.

siImageNormalChannelType 

Normal vector type.

siImageMotionChannelType 

Motion vector type.

siImageTagChannelType 

Object tag type.

Definition at line 2351 of file xsi_decl.h.

This enumeration lists the allowed filters for user-selectable channel types in the UI.

Enumerator:
siImageRGBAChannelFilter 

Combined color and alpha filter.

siImageRGBChannelFilter 

Color only filter.

siImageColorChannelFilter 

Color with optional alpha filter.

siImageAlphaChannelFilter 

Alpha only filter.

siImageIntensityChannelFilter 

RGB intensity filter.

siImageRGBEChannelFilter 

Color with fourth channel as exponent filter.

siImageDepthChannelFilter 

Depth value filter.

siImageNormalChannelFilter 

Normal vector filter.

siImageMotionChannelFilter 

Motion vector filter.

siImageTagChannelFilter 

Object tag filter.

siImageChannelFilterAll 

All.

Definition at line 2365 of file xsi_decl.h.

Indicates the method to use for calculating the center of a bounding volume.

Enumerator:
siVolumeCenterMethodCOG 

Use center of gravity (averaged location of all points).

siVolumeCenterMethodBBoxCenter 

Use center of the bounding box.

siVolumeCenterMethodObjectCenter 

Use the object's local center.

Definition at line 2381 of file xsi_decl.h.

Indicates the method to use for calculating the long axis of a bounding cylinder.

Enumerator:
siBoundingCapsuleMethodXAxis 

Use the object's local X axis.

siBoundingCapsuleMethodYAxis 

Use the object's local Y axis.

siBoundingCapsuleMethodZAxis 

Use the object's local Z axis.

siBoundingCapsuleMethodBestAxis 

Use the tightest fitting axis.

Definition at line 2389 of file xsi_decl.h.

Specifies the source path being set for the OnSourcePathChange event.

Enumerator:
siSourcePathImageSource 

An image source's source path is being changed.

siSourcePathWritableImageSource 

A writable image source's source path is being changed.

siSourcePathModelSource 

A model source's source path is being changed.

Definition at line 2398 of file xsi_decl.h.

Describes whether Model is referenced, local (regular) or an instance.

Enumerator:
siModelKind_Regular 

Regular local model (not referenced, specific to the scene).

siModelKind_Reference 

Referenced model (exported model linked to an external file).

siModelKind_Instance 

Instanced model (instance of another model in the scene).

Definition at line 2406 of file xsi_decl.h.

enum siViewport

Used as a convenient list of identifiers for the different viewports of the view manager.

The first three are special identifiers for commands and methods that use the enumeration and do not refer to a specific viewport.

Enumerator:
siViewportFocussed 

Refers to the viewport that has the focus (indicated by a light gray border).

siViewportCurrent 

Refers to the viewport that is currently under the cursor.

siViewportAll 

Refers to all viewports.

This value is only accepted as an argument if the command or method can use it.

siViewportA 

This identifies viewport A, which, in a 4-viewport view, is the upper left viewport (by default the top camera).

siViewportB 

This identifies viewport B, which, in a 4-viewport view, is the upper right viewport (by default the scene camera).

siViewportC 

This identifies viewport C, which, in a 4-viewport view, is the lower left viewport (by default the front camera).

siViewportD 

This identifies viewport D, which, in a 4-viewport view, is the lower right viewport (by default the right camera).

Definition at line 2414 of file xsi_decl.h.

This enumeration represents the list of display types for the render region.

These display types affect any framebuffer being viewed.

Enumerator:
siRenderRegionDisplayRGBA 

Show the full RGB contents of the framebuffer, alpha composed on top of the viewport's contents.

siRenderRegionDisplayRGB 

Show the full RGB contents of the framebuffer with no alpha compositing.

siRenderRegionDisplayAlpha 

Show only the alpha channel of the framebuffer with no alpha compositing.

siRenderRegionDisplayRed 

Show only the red channel of the framebuffer with no alpha compositing.

siRenderRegionDisplayGreen 

Show only the green channel of the framebuffer with no alpha compositing.

siRenderRegionDisplayBlue 

Show only the blue channel of the framebuffer with no alpha compositing.

Definition at line 2426 of file xsi_decl.h.

Type of delta modification on a referenced model.

Enumerator:
siModificationDeltaActiveResolution 

Store the active resolution of a sub-reference model.

siModificationDeltaRemoveAnimation 

Store animation removals on the current reference model.

siModificationDeltaConstraint 

Store Constraints.

siModificationDeltaUpVectorConstraint 

Store up vector constraints.

siModificationDeltaOperator 

Store Operators.

siModificationDeltaExpression 

Store Expressions.

siModificationDeltaStaticValue 

Store static values.

siModificationDeltaFCurve 

Store FCurves.

siModificationDeltaGroupRelation 

Store group relations (Objects added to a group, a layer or a pass).

siModificationDeltaCluster 

Clusters on Geometry.

siModificationDeltaClusterProperty 

Cluster Properties on Geometry.

siModificationDeltaProperty 

Added Properties.

Definition at line 2437 of file xsi_decl.h.

Specifies the relative location where new node ports will be added.

Enumerator:
siNodePortDataInsertionLocationBegining 

Insert the new port as the first in the port group instances.

siNodePortDataInsertionLocationEnd 

Insert the new port as the last in the port group instances.

siNodePortDataInsertionLocationBefore 

Insert the new port just before the specified one.

siNodePortDataInsertionLocationAfter 

Insert the new port just after the specified one.

Definition at line 2454 of file xsi_decl.h.

Defines the possible actions that trigger calling the PPGEvent callback function.

Enumerator:
siUndefinedPPGEvent 

Unknown event.

siOnInit 
siOnClosed 
siParameterChange 
siButtonClicked 
siTabChange 

Definition at line 2463 of file xsi_decl.h.

The process types that a rendering engine can perform.

These types are used both when a render engine is registered, to indicate to Softimage which process type it can perform, and when the render engine's Process callback is called to indicate which type of processing Softimage wants it to perform at that point.

Enumerator:
siRenderProcessRender 

The render engine can render an image.

siRenderProcessExportArchive 

The render engine can export the scene data given to an archive format for later off-line rendering.

siRenderProcessExportObjectArchive 

The render engine can export the objects given to an archive format to use with stand-in objects.

siRenderProcessGenerateRenderMap 

The render engine can generate render maps.

Definition at line 2474 of file xsi_decl.h.

Query codes that a rendering engine needs to respond to if it supports object archives and stand-ins, via registering itself with a siRenderProcessType::siRenderProcessExportObjectArchive process type, and multiple display bit depths.


These query codes are used in conjunction with the renderer query callback and have no meaning outside of it since the query results are returned through specific context attributes.

Enumerator:
siRenderQueryArchiveIsValid 
siRenderQueryArchiveProxies 

Returns the filenames of the display proxies for the given archive.

siRenderQueryArchiveBBox 

Returns the bounding box of a stand-in at a given frame.

siRenderQueryArchiveFrameRange 

Returns the frame range of a multi-frame object archive.

siRenderQueryDisplayBitDepths 

Returns a list of display bit depths that the rendering engine supports.

siRenderQueryWantDirtyList 

Returns a boolean indicating whether a dirty list is required or not.

siRenderQueryVersionString 

Definition at line 2483 of file xsi_decl.h.

Quality levels that a rendering engine's renderer properties can be set to, or queried for.


These quality levels are used in conjunction with the renderer quality callback and have no meaning outside of it since the quality levels are used through a specific context attribute.

Enumerator:
siRenderQualityTypeLowest 

Lowest quality level.

Used only for very quick updates.

siRenderQualityTypeLow 

Low quality level.

This is the default level for shader balls.

siRenderQualityTypeMedium 

Medium quality level.

Normal working level for the render region.

siRenderQualityTypeHigh 

High quality level.

Suitable for test renders.

siRenderQualityTypeHighest 

Highest quality level.

Suitable for final renders.

Definition at line 2495 of file xsi_decl.h.

When a render engine registers, it provides a list of specific properties that Softimage should create for it.


Note: At this time, only the render options property is supported.

Enumerator:
siRenderPropertyOptions 

A render options property for the rendering engine.

Definition at line 2505 of file xsi_decl.h.

Controls when the camera's shutter opens and closes when generating motion blur for render.

Enumerator:
siRenderShutterCenterOnFrame 

The mid-point of the shutter open period is centered on the frame being rendered, with the open and close shutter equally distant on either side of the frame.

siRenderShutterEndOnFrame 

The shutter should close on the current frame, and open at "shutter speed" frames before the current frame.

siRenderShutterStartOnFrame 

The shutter should open on the current frame, and close at "shutter speed" frames past the current frame.

Definition at line 2511 of file xsi_decl.h.

Controls how the render frame list is computed for passes.

This enum can also be used for scene render options, but siRenderFrameSourceGlobalOptions is an invalid value.

Enumerator:
siRenderFrameSourceFrameRange 

Computes the frame list from a frame range with step.

siRenderFrameSourceFrameSet 

Computes the frame list from a frame set.

siRenderFrameSourceTimeline 

Use timeline's frame range.

siRenderFrameSourceGlobalOptions 

Use a scene render options settings.

Definition at line 2519 of file xsi_decl.h.

Possible actions for the drag and drop notification.

Enumerator:
siSourceDragAction 

Drag source validation.

siSourceDropAction 

Source drop.

Definition at line 2528 of file xsi_decl.h.

Describes how the ICEAttribute data is defined.

Enumerator:
siICEAttributeCategoryUnknown 

Unknown category.

siICEAttributeCategoryBuiltin 

Built-in attribute.

siICEAttributeCategoryCustom 

User-defined attribute.

Definition at line 2535 of file xsi_decl.h.

Defines the threading models available for ICENode evaluation.

Enumerator:
siICENodeUnknownThreading 

Unknown model.

siICENodeSingleThreading 

Single-threading model.

siICENodeMultiThreading 

Multi-threading model.

siICENodeMultiEvaluationPhase 

Multi-phase evaluation model.

Definition at line 2543 of file xsi_decl.h.

Defines the particle shape types for rendering.

Enumerator:
siICEShapeUnknown 

Unknown type.

siICEShapePoint 

Point type.

siICEShapeSegment 

Segment type.

siICEShapeDisc 

Disc type.

siICEShapeRectangle 

Unknown type.

siICEShapeSphere 

Sphere type.

siICEShapeBox 

Box type.

siICEShapeCylinder 

Cylinder type.

siICEShapeCapsule 

Capsule type.

siICEShapeCone 

Cone type.

siICEShapeBlob 

Blob type.

siICEShapeInstance 

Instance type.

siICEShapeReference 

Reference type.

Definition at line 2552 of file xsi_decl.h.

This enum specifies the render verbosity settings used when rendering or exporting passes.

Enumerator:
siRenderVerbosityOff 

Verbose will be forced off even if the renderer verbosity options are activated.

siRenderVerbosityOn 

Verbose will be forced on even if the renderer verbosity options are deactivated.

siRenderVerbosityDefault 

Verbose options from the renderer's options will be used.

Definition at line 2570 of file xsi_decl.h.

Softimage TimeTransport seek modes.

Enumerator:
siTTScrubActive 

User is scrubbing time.

siTTScrubInactive 

Time transport has been requested to move to a specific time.

siTTScrubJog 

Time is scrubbing forward as a result of jogging.

Definition at line 2578 of file xsi_decl.h.

Enumerates the supported graphics drivers.

Enumerator:
siNullGraphicDriver 

No video driver.

siOpenGL20 

OpenGL 2.0.

siOpenGL30 

OpenGL 3.0.

siDirectX9 

DirectX 9.

siDirectX10 

DirectX 10.

Definition at line 2586 of file xsi_decl.h.

Defines the dimension of a hardware surface.

Enumerator:
siDefaultDimension 

Default dimension.

si1D 

1D

si2D 

2D

si3D 

3D

siRectangle 

2D Rectangle

siCube 

Cubic.

Definition at line 2596 of file xsi_decl.h.

Defines the sharing capability of a resource.

Enumerator:
siSharedResource 

Resource can be shared.

siExclusiveResource 

Resource is exclusive and cannot be shared.

Definition at line 2607 of file xsi_decl.h.

Describes the standard vertex attribute hardware slot for a Realtime Shader.

Enumerator:
siHardwareSemanticPosition 

Passed using glVertex.

siHardwareSemanticNormal 

Passed using glNormal.

siHardwareSemanticColor0 

Passed using glColor.

siHardwareSemanticColor1 

Passed using glSecondaryColor.

siHardwareSemanticTexcoord0 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord1 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord2 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord3 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord4 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord5 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord6 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord7 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord8 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord9 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord10 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord11 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord12 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord13 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord14 

Passed using glMultiTexCoord.

siHardwareSemanticTexcoord15 

Passed using glMultiTexCoord.

siHardwareSemanticAttr0 

Passed using glVertexAttribute.

siHardwareSemanticAttr1 

Passed using glVertexAttribute.

siHardwareSemanticAttr2 

Passed using glVertexAttribute.

siHardwareSemanticAttr3 

Passed using glVertexAttribute.

siHardwareSemanticAttr4 

Passed using glVertexAttribute.

siHardwareSemanticAttr5 

Passed using glVertexAttribute.

siHardwareSemanticAttr6 

Passed using glVertexAttribute.

siHardwareSemanticAttr7 

Passed using glVertexAttribute.

siHardwareSemanticAttr8 

Passed using glVertexAttribute.

siHardwareSemanticAttr9 

Passed using glVertexAttribute.

siHardwareSemanticAttr10 

Passed using glVertexAttribute.

siHardwareSemanticAttr11 

Passed using glVertexAttribute.

siHardwareSemanticAttr12 

Passed using glVertexAttribute.

siHardwareSemanticAttr13 

Passed using glVertexAttribute.

siHardwareSemanticAttr14 

Passed using glVertexAttribute.

siHardwareSemanticAttr15 

Passed using glVertexAttribute.

siHardwareSemanticFogcoord 

Passed using glFogCoord.

siHardwareSemanticPsize 

Passed using glPointSize.

siHardwareSemanticTangent 

Passed using glMultiTexCoord[6].

siHardwareSemanticBinormal 

Passed using glMultiTexCoord[7].

siHardwareSemanticWeight 

DirectX only (D3DDECLUSAGE_BLENDWEIGHT).

siHardwareSemanticIndice 

DirectX only (D3DDECLUSAGE_BLENDINDICES).

siHardwareSemanticTessfactor 

DirectX only (D3DDECLUSAGE_TESSFACTOR).

siHardwareSemanticDepth 

DirectX only (D3DDECLUSAGE_DEPTH).

siHardwareSemanticSample 

DirectX only (D3DDECLUSAGE_SAMPLE).

siHardwareSemanticMax 

Max.

Definition at line 2614 of file xsi_decl.h.

Indicates the plotting type to use when collapsing animation layers.

Enumerator:
siDefaultPlottingType 

Use the current user preference (animation.plotting_type)

siPreserveAnimation 

Preserve animation.

siPreserveTangentHandles 

Preserve tangent handles.

Definition at line 2665 of file xsi_decl.h.

This indicates the action to perform when there is a conflict with a material.

Enumerator:
siDefaultAction 

In batch mode, the material will be copied in the target material library.

In interactive mode, the user is prompted to select an action to perform.

siShareMaterial 

Share the existing material.

siCopyMaterial 

Copy the material.

Definition at line 2673 of file xsi_decl.h.

Declares the supported hardware shader versions.

Enumerator:
siHWShaderV1 

Hardware shader version 1.

Definition at line 2681 of file xsi_decl.h.

Context flags for the Graphic Sequencer.

Enumerator:
siXGSContextNormal 

Normal 3D viewport context.

siXGSContextCapture 

Capture rendering context.

siXGSContextHWRender 

Hardware rendering context.

Definition at line 2687 of file xsi_decl.h.

    {   siXGSContextNormal  = ( 1L << 1 ) ,     
    siXGSContextCapture = ( 1L << 2 ) ,     
    siXGSContextHWRender    = ( 1L << 3 )       
    }   siXGSContextFlag;

XGS render flags for the Graphic Sequencer.

Enumerator:
siRenderDefault 

Render normally.

siRenderUnsorted 

Render unsorted objects.

siRenderSorted 

Render sorted objects (back to front).

siRenderSortedNear 

Render objects sorted by nearest point in bounding box.

siRenderSortedCenter 

Render objects sorted by center of bounding box.

siRenderSortedFar 

Render objects sorted by farthest point of bounding box.

siRenderSortFront 

Sorted objects are rendered from front to back (instead of the default back to front).

siRenderSelected 

Render selected objects.

siTexEnvReplace 

Replace texture.

siRenderNoRTSOverride 

Ignore realtime shader overrides when rendering.

Definition at line 2695 of file xsi_decl.h.

    {   siRenderDefault = ( 1L << 1 ) ,     
    siRenderUnsorted    = ( 1L << 2 ) ,     
    siRenderSorted  = ( 1L << 3 ) ,     
    siRenderSortedNear  = ( 1L << 4 ) ,     
    siRenderSortedCenter    = ( 1L << 5 ) ,     
    siRenderSortedFar   = ( 1L << 6 ) ,     
    siRenderSortFront   = ( 1L << 7 ) ,     
    siRenderSelected    = ( 1L << 8 ) ,     
    siTexEnvReplace = ( 1L << 9 ) ,     
    siRenderNoRTSOverride   = ( 1L << 10 )      
    }   siXGSRenderFlag;

Determines the behavior and look of a Custom Display.

Enumerator:
siSupportCommandMap 

Enables the Softimage keyboard shortcuts for this Custom Display.

siWindowNotifications 

The Custom Display will get notified of all Window positining events such as resizing, moving, etc.

Definition at line 2710 of file xsi_decl.h.

Specifies the type of component data (vector3, boolean, color, etc.) on an ICEAttribute.

Enumerator:
siComponentDataTypeBool 

A boolean.

siComponentDataTypeLong 

A long integer.

siComponentDataTypeFloat 

A floating point.

siComponentDataTypeVector2 

A 2-point vector.

siComponentDataTypeVector3 

A 3-point vector.

siComponentDataTypeVector4 

A 4-point vector.

siComponentDataTypeQuaternion 

A quaternion.

siComponentDataTypeMatrix33 

A 3x3 matrix.

siComponentDataTypeMatrix44 

A 4x4 matrix.

siComponentDataTypeColor4 

An RGBA color.

siComponentDataTypeRotation3 

A 3-component rotation.

siComponentDataTypeShape 

Shape.

siComponentDataTypeIcon 

Icon.

Definition at line 2717 of file xsi_decl.h.

Specifies the context of component data (points, edges, etc.) on an ICEAttribute.

Enumerator:
siComponentDataContextSingleton 

One data per primitive.

siComponentDataContextComponent0D 

One data per point.

siComponentDataContextComponent1D 

One data per edge or line segment.

siComponentDataContextComponent2D 

One data per polygon or face.

siComponentDataContextComponent0D2D 

One sample point or polynode.

Definition at line 2735 of file xsi_decl.h.

Specifies the structure of component data (single element or dynamic array) on an ICEAttribute.

Enumerator:
siComponentDataStructureSingle 

One value per component data.

siComponentDataStructureDynamicArray 

Multiple values per component data.

Definition at line 2745 of file xsi_decl.h.

Types of data allowed for render channels.

All channel types, apart from the custom type, are interpreted by Softimage for display viewing.

Enumerator:
siRenderChannelUnknownType 

Unknown type.

Only used as a return value in the case of an error.

siRenderChannelColorType 

Data is interpreted as a pre-multiplied RGB color image with an optional alpha channel.

If no alpha is provided, the image is treated as fully opaque.

siRenderChannelGrayscaleType 

Data is interpreted as a single channel linear grayscale image.

siRenderChannelDepthType 

Data is interpreted as a single channel depth image, where a value of 0 indicates infinity and positive values increasing distance from the camera.

siRenderChannelNormalVectorType 

Data is interpreted as a three-channel, XYZ normalized vector.

siRenderChannelVectorType 

Data is interpreted as a three-channel, arbitrary XYZ vector or point in space.

siRenderChannelLabelType 

Data is interpreted as a single-channel, unique identifier value for each closest object visible to the camera.

siRenderChannelCustomType 

Definition at line 2752 of file xsi_decl.h.

Defines the types of data that can be associated to a ICE node port connection.

Enumerator:
siICENodeDataBool 

Boolean.

siICENodeDataLong 

Long.

siICENodeDataFloat 

Float.

siICENodeDataVector2 

2D vector.

For the C++ API, this maps to CVector2f.

siICENodeDataVector3 
siICENodeDataVector4 
siICENodeDataQuaternion 
siICENodeDataMatrix33 
siICENodeDataMatrix44 
siICENodeDataColor4 
siICENodeDataGeometry 

Geometry.

siICENodeDataLocation 

Data location.

Note: this data type is not available for Custom ICENodes.

siICENodeDataExecute 

Execution logic.

Note: this data type is not available for Custom ICENodes.

siICENodeDataReference 

Reference.

Note: this data type is not available for Custom ICENodes.

siICENodeDataRotation 
siICENodeDataShape 
siICENodeDataCustomType 

Custom data type.

siICENodeDataString 

String type.

siICENodeDataIcon 

Icon.

siICENodeDataValue 

Value (for internal use).

siICENodeDataInterface 

Interface (for internal use).

siICENodeDataMultiComp 

Multi Comp (for internal use).

siICENodeDataArithmeticSupport 

Arithmetic Support (for internal use).

siICENodeDataAny 

Any supported type.

Definition at line 2765 of file xsi_decl.h.

    {   siICENodeDataBool   = ( 1L << 0 ) ,     
    siICENodeDataLong   = ( 1L << 1 ) ,     
    siICENodeDataFloat  = ( 1L << 2 ) ,     
    siICENodeDataVector2    = ( 1L << 3 ) ,     
    siICENodeDataVector3    = ( 1L << 4 ) ,
    siICENodeDataVector4    = ( 1L << 5 ) ,
    siICENodeDataQuaternion = ( 1L << 6 ) ,
    siICENodeDataMatrix33   = ( 1L << 7 ) ,
    siICENodeDataMatrix44   = ( 1L << 8 ) ,
    siICENodeDataColor4 = ( 1L << 9 ) ,
    siICENodeDataGeometry   = ( 1L << 10 ) ,        
    siICENodeDataLocation   = ( 1L << 11 ) ,        
    siICENodeDataExecute    = ( 1L << 12 ) ,        
    siICENodeDataReference  = ( 1L << 13 ) ,        
    siICENodeDataRotation   = ( 1L << 14 ) ,
    siICENodeDataShape  = ( 1L << 15 ) ,
    siICENodeDataCustomType = ( 1L << 16 ) ,        
    siICENodeDataString = ( 1L << 17 ) ,        
    siICENodeDataIcon   = ( 1L << 18 ) ,        
    siICENodeDataValue  = ( ( ( ( ( ( ( ( ( ( ( ( ( ( siICENodeDataBool | siICENodeDataLong )  | siICENodeDataFloat )  | siICENodeDataVector2 )  | siICENodeDataVector3 )  | siICENodeDataVector4 )  | siICENodeDataQuaternion )  | siICENodeDataRotation )  | siICENodeDataMatrix33 )  | siICENodeDataMatrix44 )  | siICENodeDataColor4 )  | siICENodeDataShape )  | siICENodeDataIcon )  | siICENodeDataCustomType )  | siICENodeDataString ) ,       
    siICENodeDataInterface  = siICENodeDataGeometry,        
    siICENodeDataMultiComp  = ( ( ( ( ( ( ( siICENodeDataVector2 | siICENodeDataVector3 )  | siICENodeDataVector4 )  | siICENodeDataQuaternion )  | siICENodeDataRotation )  | siICENodeDataMatrix33 )  | siICENodeDataMatrix44 )  | siICENodeDataColor4 ) ,        
    siICENodeDataArithmeticSupport  = ( ( ( ( ( ( ( ( siICENodeDataLong | siICENodeDataFloat )  | siICENodeDataVector2 )  | siICENodeDataVector3 )  | siICENodeDataVector4 )  | siICENodeDataQuaternion )  | siICENodeDataRotation )  | siICENodeDataMatrix33 )  | siICENodeDataMatrix44 ) ,        
    siICENodeDataAny    = ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( siICENodeDataBool | siICENodeDataLong )  | siICENodeDataFloat )  | siICENodeDataVector2 )  | siICENodeDataVector3 )  | siICENodeDataVector4 )  | siICENodeDataQuaternion )  | siICENodeDataRotation )  | siICENodeDataMatrix33 )  | siICENodeDataMatrix44 )  | siICENodeDataColor4 )  | siICENodeDataShape )  | siICENodeDataGeometry )  | siICENodeDataLocation )  | siICENodeDataReference )  | siICENodeDataExecute )  | siICENodeDataCustomType )  | siICENodeDataString )  | siICENodeDataIcon )         
    }   siICENodeDataType;

Defines the way data are structured for ICE node connections: single data or dynamic array.

Enumerator:
siICENodeStructureSingle 

Single data.

siICENodeStructureArray 

Array data.

siICENodeStructureAny 

Single or Array type.

Definition at line 2794 of file xsi_decl.h.

Defines the element set associated with the data for ICE node connections.

In other words, which elements will be evaluated.

Enumerator:
siICENodeContextSingleton 

Only one element; for example, the transformation matrix of a geometry.

siICENodeContextComponent0D 

One element per vertex or point.

siICENodeContextComponent1D 

One element per edge or segment.

siICENodeContextComponent2D 

One element per polygon or subsurface.

siICENodeContextComponent0D2D 

One element per sampled point or polynode.

siICENodeContextElementGenerator 

Elements generated by a node.

These are the special nodes that generate themselves their own evaluation context, and this context can be propagated to the connected nodes. They control how many elements will be evaluated, starting at their output. The number of output elements is not related to the number of components on the output geometry.

siICENodeContextSingletonOrComponent0D 

One element or one element per vertex or point.

siICENodeContextSingletonOrComponent1D 

One element or one element per edge or segment.

siICENodeContextSingletonOrComponent2D 

One element or one element per polygon or subsurface.

siICENodeContextSingletonOrComponent0D2D 

One element or one element per sampled point or polynode.

siICENodeContextSingletonOrElementGenerator 

One element or one element generated by a node.

siICENodeContextComponent0DOr1DOr2D 

One element per: vertex or point; edge or segment; polygon or subsurface.

siICENodeContextNotSingleton 

Any element set except the singleton (one element only).

siICENodeContextAny 

Any element set.

Definition at line 2802 of file xsi_decl.h.

Determines the behavior of the auto-complete feature for a text editor widget control (see siPPGControlType::siControlTextEditor).

Enumerator:
siNone 

Turn off auto-complete.

siKeywords 

Auto-complete only keywords.

siCommands 

Auto-complete names of installed commands.

Definition at line 2821 of file xsi_decl.h.

    {   siNone  = 0,        
    siKeywords  = ( 1L << 1 ) ,     
    siCommands  = ( 1L << 2 )       
    }   siAutoCompleteMode;

Determines the availability of the File menu functions for a text editor widget control (siPPGControlType::siControlTextEditor).

By default, if you display the toolbar (explicitly set the siPPGItemAttribute::siUIToolbar attribute to true), every function (entry) in the menu will be enabled. However, you can disable the loading and saving functions by setting the siPPGItemAttribute::siUICapability attribute to one of these values.
Note: Using these values does not affect the Edit menu at all nor does it change the availability of the rest of the File menu functions (Recent Files, Preferences, and Print).

Enumerator:
siNoSaveLoad 

Disables the following options in the File menu: New, Open, Save, Save As, Save Selection.

siCanSave 

Disables the following options in the File menu: Save, Save As, Save Selection.

siCanLoad 

Disables the following options in the File menu: New, Open.

Definition at line 2829 of file xsi_decl.h.

    {   siNoSaveLoad    = 0,        
    siCanSave   = ( 1L << 1 ) ,     
    siCanLoad   = ( 1L << 2 )       
    }   siTextEditorCapability;

Defines the supported features for a custom viewport.

Enumerator:
siHardwareRendering 

The viewport supports hardware rendering.

Definition at line 2837 of file xsi_decl.h.

Softimage TimeTransport playback types.

Enumerator:
siTTPlaybackNormal 

Equivalent to Softimage TimeTransport real-time playback type.

siTTPlaybackSlideShow 

Equivalent to Softimage TimeTransport all playback type.

Definition at line 2843 of file xsi_decl.h.

Softimage TimeTransport states.

Enumerator:
siTTStateStop 

Stop.

siTTStatePlay 

Play.

siTTStateSeek 

Seek.

siTTStateTimeChange 

Time change.

siTTStateContextChange 

Context change.

siTTStateScrubChange 

Scrub change.

siTTStateSeekChange 

Seek change.

siTTStateDeviceChange 

Device change.

siTTStateFrameDropChange 

Frame drop change.

Definition at line 2850 of file xsi_decl.h.

Various flags that affect tool behaviour.

Enumerator:
siToolAllowNotifications 

Definition at line 2864 of file xsi_decl.h.

ToolContext cursors.

Enumerator:
siArrowCursor 

Standard arrow cursor.

siCrossCursor 

Crosshair cursor.

siHandCursor 

Pointing hand cursor.

siPenCursor 

Pen cursor.

siDropperCursor 

Eye dropper cursor.

siSelectCursor 

Selection cursor.

siTranslateCursor 

Translate cursor.

siRotateCursor 

Rotate cursor.

siScaleCursor 

Scale cursor.

siZoomCursor 

Magnifying glass cursor.

siDragXYCursor 

4-way arrow cursor.

siDragXCursor 

Horizontal arrow cursor.

siDragYCursor 

Vertical arrow cursor.

Definition at line 2870 of file xsi_decl.h.

ToolContext text/menu alignment.

Enumerator:
siLeftAlign 

Left-align horizontally.

siCenterAlign 

Center horizontally or vertically.

siRightAlign 

Right-align horizontally.

siTopAlign 

Top-align vertically.

siBottomAlign 

Bottom-align vertically.

Definition at line 2888 of file xsi_decl.h.

enum siSnapType

ToolContext snapping type flags.

Enumerator:
siSnapNone 

Nothing was snapped.

siSnapPoint 

Snap to points.

siSnapKnot 

snap to knots.

siSnapCenter 

Snap to centers.

siSnapMidPoint 

Snap to mid-points.

siSnapBBox 

Snap to bounding box points.

siSnap0D 

Snap to any 0D feature.

siSnapEdge 

Snap to mesh edges.

siSnapCurve 

Snap to curves.

siSnapUIsocurve 

Snap to surface U curves.

siSnapVIsocurve 

Snap to surface V curves.

siSnapBoundary 

Snap to surface boundary curves.

siSnap1D 

Snap to any 1D feature.

siSnapFace 

Snap to mesh faces.

siSnapSurface 

Snap to surfaces.

siSnap2D 

Snap to any 2D feature.

siSnapGrid 

Snap to grid.

Definition at line 2898 of file xsi_decl.h.

    {   siSnapNone  = 0L,       
    siSnapPoint = 0x1L,     
    siSnapKnot  = 0x2L,     
    siSnapCenter    = 0x4L,     
    siSnapMidPoint  = 0x8L,     
    siSnapBBox  = 0x20L,        
    siSnap0D    = 0xffffL,      
    siSnapEdge  = 0x10000L,     
    siSnapCurve = 0x20000L,     
    siSnapUIsocurve = 0x40000L,     
    siSnapVIsocurve = 0x80000L,     
    siSnapBoundary  = 0x100000L,        
    siSnap1D    = 0xff0000L,        
    siSnapFace  = 0x1000000L,       
    siSnapSurface   = 0x2000000L,       
    siSnap2D    = 0x3f000000L,      
    siSnapGrid  = 0x40000000L       
    }   siSnapType;
enum siPickMode

ToolContext picking mode flags.

Enumerator:
siPickSingleObject 

Pick a single object.

siPickSingleSubComponent 

Pick a single subcomponent.

siPickMultipleObjects 

Pick multiple objects.

siPickMultipleSubComponents 

Pick multiple subcomponents.

Definition at line 2920 of file xsi_decl.h.

enum siPickType

ToolContext picking type flags.

Enumerator:
siPickRectangle 

Rectangle selection mode.

siPickRaycast 

Raycast selection mode.

siPickLasso 

Lasso selection mode.

siPickFreeform 

Freeform selection mode.

siPickRectangleRaycast 

Rectangle-raycast selection mode.

Definition at line 2929 of file xsi_decl.h.

This indicates which UVs indices to use when the UVs are copied from one object and pasted onto another object.

Enumerator:
siDefaultPasteUVsMode 

Default mode which consist of using the source object UVs indices or the target object UVs indices when the first one doesn't make sense.

siPasteUVsUsingSourceIndices 

Paste the UVs using the source object UVs indices.

siPasteUVsUsingTargetIndices 

Paste the UVs using the target object UVs indices.

Definition at line 2939 of file xsi_decl.h.

This indicates the mathematical mode when setting a new value to a current value.

Enumerator:
siSetValueModeAbsolute 

Replaces the current value with the new value.

siSetValueModeAdditive 

Adds the new value to the current value.

siSetValueModeAddPercentage 

Adds percentage of current value to current value.

Definition at line 2947 of file xsi_decl.h.

Defines the rotation representation.

Enumerator:
siQuaternionRot 

Quaternion representation.

siEulerRot 

Euler representation.

siAxisAngleRot 

Axis angle representation.

Definition at line 56 of file xsi_rotationf.h.

       :
    SICPPSDK_INLINE void QuatToEuler( const CQuaternionf& in_quat, CVector3f& out_vct, const RotationOrder in_eOrder );

Function Documentation

virtual XSI::~CBase ( ) [virtual]

Default destructor.

CString XSI::GetClassIDName ( ) const

Returns the type of the API class in a text string,.

Returns:
The class type in a text string..
virtual siClassID XSI::GetClassID ( ) const [pure virtual]

Returns the type of the API class.

Returns:
The class type.
virtual bool XSI::IsA ( siClassID  in_ClassID ) const [virtual]

Returns true if a given class type is compatible with this API class.

Parameters:
in_ClassID Class type.
Returns:
True if the class is compatible, false otherwise.
bool XSI::IsA ( const CRef &  in_ref ) const

Returns true if a given CRef object is compatible with this API class.

Parameters:
in_ref CRef object.
Returns:
True if the class is compatible, false otherwise.
CStatus XSI::SetObject ( const CRef &  in_obj )

Sets this API class object with a reference object.

Parameters:
in_obj CRef object.
Returns:
CStatus::OK success
CStatus::Fail Failure
bool XSI::IsValid ( ) const

Returns true if the object is valid.

Returns:
True of the object is valid; false otherwise.
void XSI::ResetObject ( )

Resets this API class by deleting its CRef object.

XSI::operator CRef & ( )

Converts from CBase to a CRef reference object.

Returns:
A reference to a CRef object.
bool XSI::operator== ( const CBase &  in_obj ) const

Equality operator.

Parameters:
in_obj API class object to compare.
Returns:
true if both API class objects are identical, false otherwise.
Since:
4.0
bool XSI::operator!= ( const CBase &  in_obj ) const

Inequality operator.

Parameters:
in_obj API class object to compare.
Returns:
true if the objects are not identical, false otherwise.
Since:
4.0
const CRef& XSI::GetRef ( ) const

Converts from CBase to a constant CRef reference object.

Returns:
A constant reference to a CRef object.
void XSI::SetPtr ( void *  ) [protected]
void XSI::SetRef ( const CRef &  in_ref ) [protected]
void XSI::Clear ( ) [protected]
void* XSI::GetPtr ( void  ) const [protected]
SICPPSDK_INLINE CLine ( const CVector3 &  in_point,
const CVector3 &  in_tangent 
)

Construct a line through given point in given direction.

Parameters:
in_point Point on the line
in_tangent Tangent direction vector

Definition at line 250 of file xsi_line.h.

: m_vOrigin(in_pt), m_vTangent(in_dir)
{}

SICPPSDK_INLINE CLine ( const CLine &  in_line )

Copy constructor.

Parameters:
in_line Line to copy

Definition at line 245 of file xsi_line.h.

: m_vOrigin(in_line.m_vOrigin), m_vTangent(in_line.m_vTangent)
{
}

SICPPSDK_INLINE ~CLine ( )

Default destructor.

Definition at line 254 of file xsi_line.h.

{}

SICPPSDK_INLINE CLine& XSI::operator= ( const CLine &  in_line )

Assignment operator.

Parameters:
in_line Line to copy
Returns:
A reference to this line.
SICPPSDK_INLINE bool XSI::operator== ( const CLine &  in_line ) const

Equality operator tests the strict equality of this CLine with the specified line.

Parameters:
in_line Operand line.
Returns:
true if equal else false.
See also:
CLine::Equals
SICPPSDK_INLINE bool XSI::operator!= ( const CLine &  in_line ) const

Inequality operator tests the strict inequality of this CLine with the specified line.

Parameters:
in_line Operand line.
Returns:
true if equal else false.
See also:
CLine::Equals
SICPPSDK_INLINE bool XSI::EpsilonEquals ( const CLine &  in_line,
double  in_dEpsilon 
) const

Tests the equality of this line with the specified line, with a tolerance of Epsilon.

Parameters:
in_line Operand line.
in_dEpsilon Error margin
Possible Values: [0, +INF[ should be a positive value
Returns:
true if equal else false.
SICPPSDK_INLINE bool XSI::Equals ( const CLine &  in_line ) const

Tests the strict equality of this line with the specified line.

Parameters:
in_line Operand line.
Returns:
true if equal else false.
bool XSI::Parallel ( const CLine &  in_line ) const

Tests whether two lines are parallel.

Parameters:
in_line Operand line.
Returns:
true if equal else false.
bool XSI::Collinear ( const CLine &  in_line ) const

Tests whether two lines are collinear.

Parameters:
in_line Operand line.
Returns:
true if equal else false.
SICPPSDK_INLINE CVector3 Project ( const CVector3 &  in_point ) const

Return projection of given point on this line.

Return projection of this point on to the plane.

Returns:
Closest point on the line
Closest point on the plane
SICPPSDK_INLINE CVector3 GetClosestPoint ( const CLine &  in_line ) const

Return closest point on the the line to the given line.

Returns:
Closest point on the line

Definition at line 330 of file xsi_line.h.

{
    CVector3 l_Closest;
    Intersect( in_line, l_Closest );
    return l_Closest;
}

SICPPSDK_INLINE double GetDistance ( const CVector3 &  in_point ) const

Return distance fromt the line to the given point.

Return distance fromt the plane to the given point.

Returns:
Distance to input point

Definition at line 337 of file xsi_line.h.

{
    return Project(in_point).SubInPlace(in_point).GetLength();
}

SICPPSDK_INLINE double GetDistance ( const CLine &  in_line ) const

Return distance fromt the line to the given line.

Returns:
Distance to input line

Definition at line 342 of file xsi_line.h.

{
    CVector3 l_Tmp;
    return ( Intersect( in_line, l_Tmp ) ? 0.0 : GetDistance( in_line.m_vOrigin ) );
}

SICPPSDK_INLINE CVector3 XSI::GetPosition ( double  in_param ) const

Return position on line for given parameter.

Parameters:
in_param Parameter on line.
Returns:
Position corresponding to input parameter
double XSI::GetParameter ( const CVector3 &  in_point ) const

Return parameter on line closest to input point.

Returns:
Position corresponding to input parameter
bool Intersect ( const CLine &  in_line,
CVector3 &  out_point 
) const

Return intersection of this line with the given line.

Return intersection of this plane with the given line.

Parameters:
in_line Line to intersect.
out_point Closest point of intersection on line.
Returns:
true if lines intersect at a single point else false.
Parameters:
in_line Line to intersect.
out_point Closest point of intersection on plane.
Returns:
true if line intersects the plane else false.
SICPPSDK_INLINE const CVector3 & GetOrigin ( ) const

Return origin of the line.

Return origin of the plane.

Returns:
Reference to origin.
SICPPSDK_INLINE const CVector3 & GetTangent ( ) const

Return tangent direction of the line.

Returns:
Reference to tangent.

Definition at line 269 of file xsi_line.h.

{
    return m_vTangent;
}

SICPPSDK_INLINE CPlane & SetOrigin ( const CVector3 &  in_point )

Set origin of the line.

Set origin of the plane.

Parameters:
in_point Point on the line
Returns:
A reference to this line.
Parameters:
in_point Point on the plane
Returns:
A reference to this plane.

Definition at line 306 of file xsi_line.h.

{
    m_vOrigin = in_point;
    return *this;
}

SICPPSDK_INLINE CLine & SetTangent ( const CVector3 &  in_tangent )

Set tangent direction of the line.

Parameters:
in_tangent Tangent direction vector.
Returns:
A reference to this line.

Definition at line 312 of file xsi_line.h.

{
    m_vTangent = in_tangent;
    return *this;
}

SICPPSDK_INLINE CPlane & Set ( const CVector3 &  in_point,
const CVector3 &  in_tangent 
)

Set origin and tangent direction of the line.

Set origin and normal of the plane.

Parameters:
in_point Point on the line
in_tangent Tangent direction vector.
Returns:
A reference to this line.
Parameters:
in_point Point on the plane
in_direction Normal vector.
Returns:
A reference to this plane.
SICPPSDK_INLINE CPlane & operator*= ( const CMatrix3 &  in_matrix3 )

Right-multiplies this line by the matrix m in place (this = this .

Right-multiplies this plane by the matrix m in place (this = this .

m ).

Parameters:
in_matrix3 Operand matrix.
Returns:
A reference to this line.
See also:
CLine::MulByMatrix3InPlace

m ).

Parameters:
in_matrix3 Operand matrix.
Returns:
A reference to this plane.
See also:
CPlane::MulByMatrix3InPlace
SICPPSDK_INLINE CPlane & operator*= ( const CMatrix4 &  in_matrix4 )

Right-multiplies this line by the matrix m in place (this = this .

Right-multiplies this plane by the matrix m in place (this = this .

m ).

Parameters:
in_matrix4 Operand matrix.
Returns:
A reference to this line.
See also:
CLine::MulByMatrix4InPlace

m ).

Parameters:
in_matrix4 Operand matrix.
Returns:
A reference to this plane.
See also:
CPlane::MulByMatrix4InPlace
SICPPSDK_INLINE CPlane & operator*= ( const CTransformation &  in_transformation )

Right-multiplies this line by the transformation t in place (this = this .

Right-multiplies this plane by the transformation t in place (this = this .

t).

Parameters:
in_transformation transformation operand.
Returns:
A reference to this line.
See also:
CLine::MulByTransformationInPlace

t).

Parameters:
in_transformation transformation operand.
Returns:
A reference to this plane.
See also:
CPlane::MulByTransformationInPlace
SICPPSDK_INLINE CPlane & MulByMatrix3InPlace ( const CMatrix3 &  in_matrix3 )

Right-multiplies this line by the matrix m in place (this = this .

Right-multiplies this plane by the matrix m in place (this = this .

m ).

Parameters:
in_matrix3 Operand matrix.
Returns:
A reference to this line.

m ).

Parameters:
in_matrix3 Operand matrix.
Returns:
A reference to this plane.
SICPPSDK_INLINE CLine& XSI::MulByMatrix3 ( const CLine &  in_line,
const CMatrix3 &  in_matrix3 
)

Right-multiplies the line l by the matrix m and store the result in this line (this = l .

m ).

Parameters:
in_line Operand line
in_matrix3 Operand matrix.
Returns:
A reference to this line.
SICPPSDK_INLINE CPlane & MulByMatrix4InPlace ( const CMatrix4 &  in_matrix4 )

Right-multiplies this line by the matrix m in place (this = this .

Right-multiplies this plane by the matrix m in place (this = this .

m ).

Parameters:
in_matrix4 Operand matrix.
Returns:
A reference to this line.

m ).

Parameters:
in_matrix4 Operand matrix.
Returns:
A reference to this plane.
SICPPSDK_INLINE CLine& XSI::MulByMatrix4 ( const CLine &  in_line,
const CMatrix4 &  in_matrix4 
)

Right-multiplies the line l by the matrix m and store the result in this line (this = l .

m ).

Parameters:
in_line Operand line
in_matrix4 Operand matrix.
Returns:
A reference to this line.
SICPPSDK_INLINE CPlane & MulByTransformationInPlace ( const CTransformation &  in_transformation )

Right-multiplies this line by the transformation t in place (this = this .

Right-multiplies this plane by the transformation t in place (this = this .

t).

Parameters:
in_transformation transformation operand.
Returns:
A reference to this line.

t).

Parameters:
in_transformation transformation operand.
Returns:
A reference to this plane.
SICPPSDK_INLINE CLine& XSI::MulByTransformation ( const CLine &  in_line,
const CTransformation &  in_transformation 
)

Right-multiplies the line l by the transformation t and stores the result in this line (this = l .

t ).

Parameters:
in_line Operand line.
in_transformation transformation operand.
Returns:
A reference to this line.
static const double XSI::PI ( 3.  14159265358979323846 ) [static]
static const float XSI::PI2 ( (float) PI *2.  0f ) [static]
static const float XSI::Invert2PI ( 0.5f/(float)  PI ) [static]
static const float XSI::MilliEPS ( 1.0e-  03f ) [static]
static const float XSI::MicroEPS ( 1.0e-  06f ) [static]
static const float XSI::NanoEPS ( 1.0e-  09f ) [static]
static const float XSI::PicoEPS ( 1.0e-  012f ) [static]
double XSI::DegreesToRadians ( double  in_dDegrees ) [inline]

Converts an angle in degrees to an angle in radians.

Parameters:
in_dDegrees angle in degrees.
Returns:
Angle in radians.

Definition at line 121 of file xsi_math.h.

    { return (in_dRadians * (180.0/PI));}
double XSI::RadiansToDegrees ( double  in_dRadians ) [inline]

Converts an angle in radians to an angle in degrees.

Parameters:
in_dRadians angle in radians.
Returns:
Angle in degrees.

Definition at line 128 of file xsi_math.h.

CTransformation XSI::MapObjectPoseToWorldSpace ( const CTransformation &  in_transfoObjectSpace,
const CTransformation &  in_transfoPose 
)

Converts a Pose described in a given ObjectSpace to WorldSpace.

Parameters:
in_transfoObjectSpace ObjectSpace into which the pose is defined.
in_transfoPose Pose to convert.
Returns:
The world Pose.
See also:
CTransformation, KinematicState, Kinematics::GetGlobal, Kinematics::GetLocal
Example:
Demonstrates how to use MapObjectPoseToWorldSpace
        using namespace XSI;
        using namespace MATH;
        Application app;
        Model root = app.GetActiveSceneRoot();

        X3DObject myCube;
        root.AddGeometry( L"Cube", L"MeshSurface",L"",myCube );

        KinematicState  globalKinematicState = myCube.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posy", 4.0);
        globalKinematicState.PutParameterValue(L"posx", 2.0);

        X3DObject myCube2;
        myCube.AddGeometry( L"Cube", L"MeshSurface",L"",myCube2);

        globalKinematicState = myCube2.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posz",3.0);
        globalKinematicState.PutParameterValue(L"rotx",45.0);

        CTransformation localTransformation =
                                myCube2.GetKinematics().GetLocal().GetTransform();
        CTransformation globalTransformation =
                                myCube.GetKinematics().GetGlobal().GetTransform();

        CVector3 translation(localTransformation.GetTranslation());

        app.LogMessage(
            L"The translation of the cube relative to its parent: x " +
            CValue(translation.GetX()).GetAsText() +
            L" y " +
            CValue(translation.GetY()).GetAsText() +
            L" z " +
            CValue(translation.GetZ()).GetAsText());

        CTransformation worldTransformation =
                        MapObjectPoseToWorldSpace(  globalTransformation,
                                                    localTransformation);

        translation = worldTransformation.GetTranslation();

        app.LogMessage( L"The translation of the cube relative to " +
                        CString(L"the origin of the universe: x ") +
                        CValue(translation.GetX()).GetAsText() +
                        L" y " + CValue(translation.GetY()).GetAsText() +
                        L" z " + CValue(translation.GetZ()).GetAsText());
CVector3 XSI::MapObjectOrientationToWorldSpace ( const CTransformation &  in_transfoObjectSpace,
const CVector3 &  in_vector3Orientation 
)

Converts an Orientation described in a given ObjectSpace to WorldSpace.

Parameters:
in_transfoObjectSpace ObjectSpace in which the orientation is defined.
in_vector3Orientation Orientation to convert.
Returns:
The world orientation.
See also:
CTransformation, KinematicState, Kinematics::GetGlobal, Kinematics::GetLocal
Example:
Demonstrates MapObjectOrientationToWorldSpace
        using namespace XSI;
        using namespace MATH;
        Application app;
        Model root = app.GetActiveSceneRoot();

        X3DObject myCube;
        root.AddGeometry( L"Cube", L"MeshSurface",L"",myCube );

        KinematicState  globalKinematicState = myCube.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posy", 4.0);
        globalKinematicState.PutParameterValue(L"posx", 2.0);
        globalKinematicState.PutParameterValue(L"rotx", 45.0);

        CTransformation localTransformation =
                                myCube.GetKinematics().GetLocal().GetTransform();

        PolygonMesh mesh = myCube.GetActivePrimitive().GetGeometry();
        CVector3Array normalArray = mesh.GetPolygons().GetNormalArray();
        CVector3 orientation(normalArray[1]);

        CVector3 worldOrientation =
                    MapObjectOrientationToWorldSpace(   localTransformation,
                                                        orientation);

        app.LogMessage(
                L"The second polygon normal corresponds to ( " +
                CValue(RadiansToDegrees(worldOrientation.GetX())).GetAsText() +
                L", " +
                CValue(RadiansToDegrees(worldOrientation.GetY())).GetAsText() +
                L", " +
                CValue(RadiansToDegrees(worldOrientation.GetZ())).GetAsText() +
                L") in the world space" );
CVector3 XSI::MapObjectPositionToWorldSpace ( const CTransformation &  in_transfoObjectSpace,
const CVector3 &  in_vector3Position 
)

Converts a Position described in a given ObjectSpace to WorldSpace.

Parameters:
in_transfoObjectSpace ObjectSpace in which the position is defined.
in_vector3Position Position to convert.
Returns:
The world position.
See also:
CTransformation, KinematicState, Kinematics::GetGlobal, Kinematics::GetLocal
Example:
Demonstrates MapObjectPositionToWorldSpace
        using namespace XSI;
        using namespace MATH;
        Application app;
        Model root = app.GetActiveSceneRoot();

        X3DObject myCube;
        root.AddGeometry( L"Cube", L"MeshSurface",L"",myCube );

        KinematicState  globalKinematicState = myCube.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posy", 4.0);
        globalKinematicState.PutParameterValue(L"posx", 2.0);

        CTransformation localTransformation = myCube.GetKinematics().GetLocal().GetTransform();

        CPointRefArray pointArray = myCube.GetActivePrimitive().GetGeometry().GetPoints();
        CVector3 position(Point(pointArray.GetItem(0)).GetPosition());

        app.LogMessage(L"The local position is: X " +
                      CValue(position.GetX()).GetAsText() + CString(L" Y ") +
                      CValue(position.GetY()).GetAsText() + CString(L" Z ") +
                      CValue(position.GetZ()).GetAsText());

        CVector3 worldPosition =
                        MapObjectPositionToWorldSpace(  localTransformation,
                                                        position);

        app.LogMessage(L"The world position is: X " +
                      CValue(worldPosition.GetX()).GetAsText() + CString(L" Y ") +
                      CValue(worldPosition.GetY()).GetAsText() + CString(L" Z ") +
                      CValue(worldPosition.GetZ()).GetAsText());
CTransformation XSI::MapWorldPoseToObjectSpace ( const CTransformation &  in_transfoObjectSpace,
const CTransformation &  in_transfoPose 
)

Converts a Pose described in WorldSpace to a different ObjectSpace.

Parameters:
in_transfoObjectSpace ObjectSpace in which the position is defined.
in_transfoPose Pose to convert.
Returns:
The converted Pose.
CVector3 XSI::MapWorldOrientationToObjectSpace ( const CTransformation &  in_transfoObjectSpace,
const CVector3 &  in_vector3Orientation 
)

Converts an orientation described in WorldSpace to a different ObjectSpace.

Parameters:
in_transfoObjectSpace ObjectSpace in which the position is defined.
in_vector3Orientation Orientation to convert.
Returns:
The converted orientation.
CVector3 XSI::MapWorldPositionToObjectSpace ( const CTransformation &  in_transfoObjectSpace,
const CVector3 &  in_vector3Position 
)

Converts a position described in WorldSpace to a position in a different ObjectSpace.

Parameters:
in_transfoObjectSpace ObjectSpace in which we want to convert the position.
in_vector3Position Position to convert.
Returns:
The converted position.
See also:
CTransformation, KinematicState, Kinematics::GetGlobal, Kinematics::GetLocal
Example:
Demonstrates MapWorldPositionToObjectSpace
        using namespace XSI;
        using namespace MATH;
        Application app;
        Model root = app.GetActiveSceneRoot();

        X3DObject myCube;
        root.AddGeometry( L"Cube", L"MeshSurface", L"", myCube );

        KinematicState  globalKinematicState = myCube.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posy", 4.0);
        globalKinematicState.PutParameterValue(L"posx", 2.0);
        globalKinematicState.PutParameterValue(L"rotx", 30.0);

        CTransformation localTransformation =
                                myCube.GetKinematics().GetLocal().GetTransform();
        CVector3 position(1.0,1.0,1.0);
        CVector3 convertedPosition =
                    MapWorldPositionToObjectSpace(  localTransformation,
                                                    position);

        app.LogMessage(L"The position (1,1,1) is (" +
                    CValue(convertedPosition.GetX()).GetAsText() + L", " +
                    CValue(convertedPosition.GetY()).GetAsText() + L", " +
                    CValue(convertedPosition.GetZ()).GetAsText() +
                    L" in the cube object space");
CTransformation XSI::MapObjectPoseToObjectSpace ( const CTransformation &  in_transfoObjectSpace,
const CTransformation &  in_transfoSpace,
const CTransformation &  in_transfoPose 
)

Converts a pose described in an ObjectSpace to a pose in a different ObjectSpace.

Parameters:
in_transfoObjectSpace ObjectSpace in which the pose is described.
in_transfoSpace Space in which we want to convert the pose.
in_transfoPose Pose to convert.
Returns:
The converted transformation.
See also:
CTransformation, KinematicState, Kinematics::GetGlobal, Kinematics::GetLocal
Example:
Demonstrates MapObjectPoseToObjectSpace
        using namespace XSI;
        using namespace MATH;
        Application app;
        Model root = app.GetActiveSceneRoot();

        X3DObject myCube;
        root.AddGeometry( L"Cube", L"MeshSurface", L"",myCube );

        KinematicState  globalKinematicState = myCube.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posy", 4.0);
        globalKinematicState.PutParameterValue(L"posx", 2.0);

        X3DObject myCube2;
        myCube.AddGeometry( L"Cube", L"MeshSurface", L"", myCube2 );

        globalKinematicState = myCube2.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posz", 3.0);
        globalKinematicState.PutParameterValue(L"rotz", 45.0);

        X3DObject myCone;
        root.AddGeometry( L"Cone", L"MeshSurface", L"",myCone );

        globalKinematicState = myCube2.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posy", -2.0);
        globalKinematicState.PutParameterValue(L"rotz", 90.0);

        CTransformation localTransformation =
                            myCube2.GetKinematics().GetLocal().GetTransform();
        CTransformation parentTransformation =
                            myCube.GetKinematics().GetGlobal().GetTransform();
        CVector3 translation(localTransformation.GetTranslation());
        CTransformation destinationTransformation =
                            myCone.GetKinematics().GetGlobal().GetTransform();

        app.LogMessage(
            L"The translation of the cube relative to its parent: x " +
            CValue(translation.GetX()).GetAsText() + CString(L" Y ") +
            CValue(translation.GetY()).GetAsText() + CString(L" Z ") +
            CValue(translation.GetZ()).GetAsText());

        CTransformation convertedTranformation =
                MapObjectPoseToObjectSpace( parentTransformation,
                                            destinationTransformation,
                                            localTransformation);

        translation = convertedTranformation.GetTranslation();

        app.LogMessage(
            L"The translation of the cube relative to the cone: x " +
            CValue(translation.GetX()).GetAsText() + CString(L" Y ") +
            CValue(translation.GetY()).GetAsText() + CString(L" Z ") +
            CValue(translation.GetZ()).GetAsText());
CVector3 XSI::MapObjectOrientationToObjectSpace ( const CTransformation &  in_transfoObjectSpace,
const CTransformation &  in_transfoSpace,
const CVector3 &  in_vector3Orientation 
)

Converts an orientation described in an ObjectSpace to an orientation in a different ObjectSpace.

Parameters:
in_transfoObjectSpace ObjectSpace in which the orientation is described.
in_transfoSpace Space in which we want to convert the orientation.
in_vector3Orientation Orientation to convert.
See also:
CTransformation, KinematicState, Kinematics::GetGlobal, Kinematics::GetLocal
Example:
Demonstrates MapObjectOrientationToObjectSpace
        using namespace XSI;
        using namespace MATH;
        Application app;
        Model root = app.GetActiveSceneRoot();

        X3DObject myCube;
        root.AddGeometry( L"Cube", L"MeshSurface", L"",myCube );

        KinematicState  globalKinematicState = myCube.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posy", 4.0);
        globalKinematicState.PutParameterValue(L"posx", 2.0);

        X3DObject myCube2;
        myCube.AddGeometry( L"Cube", L"MeshSurface", L"",myCube2 );

        globalKinematicState = myCube2.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posz", 3.0);
        globalKinematicState.PutParameterValue(L"rotz", 45.0);

        X3DObject myCone;
        root.AddGeometry( L"Cone", L"MeshSurface", L"", myCone );

        globalKinematicState = myCube2.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posy", -2.0);
        globalKinematicState.PutParameterValue(L"rotz", 90.0);

        CTransformation localTransformation =
                                myCube2.GetKinematics().GetLocal().GetTransform();

        PolygonMesh myMesh = myCube.GetActivePrimitive().GetGeometry();
        CVector3Array normalArray = myMesh.GetPolygons().GetNormalArray();

        CVector3 orientation(normalArray[1]);

        CTransformation destinationTransformation =
                                myCone.GetKinematics().GetGlobal().GetTransform();

        CVector3 convertedOrientation =
            MapObjectOrientationToObjectSpace(  localTransformation,
                                                destinationTransformation,
                                                orientation);

        app.LogMessage(L"The second face of the cube normal vector " +
                CString(L"represented in the cone referential( " )+
                CValue(RadiansToDegrees(convertedOrientation.GetX())).GetAsText()
                + L", " +
                CValue(RadiansToDegrees(convertedOrientation.GetY())).GetAsText()
                + L", " +
                CValue(RadiansToDegrees(convertedOrientation.GetZ())).GetAsText() +
                L" ) in the cube object space");
CVector3 XSI::MapObjectPositionToObjectSpace ( const CTransformation &  in_transfoObjectSpace,
const CTransformation &  in_transfoSpace,
const CVector3 &  in_vector3Position 
)

Converts a position described in an ObjectSpace to a position in a different ObjectSpace.

Parameters:
in_transfoObjectSpace ObjectSpace in which the position is described.
in_transfoSpace Space in which we want to convert the position.
in_vector3Position Position to convert.
Returns:
The converted position.
See also:
CTransformation, KinematicState, GetGlobal, GetLocal
Example:
Demonstrates MapObjectPositionToObjectSpace
        using namespace XSI;
        using namespace MATH;
        //Forward declaration
        bool Above(X3DObject&, X3DObject&);

        Application app;
        Model root = app.GetActiveSceneRoot();

        X3DObject myCube;
        root.AddGeometry( L"Cube", L"MeshSurface", L"", myCube );

        KinematicState globalKinematicState = myCube.GetKinematics().GetGlobal();
        globalKinematicState.PutParameterValue(L"posy", 4.0);
        globalKinematicState.PutParameterValue(L"posx", 2.0);

        X3DObject myGrid;
        oRoot.AddGeometry( L"Grid", L"MeshSurface", L"",myGrid );
        myCube.GetKinematics().GetGlobal().PutParameterValue(L"posy",-2.0);

        if( Above(myCube,myGrid)
            app.LogMessage(L"The cube is above the grid");
        else
            app.LogMessage(L"The cube is below the grid");

        //Function that returns true if in_obj1 is above in_obj2.
        //Which means that all " y" values of in_obj1 vertices relative to
        //in_obj2 are bigger than in_obj2 "y" values
        bool Above(X3DObject& in_obj1, X3DObject& in_obj2)
        {
            double biggestY(0.0);

            CVector3Array positionArray;
            CVector3Array::iterater it;
            Geometry myGeom = in_obj1.GetActivePrimitive().GetGeoemtry()
            myGeom.Points().PositionArray(positionArray);

            //Determine the upper position in obj1;
            for(LONG i = 0; i < positionArray.GetCount(); ++i)
            {
                if(positionArray[i].GetY() > biggestY)
                { biggestY = positionArray[i].GetY();}
            }

            CTransformation globalTransformation1,globalTransformation2;
            globalTransformation1 = in_obj1.GetKinematics().GetGlobal().GetTransform();
            globalTransformation2 = in_obj2.GetKinematics().GetGlobal().GetTransform();

            Geometry myGeom = in_obj2.GetActivePrimitive().GetGeometry();
            myGeom.Points().PositionArray(positionArray);

            CVector3 convertedPosition;
            //Determine if all vertices of in_obj1 are above in_obj2
            i= 0;
            for(; i < positionArray.GetCount(); ++i)
            {
                convertdPosition =
                    MapObjectPositionToObjectSpace( globalTransformation1,
                                                    globalTransformation2,
                                                    positionArray[i]);

                if(convertdPosition.GetY() < biggestY)
                { return false;}
            }

            return true;
        }
SICPPSDK_INLINE void XSI::LimitValue ( float &  io_fVal,
float  in_fMin,
float  in_fMax 
)
void XSI::MatToEuler ( const CMatrix3f &  in_mat,
CVector3f &  io_vct,
const short  in_order 
)
void XSI::EulerToMat ( const CVector3f &  in_vct,
CMatrix3f &  out_mat,
const short  in_order 
)
void XSI::EulerToQuat ( const CVector3f &  in_vct,
CQuaternionf &  out_quat,
const short  in_order 
)
SICPPSDK_INLINE CPlane ( const CVector3 &  in_point,
const CVector3 &  in_normal 
)

Construct a plane through a point with the given normal.

Parameters:
in_point Point on the plane
in_normal Normal vector

Definition at line 301 of file xsi_plane.h.

: m_vOrigin(in_pt)
{
    SetNormal( in_normal );
}

SICPPSDK_INLINE CPlane ( const CVector3 &  in_point,
const CVector3 &  in_tangentU,
const CVector3 &  in_tangentV 
)

Construct a plane through a point with the given tangents.

Parameters:
in_point Point on the plane
in_tangentU First tangent vector
in_tangentV Second tangent vector

Definition at line 307 of file xsi_plane.h.

: m_vOrigin(in_pt)
{
    SetTangents( in_U, in_V );
}

SICPPSDK_INLINE CPlane ( const CPlane &  in_plane )

Copy constructor.

Parameters:
in_plane Line to copy

Definition at line 293 of file xsi_plane.h.

: m_vOrigin(in_plane.m_vOrigin), m_vTangentU(in_plane.m_vTangentU), m_vTangentV(in_plane.m_vTangentV), m_vNormal(in_plane.m_vNormal)
{
}

SICPPSDK_INLINE ~CPlane ( )

Default destructor.

Definition at line 298 of file xsi_plane.h.

{}

SICPPSDK_INLINE CPlane& XSI::operator= ( const CPlane &  in_plane )

Assignment operator.

Parameters:
in_plane Line to copy
Returns:
A reference to this plane.
SICPPSDK_INLINE bool XSI::operator== ( const CPlane &  in_plane ) const

Equality operator tests the strict equality of this CPlane with the specified plane.

Parameters:
in_plane Operand plane.
Returns:
true if equal else false.
See also:
CPlane::Equals
SICPPSDK_INLINE bool XSI::operator!= ( const CPlane &  in_plane ) const

Inequality operator tests the strict inequality of this CPlane with the specified plane.

Parameters:
in_plane Operand plane.
Returns:
true if equal else false.
See also:
CPlane::Equals
SICPPSDK_INLINE bool XSI::EpsilonEquals ( const CPlane &  in_plane,
double  in_dEpsilon 
) const

Tests the equality of this plane with the specified plane, with a tolerance of Epsilon.

Parameters:
in_plane Operand plane.
in_dEpsilon Error margin
Possible Values: [0, +INF[ should be a positive value
Returns:
true if equal else false.
SICPPSDK_INLINE bool XSI::Equals ( const CPlane &  in_plane ) const

Tests the strict equality of this plane with the specified plane.

Parameters:
in_plane Operand plane.
Returns:
true if equal else false.
bool XSI::Parallel ( const CPlane &  in_plane ) const

Tests whether two planes are parallel.

Parameters:
in_plane Operand plane.
Returns:
true if equal else false.
bool XSI::Coplanar ( const CPlane &  in_plane ) const

Tests whether two planes are coplanar.

Parameters:
in_plane Operand plane.
Returns:
true if equal else false.
SICPPSDK_INLINE CVector3 XSI::GetPosition ( double  in_U,
double  inV 
) const

Return position on plane for given parameters.

Parameters:
in_U First parameter.
in_V Second parameter.
Returns:
Position corresponding to input parameter
void XSI::GetParameters ( const CVector3 &  in_point,
double &  out_U,
double &  out_V 
) const

Return parameter on plane closest to input point.

Parameters:
out_U First projection parameter.
out_V Second projection parameter.
SICPPSDK_INLINE CVector3 Reflect ( const CVector3 &  in_point ) const

Return reflection of this point across the plane.

Returns:
Reflected point

Definition at line 402 of file xsi_plane.h.

{
    return Project(in_point).ScaleInPlace(2.0).SubInPlace(in_point);
}

SICPPSDK_INLINE CLine ProjectLine ( const CLine &  in_line ) const

Return projection of line on the plane.

Returns:
Projection of input line on the plane

Definition at line 407 of file xsi_plane.h.

{
    CVector3 l_Origin  = Project( in_line.GetOrigin() );
    CVector3 l_Tangent = Project( in_line.GetPosition( 1.0 ) ).SubInPlace( l_Origin );
    return CLine( l_Origin, l_Tangent );
}

SICPPSDK_INLINE CLine ReflectLine ( const CLine &  in_line ) const

Return reflection of line across the plane.

Returns:
Reflected line

Definition at line 414 of file xsi_plane.h.

{
    CVector3 l_Origin  = Reflect( in_line.GetOrigin() );
    CVector3 l_Tangent = Reflect( in_line.GetPosition( 1.0 ) ).SubInPlace( l_Origin );
    return CLine( l_Origin, l_Tangent );
}

CMatrix4& XSI::GetMirrorTransform ( CMatrix4 &  out_matrix4 ) const

Return CMatrix4 that transforms points across this plane.

Parameters:
out_matrix4 Matrix.
Returns:
Reference to output matrix
SICPPSDK_INLINE const CVector3& XSI::GetNormal ( ) const

Return normal for the plane.

Returns:
Reference to normal.
SICPPSDK_INLINE const CVector3 & GetTangentU ( ) const

Return first tangent for the plane.

Returns:
Reference to tangent.

Definition at line 332 of file xsi_plane.h.

{
    return m_vTangentU;
}

SICPPSDK_INLINE const CVector3 & GetTangentV ( ) const

Return second tangent for the plane.

Returns:
Reference to tangent.

Definition at line 337 of file xsi_plane.h.

{
    return m_vTangentV;
}

CPlane& XSI::SetNormal ( const CVector3 &  in_normal )

Set normal for the plane.

Parameters:
in_normal Normal vector.
Returns:
A reference to this plane.
CPlane& XSI::SetTangents ( const CVector3 &  in_U,
const CVector3 &  in_V 
)

Set direction of the plane.

Parameters:
in_U First tangent vector.
in_V Second tangent vector.
Returns:
A reference to this plane.
SICPPSDK_INLINE CPlane& XSI::Set ( const CVector3 &  in_point,
const CVector3 &  in_U,
const CVector3 &  in_V 
)

Set origin and tangents of the plane.

Parameters:
in_point Point on the plane
in_U First tangent vector.
in_V Second tangent vector.
Returns:
A reference to this plane.
SICPPSDK_INLINE CPlane& XSI::MulByMatrix3 ( const CPlane &  in_plane,
const CMatrix3 &  in_matrix3 
)

Right-multiplies the plane l by the matrix m and store the result in this plane (this = l .

m ).

Parameters:
in_plane Operand plane
in_matrix3 Operand matrix.
Returns:
A reference to this plane.
SICPPSDK_INLINE CPlane& XSI::MulByMatrix4 ( const CPlane &  in_plane,
const CMatrix4 &  in_matrix4 
)

Right-multiplies the plane l by the matrix m and store the result in this plane (this = l .

m ).

Parameters:
in_plane Operand plane
in_matrix4 Operand matrix.
Returns:
A reference to this plane.
SICPPSDK_INLINE CPlane& XSI::MulByTransformation ( const CPlane &  in_plane,
const CTransformation &  in_transformation 
)

Right-multiplies the plane l by the transformation t and stores the result in this plane (this = l .

t ).

Parameters:
in_plane Operand plane.
in_transformation transformation operand.
Returns:
A reference to this plane.
CRef XSI::ConvertObject ( void *  in_pAuto )

Converts an XSI Automation (XSI Object Model) object to a CRef object.

Note:
Normally XSI will automatically perform this conversion. For example when calling a custom Command implemented in C++ from scripting, any arguments which are objects will automatically be converted to the corresponding C++ API CRef-based object.
Parameters:
in_pAuto IDispatch pointer to an XSI Automation object model interface (see CValue::DataType)
Returns:
The new CRef object
void* XSI::ConvertObject ( const CRef &  in_obj )

Converts a CRef object to an XSI Automation (XSI Object Model) object.

The returned pointer can be used to communicate with the object model.

The returned object pointer has been reference counted, and the caller is responsible for calling IDispatch::Release().

Note:
The CComAPIHandler object is available as an alternative way to communicate with XSI Automation objects.
Parameters:
in_obj A constant CRef object to convert.
Returns:
IDispatch pointer to an XSI Automation object (see CValue::DataType).
bool XSI::HasClassID ( CRef &  ,
LONG   
)
bool XSI::CanSubClass ( CRef &  ,
LONG   
)
SICPPSDK_INLINE CRotationf ( )

Default constructor.

Definition at line 347 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf ( const CRotationf &  in_rotation )

Copy constructor.

Parameters:
in_rotation Rotation to copy

Definition at line 354 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf ( const CVector3f &  in_EulerAngles,
const RotationOrder  in_RotOrder = siXYZ 
)

Constructor (from CVector3f of Euler angles).

Parameters:
in_EulerAngles Euler angles to construct from
in_RotOrder Rotation order to use
See also:
CRotationf::Set, CRotationf::SetOrder

Definition at line 364 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf ( const float  in_X,
const float  in_Y,
const float  in_Z,
const RotationOrder  in_RotOrder = siXYZ 
)

Constructor (from XYZ Euler angles).

Parameters:
in_X X angle
in_Y Y angle
in_Z Z angle
in_RotOrder Rotation order to use
See also:
CRotationf::Set, CRotationf::SetOrder

Definition at line 374 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf ( const CQuaternionf &  in_Quat )

Constructor (from a quaternion).

Parameters:
in_Quat Quaternion to construct from
See also:
CRotationf::GetQuaternion, CRotationf::Set

Definition at line 359 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf ( const CVector3f &  in_Axis,
const float  in_Angle 
)

Constructor (using axis angle representation).

Parameters:
in_Axis Axis of rotation
in_Angle Rotation angle around the axis
See also:
CRotationf::GetAxisAngle, CRotationf::Set

Definition at line 369 of file xsi_rotationf.h.

{
SICPPSDK_INLINE ~CRotationf ( )

Default destructor.

Definition at line 379 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf& XSI::operator= ( const CRotationf &  in_rotation )

Assignment operator.

Parameters:
in_rotation Rotation to copy
Returns:
A reference to this rotation.
SICPPSDK_INLINE CVector3f XSI::GetXYZAngles ( const RotationOrder  in_Order ) const

Returns the euler angles of the rotation as a CVector3f from a rotation order.

Parameters:
in_Order Rotation order
Returns:
CVector3f Rotation euler angle vector
See also:
CRotationf::Set, CRotationf::GetOrder
SICPPSDK_INLINE void XSI::GetXYZAngles ( float &  io_X,
float &  io_Y,
float &  io_Z 
) const

Returns the Euler angles's representation of the rotation.

Parameters:
io_X X angle
io_Y Y angle
io_Z Z angle
See also:
CRotationf::Set, CRotationf::GetOrder
SICPPSDK_INLINE CVector3f XSI::GetXYZAngles ( ) const

Returns the Euler angles's representation of the rotation.

Returns:
Euler vector
See also:
CRotationf::Set, CRotationf::GetOrder
SICPPSDK_INLINE CRotationf::RotationOrder GetOrder ( ) const

Returns the rotation order of this rotation for the Euler angles representation.

Returns:
CRotationf::RotationOrder

Definition at line 614 of file xsi_rotationf.h.

{
SICPPSDK_INLINE void XSI::SetOrder ( const RotationOrder  in_rotOrder )

Sets the rotation order for the Euler angles representation.

Parameters:
in_rotOrder New rotation order to use
See also:
CRotationf::GetOrder
SICPPSDK_INLINE CRotationf::RotationRep GetRepresentation ( ) const

Returns the rotation representation of this rotation.

Returns:
CRotationf::RotationRep

Definition at line 619 of file xsi_rotationf.h.

{
void SetRepresentation ( const RotationRep  in_rotRep,
const RotationOrder  in_order = siXYZ 
)

Sets the rotation representation for this rotation.

Parameters:
in_rotRep Rotation representation to set
in_order New rotation order to use
See also:
CRotationf::GetOrder

Definition at line 624 of file xsi_rotationf.h.

    {
        switch( in_rep )
        {
            case siQuaternionRot:
            {
                CQuaternionf l_quat;
                switch ( m_rotRep )
                {
                    case siEulerRot:
                    {
                        CVector3f l_euler( m_X, m_Y, m_Z );
                        XSI::MATH::EulerToQuat( l_euler, l_quat, m_rotOrder );
                    }
                    break;
                    case siAxisAngleRot:
                    {
                        CVector3f l_axis( m_X, m_Y, m_Z );
                        if ( l_axis.GetLength() > MicroEPS )
                        {
                            l_axis.NormalizeInPlace();
                            AxisAngleToQuat( l_axis, m_Angle, l_quat );
                        }
                    }
                    break;
                }
                *this = l_quat;
            }
            break;

            case siEulerRot:
            {
                CVector3f l_euler;
                switch ( m_rotRep )
                {
                    case siQuaternionRot:
                    {
                        CQuaternionf l_quat( m_W, m_X, m_Y, m_Z );
                        l_quat.NormalizeInPlace();
                        QuatToEuler( l_quat, l_euler, in_order );
                    }
                    break;
                    case siAxisAngleRot:
                    {
                        CQuaternionf l_quat;
                        CVector3f l_axis( m_X, m_Y, m_Z );
                        if ( l_axis.GetLength() > MicroEPS )
                        {
                            l_axis.NormalizeInPlace();
                            AxisAngleToQuat( l_axis, m_Angle, l_quat );
                        }
                        QuatToEuler( l_quat, l_euler, in_order );
                    }
                    break;
                }
                Set( l_euler, in_order );
            }
            break;
            case siAxisAngleRot:
            {
                float l_angle = 0;
                CVector3f l_axis;
                switch ( m_rotRep )
                {
                    case siQuaternionRot:
                    {
                        CQuaternionf l_quat( m_W, m_X, m_Y, m_Z );
                        l_quat.NormalizeInPlace();
                        QuatToAxisAngle( l_quat, l_axis, l_angle );
                    }
                    break;

                    case siEulerRot:
                    {
                        CQuaternionf l_quat;
                        CVector3f l_euler( m_X, m_Y, m_Z );
                        XSI::MATH::EulerToQuat( l_euler, l_quat, m_rotOrder );
                        QuatToAxisAngle( l_quat, l_axis, l_angle );
                    }
                    break;
                }

                if ( l_axis.IsNull() )
                {
                    l_axis.Set(1.0, 0.0, 0.0); // If axis is undefined set it to a valid axis
                }
                Set( l_axis, l_angle );
            }
            break;
        }
    }
}

SICPPSDK_INLINE CQuaternionf CRotationf::GetQuaternion() const
SICPPSDK_INLINE CRotationf& XSI::Set ( const RotationOrder  in_order,
const bool  in_bCompensate = false 
)

Change the current rotation from a rotation order with the option of preserving the overall rotation matrix.

If in_bCompensate is true then XYZ rotation angles will be recomputed based on the new rotation order to maintain the overall rotation (so the object's orientation will not change). If false (default), then the XYZ rotation angles are preserved but combined in a different order so the overall rotation will change (the object's orientation will change).

Parameters:
in_order Rotation order type.
in_bCompensate Compensation flag.
Returns:
This rotation
See also:
CRotationf::SetOrder
SICPPSDK_INLINE CRotationf& XSI::Set ( const CVector3f &  in_EulerAngles,
const RotationOrder  in_Order = siXYZ 
)

Sets the current rotation from Euler angles.

Parameters:
in_EulerAngles Vector containing the rotation angles
in_Order Rotation order
Returns:
This rotation
See also:
CRotationf::GetXYZAngles, CRotationf::SetOrder
SICPPSDK_INLINE CRotationf& XSI::Set ( const float  in_X,
const float  in_Y,
const float  in_Z,
const RotationOrder  in_Order = siXYZ 
)

Sets the rotation from Euler angles.

Parameters:
in_X X angle
in_Y Y angle
in_Z Z angle
in_Order Requested rotation order
Returns:
This rotation
See also:
CRotationf::GetXYZAngles, CRotationf::SetOrder
SICPPSDK_INLINE CRotationf& XSI::Set ( const CQuaternionf &  in_Quat )

Sets the rotation from a quaternion.

Parameters:
in_Quat Quaternion to set from
Returns:
This rotation
See also:
CRotationf::GetQuaternion
SICPPSDK_INLINE CRotationf& XSI::Mul ( const CRotationf &  in_rot )

Multiplies this rotation with another one in place.

Parameters:
in_rot Rotation to multiply
Returns:
This rotation
SICPPSDK_INLINE CRotationf& XSI::Mul ( const CRotationf &  in_rot1,
const CRotationf &  in_rot2 
)

Stores the result of the multiplication of two rotations.

Parameters:
in_rot1 First rotation
in_rot2 Second rotation
Returns:
This rotation
SICPPSDK_INLINE CRotationf& XSI::Mul ( const float  in_scalar )

Multiply in-place this rotation with a scalar.

Parameters:
in_scalar scalar multiplier.
Returns:
This rotation
SICPPSDK_INLINE CRotationf & LeftMul ( const CRotationf &  in_rot )

Left multiply in-place this rotation with a rotation.

Parameters:
in_rot Rotation operand
Returns:
This rotation

Definition at line 531 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf & Interpolate ( const CRotationf &  in_rot1,
const CRotationf &  in_rot2,
const float  in_u 
)

Interpolate two rotations into this one for in_u between 0 and 1.

Parameters:
in_rot1 Starting rotation.
in_rot2 Ending rotation.
in_u Interpolation factor between 0 (starting rotation) and 1 (ending rotation).
Returns:
This rotation.

Definition at line 536 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf& XSI::Div ( const CRotationf &  in_rot1,
const float  in_scalar 
)

Divides in-place this rotation with the specified rotation and scalar.

Parameters:
in_rot1 Rotation divisor
in_scalar Scalar multiplier.
Returns:
This rotation
SICPPSDK_INLINE CRotationf & Div ( const float  in_scalar )

Divides in-place this rotation with a scalar.

Parameters:
in_scalar scalar multiplier.
Returns:
This rotation

Definition at line 520 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf & Div ( const CRotationf &  in_rot )

Divides in-place by a rotation.

Same as Mul by Invert.

Parameters:
in_rot Rotation operand.
Returns:
This rotation

Definition at line 515 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf & Div ( const CRotationf &  in_rot1,
const CRotationf &  in_rot2 
)

Divide in-place in_rot1 by in_rot2.

Same as Mul by Invert.

Parameters:
in_rot1 First rotation operand.
in_rot2 Second rotation operand.
Returns:
This rotation

Definition at line 525 of file xsi_rotationf.h.

{
SICPPSDK_INLINE CRotationf& XSI::Invert ( )

Inverts the rotation in place.

Returns:
This rotation
SICPPSDK_INLINE CRotationf& XSI::Invert ( const CRotationf &  in_rot )

Stores the invert of a rotation.

Parameters:
in_rot Rotation to invert
Returns:
This rotation
SICPPSDK_INLINE CQuaternionf XSI::GetQuaternion ( ) const

Returns the quaternion representation of the rotation.

Returns:
CQuaternionf
See also:
CRotationf::Set
SICPPSDK_INLINE CRotationf& XSI::operator= ( const CQuaternionf &  in_Quat )

Sets the rotation from a quaternion.

Parameters:
in_Quat Quaternion to set from
Returns:
This rotation
See also:
CRotationf::Set
SICPPSDK_INLINE CVector3f XSI::GetAxisAngle ( float &  io_Angle ) const

Returns the axis angle representation of the rotation.

Parameters:
io_Angle Rotation angle around the axis
Returns:
CVector3f Axis of rotation
See also:
CRotationf::Set
SICPPSDK_INLINE CRotationf& XSI::Set ( const CVector3f &  in_Axis,
const float  in_Angle 
)

Sets the rotation from an axis angle.

Parameters:
in_Axis Axis of rotation
in_Angle Rotation angle around the axis
Returns:
This rotation
See also:
CRotationf::GetAxisAngle
SICPPSDK_INLINE void XSI::SetIdentity ( )

Sets the rotation to identity rotation.

SICPPSDK_INLINE bool XSI::Equals ( const CRotationf &  in_rot ) const

Performs exact comparison of two quaternions.

Note:
Each parameter of both quaternions must be exactly the same for a match.
Parameters:
in_rot Rotation to compare against
See also:
CRotationf::EpsilonEquals
SICPPSDK_INLINE bool XSI::EpsilonEquals ( const CRotationf &  in_rot,
const float  in_fEpsilon 
) const

Performs comparison between this rotation and in_rot within the specified epsilon value.

Parameters:
in_rot Rotation to compare against.
in_fEpsilon Tolerance value
See also:
CRotationf::EpsilonEquals
SICPPSDK_INLINE bool XSI::operator== ( const CRotationf &  in_rot ) const

Performs exact comparison of two quaternions.

Note:
Each parameter of both quaternions must be exactly the same for a match.
Parameters:
in_rot Rotation to compare against
See also:
CRotationf::EpsilonEquals, CRotationf::Equals
SICPPSDK_INLINE bool XSI::operator!= ( const CRotationf &  in_rot ) const

Inequality operator tests the strict inequality of this rotation with the rotation in_rotation.

Parameters:
in_rot Operand rotation.
Returns:
true if equal else false.
See also:
CRotationf::Equals
SICPPSDK_INLINE bool XSI::operator< ( const CRotationf &  in_rot ) const

Less than operator.

Performs a comparison with a specified CRotationf to determine if this CRotationf is less than the specified CRotationf. The comparison is arbitrary and not geometrically meaningful, it's only purpose is to make CRotationf compliant with stl for sorting operations.

Parameters:
in_rot CRotationf to compare.
Returns:
true if this CRotationf is less than the specified CRotationf, false otherwise.
Since:
7.5
bool XSI::operator== ( CStatus::Code  lhs,
const CStatus &  rhs 
)

The equality operator that takes a Code on the left side and a CStatus object on the right side.

Parameters:
lhs status code
rhs status object
Returns:
bool
bool XSI::operator!= ( CStatus::Code  lhs,
const CStatus &  rhs 
)

The inequality operator that takes a Code on the left side and a CStatus object on the right side.

Parameters:
lhs status code
rhs status object
Returns:
bool
CString XSI::operator+ ( const wchar_t *  in_pwstr,
const CString &  in_refStr 
)

Addition operator.

Returns:
A new string that contains the concatenation of the two arguments.
CString XSI::operator+ ( const wchar_t  in_wchar,
const CString &  in_refStr 
)

Addition operator.

Returns:
A new string that contains the concatenation of the two arguments.
CString XSI::operator+ ( const char *  in_pstr,
const CString &  in_refStr 
)

Addition operator.

Returns:
A new string that contains the concatenation of the two arguments.
Since:
7.5
CString XSI::operator+ ( const char  in_char,
const CString &  in_refStr 
)

Addition operator.

Returns:
A new string that contains the concatenation of the two arguments.
Since:
7.5
bool XSI::operator== ( const double  lhs,
const CTime &  rhs 
)

Equality operator (takes a CTime::Format on the left side and a CTime object on the right side).

Parameters:
lhs time format
rhs time object
Returns:
bool
bool XSI::operator!= ( const double  lhs,
const CTime &  rhs 
)

Inequality operator (takes a CTime::Format on the left side and a CTime object on the right side).

Parameters:
lhs time format
rhs time object
Returns:
bool
XSI::~CSelectionChangeNotification ( )

Default destructor.

const CRefArray& XSI::GetSelectionList ( ) const

Returns a CRefArray holding the new selection list.

Returns:
CRefArray The new selection list

Variable Documentation

X, Y, Z order.

Definition at line 145 of file xsi_base.h.

Definition at line 225 of file xsi_base.h.

const wchar_t* siBoundaryFilter

Filters by boundaries (on active NURBS objects)

const wchar_t* siCameraFilter

Filters by cameras.

const wchar_t* siChainElementFilter

Filters by chain elements.

const wchar_t* siClusterFilter

Filters by clusters.

const wchar_t* siConstraintFilter

Filters by constraints.

const wchar_t* siControlFilter

Filters by control objects.

const wchar_t* siCurveFilter

Filters by curves.

const wchar_t* siEdgeFilter

Filters by edges (on active 3D objects)

const wchar_t* siEffectorFilter

Filters by chain effectors.

const wchar_t* siGenericObjectFilter

Filters by any object.

const wchar_t* siGeometryFilter

Filters by any type of geometric 3D object.

const wchar_t* siGroupFilter

Filters by groups.

const wchar_t* siImplicitFilter

Filters by implicit primitives.

const wchar_t* siIsopointFilter

Filters by isopoints (on active 3D objects)

const wchar_t* siKnotFilter

Filters by knots (on active 3D objects)

const wchar_t* siLatticeFilter

Filters by implicit lattices.

const wchar_t* siLayerFilter

Filters by layers.

const wchar_t* siLightFilter

Filters by lights.

const wchar_t* siLightPartitionFilter

Filters by light partitions.

const wchar_t* siModelFilter

Filters by models.

const wchar_t* siNullFilter

Filters by nulls.

const wchar_t* siObjectFilter

Filters by 3D objects only.

const wchar_t* siObjectPartitionFilter

Filters by object partitions.

const wchar_t* siOperatorFilter

Filters by operators.

const wchar_t* siPointCloudFilter

Filters by point clouds.

const wchar_t* siPointFilter

Filters by points.

const wchar_t* siPolygonFilter

Filters by polygons.

const wchar_t* siPolyMeshFilter

Filters by polygon meshes.

const wchar_t* siPrimitiveFilter

Filters by primitives.

const wchar_t* siPropertyFilter

Filters by properties.

const wchar_t* siSceneFilter

Filters by scenes.

const wchar_t* siShaderFilter

Filters by shaders.

const wchar_t* siSkeletonJointFilter

Filters by skeleton joint properties.

const wchar_t* siSubComponentFilter

Filters by subcomponents.

const wchar_t* siSubSurfaceFilter

Filters by subsurfaces (on active 3D objects)

const wchar_t* siSurfaceCurveFilter

Filters by surface curves (on active 3D objects)

const wchar_t* siSurfaceMeshFilter

Filters by surface meshes.

const wchar_t* siTextureControlFilter

Filters by texture controls.

const wchar_t* siTrimCurveFilter

Filters by trim curves (on active 3D objects)

const wchar_t* siUIsolineFilter

Filters by U isolines (on active 3D objects)

const wchar_t* siVIsolineFilter

Filters by V isolines (on active 3D objects)

const wchar_t* siUKnotCurveFilter

Filters by U knot curves (on active 3D objects)

const wchar_t* siVKnotCurveFilter

Filters by V knot curves (on active 3D objects)

const wchar_t* siWaveFilter

Filters by wave controls.

const wchar_t* siConditionalObjectFilter
const wchar_t* siAutoInspect

TRUE to force the property dialogs to automatically pop up on object creation.

Corresponds to User Preferences > Interaction > General > Automatically Popup Property Editors on Node Creation in the User Interface. Note: This preference cannot be changed permanently via scripting. See Property Editor Automatic Inspection for more information.

const wchar_t* siCompensationFlag

Toggle the Comp button in the Constrain panel.

Possible values are: 0 = off 1 = on Corresponds to Constrain < Compensation in the main-menu.

const wchar_t* siCustomCommandLibCache

This preference enables or disables the custom command library cache.

Disabling the cache allows developers to recompile an add-on library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siCustomOperatorLibCache

This preference enables or disables the custom operator library cache.

Disabling the cache allows developers to recompile an add-on library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siDisplayCallbackLibCache

This preference enables or disables the custom display callback library cache.

Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siDisplayLibCache

This preference enables or disables the custom view library cache.

Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siDisplayPassLibCache

This preference enables or disables the custom display pass library cache.

Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siEventLibCache

This preference enables or disables the event library cache.

Disabling the cache allows developers to recompile an add-on library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siFilterLibCache

This preference enables or disables the custom filter library cache.

Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siMenuLibCache

This preference enables or disables the custom menu library cache.

Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siPropertyLibCache

This preference enables or disables the custom property library cache.

Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siRTShaderLibCache

This preference enables or disables the Realtime shader library cache.

Disabling the cache allows developers to recompile an add-on library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siScrCommandLogEnabled

Set to True to enable command execution logging in the scripting history window.

const wchar_t* siScrCommandLogFileName

Use this user preference to specify the name of the file to use for logging commands and messages.

Use siSrcCommandLogToFile to enable logging to file.

const wchar_t* siScrCommandLogMaxSize

Use this user preference to get and set the maximum size for the scripting command/message log.

const wchar_t* siScrCommandLogToFile

Set to True to log the scripting command/message to a file.

Use siSrcCommandLogFileName to specify the log file name.

Set to True to allow the scripting command/message log to be of an unlimited size.

const wchar_t* siScrLanguage

Use this user preference to get and set the preferred scripting language.

Possible values are: "VBScript" "JScript" "PerlScript" "Python"

const wchar_t* siScrMessageLogEnabled

Set to True to enable message logging in the scripting history window.

Set to True to enable real-time message logging in the scripting history window.

Messages are delivered immediately as they arrive instead of reported at the end of the command execution.

Set to True to display time as frame.

Set to True to use the default frame format or false for a user selected format for display purposes.

Use this user preference to specify the user display frame format.

The value will be corresponding to siDisplayTimeFormat.

Use this user preference to specify the default frame format.

The value will be corresponding to siDefaultTimeFormat.

Use this user preference to access the default frame rate.

const wchar_t* siTransformAxisMode

Set the Transformation Axis Mode.

The values to provide are actually bitmasks with bit zero for X, bit one for Y, and bit two for Z.

const wchar_t* siTransformRefMode

Set the TransRefValues values for a list of possible values.

const wchar_t* siUILayoutDefault

Use this user preference to specify the default current layout that will be used when starting Softimage.

const wchar_t* siAnimationKeyword

Animation property sets.

const wchar_t* siClusterKeyword

Cluster property sets.

const wchar_t* siConstraintKeyword

Constraint property sets.

const wchar_t* siControlObjectKeyword

ControlObject property sets.

const wchar_t* siConverterKeyword

Converter property sets.

const wchar_t* siCurrentKeyword

Reuse keywords in property page dialog.

const wchar_t* siCurveKeyword

Curve property sets.

const wchar_t* siCustomPSetKeyword

CustomPSet property sets.

const wchar_t* siDeformKeyword

Deform property sets.

const wchar_t* siDynamicsKeyword

Dynamics property sets.

const wchar_t* siExpressionsKeyword

Expressions property sets.

const wchar_t* siGeneralKeyword

General property sets.

const wchar_t* siGeneratorKeyword

Generator property sets.

const wchar_t* siGeometryKeyword

Geometry property sets.

const wchar_t* siHairKeyword

Hair property sets.

const wchar_t* siIKKeyword

IK property sets.

const wchar_t* siKinematicsKeyword

Kinematics property sets.

const wchar_t* siMeshKeyword

Mesh property sets.

const wchar_t* siMixerKeyword

Mixer property sets.

const wchar_t* siModelingKeyword

Modeling property sets.

const wchar_t* siOperatorsKeyword

Operators property sets.

const wchar_t* siParticleKeyword

Particle property sets.

const wchar_t* siPrimitiveKeyword

Primitive property sets.

const wchar_t* siProjectionKeyword

Projection property sets.

const wchar_t* siRenderingKeyword

Rendering property sets.

const wchar_t* siSimulationKeyword

Simulation property sets.

const wchar_t* siSurfaceKeyword

Surface property sets.

const wchar_t* siTopologyEditorKeyword

Topology Editor property sets.

const wchar_t* siTopologyKeyword

Topology property sets.

const wchar_t* siViewingKeyword

Viewing property sets.

const wchar_t* siBoundaryCluster

boundary cluster

const wchar_t* siEdgeCluster

edge cluster

const wchar_t* siFaceCluster

face cluster

const wchar_t* siIsoLineUCluster

iso line U cluster

const wchar_t* siIsoLineVCluster

iso line V cluster

const wchar_t* siIsoPointCluster

iso point cluster

const wchar_t* siKnotCluster

knot cluster

const wchar_t* siKnotCurveUCluster

knot curve U cluster

const wchar_t* siKnotCurveVCluster

knot curve V cluster

const wchar_t* siPolygonCluster

polygon cluster

const wchar_t* siPolygonNodeCluster

polygon node cluster

const wchar_t* siSampledPointCluster

sampled point cluster

const wchar_t* siSubCurveCluster

subcurve cluster

const wchar_t* siSubSurfaceCluster

subsurface cluster

const wchar_t* siSurfaceCurveCluster

surface curve cluster

const wchar_t* siTrimCurveCluster

trim curve cluster

const wchar_t* siVertexCluster

vertex cluster

const wchar_t* si0DComponentFamily

0D Component family

const wchar_t* si1DComponentFamily

1D Component family

const wchar_t* si2DComponentFamily

2D Component family

const wchar_t* si3DObjectFamily

3D Object family

Assignment operator family.

const wchar_t* siCameraFamily

Camera family.

const wchar_t* siChainElementFamily

Chain Element family.

Clusterable Component family.

const wchar_t* siClusterFamily

Cluster family.

const wchar_t* siConstraintFamily

Constraint property family.

Contour Contrast shader family.

const wchar_t* siContourShaderFamily

Contour shader family.

Contour Store shader family.

const wchar_t* siControlObjectFamily

Control Object family.

Control Object Nurbs Texture family.

Control Object Texture family.

Control Object Texture Projection family.

const wchar_t* siConverterOperatorFamily

Converter operator family.

const wchar_t* siCurveFamily

Curve Geometry family.

const wchar_t* siDeformOperatorFamily

Deform operator family.

Displacement shader family.

const wchar_t* siEnvironmentShaderFamily

Environment shader family.

const wchar_t* siFxOperatorFamily

Fx Operator family.

const wchar_t* siGeneratorOperatorFamily

Generator operator family.

const wchar_t* siGeometryFamily

Geometry family.

const wchar_t* siGeometryShaderFamily

Geometry shader family.

const wchar_t* siGroupFamily

Group family.

const wchar_t* siImageOperatorFamily

Image Operator family.

const wchar_t* siImplicitGeometryFamily

Implicit Geometry family.

const wchar_t* siKineInfoFamily

KineInfo property family.

const wchar_t* siLatticeFamily

Lattice family.

const wchar_t* siLensShaderFamily

Lens shader family.

const wchar_t* siLightPhotonShaderFamily

Light Photon shader family.

const wchar_t* siLightPrimitiveFamily
const wchar_t* siLightShaderFamily

Light shader family.

const wchar_t* siMaterialFamily

Material property family.

const wchar_t* siMaterialShaderFamily

Material shader family.

const wchar_t* siMeshFamily

Mesh Geometry family.

const wchar_t* siNullPrimitiveFamily
const wchar_t* siNurbsCurveListFamily

Nurbs CurveList Geometry family.

const wchar_t* siNurbsSurfaceMeshFamily

Nurbs Surface Mesh Geometry family.

const wchar_t* siOperatorFamily

Operator family.

const wchar_t* siOutputShaderFamily

Output shader family.

Particle Control Object family.

const wchar_t* siParticleFamily

Particle family.

const wchar_t* siPassFamily

Pass family.

const wchar_t* siPatchNetworkFamily

Patch Network family.

const wchar_t* siPhotonShaderFamily

Photon shader family.

const wchar_t* siPlanarObjectFamily

Planar Object family.

const wchar_t* siPointCloudFamily

Point Cloud Geometry family.

const wchar_t* siPropertyFamily

Property family.

const wchar_t* siRealTimeShaderFamily

RealTime shader family.

const wchar_t* siShaderFamily

Shader family.

const wchar_t* siShadowShaderFamily

Shadow shader family.

const wchar_t* siSubComponentFamily

SubComponent family.

const wchar_t* siSurfaceCurveFamily

Surface Curve Geometry family.

const wchar_t* siSurfaceFamily

Surface Geometry family.

const wchar_t* siTextureShaderFamily

Texture shader family.

const wchar_t* siTopologyOperatorFamily

Topology operator family.

const wchar_t* siVirtualComponentFamily

Virtual Component family.

const wchar_t* siVirtualCurveFamily

Virtual Curve family.

const wchar_t* siVolumeShaderFamily

Volume shader family.

const wchar_t* si2PntCnsType

Two Points Constraint type.

const wchar_t* si3DObjectType

3D Object type

const wchar_t* si3PntCnsType

Three Points Constraint type.

const wchar_t* siActionClipType

Action Clip type (instanced action)

const wchar_t* siActionType

Action type.

const wchar_t* siAddEdgeOpType

AddEdge Operator type (add an edge between an existing point and an existing edge)

const wchar_t* siAddMeshPntOpType

Add Mesh Points Operator type.

const wchar_t* siAddNurbsCrvPntOpType

Add Nurbs Curve Points Operator type.

const wchar_t* siAddNurbsSrfPntOpType

Add Nurbs Surface Points Operator type.

const wchar_t* siAddPntMiddleCrvType

Add Point Inside Curve Operator type.

const wchar_t* siAddPntMiddleSrfOpType

Add Point Inside Surface Operator type.

const wchar_t* siAmbientLightingType

Ambient Lighting type.

const wchar_t* siArcPrimType

Implicit Arc Primitive type.

const wchar_t* siAttractorCtrlType

Attractor Control Object type (electric force)

const wchar_t* siAutoCageAssignOpType

Automatic Cage Assignment Operator type.

const wchar_t* siAutoEnvAssignOpType

Automatic Envelope Assignment Operator type.

const wchar_t* siBallJointCnsType

Ball Joint Constraint type.

const wchar_t* siBasePathCnsType

Base Path Constraint type.

const wchar_t* siBendOpType

Bend Operator type.

const wchar_t* siBevelOpType

Bevel Operator type (bevel geometry component)

const wchar_t* siBirail2GenOpType

Birail2Generators Operator Type.

const wchar_t* siBirailOpType

Birail Operator type (generates a surface from 2 curves and a profile)

const wchar_t* siBlasterOpType

Blaster Operator type.

const wchar_t* siBlendCrvOpType

Blend Curves Operator type (create a blended curve between two existing curves)

const wchar_t* siBlendSrfOpType

Blend Surfaces Operator type (blend surfaces)

const wchar_t* siBooleanGenOpType

Boolean Generator Operator type.

const wchar_t* siBooleanSrfTopoOpType

Boolean Surface Operator type.

const wchar_t* siBPlaneCnsType

Bounding Plane Constraint type.

const wchar_t* siBridgeOpType

Bridge Op Operator type (bridge polygon)

const wchar_t* siBrushPropertiesType

Brush Properties type.

const wchar_t* siBulgeOpType

Bulge Op Operator type.

const wchar_t* siBVolCnsType

Bounding Volume Constraint type.

const wchar_t* siCageDeformOpType

Cage Deform Operator type.

const wchar_t* siCamDispType

Camera Display type.

const wchar_t* siCameraLensFlareType

Camera Lens Flare type.

const wchar_t* siCameraPrimType
const wchar_t* siCameraRootPrimType

Camera Root primitive type.

const wchar_t* siCameraTxtOpType

CameraTxt Operator type (camera texture projection operator)

const wchar_t* siCamVisType

Camera Visibility type.

const wchar_t* siCapOpType

CapOp type.

const wchar_t* siCenterOpType

Center Operator type (center manipulation)

const wchar_t* siChainBonePrimType

Chain Bone Primitive type.

const wchar_t* siChainEffPrimType

Chain End Effector Primitive type.

const wchar_t* siChainRootPrimType

Chain Root Primitive type.

const wchar_t* siCirclePrimType

Implicit Circle Primitive type.

const wchar_t* siCleanCrvOpType

Clean Curve Operator type.

const wchar_t* siCleanSrfOpType

Clean Surface Operator type.

const wchar_t* siClothOpType

Cloth Operator type.

const wchar_t* siClothPropType

Cloth Property type.

const wchar_t* siCloudPrimType

Cloud Primitive type.

const wchar_t* siClsColorType

Cluster Color type.

const wchar_t* siClsCtrOpType

Cluster Center Operator type (cluster center deformation)

const wchar_t* siClsKeyType

Cluster Key type.

const wchar_t* siClsKeyWgtMapOpType

Cluster Key Weight Map Operator type.

const wchar_t* siClsPoseType

Cluster Pose type.

const wchar_t* siClsShapeCombinerOpType

Cluster Shape Combiner Operator type.

const wchar_t* siClsUVSpaceTxtType

Cluster Property UV Texture Projection type.

const wchar_t* siCoBBoxSclOpType

CoBBoxSclOp type.

const wchar_t* siCollapseOpType

Collapse Operator type (collapse geometry component)

const wchar_t* siConePrimType

Cone Primitive type.

const wchar_t* siCoPoseFCrvOpType

CoPoseFCurveOp type.

const wchar_t* siCopyOpType

Copy Operator type (geometry copy operator for instances)

const wchar_t* siCopyShapeOpType

copyshape operator type

const wchar_t* siCopyUVWOpType

CopyUVW Operator type.

const wchar_t* siCreatePolyOpType

Create Polygon Operator type.

const wchar_t* siCrvCnsType

Curve Constraint type.

const wchar_t* siCrvCreationOpType

Curve Creation Operator type.

const wchar_t* siCrvCtrlOpType

CrvControlOp type.

const wchar_t* siCrvCutOpType

CrvCutOp type.

const wchar_t* siCrvDeformOpType

Curve Deform Operator type.

NURBS Curve List Aggregate Primitive type.

const wchar_t* siCrvListPrimType

NURBS Curve List Primitive type.

const wchar_t* siCrvListToMeshOpType

Curve To Mesh Converter Operator type (curve list to polygon mesh converter)

const wchar_t* siCrvNetOpType

Curve Net Operator type.

const wchar_t* siCrvOpenCloseOpType

Open/Close Curve Operator type (open or close a curve)

const wchar_t* siCrvReparamOpType

Reparameterize Curve Operator type.

const wchar_t* siCrvShiftOpType

Curve Shift Operator type.

const wchar_t* siCubePrimType

Cube Primitive type.

const wchar_t* siCustomParamSet

Custom Parameter Set type.

const wchar_t* siCycleUVWType

Cycleuvw Operator type.

const wchar_t* siCylinderPrimType

Cylinder Primitive type.

const wchar_t* siDeformBySpineOp2Type

Deform By Spine Operator type (alternate envelope by spine operator)

const wchar_t* siDeformBySpineOpType

Deform by spine operator type (envelope by spine)

const wchar_t* siDeformOpType

Base Deform Operator type.

const wchar_t* siDeleteCompOpType

Delete Component Operator type (delete geometry component)

const wchar_t* siDelPntCrvOpType

Delete Point From Curve Operator type.

const wchar_t* siDGlowType

DGlow type.

const wchar_t* siDirCnsType

Direction Constraint type.

const wchar_t* siDiscPrimType

Disc Primitive type.

const wchar_t* siDisplayType

Display type.

const wchar_t* siDissolveCompOpType

Dissolve Component Operator type (dissolve geometry component)

const wchar_t* siDistanceOpType

Distance Operator type.

const wchar_t* siDistCnsType

Distance Constraint type.

const wchar_t* siDodecahedronPrimType

Dodecahedron Primitive type.

const wchar_t* siDragCtrlPrimType

Drag Control Primitive type.

const wchar_t* siEddyCtrlPrimType

Eddy Control Primitive type.

const wchar_t* siEditPolyOpType

Edit Polygon Operator type.

const wchar_t* siEmissionPropType

Emission Property type.

const wchar_t* siEnvelopOpType
const wchar_t* siEnvSelClsOpType
const wchar_t* siEnvWgtType

Envelope Weights type.

const wchar_t* siExplosionOpType

Explosion Operator type.

const wchar_t* siExtendCrv2PntOpType

Extend Curve To Point Operator type.

const wchar_t* siExtendToCrvOpType

Extend To Curve Operator type (extend the surface to the selected curve)

const wchar_t* siExtractCrvOpType

Extract Curve Operator type.

const wchar_t* siExtractCrvSegOpType

Extract Curve Segment Operator type (extract a curve from a segment of an existing curve)

const wchar_t* siExtractPolyOpType

Extract Polygons Operator type.

const wchar_t* siExtractSubCrvOpType

Extract Subcurve Operator type.

const wchar_t* siExtrude2ProfsOpType

Extrusion 2 Profiles Operator type (extrude 2 profiles)

const wchar_t* siExtrudeCompAxisOpType

Extrude Component Axis Operator type (extrude geometry component)

const wchar_t* siExtrudeComponentOpType

Extrude Component Operator type (extrude geometry component)

const wchar_t* siExtrusionOpType

Extrusion Operator type (extrude a curve to create a surface)

const wchar_t* siFanType

Fan Force Object type.

const wchar_t* siFilletCrvOpType

Fillet Curves Operator type (intersecting or not)

const wchar_t* siFilletSrfOpType

Fillet Surfaces Operator type.

const wchar_t* siFillHoleOpType

Fill Hole Operator type.

const wchar_t* siFilterEdgeOpType
const wchar_t* siFilterPolyOpType

Polygon Filter Operator type.

const wchar_t* siFitCrvOpType

Fit Curve Operator type (fit a new curve on to the selected curve)

const wchar_t* siFitSrfOpType

Fit Surface Operator type (fit a new surface on to the selected surface)

const wchar_t* siFlipUVWOpType

Flip UVW Operator type.

const wchar_t* siFluidOpType

Fluid Operator type.

const wchar_t* siFoldOpType

Fold Operator type.

const wchar_t* siFourSidedOpType

Four Sided Operator type.

const wchar_t* siFurOpType

Fur Operator type (fur generator operator)

const wchar_t* siFurPrimType

Fur Primitive type.

const wchar_t* siFurPropType

Fur Property type.

const wchar_t* siFurSimOpType

Fur Simulation Operator type.

const wchar_t* siGeneratorOpType

Base Generator Operator type.

const wchar_t* siGeomApproxType

Geometry Approximation type (tesselation)

const wchar_t* siGeoShaderPrimType

GeoShader Primitive Type.

const wchar_t* siGeoTxtOpType

GeoTxtOp type (copy geometry xyz to uvw texture operator)

const wchar_t* siGlobalType

Global Transform type.

const wchar_t* siGravityCtrlType

Gravity Force Control Object type.

const wchar_t* siGridPrimType

Grid Primitive type.

const wchar_t* siGroup

Group type (obsolete)

const wchar_t* siGroupType

Group type.

const wchar_t* siHealOpType

Heal Operator type.

const wchar_t* siHealUVWOpType

Heal UVW Operator type.

const wchar_t* siIcosahedronPrimType

Icosahedron Primitive type.

const wchar_t* siImageClipType
const wchar_t* siImageCropOpType

Image Crop Operator type.

const wchar_t* siImageFXOpType

Image FX Operator type.

const wchar_t* siImageObjectType

Image Object type.

const wchar_t* siImageSourceOpType
const wchar_t* siImageSourceType

Image Source type.

const wchar_t* siInsertCrvKnotOpType

Insert Curve Knot Operator type.

const wchar_t* siInsSrfKnotOpType

Insert Surface Knot Operator type (inserts a knot in a nurbs surface)

const wchar_t* siIntersectSrfOpType

Intersect Surfaces Operator type (extract a curve from the intersection of two surfaces)

const wchar_t* siInvCrvOpType

Inverse Curve Operator type (inverse curve direction)

const wchar_t* siInvertPolyOpType

Invert Polygon Operator type.

Name of the InvisiblePolygons cluster.

const wchar_t* siInvSrfOpType

Inverse Normals Operator type (inverse normals direction)

const wchar_t* siKineChainPropType

Kinematic Chain Properties type.

const wchar_t* siKineChainType

Kinematic Chain type.

const wchar_t* siKineCnsType

Kinematic Constraint type.

const wchar_t* siKineInfoType

Kinematics Information type.

const wchar_t* siKineJointType

Kinematic Joint type.

const wchar_t* siLatticeOpType

Lattice Operator type.

const wchar_t* siLatticePrimType

Lattice Primitive type.

const wchar_t* siLayersType

Layers type.

const wchar_t* siLightLensFlareType

Light Lens Flare type.

const wchar_t* siLightPrimType
const wchar_t* siLineCnsType

Line Constraint type.

const wchar_t* siLocalType

Local Transform type.

const wchar_t* siLoftOpType

Loft Generator Operator type.

const wchar_t* siMapCompOpType

Component Map Operator type.

Mark Hard Edge/Vertex Operator type.

const wchar_t* siMaterialType

Material type.

const wchar_t* siMergeCrvOpType

Merge Curves Operator type.

const wchar_t* siMergeMeshOpType

Merge Meshes Operator type.

const wchar_t* siMergeSrfOpType

Merge Surfaces Operator type.

Mesh Local Subdivision Operator type.

const wchar_t* siMeshSubdivOpType

Mesh Subdivision Operator type.

Mesh Subdivide With Center Operator type (mesh subdivision with center)

const wchar_t* siMixerAnimClipType

Mixer Animation Clip type.

const wchar_t* siMixerAnimTrackType

Mixer Animation Action Track type.

const wchar_t* siMixerAudioClipType

Mixer Audio Clip type.

const wchar_t* siMixerAudioTrackType

Mixer Audio Track type.

const wchar_t* siMixerPropType
const wchar_t* siMixerShapeClipType

Mixer Shape Clip type.

const wchar_t* siMixerShapeTrackType

Mixer Shape Track type.

const wchar_t* siMixerType

Mixer type (property)

const wchar_t* siModelClipType

3D Model Clip type

const wchar_t* siModelNullPrimType
const wchar_t* siModelType

3D Model type

const wchar_t* siMotionBlurType

Motion Blur type.

const wchar_t* siMoveComponentOpType

Move Component Operator type.

const wchar_t* siNPntCnsType

N Points Constraint type.

const wchar_t* siNullPrimType
const wchar_t* siNurbsToMeshOpType

Nurbs To Mesh Operator type.

const wchar_t* siObjClsCnsType

Object To Cluster Constraint type.

const wchar_t* siObstaclePropType

Obstacle Property type.

const wchar_t* siOctahedronPrimType

Octahedron Primitive type.

const wchar_t* siOffsetClsOpType

Offset Cluster Operator type.

const wchar_t* siOffsetCrvOpType

Offset Curve Operator type.

const wchar_t* siOffsetSrfOpType

Offset Surface Operator type (offset a surface to create a new surface)

const wchar_t* siOpenCloseSrfOpType

Open/Close Surface Operator type (open or close a surface)

const wchar_t* siOriCnsType

Orientation Constraint type.

const wchar_t* siOverrideType

Override type.

const wchar_t* siParDecayType

Particle decay type.

const wchar_t* siParObstExtSparksType

ParObstExtSparks type.

const wchar_t* siParticleEventType

Particle Event type.

const wchar_t* siParticlesOpType

Particles Operator type.

const wchar_t* siPathCnsType

Path Constraint type.

const wchar_t* siPinJointCnsType
const wchar_t* siPlaneCnsType

Plane Constraint type.

const wchar_t* siPointCloudPrimType

Point CloudPrimitive type.

const wchar_t* siPolyMeshPNetOpType

PolyMeshPNetOp type.

const wchar_t* siPolyMeshType

Polygon Mesh type.

const wchar_t* siPosCnsType

Position Constraint type.

const wchar_t* siPoseCnsType

Pose Constraint type.

const wchar_t* siProjectCrvOpType

Project Curve Operator type (project a curve on to a surface)

const wchar_t* siProportionalOpType

Proportional Modeling Operator type.

const wchar_t* siPropVolumeOpType

Proportional Volume Operator type.

const wchar_t* siPushOpType

Push Operator type.

const wchar_t* siQStretchOpType

QStretch Operator type (quick stretch)

const wchar_t* siRandomizeOpType

Randomize Operator type.

const wchar_t* siRefPlaneType

Reference Plane type.

const wchar_t* siRelaxUVWOpType

Relax UVW Operator type.

const wchar_t* siRemoveCrvKnotOpType

Remove Curve Knot Operator type.

const wchar_t* siRemSrfKnotOpType

Remove Surface Knot Operator type (removes a knot from a nurbs surface)

const wchar_t* siRenderMapType

Render Map type.

const wchar_t* siRevolutionOpType

Revolution Operator type.

const wchar_t* siRotoscopeType

Camera Rotoscopy type.

const wchar_t* siSceneAmbienceType

Scene Ambience type.

const wchar_t* siSceneColorsType

Scene Display Colors type.

const wchar_t* siSclCnsType

Scaling Constraint type.

const wchar_t* siSCMFixerOpType

SCM Fixer Operator type.

const wchar_t* siSCMTopologyOpType

SCM Topology Operator type.

const wchar_t* siScriptedOpType

Scripted Operator type (scripted operator host)

Set Edge Crease Value Operator type.

Shape Action Compound Clip type (base compound clip)

const wchar_t* siShapeActionType

Shape Action type.

const wchar_t* siVisemeActionType

Viseme Action type.

const wchar_t* siShearOpType

Shear Operator type.

const wchar_t* siShrinkWrapOpType

Shrink Wrap Operator type.

const wchar_t* siSkelCtrlOpPropType

Skeleton Controller Operator type.

const wchar_t* siSmoothEnvelopeWgtOpType

Smooth Envelope Weight Operator type.

const wchar_t* siSnapBoundOpType

Snap Boundary Operator type.

const wchar_t* siSnapCrvOpType

Snap To Curves Operator type.

const wchar_t* siSnipSrfOpType

Snip Surface Operator type.

const wchar_t* siSoftBodyOpType

SoftBody Operator type.

const wchar_t* siSpherePrimType

Sphere Primitive type.

const wchar_t* siSpineDefOp2Type

Deform by Spine Operator 2 type (alternate operator)

const wchar_t* siSpineDefOpType

Deform by Spine Operator type.

const wchar_t* siSpineWgtMapOp3Type

Spine Weight Map Operator 3 type.

const wchar_t* siSpineWgtMapOp4Type

Deform by Spine Weight Map Operator 4 type.

const wchar_t* siSpiralPrimType

Implicit Spiral Primitive type.

const wchar_t* siSplitEdgeOpType

Split Edge Operator type (split some edges)

const wchar_t* siSplitPolyOpType

Split Polygon Operator type (split some polygons)

const wchar_t* siSpotInterestPrimType

Spot Interest Primitive type.

const wchar_t* siSpotRootPrimType

Spot Root Primitive type.

const wchar_t* siSquarePrimType

Implicit Square Primitive type.

const wchar_t* siSrfCnsType

Surface Constraint type.

const wchar_t* siSrfCrvInverseOpType

Surface Curve Inverse Operator type.

const wchar_t* siSrfCrvShiftOpType

Surface Curve Shift Operator type.

const wchar_t* siSrfCtrlOpType

SrfControlOp type.

const wchar_t* siSrfDefOpType

Surface Deform Operator type.

const wchar_t* siSrfMeshPrimType

NURBS Surface Mesh Primitive type.

const wchar_t* siSrfPQOpType

SurfacePQ Operator type.

const wchar_t* siSrfReparamOpType

Reparameterize Surface Operator type.

const wchar_t* siSrfShiftOpType

Surface Shift Operator type.

const wchar_t* siSrfSubdivisionOpType

Surface Subdivision Operator type.

const wchar_t* siSrfUVCtrlOpType

Surface UV Control Operator type (Nurbs UV control)

const wchar_t* siStandInPrimType

Stand-in Primitive type.

const wchar_t* siStartOffsetOpType

Start Offset Operator type.

const wchar_t* siStitchCrvToCrvOpType

Stitch Curve To Curve Operator type (stitch curves together)

const wchar_t* siStitchCrvToSrfOpType

Stitch Curve To Surface Operator type.

const wchar_t* siStitchSrfOpType

Stitch Surfaces Operator type (stitch surfaces and curves together)

const wchar_t* siStrokeOpType

Gap Stroke Operator type.

const wchar_t* siSubCompType

Subcomponents type.

const wchar_t* siSubdivEdgeOpType

Subdivide Edge Operator type.

const wchar_t* siSubdivPolyOpType

Subdivide Polygon Operator type.

const wchar_t* siSwapSrfUVOpType

Swap Surface UVs Operator type.

const wchar_t* siSymmetrizePolygon

Symmetrize Polygon Operator type.

const wchar_t* siSymmetryCnsType

Symmetry Constraint type.

const wchar_t* siSymmetryMapOpType

Symmetry Map Genrator Operator type.

const wchar_t* siSymmetryMapType

Symmetry Map type.

const wchar_t* siSynopticViewType

Synoptic View type.

const wchar_t* siTaperOpType

Taper Operator type.

const wchar_t* siTetrahedronPrimType

Tetrahedron Primitive type.

const wchar_t* siTextToCrvListOpType

Text To CurveList Operator type.

const wchar_t* siTorusPrimType

Torus Primitive type.

const wchar_t* siTrajCnsType

Trajectory Constraint type.

const wchar_t* siTransformSetupType

Transform Setup type.

const wchar_t* siTurbulenceCtrlPrimType

Turbulence Control Primitive type.

const wchar_t* siTwistOpType

Twist Operator type.

const wchar_t* siTxtMapType

Texture Map type.

const wchar_t* siTxtOpType

Texture Projection Operator type.

const wchar_t* siTxtSupportType

Texture Support type.

const wchar_t* siUpVctCnsType

Up Vector Constraint type.

const wchar_t* siUserMotionType

User Motion Property type.

const wchar_t* siUserNormalType

User Normal Property type.

const wchar_t* siUVProjDefType

UV Projection Definition type (definition of how to perform a texture projection)

const wchar_t* siVertexcolorType

Vertex Color type.

const wchar_t* siVisibilityType

Visibility type.

const wchar_t* siVolumeDeformType

Volume Deform type (implicit sphere volume)

const wchar_t* siVolumicLightSceneType

Volumic Light Scene Local Property Set type.

const wchar_t* siVolumicLightType

Volumic Light Effect type.

const wchar_t* siVortexCtrlType

Vortex Control Object type (magnetic force)

const wchar_t* siVtxColPainterOpType

Vertex Color Painter Operator type.

const wchar_t* siVtxColPropOpType

Vertex Color Property Generator Operator type.

const wchar_t* siWaveCtrlType

Wave Control Object type.

const wchar_t* siWaveOpType

Wave Operator type.

const wchar_t* siWeldEdgesOpType

Weld Edges Operator type (weld pair of edges together)

const wchar_t* siWeldPntOpType

Weld Points Operator type (weld two points together)

const wchar_t* siWgtMapCnxOpType

Weight Map Connection Operator type.

const wchar_t* siWgtMapOpType

Weight Map Generator Operator type.

const wchar_t* siWgtMapsMixOpType

Weight Maps Mixer Operator type.

const wchar_t* siWgtMapType

Weight Map type.

const wchar_t* siWgtPainterOpType

Weight Painter Operator type.

const wchar_t* siWindType

Wind Force Object type.

const wchar_t* siWtStrokeOpType

Weight Stroke Operator type.

const wchar_t* siControlBitmap
const wchar_t* siControlBoolean
const wchar_t* siControlButton
const wchar_t* siControlCheck
const wchar_t* siControlCombo
const wchar_t* siControlEdit
const wchar_t* siControlFCurve
const wchar_t* siControlFilePath
const wchar_t* siControlFolder
const wchar_t* siControlGrid
const wchar_t* siControlIconList
const wchar_t* siControlImageClip
const wchar_t* siControlListBox
const wchar_t* siControlNumber
const wchar_t* siControlRadio
const wchar_t* siControlRGB
const wchar_t* siControlRGBA
const wchar_t* siControlStatic
const wchar_t* siControlString
const wchar_t* siControlSynoptic
const wchar_t* siControlTextEditor
const wchar_t* siUIAlignCenter
const wchar_t* siUIAlignLeft
const wchar_t* siUIAlignRight
const wchar_t* siUIAudioFile
const wchar_t* siUICaption
const wchar_t* siUIColumnCnt
const wchar_t* siUIColumnGap
const wchar_t* siUIContinue
const wchar_t* siUICX
const wchar_t* siUICY
const wchar_t* siUIDecimals
const wchar_t* siUIFCurveGhosting
const wchar_t* siUIFCurveGridSpaceX
const wchar_t* siUIFCurveGridSpaceY
const wchar_t* siUIFCurveLabelX
const wchar_t* siUIFCurveLabelY
const wchar_t* siUIFCurveNoGrid
const wchar_t* siUIFCurveNoRulerX
const wchar_t* siUIFCurveNoRulerY
const wchar_t* siUIFCurveShowTimeCursor
const wchar_t* siUIFCurveSnapX
const wchar_t* siUIFCurveSnapY
const wchar_t* siUIFCurveViewMaxX
const wchar_t* siUIFCurveViewMaxY
const wchar_t* siUIFCurveViewMinX
const wchar_t* siUIFCurveViewMinY
const wchar_t* siUIFileFilter
const wchar_t* siUIFileMustExist
const wchar_t* siUIFilePath
const wchar_t* siUIImageFile
const wchar_t* siUIInitialDir
const wchar_t* siUILabel
const wchar_t* siUILabelMinPixels
const wchar_t* siUILabelPercentage
const wchar_t* siUILineCnt
const wchar_t* siUILineGap
const wchar_t* siUILogarithmic
const wchar_t* siUIMultiSelectionListBox
const wchar_t* siUINoLabel
const wchar_t* siUINoSlider
const wchar_t* siUIOpenFile
const wchar_t* siUISelectionColor
const wchar_t* siUIShowClip
const wchar_t* siUIShowFrame
const wchar_t* siUIButtonDisable
const wchar_t* siUIGridColumnWidths
const wchar_t* siUIGridHideColumnHeader
const wchar_t* siUIGridHideRowHeader
const wchar_t* siUIGridLockColumnHeader
const wchar_t* siUIGridLockRowHeader
const wchar_t* siUIGridReadOnlyColumns
const wchar_t* siUIGridSelectionMode
const wchar_t* siUIGridShowColumns
const wchar_t* siUIStyle
const wchar_t* siUISubFolder
const wchar_t* siUISyncSlider
const wchar_t* siUIThumbWheel
const wchar_t* siUITreadmill
const wchar_t* siUIItems
const wchar_t* siUIType
const wchar_t* siUIUseSelectionIcon
const wchar_t* siUIValueOnly
const wchar_t* siUIWidthPercentage
const wchar_t* siUILineNumbering
const wchar_t* siUIFolding
const wchar_t* siUIBackgroundColor
const wchar_t* siUIForegroundColor
const wchar_t* siUIFont
const wchar_t* siUICommentColor
const wchar_t* siUIPreprocessorColor
const wchar_t* siUIMarginWidth
const wchar_t* siUICommentFont
const wchar_t* siUIFontSize
const wchar_t* siUIKeywords
const wchar_t* siUIHeight
const wchar_t* siUIHorizontalScroll
const wchar_t* siUIVerticalScroll
const wchar_t* siUILineWrap
const wchar_t* siUIKeywordFile
const wchar_t* siUIAutoComplete
const wchar_t* siUIToolbar
const wchar_t* siUICapability
const wchar_t* siUIDictionary
const wchar_t* siUIHelpFile
const wchar_t* siUIHelpID

Reference to a topic in the Help file.Normally this is only used for internal objects.

const wchar_t* siUILanguage
const wchar_t* siUILogic
const wchar_t* siUILogicFile
const wchar_t* siUILogicPrefix
const wchar_t* siUIShowChildren
const wchar_t* siArgHandlerCollection
const wchar_t* siArgHandlerFrame
const wchar_t* siArgHandlerFrameRate
const wchar_t* siArgHandlerSingleObj
const wchar_t* siFilter3DObjectType

Represents the filter objects that can be used with 3D objects.

const wchar_t* siFilterObjectType
const wchar_t* siFilterPropertyType

Represents the filter objects that can be used with property objects.

const wchar_t* siFilterSubComponentType
const wchar_t* siClipAnimationType
const wchar_t* siClipAnimCompoundType
const wchar_t* siClipAudioType

Represents clip objects which are instances of audio files.

const wchar_t* siClipImageType

Represents an ImageClip object.

const wchar_t* siClipMixerType

Represents clip objects which are the top-level container for all other clip objects.

const wchar_t* siClipShapeCompoundType
const wchar_t* siClipShapeType
const wchar_t* siTrackAnimationType
const wchar_t* siTrackAudioType

Represents the track objects which organize audio Clip objects.

const wchar_t* siTrackShapeType

Represents the track objects which organize shape Clip objects.

const wchar_t* siTransitionBridgeType
const wchar_t* siTransitionCardinalType
const wchar_t* siTransitionStandardType
const wchar_t* siAnimCompoundAnimItem

Represents a compound animation source stored in an ActionSource.

const wchar_t* siConstraintAnimItem

Represents an Constraint stored in an ActionSource.

const wchar_t* siExpressionAnimItem

Represents an Expression stored in an ActionSource.

const wchar_t* siFCurveAnimItem

Represents an FCurve stored in an ActionSource.

const wchar_t* siShapeCompoundAnimItem

Represents a shape compound source stored in an ActionSource.

const wchar_t* siShapeKeyAnimItem

Represents an ShapeKey stored in an ActionSource.

const wchar_t* siStaticValueAnimItem

Represents an StaticSource stored in an ActionSource.

const wchar_t* siCompoundMappedItem

Represents a compound item in a compound clip.

const wchar_t* siConstraintMappedItem
const wchar_t* siExpressionMappedItem
const wchar_t* siFCurveMappedItem
const wchar_t* siShapeCompoundMappedItem

Represents a shape compound item in a compound clip.

const wchar_t* siShapeKeyMappedItem
const wchar_t* siStaticValueMappedItem
const wchar_t* siSEFilterActionNodes

Show only Action nodes.

const wchar_t* siSEFilterAllNodeTypes

Show All Node types.

const wchar_t* siSEFilterAnimatableNodes

Show only Animatable parameter nodes.

const wchar_t* siSEFilterAnimatedNodes

Show only Animated parameter nodes.

const wchar_t* siSEFilterClusterNodes

Show only Cluster nodes.

const wchar_t* siSEFilterGroupNodes

Show only Group nodes.

const wchar_t* siSEFilterKeywordAll

Show nodes with any keyword set.

Show nodes with Animation keyword set.

const wchar_t* siSEFilterKeywordCustom

Show nodes with Custom keyword set.

const wchar_t* siSEFilterKeywordGeneral

Show nodes with General keyword set.

Show nodes with Kinematics keyword set.

const wchar_t* siSEFilterKeywordModeling

Show nodes with Modeling keyword set.

Show nodes with Rendering keyword set.

const wchar_t* siSEFilterKeywordViewing

Show nodes with Viewing keyword set.

const wchar_t* siSEFilterMaterialNodes

Show only Material nodes.

Show only Miscellaneous nodes.

const wchar_t* siSEFilterModelNodes

Show only Model nodes.

const wchar_t* siSEFilterObjectNodes

Show only Object nodes.

const wchar_t* siSEFilterOperatorNodes

Show only Operator nodes.

const wchar_t* siSEFilterParameterNodes

Show only regular Parameter (non-animatable) nodes.

const wchar_t* siSEFilterPrimitiveNodes

Show only Primitive nodes.

const wchar_t* siSEFilterPropertyNodes

Show only Property nodes.

const wchar_t* siSEFilterSceneNodes

Show only Scene nodes.

const wchar_t* siSEFilterShaderNodes

Show only Shader nodes.

const wchar_t* siImageDataTypeRGBA

Represents a four channel RGB color image, where the fourth channel is the alpha matte.

const wchar_t* siImageDataTypeRGB

Represents a three channel, RGBA color image.

const wchar_t* siImageDataTypeRGBE

Represents a four channel, RGB color image, where the fourth channel is an exponent.

Used for HDR images.

const wchar_t* siImageDataTypeAlpha

Represents a single channel, alpha matte image.

const wchar_t* siImageDataTypeIntensity

Represents a single channel, grayscale intensity image.

const wchar_t* siImageDataTypeDepth

Represents a single channel, depth value image.

const wchar_t* siImageDataTypeNormal

Represents a three channel, vector image composed of normalized vectors.

const wchar_t* siImageDataTypeMotion

Represents a three channel, motion vector image.

const wchar_t* siImageDataTypeVector

Represents a three channel image composed of arbitrary vectors.

const wchar_t* siImageDataTypePoint

Represents a three channel image composed of arbitrary points in space.

const wchar_t* siImageDataTypeLabel

Represents a single channel, object label image.

const wchar_t* siImageDataTypeBitMask

Represents a single channel, single bit-mask image.

const wchar_t* siATFilterPresetAll

Display all nodes for the selected elements.

const wchar_t* siATFilterPresetCustom

Display any type of custom parameter set for the selected elements.

This includes proxy parameter sets, marking sets, and annotation properties.

const wchar_t* siATFilterPresetGeneral

Display only the general properties for the selected elements.

const wchar_t* siATFilterPresetModeling

Display only the modeling properties for the selected elements.

const wchar_t* siATFilterPresetAnimation

Display only the animation properties for the selected elements.

Display only the kinematics properties for the selected elements.

const wchar_t* siATFilterPresetRendering

Display only the rendering properties for the selected elements.

const wchar_t* siATFilterPresetViewing

Display only the viewing properties for the selected elements.

Display only the local transform parameters for the selected elements.

const wchar_t* siATFilterPresetPosition

Display only the position parameters for the selected elements.

const wchar_t* siATFilterPresetPositionX

Display only the position in X parameters for the selected elements.

const wchar_t* siATFilterPresetPositionY

Display only the position in Y parameters for the selected elements.

const wchar_t* siATFilterPresetPositionZ

Display only the position in Z parameters for the selected elements.

const wchar_t* siATFilterPresetRotation

Display only the rotation parameters for the selected elements.

const wchar_t* siATFilterPresetRotationX

Display only the rotation in X parameters for the selected elements.

const wchar_t* siATFilterPresetRotationY

Display only the rotation in Y parameters for the selected elements.

const wchar_t* siATFilterPresetRotationZ

Display only the rotation in Z parameters for the selected elements.

const wchar_t* siATFilterPresetScaling

Display only the scaling parameters for the selected elements.

const wchar_t* siATFilterPresetScalingX

Display only the scaling in X parameters for the selected elements.

const wchar_t* siATFilterPresetScalingY

Display only the scaling in Y parameters for the selected elements.

const wchar_t* siATFilterPresetScalingZ

Display only the scaling in Z parameters for the selected elements.

const wchar_t* siATFilterPresetColor

Display only the color parameters for the selected elements.

const wchar_t* siATFilterTaggedAll

Filter all tagged parameters.

const wchar_t* siATFilterTagged1

Filter the tagged 1 parameters.

const wchar_t* siATFilterTagged2

Filter the tagged 2 parameters.

const wchar_t* siATFilterTagged3

Filter the tagged 3 parameters.

const wchar_t* siATFilterTagged4

Filter the tagged 4 parameters.

const wchar_t* siATFilterTagged5

Filter the tagged 5 parameters.

const wchar_t* siATFilterTagged6

Filter the tagged 6 parameters.

const wchar_t* siATFilterTagged7

Filter the tagged 7 parameters.

const wchar_t* siATFilterTagged8

Filter the tagged 8 parameters.

const wchar_t* siATFilterTagged9

Filter the tagged 9 parameters.

const wchar_t* siATFilterTagged10

Filter the tagged 10 parameters.

const wchar_t* siPropertyFilterAttribute
const wchar_t* siCustomTypeNameAttribute
const wchar_t* siShaderFamilyAttribute

Type of filter for a shader's family.

const wchar_t* siWritableImageAttribute

Type of filter for a writable image.

Type of filter for a writable image type.

Type of filter to match the Red color for a RenderTree node.

Type of filter to match the Green color for a RenderTree node.

Type of filter to match the Blue color for a RenderTree node.

Attribute used for defining the version of a hardware shader.

const wchar_t* siShaderFamilyCntContrast

mental ray Contour Contrast Shader

const wchar_t* siShaderFamilyCntMat

mental ray Contour Material

const wchar_t* siShaderFamilyCntStore

mental ray Contour Store Shader

const wchar_t* siShaderFamilyData

mental ray Data Blob

const wchar_t* siShaderFamilyEnvironment

mental ray Environment Shader (environment phenomenon in a material or camera)

const wchar_t* siShaderFamilyGeometry

mental ray Geometry Shader (geometry phenomenon)

const wchar_t* siShaderFamilyLens

mental ray Lens Shader (lens phenomenon in a camera)

const wchar_t* siShaderFamilyLight

mental ray Light Shader (light phenomenon)

const wchar_t* siShaderFamilyLightmap

mental ray Lightmap Shader

const wchar_t* siShaderFamilyOutput

mental ray Output Shader (output phenomenon in a camera)

const wchar_t* siShaderFamilyPhenomMat

mental ray Material Phenomenon

const wchar_t* siShaderFamilyPhotonLight

mental ray Photon Light Shader (photon emitter phenomenon in a light)

const wchar_t* siShaderFamilyPhotonMat

mental ray Photon Material Shader (photon phenomenon in a material)

mental ray Photon Volume Shader (photon phenomenon in a material or camera)

const wchar_t* siShaderFamilyShadowMat

mental ray Shadow Material Shader (shadow phenomenon in a material)

const wchar_t* siShaderFamilyState

mental ray State Shader

const wchar_t* siShaderFamilySurfaceMat

mental ray Surface Material Shader (material phenomenon in a material)

const wchar_t* siShaderFamilyTexture

mental ray Texture Shader (texture phenomenon)

const wchar_t* siShaderFamilyVolume

mental ray Volume Shader (volume phenomenon in a material or camera)

const wchar_t* siShaderFamilyRTShader

Realtime Shader.

const wchar_t* siXGSRealTimePortType
const wchar_t* siHWShaderPortType
const wchar_t* siHardwareVertexPosition
const wchar_t* siHardwareVertexNormal
const wchar_t* siHardwareVertexColor

Default vertex color name.

const wchar_t* siHardwareVertexTangent

Tangent.

const wchar_t* siHardwareVertexBinormal

Binormal.

const wchar_t* siHardwareVertexTexCoord

Texture projection.

const wchar_t* siHardwareVertexWeightMap

Weight map.

Point velocity.

Orientation.

const wchar_t* siHardwareVertexAge

Age.

const wchar_t* siHardwareVertexRadius

Radius.

const wchar_t* siHardwareVertexID

ID.

const wchar_t* siHardwareVertexFog

Fog.

const wchar_t* siHardwareVertexWeight

Weight.

const wchar_t* siHardwareVertexIndice

Index.

Tesselation factor.

const wchar_t* siHardwareVertexDepth

Depth.

const wchar_t* siHardwareVertexSample
const wchar_t* siHardwareVertexAuto

Let Softimage handle the creation of the attribute (useful for tangents and binormals).

Constant Boolean ICE attribute to control texture U wrapping.

Valid only when used on a texture space parameter.

Constant Boolean ICE attribute to control texture V wrapping.

Valid only when used on a texture space parameter.

Constant Boolean ICE attribute to control texture W wrapping.

Valid only when used on a texture space parameter.

Constant Matrix44 ICE attribute to control texture matrix.

Valid only when used on a texture space parameter.

Constant Boolean ICE attribute to control if coordinates are homogeneous.

Valid only for rendering when used on a texture space parameter.

Constant Boolean ICE attribute to control if attributes are smoothed based on the subdivision ssurface algorithm.

Valid only for rendering on subdivision surface meshes.

const char kRevLogTable256[] [static]
Initial value:
{
  8, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  7, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
  4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0
}

Definition at line 25 of file xsi_indexset.h.

const LONG kBitShift = 5

Definition at line 45 of file xsi_indexset.h.

const LONG kBitSize = 32

Definition at line 46 of file xsi_indexset.h.

CVector3 m_vOrigin

Definition at line 235 of file xsi_line.h.

CVector3 m_vTangent

Definition at line 236 of file xsi_line.h.

CVector3 m_vNormal

Definition at line 282 of file xsi_plane.h.

CVector3 m_vTangentU

Definition at line 283 of file xsi_plane.h.

CVector3 m_vTangentV

Definition at line 284 of file xsi_plane.h.

E siXZY = 1

X, Z, Y order.

Definition at line 47 of file xsi_rotationf.h.

E siYXZ = 2

Y, X, Z order.

Definition at line 48 of file xsi_rotationf.h.

E siYZX = 3

Y, Z, X order.

Definition at line 49 of file xsi_rotationf.h.

E siZXY = 4

Z, X, Y order.

Definition at line 50 of file xsi_rotationf.h.

E siZYX
Initial value:
 5
    }

Z, Y, X order.

Definition at line 51 of file xsi_rotationf.h.

float m_X

Definition at line 337 of file xsi_rotationf.h.

float m_Y

Definition at line 337 of file xsi_rotationf.h.

float m_Z

Definition at line 337 of file xsi_rotationf.h.

float m_W

Definition at line 340 of file xsi_rotationf.h.

float m_Angle

Definition at line 341 of file xsi_rotationf.h.

RotationOrder m_rotOrder

Definition at line 342 of file xsi_rotationf.h.

union { ... }
unsigned char m_rotRep

Definition at line 344 of file xsi_rotationf.h.

void* m_pImpl

Definition at line 61 of file xsi_viewnotification.h.