<     > 

GetConnectionStackInfo (DataRepository)

Introduced

5.1

Description

Returns information in XML format about which objects read from and write to an object. The connection stack is called the ConstructionHistory in the context of a Primitive.

The connection stack can contain connections to Operators, FCurves, Shaders and other objects, so it is more than just a "Operator Stack". The order of the objects in the connection stack is important because it determines the order in which the scene is evaluated. For example, if a scripted operator reads from a Primitive above a deform operator that reads and writes to the Primitive, then the scripted operator will read the deformed version of the geometry, not the original version.

This method returns low-level information, including the presence of hidden objects, that is intended for internal Softimage usage. It is exposed in the SDK primarily to help users write and debug CustomOperators.

The format of the XML may change in the future. Currently it returns the following possible attributes:

object - SIObject.FullName of the object. Empty if there is no active connection.

type - "in" or "out". If "in" it means that the object being queried is reading data from the connected object.

localparameter - Some connections read and write to a specific Parameter. In that case this contains the Parameter.ScriptName.

remoteparameter - If the connection is to a specific parameter on the connected object, then this contains its Parameter.ScriptName.

hidden - "true" if the object has the siNotInspectable capability. See ProjectItem.Capabilities.

region - For internal use.

datacopy - For internal use. This is the internal handle to the object, for example "0x1c9f0448". The value of this handle serves no meaningful purpose in the context of the SDK. Softimage may create several temporary "datacopies" of an individual object to assist in the clean evaluation of the scene.

Scripting Syntax

DataRepository.GetConnectionStackInfo( Object )

C# Syntax

String DataRepository.GetConnectionStackInfo( Object in_object );

Parameters

Return Value

XML String, containing the connections in a top-to-bottom ordering.

Examples

• See DataRepository.GetConnectionStackInfo.1.js

• See DataRepository.GetConnectionStackInfo.2.js

Autodesk Softimage 2011     <     >