CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
OdDbHighlightOverrule Class Reference

#include <DbEntityOverrule.h>

Inheritance diagram for OdDbHighlightOverrule:
OdRxOverrule OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbHighlightOverrule)
 
 OdDbHighlightOverrule ()
 
virtual void highlight (const OdDbEntity *pSubject, bool bDoIt=true, const OdDbFullSubentPath *pSubId=0, bool highlightAll=false)
 
- Public Member Functions inherited from OdRxOverrule
 ODRX_DECLARE_MEMBERS (OdRxOverrule)
 
virtual ~OdRxOverrule ()
 
virtual bool isApplicable (const OdRxObject *pOverruledSubject) const =0
 
- 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
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxOverrule
static OdResult addOverrule (OdRxClass *pClass, OdRxOverrule *pOverrule, bool bAddAtLast=false)
 
static OdResult removeOverrule (OdRxClass *pClass, OdRxOverrule *pOverrule)
 
static void setIsOverruling (bool bIsOverruling)
 
static bool isOverruling ()
 
static bool hasOverrule (const OdRxObject *pSubject, OdRxClass *pOverruleClass)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class overrules a subset of highlight linked operations which an entity specifies. It is used as a base class for classes derived from OdDbEntity to change their behavior. Each default implementation calls the corresponding method of the target class.

Corresponding C++ library: TD_Db <group OdDb_Classes>

Definition at line 455 of file DbEntityOverrule.h.

Constructor & Destructor Documentation

◆ OdDbHighlightOverrule()

OdDbHighlightOverrule::OdDbHighlightOverrule ( )

Constructor creates an instance of this class.

Member Function Documentation

◆ highlight()

virtual void OdDbHighlightOverrule::highlight ( const OdDbEntity pSubject,
bool  bDoIt = true,
const OdDbFullSubentPath pSubId = 0,
bool  highlightAll = false 
)
virtual

Overrules OdDbEntity::subHighlight() method and calls it in the default implementation.

Parameters
pSubject[in] A raw pointer to an entity.
bDoIt[in] Indicates whether to highlight.
pSubId[in] A full subentity path that identifies the subentity to be highlighted.
highlightAll[in] Indicates whether to highlight in all viewports.

◆ ODRX_DECLARE_MEMBERS()

OdDbHighlightOverrule::ODRX_DECLARE_MEMBERS ( OdDbHighlightOverrule  )

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