Go to: Synopsis. Return value. Related. Flags. MEL examples.

Synopsis

displayRGBColor [-alpha] [-create] [-hueSaturationValue] [-list] [-resetToFactory] [-resetToSaved] string

displayRGBColor is undoable, queryable, and NOT editable.

This command changes or queries the display color for anything in the application that allows the user to set its color. These colors are part of the UI and not part of the saved data for a model. This command is not undoable.

Return value

stringwhen the list flag is used, none otherwise

In query mode, return type is based on queried flag.

Related

currentUnit, displayAffected, displayColor, displayCull, displayLevelOfDetail, displayPref, displaySmoothness, displayStats, displaySurface, hide, refresh, showHidden, toggle

Flags

alpha, create, hueSaturationValue, list, resetToFactory, resetToSaved
Long name (short name) Argument types Properties
-alpha(-a)
2023
 query
Indicates that we want to query the alpha value of the color. Upon query, returns RGBA or HSVA as an array of 4 floats.
-create(-c) create
Creates a new RGB display color which can be queried or set. If is used only when saving color preferences. name Specifies the name of color to change.
-hueSaturationValue(-hsv) createquery
Indicates that rgb values are really hsv values. Upon query, returns the HSV values as an array of 3 floats. h s v The HSV values for the color. (Between 0-1)
-list(-l) create
Writes out a list of all RGB color names and their value.
-resetToFactory(-rf) create
Resets all the RGB display colors to their factory defaults.
-resetToSaved(-rs) create
Resets all the RGB display colors to their saved values.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

// Set the background colour to red
displayRGBColor "background" 1 0 0;

// Set the background colour to red with semi-transparency
displayRGBColor "background" 1 0 0 0.5;

// List the current RGB color settings
displayRGBColor -list;

// Query a RGB color by name
displayRGBColor "object" -query

// Query the HSVA values of a color
displayRGBColor "object" -query -hsv -alpha