VisualizationFoundation CATColorMap

Usage: you must use this class as is. You should never derive it.

public class CATColorMap

Class to create a table of 256 indexed colors.
Role: This class permits to have a relationship between an indexed color and its red, green and blue components.
The table index ranges from 0 to 255.

Constructor and Destructor Index


o CATColorMap()
Constructs a default color map.
o CATColorMap(CATColorMap&)
Constructs a color map by copy.
o ~CATColorMap()
Deletes the color map.

Method Index


o GetColor(int,int*,int*,int*)
Retrieves the red, green and blue components of an indexed color.
o GetColor(int,float*,float*,float*)
Retrieves the red, green and blue components of an indexed color.
o GetForegroundColor(float,float,float)
Returns the index of the indexed foreground color for the red, green and blue components specified.
o SetColor(int,int,int,int)
Sets the red, green and blue components of an indexed color.
o SetColor(int,float,float,float)
Sets the red, green and blue components of an indexed color.

Constructor and Destructor


o CATColorMap
public CATColorMap()
Constructs a default color map.
o CATColorMap
public CATColorMap( const iColorMap)
Constructs a color map by copy.
Parameters:
iColorMap
The color map to be copied.
o ~CATColorMap
public virtual ~CATColorMap()
Deletes the color map.

Methods


o GetColor
public GetColor( const Index,
oRed,
oGreen,
oBlue)
Retrieves the red, green and blue components of an indexed color.
Parameters:
iIndex
The index of the color to be read. Legal values: iIndex ranges from 0 to 255.
oRed
The red component of the color. Legal values: oRed ranges from 0 to 255.
oGreen
The green component of the color. Legal values: oGreen ranges from 0 to 255.
oBlue
The blue component of the color. Legal values: oBlue ranges from 0 to 255.
o GetColor
public GetColor( const iIndex,
oRed,
oGreen,
oBlue)
Retrieves the red, green and blue components of an indexed color.
Parameters:
iIndex
The index of the color to be read. Legal values: iIndex ranges from 0 to 255.
oRed
The red component of the color. Legal values: oRed ranges from 0.0 to 1.0.
oGreen
The green component of the color. Legal values: oGreen ranges from 0.0 to 1.0.
oBlue
The blue component of the color. Legal values: oBlue ranges from 0.0 to 1.0.
o GetForegroundColor
public GetForegroundColor( const iRed,
const iGreen,
const iBlue)
Returns the index of the indexed foreground color for the red, green and blue components specified.
Parameters:
iRed
The red component of the color. Legal values: iRed ranges from 0.0 to 1.0.
iGreen
The green component of the color. Legal values: iGreen ranges from 0.0 to 1.0.
iBlue
The blue component of the color. Legal values: iBlue ranges from 0.0 to 1.0.
o SetColor
public SetColor( const iIndex,
const iRed,
const iGreen,
const iBlue)
Sets the red, green and blue components of an indexed color.
Parameters:
iIndex
The index of the color. Legal values: iIndex ranges from 0 to 255.
iRed
The red component of the color. Legal values: iRed ranges from 0 to 255.
iGreen
The green component of the color. Legal values: iGreen ranges from 0 to 255.
iBlue
The blue component of the color. Legal values: iBlue ranges from 0 to 255.
o SetColor
public SetColor( const iIndex,
const iRed,
const iGreen,
const iBlue)
Sets the red, green and blue components of an indexed color.
Parameters:
iIndex
The index of the color. Legal values: iIndex ranges from 0 to 255.
iRed
The red component of the color. Legal values: iRed ranges from 0.0 to 1.0.
iGreen
The green component of the color. Legal values: iGreen ranges from 0.0 to 1.0.
iBlue
The blue component of the color. Legal values: iBlue ranges from 0.0 to 1.0.
This object is included in the file: CATColorMap.h
If needed, your Imakefile.mk should include the module: CATVisFoundation

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.