Parameter

Object Hierarchy | Related C++ Class: Parameter

Inheritance

SIObject
   Parameter

Introduced

1.5

Description

Represents a parameter value, which defines an attribute of an object; for example, the angle parameter of the twist operator or the color of a light. Parameters (sometimes called properties), are the 'atomic' elements of a parameter set (the posx in Cone.kine.ltransfo.pos.posx) whose values determine the behavior of something.

Note: A parameter set (often called a 'property set') is a collection of parameters whose values can determine the appearance, behavior, or simply provide information about an element in a scene. Parameter sets (the Property object for scripting) define the visual aspect of objects as displayed in the viewport; some provide motion information such as time; and others are used internally to control the way specific operations are performed.

In the user interface, you can edit and animate the parameters of most parameter sets using property editors. Related parameters are usually displayed as a property page within a property editor.

In the object model, the Parameter object is a member of the ParameterCollection, which you can get using ProjectItem.Parameters. For custom-defined parameters, you can create them on the CustomProperty object (see CustomProperty.AddParameter and CustomProperty.AddParameter2).

Methods

AddCustomOp

AddExpression

AddFCurve

AddFCurve2

AddScriptedOp

AddScriptedOpFromFile

AnimatedParameters

Connect

ConnectFromFile

ConnectFromFile2

ConnectFromPreset

ConnectFromPreset2

ConnectFromProgID

ConnectFromProgID2

Disconnect

Enable

GetInstanceValue

GetValue2

IsAnimated

IsClassOf

IsEqualTo

IsLocked

IsSupportedInstanceValue

PutValue2

SetCapabilityFlag

SetInstanceValue

SetLock

Show

UnSetLock

 

 

 

Properties

Animatable

Application

Capabilities

Categories

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

See Also

ParameterCollection

ProjectItem.Parameters

Property

CustomProperty

CustomProperty.AddParameter

CustomProperty.AddParameter2

ProjectItem

 

Examples

• See Parameter.1.vbs

• See Parameter.2.vbs



Autodesk Softimage 2010