OdCmEntityColor Class

Class Hierarchy

Syntax

C++

class OdCmEntityColor;

File

CmColorBase.h

Description

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

Remarks

The entity color object can specify any of the following color methods:

Name	Value	Description
kByLayer	0xC0	Color is specified by the layer object on which the object resides.
kByBlock	0xC1	Color is specified by the block object in which the object is contained.
kByColor	0xC2	Color is specified by an RGB value.
kByACI	0xC3	Color is specified by an index (ACI) of a color palette.
kByPen	0xC4	Color is specified by an index of a pen color table.
kForeground	0xC5	Color is the same as the foreground color.
kByDgnIndex	0xC7	Color is specified by an index of a .dgn color table.
kNone	0xC8	Color is absent (object is clear).

An entity has no color from the time it is first instantiated until it is assigned one or added to a database. The ColorMethod enumeration defines the constants for color methods.

Overview of Classes that Implement Color and Transparency

Methods of the Color Definition

	Name	Description
	OdCmEntityColor	This is the overview for the OdCmEntityColor constructor overload.

OdCmEntityColor Data Members

	Name	Description
	mLUT	Maps the colors between ACI values and RGB values.

OdCmEntityColor Enumerations

	Name	Description
	ACIcolorMethod	Represents color indices for the ACI color method.
	Color	Represents the RGB color components.
	ColorMethod	Represents the color method.

OdCmEntityColor Methods

	Name	Description
	blue	This is the overview for the blue method overload.
	color	This is the overview for the color method overload.
	colorIndex	This is the overview for the colorIndex method overload.
	colorMethod	This is the overview for the colorMethod method overload.
	green	This is the overview for the green method overload.
	isByACI	This is the overview for the isByACI method overload.
	isByBlock	This is the overview for the isByBlock method overload.
	isByColor	This is the overview for the isByColor method overload.
	isByDgnIndex	This is the overview for the isByDgnIndex method overload.
	isByLayer	This is the overview for the isByLayer method overload.
	isForeground	This is the overview for the isForeground method overload.
	isNone	This is the overview for the isNone method overload.
	lookUpACI	Converts the RGB value specified by the red, green, and blue components to an ACI value.
	lookUpRGB	Converts the specified color index (ACI value) to an RGB value.
	red	This is the overview for the red method overload.
	setBlue	This is the overview for the setBlue method overload.
	setColor	This is the overview for the setColor method overload.
	setColorIndex	This is the overview for the setColorIndex method overload.
	setColorMethod	This is the overview for the setColorMethod method overload.
	setDgnColorIndex	Sets the .dgn color index (DgnIndex) of a color palette and sets the color method to byDgnIndex for the entity color object.
	setGreen	This is the overview for the setGreen method overload.
	setRed	This is the overview for the setRed method overload.
	setRGB	This is the overview for the setRGB method overload.
	setTrueColor	This is the overview for the setTrueColor method overload.
	setTrueColorMethod	This is the overview for the setTrueColorMethod method overload.
	trueColor	This is the overview for the trueColor method overload.
	trueColorMethod	This is the overview for the trueColorMethod method overload.

OdCmEntityColor Nested Types

Name	Description
RGBM	Represents the combined value of the color and color method.

OdCmEntityColor Operators

	Name	Description
	!=	Compares two entity color objects as integer values, and returns true when their values are not equal or false when their values are equal.
	=	Copies an entity color object specified on the right of the operator to the entity color object specified on the left.
	==	Compares two entity color objects as integer values, and returns true when their values are equal or false when their values are not equal.

Send feedback about this topic