#include <DbColor.h>
Public Member Functions inherited from Detailed Description
<group OdDb_Classes>
This class implements the color object that stores information about a color as an element of the database container. The database stores the color instances in the dictionary and associates the object ID with an each color instance. The color dictionary is accessed from the database object using the getColorDictionaryId() method. The root drawing dictionary, associates the "ACAD_COLOR" name with the color dictionary.
- See also
- <link db_color_sample_dictionary, Example of Working with the Color Dictionary Object>
<link db_color_sample_object, Example of Entering and Displaying for Color Objects>
- See also
- <link cm_concept, Concept of Colors>
<link db_color_concept, Concept of Database Colors>
Constructor & Destructor Documentation
◆ OdDbColor()
| OdDbColor::OdDbColor | ( | ) |
Builds an instance of the color object.
- Remarks
- Use the static pseudo-constructor instead it. See: <link db_color_manipulate, Manipulating Objects of the Color Dictionary>
Member Function Documentation
◆ cmColor()
| const OdCmColor & OdDbColor::cmColor | ( | ) | const |
Returns the unnamed color and named color instance specified by the byLayer, byBlock, byColor, byACI, byPen, Foreground, byDgnIndex, None color methods, or name in a book.
- See also
- <link db_color_sample_dictionary, Example of Working with the Color Dictionary Object>
<link db_color_sample_object, Example of Entering and Displaying for Color Objects>
<link db_color, Working with Colors>
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbObject.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbObject.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbObject.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbObject.
◆ entityColor()
| OdCmEntityColor OdDbColor::entityColor | ( | ) | const |
Returns the unnamed entity color instance specified by the byLayer, byBlock, byColor, byACI, byPen, Foreground, byDgnIndex, None color methods.
- See also
- <link cm_color_sample_entity, Example of Working with the Entity Color>
<link db_color, Working with Colors>
<link cm, Colors and Transparencies>
<link OdCmEntityColor, OdCmEntityColor class>
◆ ODDB_DECLARE_MEMBERS()
| OdDbColor::ODDB_DECLARE_MEMBERS | ( | OdDbColor | ) |
◆ setColor()
Sets the unnamed color and named color instance for the database color object.
- Parameters
-
cmColor [in] A reference to the color instance.
- See also
- <link db_color_sample_dictionary, Example of Working with the Color Dictionary Object>
<link db_color_sample_object, Example of Entering and Displaying for Color Objects>
<link db_color, Working with Colors>
The documentation for this class was generated from the following file: