CFx SDK Documentation  2020SP3
Public Member Functions | Protected Member Functions | List of all members
OdSelectionSet Class Referenceabstract

#include <SSet.h>

Inheritance diagram for OdSelectionSet:
OdRxObject OdDbSelectionSet OdStaticRxObject< OdDbSelectionSet > CFxSelectionSet

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdSelectionSet)
 
virtual const OdRxObjectbaseDatabase () const =0
 
virtual OdSelectionSetIteratorPtr newIterator () const =0
 
virtual OdUInt32 numEntities () const =0
 
virtual void append (OdDbStub *entityId, OdDbSelectionMethod *pMethod=0)=0
 
virtual void append (const OdDbBaseFullSubentPath &subent, OdDbSelectionMethod *pMethod=0)=0
 
virtual void append (const OdSelectionSet *pSSet)=0
 
virtual void remove (OdDbStub *entityId)=0
 
virtual void remove (const OdDbBaseFullSubentPath &subent)=0
 
virtual void remove (const OdSelectionSet *pSSet)=0
 
virtual bool isMember (OdDbStub *entityId) const =0
 
virtual bool isMember (const OdDbBaseFullSubentPath &subent) const =0
 
virtual OdDbSelectionMethodPtr method (OdDbStub *entityId) const =0
 
virtual void clear ()=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
 

Protected Member Functions

 OdSelectionSet ()
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class represents Selection Sets in an Teigha application.

Remarks
Only entities from an OdDbDatabase object's ModelSpace or PaperSpace may be added to a Selection Set.

<group OdDb_Classes>

Definition at line 164 of file SSet.h.

Constructor & Destructor Documentation

◆ OdSelectionSet()

OdSelectionSet::OdSelectionSet ( )
protected

Member Function Documentation

◆ append() [1/3]

virtual void OdSelectionSet::append ( const OdDbBaseFullSubentPath subent,
OdDbSelectionMethod pMethod = 0 
)
pure virtual

Appends the specified subentity to this SelectionSet object.

Parameters
subent[in] Subentity path to append.

◆ append() [2/3]

virtual void OdSelectionSet::append ( const OdSelectionSet pSSet)
pure virtual

Appends the specified entity to this SelectionSet object.

Parameters
pSSet[in] Other selection set to copy entities from.

Implemented in OdDbSelectionSet.

◆ append() [3/3]

virtual void OdSelectionSet::append ( OdDbStub *  entityId,
OdDbSelectionMethod pMethod = 0 
)
pure virtual

Appends the specified entity to this SelectionSet object.

Parameters
entityId[in] Object ID of the OdDbEntity.
method[in] Selection method to associate with object

◆ baseDatabase()

virtual const OdRxObject* OdSelectionSet::baseDatabase ( ) const
pure virtual

◆ clear()

virtual void OdSelectionSet::clear ( )
pure virtual

Removes all members of this SelectionSet object.

◆ isMember() [1/2]

virtual bool OdSelectionSet::isMember ( const OdDbBaseFullSubentPath subent) const
pure virtual

Returns true if and only if the specified subentity is a member of this SelectionSet object.

Parameters
entityId[in] Subentity path.

◆ isMember() [2/2]

virtual bool OdSelectionSet::isMember ( OdDbStub *  entityId) const
pure virtual

Returns true if and only if the specified entity is a member of this SelectionSet object.

Parameters
entityId[in] Object ID of the OdDbEntity.

◆ method()

virtual OdDbSelectionMethodPtr OdSelectionSet::method ( OdDbStub *  entityId) const
pure virtual

◆ newIterator()

virtual OdSelectionSetIteratorPtr OdSelectionSet::newIterator ( ) const
pure virtual

Returns an Iterator object that provides access to the entities in this Selection Set.

◆ numEntities()

virtual OdUInt32 OdSelectionSet::numEntities ( ) const
pure virtual

Returns the number of entities in this group.

◆ ODRX_DECLARE_MEMBERS()

OdSelectionSet::ODRX_DECLARE_MEMBERS ( OdSelectionSet  )

◆ remove() [1/3]

virtual void OdSelectionSet::remove ( const OdDbBaseFullSubentPath subent)
pure virtual

Removes the specified subentity from this SelectionSet object.

Parameters
subent[in] Subentity path to remove.

◆ remove() [2/3]

virtual void OdSelectionSet::remove ( const OdSelectionSet pSSet)
pure virtual

Removes the specified entity from this SelectionSet object.

Parameters
pSSet[in] Object ID of the OdDbEntity.

Implemented in OdDbSelectionSet.

◆ remove() [3/3]

virtual void OdSelectionSet::remove ( OdDbStub *  entityId)
pure virtual

Removes the specified entity from this SelectionSet object.

Parameters
entityId[in] Object ID of the OdDbEntity.

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