CFx SDK Documentation  2020SP3
Public Types | Public Member Functions | List of all members
OdDbRapidRTRenderSettings Class Reference

#include <DbRenderSettings.h>

Inheritance diagram for OdDbRapidRTRenderSettings:
OdDbRenderSettings OdDbObject OdGiDrawable OdRxObject

Public Types

enum  RenderTarget { krLevel = 0, krTime, krInfinite }
 
- Public Types inherited from OdGiDrawable
enum  SetAttributesFlags {
  kDrawableNone = 0, kDrawableIsAnEntity = 1, kDrawableUsesNesting = 2, kDrawableIsCompoundObject = 4,
  kDrawableViewIndependentViewportDraw = 8, kDrawableIsInvisible = 16, kDrawableHasAttributes = 32, kDrawableRegenTypeDependantGeometry = 64,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128), kDrawableRegenDraw = 256, kDrawableStandardDisplaySingleLOD = 512, kDrawableShadedDisplaySingleLOD = 1024,
  kDrawableViewDependentViewportDraw = 2048, kDrawableBlockDependentViewportDraw = 4096, kDrawableIsExternalReference = 8192, kDrawableNotPlottable = 16384,
  kLastFlag = kDrawableNotPlottable
}
 
enum  DrawableType {
  kGeometry = 0, kDistantLight = 1, kPointLight = 2, kSpotLight = 3,
  kAmbientLight, kSolidBackground, kGradientBackground, kImageBackground,
  kGroundPlaneBackground, kViewport, kWebLight, kSkyBackground,
  kImageBasedLightingBackground
}
 

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbRapidRTRenderSettings)
 
 OdDbRapidRTRenderSettings ()
 
virtual ~OdDbRapidRTRenderSettings ()
 
OdResult setRenderTarget (RenderTarget target)
 
RenderTarget renderTarget () const
 
OdResult setRenderLevel (int level)
 
int renderLevel () const
 
OdResult setRenderTime (int time)
 
int renderTime () const
 
OdResult setLightingModel (OdGiLightingMode mode)
 
OdGiLightingMode lightingModel () const
 
OdResult setFilterType (OdGiFilterType type)
 
OdGiFilterType filterType () const
 
OdResult setFilterWidth (float width)
 
float filterWidth () const
 
OdResult setFilterHeight (float height)
 
float filterHeight () const
 
OdResult setFilterDimensions (float width, float height)
 
void filterDimensions (float &width, float &height) const
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
virtual bool operator== (const OdDbRapidRTRenderSettings &settings)
 
- Public Member Functions inherited from OdDbRenderSettings
 ODDB_DECLARE_MEMBERS (OdDbRenderSettings)
 
 OdDbRenderSettings ()
 
virtual ~OdDbRenderSettings ()
 
virtual OdGiDrawabledrawable ()
 
OdResult setName (const OdString &name)
 
OdString name () const
 
void setDescription (const OdString &description)
 
OdString description () const
 
void setDisplayIndex (int displayIndex)
 
int displayIndex () const
 
void setMaterialsEnabled (bool materialsEnabled)
 
bool materialsEnabled () const
 
void setTextureSampling (bool textureSampling)
 
bool textureSampling () const
 
void setBackFacesEnabled (bool backFacesEnabled)
 
bool backFacesEnabled () const
 
void setShadowsEnabled (bool shadowsEnabled)
 
bool shadowsEnabled () const
 
OdResult setPreviewImageFileName (const OdString &filename)
 
OdString previewImageFileName () const
 
void setDiagnosticBackgroundEnabled (bool diagnosticBackgroundEnabled)
 
bool diagnosticBackgroundEnabled () const
 
OdResult setIsPredefined (bool bSet)
 
bool isPredefined () const
 
virtual bool operator== (const OdDbRenderSettings &settings)
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~OdDbObject ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
OdDbObjectId objectId () const
 
OdDbHandle getDbHandle () const
 
OdDbHandle handle () const
 
OdDbObjectId ownerId () const
 
virtual void setOwnerId (OdDbObjectId ownerId)
 
OdDbDatabasedatabase () const
 
void createExtensionDictionary ()
 
OdDbObjectId extensionDictionary () const
 
bool releaseExtensionDictionary ()
 
OdDbXrecordPtr createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)
 
void upgradeOpen ()
 
void downgradeOpen ()
 
void cancel ()
 
virtual OdResult subOpen (OdDb::OpenMode mode)
 
virtual void subClose ()
 
OdResult erase (bool eraseIt=true)
 
virtual OdResult subErase (bool erasing)
 
void handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)
 
virtual void subHandOverTo (OdDbObject *pNewObject)
 
void swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void audit (OdDbAuditInfo *pAuditInfo)
 
void dwgIn (OdDbDwgFiler *pFiler)
 
void dwgOut (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfIn (OdDbDxfFiler *pFiler)
 
virtual void dxfOut (OdDbDxfFiler *pFiler) const
 
virtual OdResult dxfInFields_R12 (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields_R12 (OdDbDxfFiler *pFiler) const
 
virtual OdDb::DuplicateRecordCloning mergeStyle () const
 
virtual OdResBufPtr xData (const OdString &regappName=OdString::kEmpty) const
 
virtual void setXData (const OdResBuf *pRb)
 
bool isEraseStatusToggled () const
 
bool isErased () const
 
bool isReadEnabled () const
 
bool isWriteEnabled () const
 
bool isNotifyEnabled () const
 
bool isModified () const
 
bool isModifiedXData () const
 
bool isModifiedGraphics () const
 
bool isNewObject () const
 
bool isNotifying () const
 
bool isUndoing () const
 
bool isReallyClosing () const
 
bool isDBRO () const
 
void assertReadEnabled () const
 
void assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
 
void assertNotifyEnabled () const
 
void disableUndoRecording (bool disable)
 
bool isUndoRecordingDisabled () const
 
OdDbDwgFilerundoFiler ()
 
virtual void applyPartialUndo (OdDbDwgFiler *pUndoFiler, OdRxClass *pClassObj)
 
void addReactor (OdDbObjectReactor *pReactor) const
 
void removeReactor (OdDbObjectReactor *pReactor) const
 
virtual void addPersistentReactor (const OdDbObjectId &objId)
 
virtual void removePersistentReactor (const OdDbObjectId &objId)
 
bool hasPersistentReactor (const OdDbObjectId &objId) const
 
OdDbObjectIdArray getPersistentReactors () const
 
OdDbObjectReactorArray getTransientReactors () const
 
virtual void recvPropagateModify (const OdDbObject *pSubObj)
 
virtual void xmitPropagateModify () const
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr deepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
virtual void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)
 
void setOdDbObjectIdsInFlux ()
 
bool isOdDbObjectIdsInFlux () const
 
virtual void copied (const OdDbObject *pObject, const OdDbObject *pNewObject)
 
virtual void erased (const OdDbObject *pObject, bool erasing=true)
 
virtual void goodbye (const OdDbObject *pObject)
 
virtual void openedForModify (const OdDbObject *pObject)
 
virtual void modified (const OdDbObject *pObject)
 
virtual void subObjModified (const OdDbObject *pObject, const OdDbObject *pSubObj)
 
virtual void modifyUndone (const OdDbObject *pObject)
 
virtual void modifiedXData (const OdDbObject *pObject)
 
virtual void unappended (const OdDbObject *pObject)
 
virtual void reappended (const OdDbObject *pObject)
 
bool isAProxy () const
 
virtual void objectClosed (const OdDbObjectId &objectId)
 
virtual void modifiedGraphics (const OdDbObject *pObject)
 
virtual void copyFrom (const OdRxObject *pSource)
 
bool hasSaveVersionOverride () const
 
void setHasSaveVersionOverride (bool hasSaveVersionOverride)
 
virtual OdDb::DwgVersion getObjectSaveVersion (const OdDbFiler *pFiler, OdDb::MaintReleaseVer *pMaintVer=0) const
 
virtual OdDbObjectPtr decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
virtual OdDbObjectPtr decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
void convertForSave (OdDb::DwgVersion ver)
 
virtual void composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)
 
virtual bool subWorldDraw (OdGiWorldDraw *pWd) const
 
virtual void subViewportDraw (OdGiViewportDraw *pVd) const
 
virtual bool isPersistent () const
 
virtual OdDbStub * id () const
 
ODRX_SEALED_VIRTUAL OdResult getClassID (void *pClsid) const ODRX_SEALED
 
void setGsNode (OdGsCache *pNode)
 
OdGsCachegsNode () const
 
void xDataTransformBy (const OdGeMatrix3d &xfm)
 
bool hasFields () const
 
OdDbObjectId getField (const OdString &fieldName) const
 
OdDbObjectPtr getField (const OdString &fieldName, OdDb::OpenMode mode) const
 
virtual OdDbObjectId setField (const OdString &fieldName, OdDbField *pField)
 
virtual OdResult removeField (OdDbObjectId fieldId)
 
virtual OdDbObjectId removeField (const OdString &fieldName)
 
OdDbObjectId getFieldDictionary () const
 
OdDbObjectPtr getFieldDictionary (OdDb::OpenMode mode) const
 
virtual OdRxClasssaveAsClass (OdRxClass *pClass) const
 
- Public Member Functions inherited from OdGiDrawable
 ODRX_DECLARE_MEMBERS (OdGiDrawable)
 
virtual DrawableType drawableType () const
 
ODRX_SEALED_VIRTUAL OdUInt32 setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdDbObject
 OdDbObject ()
 
virtual OdResult subGetClassID (void *pClsid) const
 
virtual OdDbObjectPtr subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
 
virtual OdDbObjectPtr subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
 
- Protected Member Functions inherited from OdGiDrawable
 OdGiDrawable ()
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

This class is a container class for the properties relevent to rapid RT renderers.

Remarks
Database-resident OdDbRapidRTRenderSettings objects are stored in the NamedObjectsDictionary under ACAD_RENDER_RAPIDRT_SETTINGS.

In addition, the active RenderSettings are stored in the NamedObjectsDictionary under ACAD_RENDER_ACTIVE_RAPIDRT_SETTINGS.

See also
TD_Db <group OdDb_Classes>

Definition at line 890 of file DbRenderSettings.h.

Member Enumeration Documentation

◆ RenderTarget

Rendring quit condition.

Enumerator
krLevel 
krTime 
krInfinite 

Definition at line 896 of file DbRenderSettings.h.

Constructor & Destructor Documentation

◆ OdDbRapidRTRenderSettings()

OdDbRapidRTRenderSettings::OdDbRapidRTRenderSettings ( )

◆ ~OdDbRapidRTRenderSettings()

virtual OdDbRapidRTRenderSettings::~OdDbRapidRTRenderSettings ( )
virtual

Member Function Documentation

◆ dwgInFields()

virtual OdResult OdDbRapidRTRenderSettings::dwgInFields ( OdDbDwgFiler pFiler)
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 OdDbRenderSettings.

◆ dwgOutFields()

virtual void OdDbRapidRTRenderSettings::dwgOutFields ( OdDbDwgFiler pFiler) const
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 OdDbRenderSettings.

◆ dxfInFields()

virtual OdResult OdDbRapidRTRenderSettings::dxfInFields ( OdDbDxfFiler pFiler)
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 OdDbRenderSettings.

◆ dxfOutFields()

virtual void OdDbRapidRTRenderSettings::dxfOutFields ( OdDbDxfFiler pFiler) const
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 OdDbRenderSettings.

◆ filterDimensions()

void OdDbRapidRTRenderSettings::filterDimensions ( float &  width,
float &  height 
) const
inline

Returns currently set render filter width and height.

Parameters
width[out] Render filter width value.
height[out] Render filter height value.

Definition at line 1020 of file DbRenderSettings.h.

◆ filterHeight()

float OdDbRapidRTRenderSettings::filterHeight ( ) const

Returns currently set render filter height.

◆ filterType()

OdGiFilterType OdDbRapidRTRenderSettings::filterType ( ) const

Returns currently set render filter type.

◆ filterWidth()

float OdDbRapidRTRenderSettings::filterWidth ( ) const

Returns currently set render filter width.

◆ lightingModel()

OdGiLightingMode OdDbRapidRTRenderSettings::lightingModel ( ) const

Returns currently set render lighting model.

◆ ODDB_DECLARE_MEMBERS()

OdDbRapidRTRenderSettings::ODDB_DECLARE_MEMBERS ( OdDbRapidRTRenderSettings  )

◆ operator==()

virtual bool OdDbRapidRTRenderSettings::operator== ( const OdDbRapidRTRenderSettings settings)
virtual

◆ renderLevel()

int OdDbRapidRTRenderSettings::renderLevel ( ) const

Returns currently set render level.

◆ renderTarget()

RenderTarget OdDbRapidRTRenderSettings::renderTarget ( ) const

Returns currently set render target.

◆ renderTime()

int OdDbRapidRTRenderSettings::renderTime ( ) const

Returns currently set render time.

◆ setFilterDimensions()

OdResult OdDbRapidRTRenderSettings::setFilterDimensions ( float  width,
float  height 
)
inline

Sets render filter width and height.

Parameters
width[in] New render filter width value.
height[in] New render filter height value.
Returns
Returns eOk if successful, or an appropriate error code if not.

Definition at line 1007 of file DbRenderSettings.h.

◆ setFilterHeight()

OdResult OdDbRapidRTRenderSettings::setFilterHeight ( float  height)

Sets render filter height.

Parameters
height[in] New render filter height value.
Returns
Returns eOk if successful, or an appropriate error code if not.

◆ setFilterType()

OdResult OdDbRapidRTRenderSettings::setFilterType ( OdGiFilterType  type)

Sets render filter type.

Parameters
type[in] New render filter type value.
Returns
Returns eOk if successful, or an appropriate error code if not.

◆ setFilterWidth()

OdResult OdDbRapidRTRenderSettings::setFilterWidth ( float  width)

Sets render filter width.

Parameters
width[in] New render filter width value.
Returns
Returns eOk if successful, or an appropriate error code if not.

◆ setLightingModel()

OdResult OdDbRapidRTRenderSettings::setLightingModel ( OdGiLightingMode  mode)

Sets render lighting model.

Parameters
mode[in] New render lighting model value.
Returns
Returns eOk if successful, or an appropriate error code if not.

◆ setRenderLevel()

OdResult OdDbRapidRTRenderSettings::setRenderLevel ( int  level)

Sets render level.

Parameters
level[in] New render level value.
Returns
Returns eOk if successful, or an appropriate error code if not.

◆ setRenderTarget()

OdResult OdDbRapidRTRenderSettings::setRenderTarget ( RenderTarget  target)

Sets render target.

Parameters
target[in] New render target value.
Returns
Returns eOk if successful, or an appropriate error code if not.

◆ setRenderTime()

OdResult OdDbRapidRTRenderSettings::setRenderTime ( int  time)

Sets render time.

Parameters
time[in] New render time value.
Returns
Returns eOk if successful, or an appropriate error code if not.

◆ subSetAttributes()

virtual OdUInt32 OdDbRapidRTRenderSettings::subSetAttributes ( OdGiDrawableTraits pTraits) const
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 OdDbRenderSettings.


The documentation for this class was generated from the following file: