OdCmEntityColor Class

Syntax

C++

class OdCmEntityColor;

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.

Class Hierarchy

File: CmColorBase.h

Module: API Reference

Overview of Classes that Implement Color and Transparency

Methods of the Color Definition

OdCmColorBase class

OdCmColor class

Methods

OdCmEntityColor()

This is the overview for the OdCmEntityColor constructor overload.

Data Members

mLUT	Maps the colors between ACI values and RGB values.

Enumerations

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

Methods

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(OdUInt8)	This is the overview for the setBlue method overload.
setColor(OdUInt32)	This is the overview for the setColor method overload.
setColorIndex(OdInt16)	This is the overview for the setColorIndex method overload.
setColorMethod(ColorMethod)	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(OdUInt8)	This is the overview for the setGreen method overload.
setRGB(OdUInt8, OdUInt8, OdUInt8)	This is the overview for the setRGB method overload.
setRed(OdUInt8)	This is the overview for the setRed method overload.
setTrueColor()	This is the overview for the setTrueColor method overload.

Nested Types

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

Operators

!=	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.

Links

OdCmEntityColor Constructor
OdCmEntityColor Enumerations
OdCmEntityColor Data Members
OdCmEntityColor Methods
OdCmEntityColor Operators
OdCmEntityColor Nested Types

Relief for ODA Team in Ukraine