#include <DbRenderSettings.h>
Public Member Functions inherited from Detailed Description
This class is a container class for the properties relevent to generic high-fidelity renderers.
- Remarks
- Database-resident OdDbRenderSettings objects are stored in the NamedObjectsDictionary under ACAD_RENDER_SETTINGS.
In addition, the active RenderSettings are stored in the NamedObjectsDictionary under ACAD_RENDER_ACTIVE_SETTINGS.
- See also
- TD_Db <group OdDb_Classes>
Definition at line 43 of file DbRenderSettings.h.
Constructor & Destructor Documentation
◆ OdDbRenderSettings()
| OdDbRenderSettings::OdDbRenderSettings | ( | ) |
◆ ~OdDbRenderSettings()
|
virtual |
Member Function Documentation
◆ backFacesEnabled()
| bool OdDbRenderSettings::backFacesEnabled | ( | ) | const |
Returns true if and only if back-facing faces are rendered for this RenderSettings object.
◆ description()
| OdString OdDbRenderSettings::description | ( | ) | const |
Returns the description of this RenderSettings object.
◆ diagnosticBackgroundEnabled()
| bool OdDbRenderSettings::diagnosticBackgroundEnabled | ( | ) | const |
Return true if and only if the diagnostic background is enabled for this RenderSettings object.
◆ displayIndex()
| int OdDbRenderSettings::displayIndex | ( | ) | const |
Returns the DisplayIndex of this RenderSettings object.
- Remarks
- The DisplayIndex specfies the display order in the UI of the entries in the ACAD_RENDER_SETTINGS dictionary.
DisplayIndices need not be positive or consecutive, and are not intended for use as ID numbers.
◆ drawable()
|
virtual |
Returns the OdGiDrawable for this RenderSettings object.
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.
Reimplemented in OdDbRapidRTRenderSettings, and OdDbMentalRayRenderSettings.
◆ 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.
Reimplemented in OdDbRapidRTRenderSettings, and OdDbMentalRayRenderSettings.
◆ 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.
Reimplemented in OdDbRapidRTRenderSettings, and OdDbMentalRayRenderSettings.
◆ 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.
Reimplemented in OdDbRapidRTRenderSettings, and OdDbMentalRayRenderSettings.
◆ isPredefined()
| bool OdDbRenderSettings::isPredefined | ( | ) | const |
Returns flag which is identifies does this render settings are predefined or not.
◆ materialsEnabled()
| bool OdDbRenderSettings::materialsEnabled | ( | ) | const |
Returns true if and only if materials are rendered on a per-object basis for this RenderSettings object.
- Remarks
- If true, materials are rendered on a per-object basis. If false, all objects are rendered with the global material.
The default value for MaterialsEnabled == true.
◆ name()
| OdString OdDbRenderSettings::name | ( | ) | const |
Returns the name of this RenderSettings object.
◆ ODDB_DECLARE_MEMBERS()
| OdDbRenderSettings::ODDB_DECLARE_MEMBERS | ( | OdDbRenderSettings | ) |
◆ operator==()
|
virtual |
◆ previewImageFileName()
| OdString OdDbRenderSettings::previewImageFileName | ( | ) | const |
Returns the full filename of the preview image for this RenderSettings object.
- Remarks
If the PreviewImageFileName is blank, no preview image is associated with this RenderSettings object.
◆ setBackFacesEnabled()
| void OdDbRenderSettings::setBackFacesEnabled | ( | bool | backFacesEnabled | ) |
Controls the rendering of back-facing faces for this RenderSettings object.
- Parameters
-
backFacesEnabled [in] Controls BackFacesEnabled.
- Remarks
- Back-facing faces are rendered if and only if BackFacesEanbled == true;
- The default value for BackFacesEnabled == true;
◆ setDescription()
Sets the description of this RenderSettings object.
- Parameters
-
description [in] Description.
◆ setDiagnosticBackgroundEnabled()
| void OdDbRenderSettings::setDiagnosticBackgroundEnabled | ( | bool | diagnosticBackgroundEnabled | ) |
Controls the rendering of the diagnostic background for this RenderSettings object.
- Parameters
-
diagnosticBackgroundEnabled [in] Controls DiagnosticBackgroundEnabled.
- Remarks
- The diagnostic (checker) background overrides the background for this RenderSettings object.
The default value of DiagnosticBackgroundEnabled == false.
◆ setDisplayIndex()
| void OdDbRenderSettings::setDisplayIndex | ( | int | displayIndex | ) |
Sets the DisplayIndex of this RenderSettings object.
- Parameters
-
displayIndex [in] DisplayIndex.
- Remarks
- The DisplayIndex specfies the display order in the UI of the entries in the ACAD_RENDER_SETTINGS dictionary.
DisplayIndices need not be positive or consecutive, and are not intended for use as ID numbers.
◆ setIsPredefined()
| OdResult OdDbRenderSettings::setIsPredefined | ( | bool | bSet | ) |
Sets flag which is identifies does this render settings are predefined or not.
- Parameters
-
bSet [in] Set flag.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
◆ setMaterialsEnabled()
| void OdDbRenderSettings::setMaterialsEnabled | ( | bool | materialsEnabled | ) |
Controls the rendering of materials on a per-object basis for this RenderSettings object.
- Parameters
-
materialsEnabled [in] Controls MaterialsEnabled.
- Remarks
- If true, materials are rendered on a per-object basis. If false, all objects are rendered with the global material.
The default value for MaterialsEnabled == true.
◆ setName()
Sets the name of this RenderSettings object.
- Parameters
-
name [in] Name.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- No check is made for RenderSettings objects with duplicate names.
◆ setPreviewImageFileName()
Sets the full filename of the preview image for this RenderSettings object.
- Parameters
-
filename [in] Filename.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- If the PreviewImageFileName is blank, no preview image is associated with this RenderSettings object. The default value for PreviewImageFileName is blank.
◆ setShadowsEnabled()
| void OdDbRenderSettings::setShadowsEnabled | ( | bool | shadowsEnabled | ) |
Controls the casting of shadows for this RenderSettings object.
- Parameters
-
shadowsEnabled [in] Controls ShadowsEnabled.
- Remarks
- Shadows are cast if and only if ShadowsEnabled == true;
- The default value for ShadowsEnabled == true;
◆ setTextureSampling()
| void OdDbRenderSettings::setTextureSampling | ( | bool | textureSampling | ) |
Controls the sampling of image textures for this RenderSettings object.
- Parameters
-
textureSampling [in] Controls TextureSampling.
◆ shadowsEnabled()
| bool OdDbRenderSettings::shadowsEnabled | ( | ) | const |
Returns true if and only if shadows are cast for this RenderSettings object.
◆ 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.
Reimplemented in OdDbRapidRTRenderSettings, and OdDbMentalRayRenderSettings.
◆ textureSampling()
| bool OdDbRenderSettings::textureSampling | ( | ) | const |
Returns true if and only if texture sampling is enabled for this RenderSettings object.
The documentation for this class was generated from the following file: