Autodesk Softimage SDK Documentation

ContentsSoftimage SDK Programmer's GuideWhat's New / What's ChangedSoftimage 2014 Softimage 2013Softimage 2012 Subscription Advantage PackSoftimage 2012Softimage 2011Getting StartedIntroducing the Components of the SDKUnderstanding the Softimage SDK ArchitectureAbout the Structure of the Softimage APIsHow is the Softimage Object Model Different from the C++ API?Types of Customization in SoftimageUsing the HelpHow to Read the Commands and Scripting Reference GuideCustomizing Softimage using the SDKSelf-Installing Plug-insWhat is a Self-Installing Plug-in?Getting Started with the Plug-in Wizard Setting Plug-in PropertiesSpecifying a Help File for a Plug-inRegistering Plug-in ItemsNaming Plug-in ItemsUsing Prefixes with Custom PropertiesExporting CallbacksDeploying Self-Installing Plug-insCallbacks for Self-Installing Plug-insCallbacks by Plug-in TypeCallbacks ListCustom PrimitivesCreating a Custom PrimitiveCustom Primitive WizardCustom CommandsWhat is a Custom Command?Custom Command WizardRegistering CommandsSetting Command CapabilitiesProviding User Interface Text for a CommandAdding ArgumentsWorking with ArgumentsReturning Values Exporting C++ CallbacksCalling C++ Custom Commands from ScriptingAdding Commands to MenusUndoing and Redoing Custom Commands Custom OperatorsWhat is a Custom Operator?Registering OperatorsCustom Operator WizardMaking ConnectionsAdding Custom ParametersStatic versus Dynamic OperatorsApplying Operators in SoftimageLimitationsRuntime vs. Self-Installed Custom OperatorsTips and TricksCustom PropertiesWhat are Custom Properties?Creating Custom PropertiesBuilding DialogsDefining a Custom PropertyCreating a Self-Installing PropertyMigrating Properties to Self-InstallingProperty CallbacksProperty Page ControlsLabels Static Text Bitmap Widget Editable Text Boxes Single-line Text Multi-line Text Text Editor Widget Enum Controls List Box Combo/Drop-Down Box Radio Buttons Icon Buttons Bitfield Path Controls File Browser Widget Folder Widget Numeric Controls Numeric Edit Box with Slider RGB Color Control RGBA Color Control FCurve Widget GridData WidgetSynoptic Widget Check Box Command ButtonSetting Control Attributes Grouping Controls Wrapping Controls (Rows) Using Multiple Pages (Tabs) Resizing Control Windows Dynamically Changing Custom Properties Defining On-the-fly Property Pages Providing Help FilesCustom Property Page ExamplesCustom ICENodesWhat is a Custom ICENode?Processing phasesImplementation OverviewRegistering a Custom ICENodeICENodeDef ObjectsRegistration ExampleCustom ICENode ProcessingPort Data AccessPort Data IndexingIterating Over Port DataMultiple Port ConnectionsHandling Port PolymorphismUser DataCustomVector3ToScalar ExampleCustom ICENode CategoriesRegular Custom ICENodeSingle-Thread Custom ICENodeMulti-Phase Custom ICENodeElement Generator Custom ICENodesSingle-Thread/Element Generator Custom ICENodeMulti-Phase/Element Generator Custom ICENodeApplying Custom ICENodesCustom ICENode WizardPortsCustom TypesOptionsCodeCustomizing Icons for Custom ICENodesLimitationsCustom ShadersUnderstanding Softimage Custom ShadersInstantiating Shader Definitions and the ProgIDCreating Shader Definition Plug-insCreating Shader Language Parser DefinitionsCreating Realtime (Hardware) Shader Plug-insPopulating the Preset ManagerShader FamiliesDetecting Shader FamiliesNative Softimage Shader FamiliesCreating Custom Shader FamiliesShader Parameter DefinitionsParameter Data TypesAdding Parameter DefinitionsRefining UI Controls for Parameter DefinitionsVBScript Example: Grouping Ports in the Render TreeJScript Example: No UI for Parameter DefinitionSetting ShaderDef AttributesProviding Renderer InformationEditing Shader Code in SoftimageShader Definition and Parser ExamplesUsing the Mental Ray Shader WizardCustom Fx OperatorsWhat is a Custom Fx Operator?Source Code ExamplesUFO TerminologyImplementationDefinitionRaster Inputs and OutputsUser DataRenderingScreen Drawing and Screen InteractionMemory AllocationCompiling Fx OperatorsInstalling UFOsCharacter Development KitUsing the Character Development KitCommand Access to Rig from Biped, Dogleg, and QuadrupedBuilding a Customized RigExample: Anatomy of a Custom Rig ScriptIdentifying Guide Objects in the Default GuidesHead and NeckChest and SpineBelly and HipsTailArms, Hands, and FingersLegs and FeetSkinWorking with Return ValuesExample: Making an Octopus RigCDK Object Reference Biped Quadruped Head Arm Hand Belly Spine Torso Tail Leg DogLeg Foot Joint Shadow BicepRoll ForeArmRoll ControlSpline PointSlide ThighSlide UI Custom FiltersWhat is a Custom Filter?Filter TypesFilter CallbacksCreating a FilterWriting 3D Object FiltersWriting SubComponent FiltersWriting Property FiltersWriting Object FiltersUsing Custom Filters in CodeRegistering a Filter Custom EventsWhat is an Event?Supported EventsCreating an EventRegistering Event HandlersEvent CallbacksContext AttributesMuting EventsProgrammatically Installing Event Handlers Custom Display HostAbout the Custom Display HostSetting Up the Developer EnvironmentComponents of a Custom Display HostCustom RenderersWhat is a Custom Renderer?Registering a Rendering EngineAdding PropertiesSpecifying File FormatsRendering ImagesExporting ArchivesSingle and Multi-Frame ArchivesRendering a Subset of the SceneDevice DriversWhat is a Device Driver?Creating a Device DriverRegistering Your Device Driver in SoftimagePackaging Your Device DriverDevice Driver Example Standard and Contextual MenusWhat Can I Customize with Menus?How to Make Your Own MenusRegistering a Custom Menu in SoftimagePackaging Your Custom MenuCustom Menu ExamplesSpreadsheet QueriesWhat is a Spreadsheet Query?Scripting for the Spreadsheet Queries Installing the Spreadsheet QueriesBuilding and Deploying CustomizationsWhat are my Deployment Options?Using the Softimage User Interface Toolkit (XSIUIToolkit)Walkthrough: The Plug-in ManagerWorking with the Plug-in ManagerWorking with the Plug-in TreeResolving Plug-in ConflictsUsing WorkgroupsManaging WorkgroupsWalkthrough: Building an Add-onAdd-on PackagesAdd-on DirectoriesDocumenting Add-onsPackaging Add-onsEditing Add-on PackagesInstalling and Uninstalling Add-onsWhat's in an Add-on Package?Using Install Shield to Install Softimage Plug-insUsing the Package DialogsUsing the Command Line for Installing Files and MoreWorking with Add-ons through the Object ModelLimitationsCross-Platform DeploymentBundling Several Handlers in One Library File (.DLL/SO)Graphic SequencerAbout Controlling the Hardware Display in SoftimageCreating Softimage Graphic Sequencer (XGS) Plug-insViewport Callback TypesWorking with the SDKSelectionAccessing the SelectionFinding Out What's Currently Selected Accessing the List of Selected ObjectsAccessing the List of Selected Components via the Object ModelAccessing the List of Selected Components via the C++ APIWorking with the Selection List as a CRefArray (C++ API only)Getting the Current Selection FilterManipulating the SelectionSelecting a Single Item (Adding to the Selection)Selecting a List of ItemsDeselecting Specific Items (Removing from the Selection)Deselecting Everything (Clearing the Selection)Dealing with HierarchyModeling Deforming Geometry (Changing Components)Changing the Topology (Adding and Removing Components)Getting at ClustersAccessing Texture UVs Accessing Vertex ColorsEnumerating Polygon IslandsGetting the Local Reference Frame Manipulation Mode ValuesAnimationAnimation LevelsExpressions Creating Expressions Accessing ExpressionsLinked ParametersFCurvesFCurve Interpolation and ExtrapolationConstraintsShape AnimationEnvelopesSources and Clips DataSource Relative NameAnimation MixerPlayback ControlsAccessing the PlayControl Property SetGetting and Changing the Current FrameMoving Around in the TimelineStarting the Playback in Any DirectionChanging the PlayControl OptionsControlling the Frame Rate and FormatRunning Commands During Playback at Each Frame ChangeICE NodesWhat is ICE?Port Polymorphism and Data IntegrityAccessing Data from Array NodesDebugging ICE GraphsICE Node ParticlesCreating a Particle CloudAccessing the Components of a Simulated ICE Tree Working with the Softimage Scene Graph Finding 3D Objects Tree Crawling Special Navigational Tools Finding Elements using the Full PathWorking with Parameters What is a Parameter?Accessing Parameter Values Compound ParametersProxy ParametersSetting Values After a Scene Has Loaded (Auxiliary Files) Working with Return Values and Output Arguments What is a Return Value? What is an Output Argument?Output Argument Support by Language What is an ISIVTCollection? What Happens when the Function Already Returns a Value?Examples of Handling Return Values and Output Arguments VBScript Example: Output Arguments vs. the ISIVTCollection VBScript Example: Getting Output Arguments from a Method JScript Example: Using the Method Ô2' WorkaroundJScript Example: Using the ISIVTCollection Python Example: Working with the ISIVTCollection returned from a CommandPython Example: Using Tuples to Access Output Arguments from a MethodExample: Custom Command Workaround for Both Output Arguments and Return ValuesWorking with Operators What is an Operator? Applying Operators About Connection Sets Accessing Operators and BeyondWorking with Files and PathsGetting External File InformationUNC PathStoring Custom (User) DataWhat is User Data?Attaching Binary User Data to ObjectsAccessing Binary User Data on ComponentsAccessing Templated User Data on ComponentsFinding User Data in a SceneImporting User Data from SOFTIMAGE|3DInteracting with the UserWorking with User PreferencesScript DevelopmentIntroduction to Scripting in SoftimageSupported Scripting LanguagesUsing the Softimage Object Model for NovicesWhere to Find More InformationPython ScriptingGetting Python to Recognize Softimage Constants (Enums)Getting Output Arguments from MethodsLinking Python Classes to Command ButtonsWorking with Custom Python Modules in Softimage Returning Python Types from Custom CommandsShortcuts for PythonTips ExamplesCommand ExamplesObject Model ExamplesScript EditorUsing the Script EditorEditing ScriptsMaking Coding EasierCustomizing Your Scripting EnvironmentUsing the Command HistoryGetting HelpManaging Script FilesRunning ScriptsAccessing Scene ElementsString Expressions Object Name Components Element TypesParameters Object List Marked Parameter ListSelecting through Scripting CommandsData Types and Return ValuesWhat is 'Type'?Comparing Data Types across LanguagesIntegerLongFloatDoubleStringBooleanVariantArrayKeyValueReturning ValuesWhat You Should Know about Return ValuesWhat to Watch Out for with Objects and CollectionsMaking Sure Returned Values are ValidChecking Return Values for TypeWorking with Arrays (and Other Collections) in SoftimageUsing (Native) ArraysUsing the GridData ObjectUsing a GridData Object in a Custom Property SetUsing a Temporary GridData ObjectCollections vs. ArraysUsing CollectionsCreating and Adding to CollectionsRemoving Collections and CollectionItemsGroups vs. Collections and ArraysUsing Native Softimage Commands To Access GroupsUsing the Object Model to Access GroupsSpecial Scripting Functions and ObjectsCreating ActiveX ObjectsGlobal (Intrinsic) ObjectsWriting Optimized CodeUse the Object Model instead of GetValue and SetValueUsing EvaluateAt() instead of Changing the Current FrameUsing Global Variables with the Object ModelAvoiding Unnecessary Conversions between String Expressions and Object PointersDebugging ScriptsUsing the Microsoft Script DebuggerUsing the PyWin Debugger Understanding Error MessagesERROR : 2001-<function_name> - Argument <#> is invalidERROR : 2038 - Bad Variable TypeERROR : 2000 - Argument <#> (<parametername>) is invalidERROR : Cannot use parentheses when calling a SubERROR : Expected end of statementERROR : Invalid argument specifiedERROR : <enum_name> is not definedERROR : <tuple_name> is not definedERROR : 'tuple' object has no attributeERROR : Object doesn't support this property or method:ERROR : Object not a collectionERROR : Object requiredERROR : (Python) dict can not be converted to a COM VARIANTERROR : Syntax errorERROR : Type mismatchERROR : Wrong number of arguments or invalid property assignmentIssues in Batch Scripting How to Check in Which Mode (Batch or Interactive) Softimage is RunningPassing Arguments to Batch ScriptsRunning Scripts in Batch ModeRunning Scripts RemotelyAutomatically Closing the Command WindowReal-Time Message LoggingInteracting with Other ApplicationsC++ API DevelopmentAbout the C++ APIBuilding C++ Plug-insCreating C++ Plug-insCompiling Plug-insDebugging Plug-insRebuilding Plug-insCommon Build ProblemsEnvironment Variables and Build FlagsProgramming with the C++ APIReferencing Softimage Objects: CRefAbout the CRef Casting OperatorInteracting with Softimage Using Variants and SafeArraysUV OrderingParameter Performance Optimization Calling Commands from C++Accessing Return ValuesDealing with Output ArgumentsLegacy Plug-in CallbacksMigrating Legacy Plug-insMixing the C++ API with the Softimage Object ModelC# DevelopmentUsing C# with SoftimageBuilding C# Plug-insCreating C# Plug-insCompiling Plug-insDebugging Plug-insRebuilding Plug-insCommon Build or Load ProblemsPlug-in Fails to Load from Network Share Softimage Failed to Load a .NET Plug-inProgramming with C#Interacting with SoftimageAbout Data Types and Casting in C#Using Enums and String ConstantsCalling Object Model MembersCalling Commands from C#Building Softimage Plug-ins with C#Creating an XSICollection Object