ArrayParameter

Object Hierarchy | Related C++ Class: ArrayParameter

Inheritance

SIObject
   Parameter
       ArrayParameter

Introduced

4.0

Description

An Array parameter is a special kind of parameter that can contain a variable number of entries, all of the same type. The array can have entries added (ArrayParameter.Add), removed (ArrayParameter.Remove) or moved around (ArrayParameter.Move) within the array.

Note: The ArrayParameter is zero-based.

Warning: The following properties are unsupported for the ArrayParameter object:

Parameter.Source

Parameter.Sources

Parameter.Value

Parameter.OriginalValue

Methods

Add

AddCustomOp

AddExpression

AddFCurve

AddFCurve2

AddScriptedOp

AddScriptedOpFromFile

AddValue

AnimatedParameters

Connect

ConnectFromFile

ConnectFromFile2

ConnectFromPreset

ConnectFromPreset2

ConnectFromProgID

ConnectFromProgID2

Disconnect

Enable

GetInstanceValue

GetValue2

IsAnimated

IsClassOf

IsEqualTo

IsLocked

IsSupportedInstanceValue

Move

PutValue2

Remove

SetCapabilityFlag

SetInstanceValue

SetLock

Show

UnSetLock

 

 

 

Properties

Animatable

Application

Capabilities

Categories

Count

Default

Description

FullName

HasInstanceValue

Help

Keyable

LockLevel

LockType

Marked

Max

Min

Model

Name

NestedObjects

Origin

OriginalValue

OriginPath

OverridenObject

OverridingObject

Parameters

Parent

Parent3DObject

ReadOnly

ScriptName

Source

Sources

SuggestedMax

SuggestedMin

Tags

Type

Value

ValueType

 

 

 

Examples

JScript Example

/*
This example creates a cube, applies the XSIColorMixer shader to
the material's surface port and adds a new layer.
*/
NewScene( null, false );
oCube = ActiveSceneRoot.AddGeometry( "Cube", "MeshSurface" );
oMat = oCube.AddMaterial( "Phong" );
oMixer = oMat.surface.ConnectFromProgid( "Softimage.XSIColorMixer.1" );
oLayers = oMixer.layers;
LogMessage( "Before adding: " + oLayers.Count );
oNewLayer = oLayers.Add( );
LogMessage( "After adding: " + oLayers.Count );
oLayers.Remove( 0 );
LogMessage( "Before removing: " + oLayers.Count );

See Also

Parameter

ParameterCollection

ProjectItem.Parameters

Property

CustomProperty

CustomProperty.AddParameter

CustomProperty.AddParameter2

CustomProperty.AddParameter3

ProjectItem

Shader

 

 



Autodesk Softimage v7.5