OdDgColorTable Class

Syntax

C++

class OdDgColorTable : public OdDgElement;

Description

The ordinary color table of DGN files. Each database (file) could have its color table of 256 colors (otherwise, the default color table is available). This table keeps all color for the indices [0...255].

Also, the extended color table could be stored among xAttributes of the file (see the static methods below). This table could keep an unlimited number of colors linked by indices of { indices > 255 }.

Please, note that a set of values is predefined (kColorByCell, kByLevel, etc). See OdDgGraphicsElement.h for details.

Corresponding C++ library: TG_Db

Class Hierarchy

File: DgColorTable.h

Module: API Reference

Methods

Show:Inherited

No members matching the current filter

OdDgElement()	This is the overview for the OdDgElement constructor overload.
~OdDgElement	(Inherited from OdDgElement)

Enumerations

DragStat
ElementTypes	All types of elements... more
GripStat
OsnapMode

Friends

Show:Inherited

No members matching the current filter

class OdDgElementImpl	(Inherited from OdDgElement)
class OdDgElementOverrule	(Inherited from OdDgElement)
class OdDgGeometryOverrule	(Inherited from OdDgElement)
class OdDgGripOverrule	(Inherited from OdDgElement)
class OdDgHighlightOverrule	(Inherited from OdDgElement)
class OdDgNamedGroupHeader	(Inherited from OdDgElement)
class OdDgOsnapOverrule	(Inherited from OdDgElement)
class OdDgTransformOverrule	(Inherited from OdDgElement)

Methods

Show:Inherited

No members matching the current filter

addExtendedColor	Add extended color to extended color table. Return dgn color index of new color.
addLinkage(OdUInt16, OdBinaryData const&, bool)	This is the overview for the addLinkage method overload.
addPersistentReactor	Adds the specified persistent reactor to this element's reactor list. (Inherited from OdDgElement)
addReactor	Adds the specified transient reactor to this element's reactor list. (Inherited from OdDgElement)
addRef	OdRxObject overridden (Inherited from OdDgElement)
addXAttribute	Adds the XAttribute with specified handler ID. (Inherited from OdDgElement)
appendToOwner	This function appends this object to the specified owner object. (Inherited from OdDgElement)
applyPartialUndo	(Inherited from OdDgElement)
assertNotifyEnabled	Throws an exception if this object is not open OdDg::kForNotify. (Inherited from OdDgElement)
assertReadEnabled	Throws an exception if this object is not open OdDg::kForRead. (Inherited from OdDgElement)
assertWriteEnabled	Throws an exception if this object is not open OdDg::kForWrite, and controls automatic undo and notification of modifications. (Inherited from OdDgElement)
cloneMeForDragging	Returns the cloneMeForDragging flag for this entity. (Inherited from OdDgElement)
closed	Notification function called immediately before an element is closed. (Inherited from OdDgElement)
composeForLoad	(Inherited from OdDgElement)
copied	Notification function called whenever the notifying element has had its clone() member function called. (Inherited from OdDgElement)
copyFieldReferencesForWBlockClone	Writes object references of this object during wblock clone. (Inherited from OdDgElement)
copyFrom	Copies the contents of the specified object into this object when possible. (Inherited from OdDgElement)
copyLinkageReferencesForWBlockClone	(Inherited from OdDgElement)
copyXAttributeReferencesForWBlockClone	(Inherited from OdDgElement)
correctPaletteForWhiteBackground	If background is white MicroStation draws elements black instead of white. To do the same if background color is defined for this palette as white (element with index #254) then all elements in palette with white will be tuned to black.
currentPalette
database	Returns the OdDgDatabase that contains this object. (Inherited from OdDgElement)
decomposeForSave	Determines the behavior for custom objects when saving. (Inherited from OdDgElement)
deepClone	Performs a deep clone of this object. (Inherited from OdDgElement)
defaultACadPalette
defaultPalette
dgnIn	Reads the DGN format data of this object from the specified file. (Inherited from OdDgElement)
dgnInFields	Reads the DGN data of this object. (Inherited from OdDgElement)
dgnOut	Writes the DGN format data of this object to the specified filer. (Inherited from OdDgElement)
dgnOutFields	Writes the DGN data of this object. (Inherited from OdDgElement)
disableUndoRecording	Controls the undo recording of this object in OdDgDatabase. (Inherited from OdDgElement)
downgradeOpen	Downgrades this object from OdDg::kForWrite to OdDg::kForRead, and returns isReadEnabled(); (Inherited from OdDgElement)
dragStatus	Notification function called when this entity is involved in a drag operation. (Inherited from OdDgElement)
elementId	Returns the Object ID of this object. (Inherited from OdDgElement)
erase	Sets the erased mode of this object. (Inherited from OdDgElement)
erased	Notification function called whenever an element has been erased or unerased. (Inherited from OdDgElement)
explode	(Inherited from OdDgElement)
explodeGeometry	(Inherited from OdDgElement)
explodeGeometryToBlock	(Inherited from OdDgElement)
explodeToBlock	(Inherited from OdDgElement)
getColorIndexByRGB	it tries to find the given RGB color within existing color tables (or add a new color to the extended color table)
getElementSubType	Returns the element subtype. (Inherited from OdDgElement)
getElementType	Returns the element type. (Inherited from OdDgElement)
getExtendedColor	Get extended color from extended color table by dgn color index. Return true if color with requested dgn color index is present into table.
getExtendedColorCount	Return count of extended colors into extended color table.
getExtendedColorIndex	Return dgn color index of extended color by index into extended color table.
getGeomExtents(const OdDgElementId&, OdGeExtents3d&)	This is the overview for the getGeomExtents method overload.
getGeometryModified	(Inherited from OdDgElement)
getGripPoints(OdDgGripDataPtrArray&, const double, const int, const OdGeVector3d&, const int)	This is the overview for the getGripPoints method overload.
getLastModifiedTime()	This is the overview for the getLastModifiedTime method overload.
getLinkages(OdRxObjectPtrArray&)	This is the overview for the getLinkages method overload.
getLockedFlag	Returns true if and only if this element is marked as locked. (Inherited from OdDgElement)
getOsnapPoints(OdDgElement::OsnapMode, OdGsMarker, const OdGePoint3d&, const OdGePoint3d&, const OdGeMatrix3d&, OdGePoint3dArray&)	This is the overview for the getOsnapPoints method overload.
getPersistentReactors	Returns this element's persistent reactors. (Inherited from OdDgElement)
getStretchPoints	(Inherited from OdDgElement)
getStringLinkage	Returns the String Linkage value. (Inherited from OdDgElement)
getTransformedCopy	Creates a copy of this element, and applies the supplied transformation to the newly created copy. (Inherited from OdDgElement)
getTransientReactors	Returns this element's transient reactors. (Inherited from OdDgElement)
getXAttributes(OdRxObjectPtrArray&)	This is the overview for the getXAttributes method overload.
getXDataLinkage	Returns the XData Linkage value. (Inherited from OdDgElement)
goodbye	Notification function called just before an element is deleted from memory. (Inherited from OdDgElement)
gripStatus	Notification function called when this entity is involved in a grip operation. (Inherited from OdDgElement)
gsNode	(Inherited from OdDgElement)
handOverTo	Replaces this database -resident (DBRO) object with the specified non- database -resident (NDBRO) object, while retaining this object's elementId, handle, owner, and reactor list. (Inherited from OdDgElement)
hasPersistentReactor	This method returns true if elmId is the Element ID of a reactor attached to this element. Otherwise, it returns false. (Inherited from OdDgElement)
hasRGBColor
hideMeForDragging	Returns the hideMeForDragging flag for this entity. (Inherited from OdDgElement)
highlight	(Inherited from OdDgElement)
id	(Inherited from OdDgElement)
isContentSnappable	(Inherited from OdDgElement)
isCorrectIndex(const OdDgDatabase*, OdUInt32)	This is the overview for the isCorrectIndex method overload.
isDBRO	Returns true if and only this object is a database -resident object. (Inherited from OdDgElement)
isErased	Returns true if and only if this object is marked as erased. (Inherited from OdDgElement)
isModifiedGraphics	Returns true if and only if an object derived from OdDbEntity has been modified. (Inherited from OdDgElement)
isNewObject	Returns true if and only if this object has not been closed since it was created. (Inherited from OdDgElement)
isNotifyEnabled	Returns true if and only if this object is open OdDg::kForNotify. (Inherited from OdDgElement)
isOdDgElementIdsInFlux	Returns true if and only if this object's Object ID is not valid because the OdDgElement::subDeepClone or OdDgElement::subWblockClone() have yet to be completed. (Inherited from OdDgElement)
isPersistent	(Inherited from OdDgElement)
isReadEnabled	Returns true if and only if this object is open OdDg::kForRead. (Inherited from OdDgElement)
isUndoing	Returns true if and only if this object is taking part in an Undo operation. (Inherited from OdDgElement)
isWriteEnabled	Returns true if and only if this object is open OdDg::kForWrite. (Inherited from OdDgElement)
loadFromFile	Load color table from color resource *.tbl file.
lookupRGB(OdDgDatabase*, OdUInt32)	This is the overview for the lookupRGB method overload.
lookupTrueColor	use the color tables of the given database to search for the color (either ordinary or extended ones); returns zero if fails (+the method to check indices)
modified	Notification function called whenever an element is opened OdDg::kForWrite, a function has been called that could modify the contents of this element, and this element is now being closed. (Inherited from OdDgElement)
modifiedGeometry	Notification function called whenever an geometry of element derived from OdDgGraphicsElement is modified. (Inherited from OdDgElement)
modifiedGraphics	Notification function called whenever an element derived from OdDgGraphicsElement is modified. (Inherited from OdDgElement)
modifiedLinkages	Notification function called whenever the attribute linkages has been written to the notifying element. (Inherited from OdDgElement)
modifyUndone	Notification function called whenever the notifying element is in the midst an Undo operation that is undoing modifications. (Inherited from OdDgElement)
moveGripPointsAt(const OdDgVoidPtrArray&, const OdGeVector3d&, int)	This is the overview for the moveGripPointsAt method overload.
moveStretchPointsAt	Moves the specified stretch points of this entity. (Inherited from OdDgElement)
needPostprocessingAfterMTLoading	If true then composeForLoad will be called second time in single thread mode after multithread loading. (Inherited from OdDgElement)
numRefs	(Inherited from OdDgElement)
openedForModify	Notification function called whenever an element is opened for modify OdDg::kForWrite. (Inherited from OdDgElement)
ownerId	Returns the element ID of this element's owner. (Inherited from OdDgElement)
palette
reappended	Notification function called whenever a Redo process processes the reappending of the notifying element to the database. (Inherited from OdDgElement)
recordGraphicsModified	Sets the bit flag indicating the entity's geometry is changed. (Inherited from OdDgElement)
recvPropagateModify	Allows a subelement of a complex element to notify its root element that it has been changed. (Inherited from OdDgElement)
release	(Inherited from OdDgElement)
removeLinkages	Removes the linkages with specified application ID. (Inherited from OdDgElement)
removePersistentReactor	Removes the specified persistent reactor from this element's reactor list. (Inherited from OdDgElement)
removeReactor	Removes the specified transient reactor from this element's reactor list. (Inherited from OdDgElement)
removeXAttributes	Removes the XAttributes with specified handler ID. (Inherited from OdDgElement)
saveToFile	Save color table to color resource *.tbl file.
setDatabaseDefaults	Applies the default properties of the specified database to this entity. (Inherited from OdDgElement)
setExtendedColor	Set extended color to extended color table by dgn color index. Return true if color with requested dgn color index is presented into table and modification of color successfully finished.
setGeometryModified	(Inherited from OdDgElement)
setGsNode	(Inherited from OdDgElement)
setLastModifiedTime	Set the time of the last modification. (Inherited from OdDgElement)
setLinkages	Sets the linkages with specified application ID. (Inherited from OdDgElement)
setLockedFlag	(Inherited from OdDgElement)
setOdDgElementIdsInFlux	Called on a new created cloned object to indicate that its Object ID is not valid. (Inherited from OdDgElement)
setOwnerId	Sets this element's ownerId data member. (Inherited from OdDgElement)
setPalette
setPropertiesFrom	Copies the properties from the specified entity to this entity. (Inherited from OdDgElement)
setStringLinkage	Sets the String Linkage value. (Inherited from OdDgElement)
setXAttributes	Sets the XAttributes with specified handler ID. (Inherited from OdDgElement)
setXDataLinkage	Sets the XData Linkage value. (Inherited from OdDgElement)
subClose	Called as the first operation as this object is being closed, for database -resident objects only. When overriding this function: 1) If the OdDgElement's state is incorrect, return something other than eOk. 2) If the parent class's subClose() returns anything other than eOk, immediately return it. 3) If other actions are required before close, do them. 4) Return eOk. If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns false. The default implementation of this function does nothing but return eOk. This function can be overridden in... more (Inherited from OdDgElement)
subElementModified	Notification function called whenever a method of the specified subelement has called assertWriteEnabled() (Inherited from OdDgElement)
subErase	Called as the first operation as this object is being erased or unerased. (Inherited from OdDgElement)
subGetTransformedCopy	(Inherited from OdDgElement)
subHandOverTo	Called as the first operation of the handOverTo function. (Inherited from OdDgElement)
subOpen	Notification function called by the ODA Drawings API for DGN immediately before an object is opened. (Inherited from OdDgElement)
subSetAttributes	(Inherited from OdDgElement)
subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set. (Inherited from OdDgElement)
subSwapIdWith	Called as the first operation of swapIdWith (Inherited from OdDgElement)
subTransformBy	(Inherited from OdDgElement)
subViewportDraw	(Inherited from OdDgElement)
subWorldDraw	(Inherited from OdDgElement)
swapIdWith	Swaps the elementIDs, and handles between this object and another object. (Inherited from OdDgElement)
transformBy	Applies the specified 3D transformation matrix to this entity. (Inherited from OdDgElement)
unappended	Notification function called whenever the Undo process processes the appending of the notifying element to the database. (Inherited from OdDgElement)
undoFiler	Returns the undo filer associated with this object. (Inherited from OdDgElement)
updateFieldReferencesForWBlockClone	(Inherited from OdDgElement)
updateLinkageReferencesForWBlockClone	(Inherited from OdDgElement)
updateXAttributeReferencesForWBlockClone	(Inherited from OdDgElement)
upgradeOpen	Upgrades this object from OdDg::kForRead to OdDg::kForWrite if there is only one reader, and returns isWriteEnabled(); (Inherited from OdDgElement)
wblockClone	Performs a shallow clone of this object. (Inherited from OdDgElement)
xmitPropagateModify	Allows a subelement of a complex element to notify its root element that it has been changed. (Inherited from OdDgElement)

Links

OdDgColorTable Methods

Relief for ODA Team in Ukraine