OdCmColor Class

Class Hierarchy

Syntax

C++

class OdCmColor : public OdCmColorBase;

File

CmColor.h

Description

This class implements Color object that represents the unnamed and named colors specified by the byLayer, byBlock, byColor, byACI, byPen, Foreground, byDgnIndex, or None color methods.

The OdCmEntityColor class, the OdCmColorBase class

Group

OdCm Classes

Public Methods

	Name	Description
	~OdCmColor	Empty destructor.
	OdCmColor	This is the overview for the OdCmColor constructor overload.

OdCmColor Data Members

	Name	Description
	MaxColorIndex

OdCmColor Methods

	Name	Description
	audit	Perform an audit operation on this object.
	blue	Returns the value of the blue component of this color.
	bookName	Returns the current book name.
	color	Returns the current color value as integer.
	colorIndex	Returns the color index (ACI) of the entity color object.
	colorMethod	Returns the color method of this color.
	colorName	Returns the name of the current color.
	colorNameForDisplay	If colorName isn't empty, returns it as a string. Otherwise returns color method as a string.
	dwgIn	Reads the .dwg file format data of this object from the specified file.
	dwgInAsTrueColor
	dwgOut	Writes the .dwg file format data of this object to the specified filer.
	dwgOutAsTrueColor
	dxfIn	Reads the DXF format data of this object from the specified filer.
	dxfOut	Writes the DXF format data of this object to the specified filer.
	entityColor	Returns the OdCmEntityColor settings of the database color object.
	getDescription	Returns the description string of the database color object.
	getDictionaryKey	Returns a dictionary key based on the color name and book name of the database color object.
	getExplanation	Returns the explanation string of the database color object.
	green	Returns the value of the green component of this color.
	isByACI	Checks if the color is specified by an index (ACI) of a color palette (color method of this color is set to "kByACI").
	isByBlock	Checks if the color is specified by the block object in which the object is contained (color method of this color is set to "kByBlock", or it is set to "kByACI" and ACI color method is "kACIbyBlock").
	isByColor	Checks if the color is specified by an RGB value (color method of this color is set to "kByColor").
	isByDgnIndex	Checks if the color is specified by an index of a .dgn color table (color method of this color is set to "kByDgnIndex").
	isByLayer	Checks if the color is specified by the layer object on which the object resides (color method of this color is set to "kByLayer", or it is set to "kByACI" and ACI color method is "kACIbyLayer").
	isForeground	Checks if the color is the same as the foreground color (color method of this color is set to "kForeground", or it is set to "kByACI" and ACI color method is "kACIforeground").
	isNone	Checks if the color is absent (color method of this color is set to "kNone", or it is set to "kByACI" and ACI color method is "kACInone").
	red	Returns the value of the red component of this color.
	setBlue	Sets the blue component of this color.
	setColor	Sets a color and color method from an integer value.
	setColorIndex	Sets the color index (ACI) of a color palette and sets the color method to byACI for the entity color object.
	setColorMethod	Sets a color method for this color.
	setGreen	Sets the green component of this color.
	setNames	Sets the color name and the book name.
	setNamesFromDictionaryKey	Sets the book name and color name for the dictionary keyword.
	setRed	Sets the red component of this color.
	setRGB	Sets color using RGB values. Color method is set to "kByColor".

OdCmColor Operators

	Name	Description
	!=	This is the overview for the != operator overload.
	=	This is the overview for the = operator overload.
	==	This is the overview for the == operator overload.

Send feedback about this topic