OperatorContext.GetParameterValue
 
 
 

OperatorContext.GetParameterValue

Introduced

v5.1

Description

Returns the current value (Boolean, Double, String or other supported type) of the specified parameter. This method provides access only to the parameters of the CustomOperator. For example, an Operator often has parameters that allow the user or the plug-in to configure the operator's behavior, such as "RecursionDepth", "UDivisions", "Height" or "CenterX".

Note: It cannot be used to retrieve the value of parameters on any other object in the scene. For that scenario the operator should connect to the Parameter (or object that owns the parameter) and use OperatorContext.GetInputValue to retrieve the parameter value.

C# Syntax

Object OperatorContext.GetParameterValue( String bszParamName );

Scripting Syntax

OperatorContext.GetParameterValue( ParameterName );

Parameters

Parameter Type Description
ParameterName String Scripting name (Parameter.ScriptName) of the parameter

See Also

CustomOperator.AddParameter