 |
| |
A palette object represents a color lookup table that maps indices to red, green, and blue values.
IDLgrPalette::CleanupThe IDLgrPalette:: Cleanup procedure method performs all cleanup on the object. IDLgrPalette is described above.
NOTE: Cleanup methods are special lifecycle methods , and as such cannot be called outside the context of object destruction. This means that in most cases, you cannot call the Cleanup method directly. There is one exception to this rule: If you write your own subclass of this class, you can call the Cleanup method from within the Cleanup method of the subclass.
IDLgrPalette::GetRGBThe IDLgrPalette:: GetRGB function method returns the RGB values contained in the palette at the given index. The returned value is a three-element vector of the form [red, green, blue]. IDLgrPalette is described above.
IDLgrPalette::GetPropertyThe IDLgrPalette:: GetProperty procedure method retrieves the value of a property or group of properties for the palette. IDLgrPalette is described above.
Any keyword to IDLgrPalette::Init
Set this keyword to a named variable that will contain an anonymous structure containing the values of all of the properties associated with the state of this object. State information about the object includes things like color, range, tick direction, etc., but not image, vertex, or connectivity data, or user values.
Set this keyword to return the current bottom stretch value of the palette. This value is in the range of 0 £ Value £ 100.
IDLgrPalette::InitThe IDLgrPalette:: Init function method initializes a palette object. IDLgrPalette is described above.
NOTE: Init methods are special lifecycle methods , and as such cannot be called outside the context of object creation. This means that in most cases, you cannot call the Init method directly. There is one exception to this rule: If you write your own subclass of this class, you can call the Init method from within the Init method of the subclass.
Obj = OBJ_NEW('IDLgrPalette', [aRed , aGreen , aBlue] )
Result =
Obj
->
[IDLgrPalette::]
Init(
[aRed
,
aGreen
,
aBlue]
)
(
In a subclass' Init method only
.)
A vector containing the red values for the color palette. These values should be within the range of 0 £ Value £ 255. The number of elements comprising the aRed vector must not exceed 256.
Properties retrievable via IDLgrPalette::GetProperty
A vector containing the blue values for the color palette. Setting this value is the same as specifying the aBlue argument to the IDLgrPalette::Init method.
Set this keyword equal to the bottom parameter for stretching the colors in the palette. This value must be in the range of 0 £ Value £ 100. The default value is 0.
Set this keyword to the gamma value to be applied to the color palette. This value should be in the range of 0.1 £ Gamma £ 10.0. The default is 1.0.
A vector containing the green values for the color palette. Setting this value is the same as specifying the aGreen argument to the IDLgrPalette::Init method.
Set this keyword equal to a string containing the name associated with this object. The default is the null string, ' '.
A vector containing the red values for the color palette. Setting this value is the same as specifying the aRed argument to the IDLgrPalette::Init method.
Set this keyword equal to the top parameter for stretching the colors in the palette. This value must be in the range of 0 £ Value £ 100. The default value is 100.
Set this keyword to a value of any type. You can use this "user value" to contain any information you wish. Remember that if you set the user value equal to a pointer or object reference, you should destroy the pointer or object reference explicitly when destroying the object it is a user value of.
IDLgrPalette::LoadCTThe IDLgrPalette:: LoadCT procedure method loads one of the IDL predefined color tables into an IDLgrPalette object. IDLgrPalette is described above.
IDLgrPalette::NearestColorThe IDLgrPalette:: NearestColor function method returns the index of the color in the palette that best matches the given RGB values. IDLgrPalette is described above.
The red value of the color that should be matched. This value should be within the range of 0 £ Value £ 255.
IDLgrPalette::SetRGBThe IDLgrPalette:: SetRGB procedure method sets the color values at a specified index in the palette to the specified Red, Green and Blue values. IDLgrPalette is described above.
IDLgrPalette::SetPropertyThe IDLgrPalette:: SetProperty procedure method sets the value of a property or group of properties for the palette. IDLgrPalette is described above.
Any keyword to IDLgrPalette::Init