What You Can Call from a Custom Operator

Not everything included in the Autodesk Softimage SDK is available from within a scripted operator. For example, you cannot get your custom operator to call any commands. In addition, only special methods and properties are available from the object model.

If you need to know whether the method or property you want to use is safe for custom operators you can refer to the individual reference page for that item or you can refer to the list below:

A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X | Y | Z

A

Add, ShaderArrayParameter

AddArrayParamDef, ShaderParamDefContainer

AddButton, PPGLayout

AddColor, PPGLayout

AddCurve, NurbsCurveList

AddEnumControl, PPGLayout

AddFCurve, PPGLayout

AddGroup, PPGLayout

AddItem, PPGLayout

AddParamDef, ShaderParamDefContainer

AddRendererDef, ShaderDef

AddRow, PPGLayout

AddShaderFamily, ShaderDef

AddSpacer, PPGLayout

AddStaticText, PPGLayout

AddString, PPGLayout

AddSurface, NurbsSurfaceMesh

AddTab, PPGLayout

Animatable, Parameter

Array

ClusterElementCollection

ControlPointCollection

Array32, UserDataBlob

Attributes

ShaderDef

ShaderParamDef

B

Background, Partition

BeginEdit, GridData

BelongsTo, ProjectItem

BinaryData, CustomProperty

Branch, Property

BranchFlag, ProjectItem

BranchGroup, Port

ByteArray, UserDataBlob

C

Cache, Geometry

Capabilities

Parameter

ProjectItem

ShaderParamDef

Category, ShaderDef

Clear

PPGLayout

ShaderArrayParameter

UserDataBlob

UserDataMap

ClearItem, UserDataMap

Closed, NurbsCurveList

Code, CustomOperator

CodePath, MetaShaderRendererDef

CodeText, MetaShaderRendererDef

ColumnCount, GridData

ComponentCollection, SubComponent

ConstructPointLocators

NurbsSurfaceMesh

PolygonMesh

ControlPoints

NurbsCurve

NurbsSurface

Count

ActionDeltaCollection

ActionDeltaItemCollection

ActionSourceCollection

AnimationSourceItemCollection

ArgumentCollection

ArrayParameter

ChainBoneCollection

ChannelCollection

ClipCollection

ClipEffectItemCollection

ClipRelationCollection

ClusterCollection

ClusterElementCollection

ClusterPropertyCollection

ConstraintCollection

DataSourceCollection

EnvelopeCollection

EventInfoCollection

FacetCollection

FCurveCollection

FCurveKeyCollection

FileReferenceCollection

FilterCollection

FramebufferCollection

FxOperatorCollection

GroupCollection

ICEAttributeCollection

ICECompoundNodeCollection

ICEDataModifierNodeCollection

ICEDataProviderNodeCollection

ICENodeCollection

ICENodeInputPortCollection

ICENodeOutputPortCollection

ICENodePortCollection

ICETreeCollection

ImageClipCollection

InputPortCollection

KnotCollection

LayerCollection

LayoutCollection

LibraryCollection

LinktabRuleCollection

MappedItemCollection

MaterialCollection

MetaShaderRendererDefCollection

ModelCollection

NurbsCurveCollection

OperatorCollection

OutputPortCollection

ParameterCollection

ParticleAttributeCollection

ParticleTypeCollection

PartitionCollection

PassCollection

PluginCollection

PluginItemCollection

PointCollection

PointLocatorData

PortCollection

PortGroupCollection

PPGLayout

PrimitiveCollection

ProjectItemCollection

PropertyCollection

RenderChannelCollection

RendererCollection

SampleCollection

SceneItemCollection

SegmentCollection

ShaderArrayParameter

ShaderCollection

ShaderDefCollection

ShaderParamDefCollection

ShaderParameterCollection

SimulationEnvironmentCollection

SIObjectCollection

StaticKinematicStateCollection

TextureLayerCollection

TextureLayerPortCollection

TrackCollection

TransitionCollection

TriangleCollection

TrianglePointCollection

UserDataMap

ViewCollection

X3DObjectCollection

Crease

Edge

Vertex

CreaseArray

EdgeCollection

VertexCollection

CreateShaderDef, XSIFactory

CreateShaderParamDefOptions, XSIFactory

CurrentFrame, UpdateContext

Curves, NurbsCurveList

D

Data, GridData

DataType

ShaderParamDef

ShaderParameter

Debug, CustomOperator

Default, Parameter

DefaultBackground, ShaderballOptions

DefaultImageClip, Scene

DefaultModel, ShaderballOptions

DefaultValue, ShaderParamDef

Definition, ShaderParameter

DefinitionPath, ShaderDef

Definitions, ShaderParamDefContainer

Degree, NurbsCurve

Delete, PPGLayout

Description, Parameter

Dimension

ControlPointCollection

ShaderballOptions

DisplayName

ShaderDef

ShaderParamDef

E

Edges

PolygonFace

PolygonMesh

Elements

Cluster

ClusterProperty

Enable, Parameter

EndEdit, GridData

EndGroup, PPGLayout

EndRow, PPGLayout

EvaluateClusterProperty, Geometry

EvaluateNormalizedPosition

NurbsCurve

NurbsSurface

EvaluateNormalizedPosition2, NurbsSurface

EvaluateNormals, Geometry

EvaluatePosition

NurbsCurve

NurbsSurface

EvaluatePosition2, NurbsSurface

EvaluatePositionFromPercentage, NurbsCurve

EvaluatePositions, Geometry

EventID, PPGEventContext

F

Facets, Geometry

Families, ProjectItem

Flags, Port

Framebuffers, Pass

Frames, Pass

FullName, SIObject

G

Get

NurbsCurve

NurbsCurveList

NurbsSurface

NurbsSurfaceMesh

PolygonMesh

ValueMap

Get2

NurbsCurve

NurbsCurveList

NurbsSurface

NurbsSurfaceMesh

PolygonMesh

GetAttribute

Context

PPGItem

PPGLayout

GetCell, GridData

GetClosestCurvePosition, NurbsCurveList

GetClosestCurvePosition2, NurbsCurveList

GetClosestLocations, Geometry

GetClosestLocationsWithinRadius, Geometry

GetClosestSurfacePosition, NurbsSurfaceMesh

GetClosestSurfacePosition2, NurbsSurfaceMesh

GetColumnComboItems, GridData

GetColumnLabel, GridData

GetColumnType, GridData

GetColumnValues, GridData

GetIndexArrayFromUVSamplingCoordinateArray, NurbsSampleCollection

GetIndexFromUVSamplingCoordinate, NurbsSampleCollection

GetItem2, UserDataMap

GetItemSize2, UserDataMap

GetItemValue2, UserDataMap

GetMultiplicity, KnotCollection

GetNormalizedUFromU, NurbsCurve

GetNormalizedUVArray, NurbsSurfaceMesh

GetNormalizedUVFromUV, NurbsSurface

GetNormalizedUVFromUV2, NurbsSurface

GetNumInstancesInGroup, Operator

GetNumPortGroups, Operator

GetNumPortsInGroup, Operator

GetParamDefByName, ShaderParamDefContainer

GetPercentageFromU, NurbsCurve

GetPolygonIndexArray, PolygonMesh

GetPort2, Operator

GetRaycastIntersections, Geometry

GetRendererDefByName, ShaderDef

GetRowLabel, GridData

GetRowValues, GridData

GetShaderDef, XSIApplication

GetStaticKinematicState, X3DObject

GetStaticKinematicStates, Cluster

GetSubSurfaceIndexArray, NurbsSurfaceMesh

GetSurfacePointLocatorsFromPoints, Geometry

GetTransform2

KinematicState

StaticKinematicState

GetTriangleNodeIndexArray, PolygonMesh

GetTriangleVertexIndexArray, PolygonMesh

GetTriangleWeightArray, PolygonMesh

GetTrim, NurbsSurface

GetTrim2, NurbsSurface

GetUFromNormalizedU, NurbsCurve

GetUFromPercentage, NurbsCurve

GetUVFromNormalizedUV, NurbsSurface

GetUVFromNormalizedUV2, NurbsSurface

GetUVSamplingCoordinateArray, NurbsSampleCollection

GetValue2, Parameter

Global, Kinematics

GroupIndex, Port

GroupInstance, Port

GroupName, Port

GrowNeighborEdges

Edge

EdgeCollection

GrowNeighborPolygons

PolygonFace

PolygonFaceCollection

GrowNeighborVertices

Vertex

VertexCollection

H

HasDefaultValue, ShaderParamDef

HasStaticKinematicState

Cluster

X3DObject

I

Index

Facet

NurbsCurve

Point

PolygonNode

Port

Sample

Segment

IndexArray

FacetCollection

PointCollection

PolygonNodeCollection

SampleCollection

SegmentCollection

Init, ShaderballOptions

InputParamDefs, ShaderDef

InputPorts, Operator

InspectedObjects, PPGEventContext

IsAlwaysComplete, Cluster

IsArray, ShaderParamDef

IsBoundary

ControlPoint

Edge

Vertex

IsClassOf, SIObject

IsConnected, Operator

IsEmpty

UserDataBlob

UserDataItem

UserDataMap

IsEqualTo, SIObject

IsHard, Edge

IsHardArray, EdgeCollection

IsInput, ShaderParamDef

IsLocked

Parameter

ProjectItem

IsOutput, ShaderParamDef

IsSelected, ProjectItem

IsShaderFamily, ShaderDef

IsStructure, ShaderParamDef

Item

ActionDeltaCollection

ActionDeltaItemCollection

ActionSourceCollection

AnimationSourceItemCollection

ArgumentCollection

ChainBoneCollection

ChannelCollection

ClipCollection

ClipEffectItemCollection

ClipRelationCollection

ClusterCollection

ClusterPropertyCollection

ConstraintCollection

DataSourceCollection

EnvelopeCollection

EventInfoCollection

FCurveCollection

FCurveKeyCollection

FileReferenceCollection

FilterCollection

FramebufferCollection

FxOperatorCollection

GroupCollection

ICEAttributeCollection

ICECompoundNodeCollection

ICEDataModifierNodeCollection

ICEDataProviderNodeCollection

ICENodeCollection

ICENodeInputPortCollection

ICENodeOutputPortCollection

ICENodePortCollection

ICETreeCollection

ImageClipCollection

InputPortCollection

LayerCollection

LayoutCollection

LibraryCollection

LinktabRuleCollection

MappedItemCollection

MaterialCollection

MetaShaderRendererDefCollection

ModelCollection

OperatorCollection

OutputPortCollection

ParameterCollection

ParticleAttributeCollection

ParticleTypeCollection

PartitionCollection

PassCollection

PluginCollection

PluginItemCollection

PortCollection

PortGroupCollection

PPGLayout

PrimitiveCollection

ProjectItemCollection

PropertyCollection

RenderChannelCollection

RendererCollection

SceneItemCollection

ShaderArrayParameter

ShaderCollection

ShaderDefCollection

ShaderParamDefCollection

ShaderParameterCollection

SimulationEnvironmentCollection

SIObjectCollection

StaticKinematicStateCollection

TextureLayerCollection

TextureLayerPortCollection

TrackCollection

TransitionCollection

UserDataMap

ViewCollection

X3DObjectCollection

ItemDef, ShaderArrayParamDef

ItemInitialCount, ShaderArrayParamDef

ItemInitialValues, ShaderArrayParamDef

ItemName, ShaderArrayParamDef

ItemSize, UserDataMap

ItemValue, UserDataMap

ItemsByIndex, ClusterElementCollection

K

Keyable, Parameter

Knots

NurbsCurve

NurbsSurface

L

Label, PPGItem

LabelMinPixels, PPGItem

LabelPercentage, PPGItem

Language, PPGLayout

Length

NurbsCurve

NurbsCurveList

LittleEndian, UserDataMap

Local, Kinematics

LockLevel

Parameter

ProjectItem

LockMasters, ProjectItem

LockType

Parameter

ProjectItem

Logic, PPGLayout

M

MainPort, ShaderParamDef

MasterParameter, ProxyParameter

Max, Parameter

MaxValue, ShaderParamDef

Min, Parameter

MinValue, ShaderParamDef

Move, ShaderArrayParameter

Mute, Operator

N

Name

PPGItem

SIObject

Names, ValueMap

NbPoints, Facet

NeighborEdges

Edge

EdgeCollection

PolygonFace

PolygonFaceCollection

Vertex

VertexCollection

NeighborPolygons

Edge

EdgeCollection

PolygonFace

PolygonFaceCollection

Vertex

VertexCollection

NeighborVertices

Edge

EdgeCollection

PolygonFace

PolygonFaceCollection

Vertex

VertexCollection

Nodes

Edge

PolygonFace

PolygonMesh

Vertex

Normal

Point

PolygonNode

NormalArray

FacetCollection

PointCollection

PolygonFaceCollection

PolygonNodeCollection

SegmentCollection

NurbsSamples, NurbsSurface

NurbsSurface, NurbsSample

O

Operator, UpdateContext

OriginalValue, Parameter

OutputParamDefs, ShaderDef

OutputPort, OperatorContext

OutputPorts, Operator

OutputTarget, OperatorContext

P

PPGLayout

ProjectItem

ShaderDef

Parameters

Parameter

ProjectItem

Parsed, ShaderDef

Parser, ShaderDef

ParserBased, ShaderDef

PartitionType, Partition

Partitions, Pass

Plugin, ShaderDef

PluginBased, ShaderDef

PluginFilename, ShaderDef

Points

Facet

Geometry

Segment

PolygonNodeNormalArray, PolygonFaceCollection

PolygonNodePolygonFaceIndexArray, PolygonFaceCollection

Polygons, PolygonMesh

Port, Operator

PortAt, Operator

PortGroups, Operator

PortType, Port

Position, Point

PositionArray, PointCollection

PrimaryShaderFamily, ShaderDef

ProgID, ShaderDef

PutTransform2, KinematicState

PutValue2, Parameter

R

ReadOnly, Parameter

RegisterShader, PluginRegistrar

RegisterShaderCustomParameterType, XSIApplication

RegisterShaderFamily, XSIApplication

RegisterShaderLanguageParser, PluginRegistrar

Remove

ShaderArrayParameter

ValueMap

RemoveRendererDef, ShaderDef

RemoveShaderDef, XSIFactory

RenderTreeLayout, ShaderDef

RendererDefs, ShaderDef

RendererOptions, MetaShaderRendererDef

Reset, ShaderballOptions

RowCount, GridData

S

Samples

Facet

Point

Segment

ScriptName, Parameter

Segments

Facet

Geometry

Selected, ProjectItem

Set

NurbsCurve

NurbsCurveList

NurbsSurface

NurbsSurfaceMesh

PolygonMesh

ValueMap

SetAnimatable, ShaderParamDefOptions

SetAsSelected, ProjectItem

SetAttribute

Context

PPGItem

PPGLayout

ShaderParamDefOptions

SetCapabilityFlag

Parameter

ProjectItem

SetCell, GridData

SetColumnComboItems, GridData

SetColumnLabel, GridData

SetColumnType, GridData

SetColumnValues, GridData

SetDefaultValue, ShaderParamDefOptions

SetHardLimit, ShaderParamDefOptions

SetInspectable, ShaderParamDefOptions

SetLongName, ShaderParamDefOptions

SetRowLabel, GridData

SetRowValues, GridData

SetShortName, ShaderParamDefOptions

SetSoftLimit, ShaderParamDefOptions

SetTexturable, ShaderParamDefOptions

SetupPointLocatorQueries, Geometry

ShaderDef, Shader

ShaderDefinitions, XSIApplication

ShaderFamilies, ShaderDef

ShaderInstanceCount, ShaderDef

ShaderInstances, ShaderDef

ShaderballOpts, ShaderDef

Show, Parameter

ShowByDefault, ShaderballOptions

Singleton, Property

Size

UserDataBlob

UserDataItem

Source, Context

StaticArray, ShaderArrayParamDef

SubComponent

Facet

FacetCollection

NurbsCurve

NurbsCurveCollection

Point

PointCollection

Sample

SampleCollection

Segment

SegmentCollection

SubParamDefs, ShaderStructParamDef

SuggestedMax, Parameter

SuggestedMaxValue, ShaderParamDef

SuggestedMin, Parameter

SuggestedMinValue, ShaderParamDef

SupportsBranchGroup, Operator

Surfaces, NurbsSurfaceMesh

SymbolName, MetaShaderRendererDef

T

Tags, Parameter

Target, Port

Target2, Port

TargetPath, Port

Targets, ShaderParameter

Template, UserDataMap

Texturable, ShaderParamDef

Time, OperatorContext

Transform

KinematicState

StaticKinematicState

TriangleSubIndexArray, PolygonFace

TrimCount, NurbsSurface

TurnInternalEdgeOffset, PolygonFace

Type

PPGItem

SIObject

U

U, NurbsSample

UIItems, PPGItem

UKnots, NurbsSurface

UNormalized, NurbsSample

USamplingCoordinate, NurbsSample

USamplingCount, NurbsSampleCollection

UserData

Context

UpdateContext

V

V, NurbsSample

VKnots, NurbsSurface

VNormalized, NurbsSample

VSamplingCoordinate, NurbsSample

VSamplingCount, NurbsSampleCollection

Validate, CustomOperator

Value

InputPort

OutputPort

Parameter

UserDataBlob

UserDataItem

ValueType, Parameter

Values, ValueMap

Vertices

Edge

PolygonFace

PolygonMesh

W

W, ControlPoint

WidthPercentage, PPGItem

X

X, ControlPoint

Y

Y, ControlPoint

Z

Z, ControlPoint

 

 



Autodesk Softimage 2011