Global (Intrinsic) Objects

 
 
 

There are a number of intrinsic objects with global scope available within Softimage. An intrinsic object is one that you do not have to create an instance of it in your code but can refer to it by name. The following intrinsic objects are available within Softimage scripting:

Language Element

Description

Application Object (see XSIApplication)

An intrinsic object that represents the running instance of a Softimage application.

  • In VBScript and JScript all the methods and properties of the Application object are available even without specifying the "Application." prefix. For example, using LogMessage is the same as using Application.LogMessage.

  • All Softimage commands are available as if they were methods of the Application object. For example, Application.NewScene() executes the NewScene command. This is the main syntax for calling commands from Python.

Dictionary Object

An intrinsic object that provides access to application definitions (see GetObject (Dictionary)) and methods to access existing objects using the full path name (see GetObject (Dictionary)).

XSIFactory Object

An intrinsic object that provides access to functions for creating helper objects (see CreateActiveXObject (XSIFactory)) and objects that need to be created without being made part of the scene graph (see CreateGridData (XSIFactory)).

XSIMath Object

An intrinsic object that provides basic 3D mathematics functionality.

XSIUIToolkit Object

An intrinsic object that provides access to user interface objects such as the ProgressBar object.

XSIUtils Object

An intrinsic object that provides access to miscellaneous methods such as the QuickSort (XSIUtils) method.

Important

Intrinsic objects are not available within the context of Netview.

The following example illustrates the use of the XSIMath and XSIApplication global objects:

	Dim v3
	
	' Create a Vector3 object directly from XSIMath
	Set v3 = XSIMath.CreateVector3
	v3.Set 10.0, 10.0, 10.0
	v3.ScaleInPlace 2
	' This calls the LogMessage method of the global
	' Application object which prints the array of
	' XYZ values returned from the Get2 method 
	' separated by the comma-space string
	LogMessage join( v3.Get2, ", " )
	
	' Outputs:
	'INFO : 20, 20, 20

Creative Commons License Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License