ArrayParameter

Object Hierarchy | Related C++ Class: ArrayParameter

Inheritance

SIObject

Parameter

ArrayParameter

Introduced

v4.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 operator GetInstanceValue GetValue2 operator
IsAnimated IsClassOf operator IsEqualTo operator IsLocked operator
IsSupportedInstanceValue Move PutValue2 operator Remove
SetCapabilityFlag operator SetInstanceValue SetLock Show operator
UnSetLock      
       

Properties

Animatable operator Application Capabilities operator Categories
Count operator Default operator Description operator FullName operator
HasInstanceValue Help Keyable operator LockLevel operator
LockType operator Marked Max operator Min operator
Model Name operator NestedObjects Origin
OriginPath OriginalValue operator OverridenObject OverridingObject
Parameters operator Parent Parent3DObject ReadOnly operator
ScriptName operator Source Sources SuggestedMax operator
SuggestedMin operator Tags operator Type operator Value operator
ValueType operator      
       

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