#include <DbVisualStyle.h>
Static Public Member Functions | |
| static OdGiFaceStylePtr | createFaceStyle () |
| static OdGiEdgeStylePtr | createEdgeStyle () |
| static OdGiDisplayStylePtr | createDisplayStyle () |
| static OdGiVisualStylePtr | createVisualStyle () |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
This class represents a visual style (a collection of properties) in an OdDbDatabase instance.
<group OdDb_Classes>
Definition at line 79 of file DbVisualStyle.h.
Constructor & Destructor Documentation
◆ OdDbVisualStyle()
| OdDbVisualStyle::OdDbVisualStyle | ( | ) |
Default constructor.
Member Function Documentation
◆ createDisplayStyle()
|
static |
Creates a display style of the visual style.
- Returns
- A smart pointer to the created OdGiDisplayStyle object.
◆ createEdgeStyle()
|
static |
Creates an edge style of the visual style.
- Returns
- A smart pointer to the created OdGiEdgeStyle object.
◆ createFaceStyle()
|
static |
Creates a face style of the visual style.
- Returns
- A smart pointer to the created OdGiFaceStyle object.
◆ createVisualStyle()
|
static |
Creates a OdGiVisualStyle instance.
- Returns
- A smart pointer to the created OdGiVisualStyle object.
◆ description()
| const OdString OdDbVisualStyle::description | ( | ) | const |
Returns the description for the visual style as a string.
◆ displayStyle()
| const OdGiDisplayStyle& OdDbVisualStyle::displayStyle | ( | ) | const |
Returns a reference to a display style of the visual style.
◆ drawable()
|
virtual |
Returns a pointer to the OdGiDrawable for the object. If the object doesn't have an associated OdGiDrawable object, this function returns NULL.
Reimplemented from OdDbObject.
◆ 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.
◆ edgeStyle()
| const OdGiEdgeStyle& OdDbVisualStyle::edgeStyle | ( | ) | const |
Returns a reference to an edge style of the visual style.
◆ faceStyle()
| const OdGiFaceStyle& OdDbVisualStyle::faceStyle | ( | ) | const |
Returns a reference to a face style of the visual style.
◆ isInternalUseOnly()
| bool OdDbVisualStyle::isInternalUseOnly | ( | ) | const |
Determines whether the visual style is for internal use only.
- Returns
- true - if the visual style is for internal use only. false - otherwise.
◆ name()
Gets a name (key) of the OdGiVisualStyle object in the dictionary.
- Parameters
-
value [out] A reference to a string value to get the name.
◆ ODDB_DECLARE_MEMBERS()
| OdDbVisualStyle::ODDB_DECLARE_MEMBERS | ( | OdDbVisualStyle | ) |
◆ setDescription()
Sets the description for the visual style.
- Parameters
-
pDescription [in] Reference to a string that contains the description for this visual style to set.
◆ setDisplayStyle()
| void OdDbVisualStyle::setDisplayStyle | ( | const OdGiDisplayStyle & | displayStyle | ) |
Sets the display style of the visual style.
- Parameters
-
displayStyle [in] Reference to the OdGiDisplayStyle object to set.
◆ setEdgeStyle()
| void OdDbVisualStyle::setEdgeStyle | ( | const OdGiEdgeStyle & | edgeStyle | ) |
Sets the edge style of the visual style.
- Parameters
-
edgeStyle [in] Reference to the OdGiEdgeStyle object to set.
◆ setFaceStyle()
| void OdDbVisualStyle::setFaceStyle | ( | const OdGiFaceStyle & | faceStyle | ) |
Sets the face style of the visual style.
- Parameters
-
faceStyle [in] Reference to the OdGiFaceStyle object to set.
◆ setInternalUseOnly()
| void OdDbVisualStyle::setInternalUseOnly | ( | bool | bInternalUseOnly | ) |
Sets a flag that indicates the visual style is for internal use only.
- Parameters
-
bInternalUseOnly [in] Boolean value to set.
◆ setTrait() [1/7]
| void OdDbVisualStyle::setTrait | ( | OdGiVisualStyleProperties::Property | prop, |
| bool | bVal, | ||
| OdGiVisualStyleOperations::Operation | op = OdGiVisualStyleOperations::kSet |
||
| ) |
Sets a boolean property of the visual style.
- Parameters
-
prop [in] OdGiVisualStyleProperties::Property to set. bVal [in] Boolean property value to set. op [in] OdGiVisualStyleOperations::Operation to use for setting the property.
◆ setTrait() [2/7]
| void OdDbVisualStyle::setTrait | ( | OdGiVisualStyleProperties::Property | prop, |
| const OdCmColor * | pColor, | ||
| OdGiVisualStyleOperations::Operation | op = OdGiVisualStyleOperations::kSet |
||
| ) |
Sets a color property of the visual style by the given OdCmColor value.
- Parameters
-
prop [in] OdGiVisualStyleProperties::Property to set. pColor [in] Pointer to the OdCmColor value to set. op [in] OdGiVisualStyleOperations::Operation to use for setting the property.
◆ setTrait() [3/7]
| void OdDbVisualStyle::setTrait | ( | OdGiVisualStyleProperties::Property | prop, |
| const OdGiVariant * | pVal, | ||
| OdGiVisualStyleOperations::Operation | op = OdGiVisualStyleOperations::kSet |
||
| ) |
Sets a property of the visual style.
- Parameters
-
prop [in] OdGiVisualStyleProperties::Property to set. pVal [in] Pointer to the OdGiVariant property value to set. op [in] OdGiVisualStyleOperations::Operation to use for setting the property.
◆ setTrait() [4/7]
| void OdDbVisualStyle::setTrait | ( | OdGiVisualStyleProperties::Property | prop, |
| const OdString & | strVal, | ||
| OdGiVisualStyleOperations::Operation | op = OdGiVisualStyleOperations::kSet |
||
| ) |
Sets a string property of the visual style.
- Parameters
-
prop [in] OdGiVisualStyleProperties::Property to set. strVal [in] Reference to the OdString value to set. op [in] OdGiVisualStyleOperations::Operation to use for setting the property.
◆ setTrait() [5/7]
| void OdDbVisualStyle::setTrait | ( | OdGiVisualStyleProperties::Property | prop, |
| double | dVal, | ||
| OdGiVisualStyleOperations::Operation | op = OdGiVisualStyleOperations::kSet |
||
| ) |
Sets a double property of the visual style.
- Parameters
-
prop [in] OdGiVisualStyleProperties::Property to set. dVal [in] Boolean property value to set. op [in] OdGiVisualStyleOperations::Operation to use for setting the property.
◆ setTrait() [6/7]
| void OdDbVisualStyle::setTrait | ( | OdGiVisualStyleProperties::Property | prop, |
| double | red, | ||
| double | green, | ||
| double | blue, | ||
| OdGiVisualStyleOperations::Operation | op = OdGiVisualStyleOperations::kSet |
||
| ) |
Sets a color property of the visual style with given RGB component values.
- Parameters
-
prop [in] OdGiVisualStyleProperties::Property to set. red [in] Red component value to set. green [in] Green component value to set. blue [in] Blue component value to set. op [in] OdGiVisualStyleOperations::Operation to use for setting the property.
◆ setTrait() [7/7]
| void OdDbVisualStyle::setTrait | ( | OdGiVisualStyleProperties::Property | prop, |
| OdInt32 | nVal, | ||
| OdGiVisualStyleOperations::Operation | op = OdGiVisualStyleOperations::kSet |
||
| ) |
Sets an integer property of the visual style.
- Parameters
-
prop [in] OdGiVisualStyleProperties::Property to set. nVal [in] Integer property value to set. op [in] OdGiVisualStyleOperations::Operation to use for setting the property.
◆ setTraitFlag()
| void OdDbVisualStyle::setTraitFlag | ( | OdGiVisualStyleProperties::Property | flagProp, |
| OdUInt32 | flagVal, | ||
| bool | bEnable = true |
||
| ) |
Sets a property flag for the visual style (for properties that are bitfield enumerations).
- Parameters
-
flagProp [in] OdGiVisualStyleProperties::Property to set. flagVal [in] Flag value to set. bEnable [in] Boolean value that defines if the flag is enabled. Use true to enable the flag, false to disable.
◆ setType()
| void OdDbVisualStyle::setType | ( | OdGiVisualStyle::Type | type | ) |
Sets the type of the visual style. All available types are defined in the OdGiVisualStyle::Type enumeration.
- Parameters
-
type [in] The visual style type to set.
◆ subSetAttributes()
|
virtual |
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
- Parameters
-
pTraits [in] Pointer to the OdGiDrawableTraits object to be set.
- Remarks
- When overriding subSetAttributes(), you must OR (|) the return value of <base class>::subSetAttributes(pTraits) with any flags you add.
A derived class may not remove flags for any reason.
The default implementation does nothing but returns kDrawableNone. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ trait()
| OdGiVariantPtr OdDbVisualStyle::trait | ( | OdGiVisualStyleProperties::Property | prop, |
| OdGiVisualStyleOperations::Operation * | pOp = NULL |
||
| ) | const |
Gets a property of the visual style and an operation that is currently used for this property.
- Parameters
-
prop [in] OdGiVisualStyleProperties::Property to set. op [out] Output OdGiVisualStyleOperations::Operation that is currently in effect for this property.
- Returns
- Returns a smart pointer to the OdGiVariant value of the property.
◆ traitFlag()
| bool OdDbVisualStyle::traitFlag | ( | OdGiVisualStyleProperties::Property | flagProp, |
| OdUInt32 | flagVal | ||
| ) | const |
Gets a property flag from the visual style (for properties that are bitfield enumerations).
- Parameters
-
flagProp [in] OdGiVisualStyleProperties::Property to get. flagVal [in] Flag value to get.
- Returns
- true - if the flag is enabled. false - otherwise.
◆ type()
| OdGiVisualStyle::Type OdDbVisualStyle::type | ( | ) | const |
Returns the type of the visual style. All available types are defined in the OdGiVisualStyle::Type enumeration.
The documentation for this class was generated from the following file: