Object Model: ICETree

ICETree

Object Hierarchy | Related C++ Class: ICETree

Inheritance

SIObject

ProjectItem

ICENode

ICENodeContainer

ICETree

Introduced

v7.0

Description

The ICETree object represents a node graph and holds all the effect nodes together. It serves as a container for objects such as ICENode and ICECompoundNode. The ICETree is attached to the Primitive being modified and acts like the evaluation entry-point for the entire graph. ICETree objects can be created with the ApplyOp command by passing the ICETree preset as argument.

Methods

AddCustomOp	AddICEAttribute	AddScriptedOp	AddScriptedOpFromFile
AnimatedParameters2	BelongsTo	EvaluateAt	GetGroupInstanceCount
GetICEAttributeFromName	GetPortCount	GetPortFromIndex	GetPortFromIndex2
GetPortFromName	GetPortFromName2	IsA	IsAnimated2
IsClassOf	IsEqualTo	IsKindOf	IsLocked
IsSelected	LockOwners	RemoveICEAttribute	SetAsSelected
SetCapabilityFlag	SetLock	TaggedParameters	UnSetLock

Properties

Application	BranchFlag	Capabilities	Categories
CompoundNodes	DataModifierNodes	DataProviderNodes	EvaluationID
Families	FullName	Help	HierarchicalEvaluationID
ICEAttributes	InputPorts	IsConnected	LockLevel
LockMasters	LockType	Model	Name
NestedObjects	Nodes	ObjectID	Origin
OriginPath	OutputPorts	Owners	PPGLayout
Parameters	Parent	Parent3DObject	PortGroupCount
RootNodeContainer	Selected	Type

Examples

1. Python Example

#Simple example for creating a ICETree object.
Application.CreatePrim("Grid", "MeshSurface", "", "")
t = Application.ApplyOp("ICETree", "grid", "", "", "", 0)
# The new ICETree returned by ApplyOp is encapsulated within an ISIVTCollection at position 0
Application.LogMessage( Application.ClassName( t(0) ) )

2. Python Example

#Simple example for accessing a ICETree object.
Application.CreatePrim("Grid", "MeshSurface", "", "")
Application.ApplyOp("ICETree", "grid", "", "", "", 0)
x3DGrid = Application.Selection( 0 )
trees = x3DGrid.ActivePrimitive2.ICETrees
for t in trees:
        Application.LogMessage( Application.ClassName( t ) )