SetParameterColor
 
 
 

SetParameterColor

Introduced

v4.0

Description

Sets the color on each parameter in the specified list. In the case of fcurves that already have an assigned color (x,y,z for example), this user color would supercede the default color. This color is used as the node color in the SceneExplorer, curve color in the FCurveEditor and key color in the DopeSheet.

Scripting Syntax

SetParameterColor( [InputObjs], [Value] );

Parameters

Parameter Type Description
InputObjs String List of parameters to color

Default Value: Currently selected and marked parameters.

Value Number Color value to use, which has the following hexadecimal form:

0x00bbggrr

The low-order byte contains a value for the relative intensity of red; the second byte contains a value for green; and the third byte contains a value for blue. The high-order byte must be zero. The maximum value for a single byte is 0xFF.

Default Value: None in which case a color editor dialog will pop-up.

Examples

VBScript Example

' This example demonstrates how to use the SetParameterColor command by creating
' a simple null, adding a custom parameter and then setting the color of that
' custom parameter.  It also sets a simple animation on that custom param so
' there is a curve to display in the AnimationEditor.
'
NewScene, False
GetPrim "Null"
SIAddCustomParameter "null", "yellow_param", siDouble, 0, 0, 1, , 5, 0, 1
SetParameterColor "null.CustomPSet.yellow_param", 65520
SaveKey "null.CustomPSet.yellow_param", 1, 0
SaveKey "null.CustomPSet.yellow_param", 50, 1
SaveKey "null.CustomPSet.yellow_param", 100, 0.5
' 
' If you wish you can now view that parameter color by opening a SceneExplorer
' (make sure that the option 'Use Wire Colors' is on) and expanding the CustomPSet
' node, or opening the FCurveEditor or DopeSheet (from with the Animation Editor)
' and viewing the curve/track.

See Also

ClearParameterColor