CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdSSetTracker Class Reference

#include <EdBaseUserIO.h>

Inheritance diagram for OdSSetTracker:
OdEdInputTracker OdRxObject OdEdSSetTracker

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdSSetTracker)
 
virtual bool append (OdDbStub *id, const OdDbSelectionMethod *pMethod)
 
virtual bool remove (OdDbStub *id, const OdDbSelectionMethod *pMethod)
 
virtual bool trackSubentities () const
 
virtual bool append (const OdDbBaseFullSubentPath &subEntPath, const OdDbSelectionMethod *pMethod)
 
virtual bool remove (const OdDbBaseFullSubentPath &subEntPath, const OdDbSelectionMethod *pMethod)
 
- Public Member Functions inherited from OdEdInputTracker
 ODRX_DECLARE_MEMBERS (OdEdInputTracker)
 
virtual int addDrawables (OdGsView *pView)=0
 
virtual void removeDrawables (OdGsView *pView)=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 OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

<group OdEd_Classes>

Definition at line 38 of file EdBaseUserIO.h.

Member Function Documentation

◆ append() [1/2]

virtual bool OdSSetTracker::append ( const OdDbBaseFullSubentPath subEntPath,
const OdDbSelectionMethod pMethod 
)
virtual

Called by select framework when a subentity is going to be appended to working selection set.

Parameters
subEntPath[in] Descriptor of the subentity is going to be appended.
pMethod[in] Selection Method object, describing a method a subentity was selected.
Returns
flag indicating if the subentity can be added to working selection set or not.
Remarks
To enable calling this calback method OdSSetTracker::trackSubentities() should be overridden to return true.

Reimplemented in OdEdSSetTracker.

◆ append() [2/2]

virtual bool OdSSetTracker::append ( OdDbStub *  id,
const OdDbSelectionMethod pMethod 
)
virtual

Called by select framework when an entity is going to be appended to working selection set.

Parameters
id[in] Object id of the entity is going to be appended.
pMethod[in] Selection Method object, describing a method the entity was selected.
Returns
flag indicating if the entity can be added to working selection set or not.

Reimplemented in OdEdSSetTracker.

◆ ODRX_DECLARE_MEMBERS()

OdSSetTracker::ODRX_DECLARE_MEMBERS ( OdSSetTracker  )

◆ remove() [1/2]

virtual bool OdSSetTracker::remove ( const OdDbBaseFullSubentPath subEntPath,
const OdDbSelectionMethod pMethod 
)
virtual

Called by select framework when a subentity is going to be removed from working selection set.

Parameters
subEntPath[in] Descriptor of the subentity is going to be removed.
pMethod[in] Selection Method object, describing a method a subentity was selected.
Returns
flag indicating if subentity can be removed to working selection set or not.
Remarks
To enable calling this calback method OdSSetTracker::trackSubentities() should be overridden to return true.

Reimplemented in OdEdSSetTracker.

◆ remove() [2/2]

virtual bool OdSSetTracker::remove ( OdDbStub *  id,
const OdDbSelectionMethod pMethod 
)
virtual

Called by select framework when an entity is going to be removed to working selection set.

Parameters
id[in] Object id of the entity is going to be removed.
pMethod[in] Selection Method object, describing a method the entity was selected.
Returns
flag indicating if the entity can be removed from working selection set or not.

Reimplemented in OdEdSSetTracker.

◆ trackSubentities()

virtual bool OdSSetTracker::trackSubentities ( ) const
virtual

Called by selection framework. If returned true then append()/remove() would be called for every subentity.


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