CFx SDK Documentation  2023 SP0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OdDbSelectionSet Class Referenceabstract

#include <DbSSet.h>

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

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbSelectionSet)
 
virtual const OdDbDatabasedatabase () const =0
 
virtual OdDbObjectIdArray objectIdArray () const =0
 
 TD_USING (OdSelectionSet::append)
 
virtual void append (const OdDbObjectId &entityId, OdDbSelectionMethod *pMethod=0)=0
 
virtual void append (const OdDbObjectIdArray &entityIds, OdDbSelectionMethod *pMethod=0)
 
virtual void append (const OdDbFullSubentPath &subent, OdDbSelectionMethod *pMethod=0)=0
 
virtual void append (const OdSelectionSet *pSSet)
 
 TD_USING (OdSelectionSet::remove)
 
virtual void remove (const OdDbObjectId &entityId)=0
 
virtual void remove (const OdDbObjectIdArray &entityIds)
 
virtual void remove (const OdDbFullSubentPath &subent)=0
 
virtual void remove (const OdSelectionSet *pSSet)
 
 TD_USING (OdSelectionSet::isMember)
 
virtual bool isMember (const OdDbObjectId &entityId) const =0
 
virtual bool isMember (const OdDbFullSubentPath &subent) const =0
 
 TD_USING (OdSelectionSet::method)
 
virtual OdDbSelectionMethodPtr method (const OdDbObjectId &entityId) const =0
 
virtual OdUInt32 subentCount (const OdDbObjectId &entityId) const =0
 
virtual bool getSubentity (const OdDbObjectId &entityId, OdUInt32 i, OdDbFullSubentPath &path) const =0
 
virtual OdDbSelectionMethodPtr method (const OdDbFullSubentPath &subent) const =0
 
- Public Member Functions inherited from OdSelectionSet
 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 remove (OdDbStub *entityId)=0
 
virtual void remove (const OdDbBaseFullSubentPath &subent)=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
 

Static Public Member Functions

static OdDbSelectionSetPtr createObject (const OdDbDatabase *pDb)
 
static OdDbSelectionSetPtr select (const OdDbDatabase *pDb, const OdRxObject *pFilter=0)
 
static OdDbSelectionSetPtr select (const OdDbObjectId &vpId, int nPoints, const OdGePoint3d *wcsPts, OdDbVisualSelection::Mode mode=OdDbVisualSelection::kCrossing, OdDbVisualSelection::SubentSelectionMode sm=OdDbVisualSelection::kDisableSubents, const OdRxObject *pFilter=0)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

 OdDbSelectionSet ()
 
- Protected Member Functions inherited from OdSelectionSet
 OdSelectionSet ()
 

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 124 of file DbSSet.h.

Constructor & Destructor Documentation

◆ OdDbSelectionSet()

OdDbSelectionSet::OdDbSelectionSet ( )
protected

Member Function Documentation

◆ append() [1/4]

virtual void OdDbSelectionSet::append ( const OdDbFullSubentPath subent,
OdDbSelectionMethod pMethod = 0 
)
pure virtual

Appends the specified subentity to this SelectionSet object.

Parameters
subent[in] Subentity path to append.
pMethod[in] Selection method to associate with objects

◆ append() [2/4]

virtual void OdDbSelectionSet::append ( const OdDbObjectId entityId,
OdDbSelectionMethod pMethod = 0 
)
pure virtual

◆ append() [3/4]

virtual void OdDbSelectionSet::append ( const OdDbObjectIdArray entityIds,
OdDbSelectionMethod pMethod = 0 
)
virtual

Appends the specified entity to this SelectionSet object.

Parameters
entityIds[in] Array of Object IDs of the OdDbEntity's.
pMethod[in] Selection method to associate with objects.

◆ append() [4/4]

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

Appends the specified entity to this SelectionSet object.

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

Implements OdSelectionSet.

◆ createObject()

static OdDbSelectionSetPtr OdDbSelectionSet::createObject ( const OdDbDatabase pDb)
static

Creates a SelectionSet object for the specified database.

Parameters
pDb[in] Pointer to the database object for which to create the SelectionSet object.
Returns
Returns a SmartPointer to the new SelectionSet object.

◆ database()

virtual const OdDbDatabase* OdDbSelectionSet::database ( ) const
pure virtual

◆ getSubentity()

virtual bool OdDbSelectionSet::getSubentity ( const OdDbObjectId entityId,
OdUInt32  i,
OdDbFullSubentPath path 
) const
pure virtual

Returns the given subentity path inside the entity with the given id. (analogous to acedSSSubentName)

Parameters
entityId[in] entity id for the parent of the subentity
i[in] index of the subentity.
path[out] Path to the subentity.
Returns
Returns true if and only if "i" is valid index in the subentities array.

◆ isMember() [1/2]

virtual bool OdDbSelectionSet::isMember ( const OdDbFullSubentPath 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 OdDbSelectionSet::isMember ( const OdDbObjectId entityId) const
pure virtual

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

Parameters
entityId[in] Subentity path.

◆ method() [1/2]

virtual OdDbSelectionMethodPtr OdDbSelectionSet::method ( const OdDbFullSubentPath subent) const
pure virtual

Returns the selection method for the given subentity.

◆ method() [2/2]

virtual OdDbSelectionMethodPtr OdDbSelectionSet::method ( const OdDbObjectId entityId) const
pure virtual

Returns the selection method for the given subentity.

Parameters
entityId[in] Subentity path.

◆ objectIdArray()

virtual OdDbObjectIdArray OdDbSelectionSet::objectIdArray ( ) const
pure virtual

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

◆ ODRX_DECLARE_MEMBERS()

OdDbSelectionSet::ODRX_DECLARE_MEMBERS ( OdDbSelectionSet  )

◆ remove() [1/4]

virtual void OdDbSelectionSet::remove ( const OdDbFullSubentPath subent)
pure virtual

Removes the specified subentity from this SelectionSet object.

Parameters
subent[in] Subentity path to remove.

◆ remove() [2/4]

virtual void OdDbSelectionSet::remove ( const OdDbObjectId entityId)
pure virtual

Removes the specified entity from this SelectionSet object.

Parameters
entityId[in] Object ID of the OdDbEntity.

◆ remove() [3/4]

virtual void OdDbSelectionSet::remove ( const OdDbObjectIdArray entityIds)
virtual

Removes the specified entity from this SelectionSet object.

Parameters
entityIds[in] Array Object ID of the OdDbEntity.

◆ remove() [4/4]

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

Removes the specified entity from this SelectionSet object.

Parameters
pSSet[in] Object ID of the OdDbEntity.

Implements OdSelectionSet.

◆ select() [1/2]

static OdDbSelectionSetPtr OdDbSelectionSet::select ( const OdDbDatabase pDb,
const OdRxObject pFilter = 0 
)
static

Filter selection only.

Parameters
pDb[in] Pointer to the database object for which to create the SelectionSet object.
pFilter[in] object of type OdDbSelectionFilter or pointer to a OdResBuf chain defining the filter.

◆ select() [2/2]

static OdDbSelectionSetPtr OdDbSelectionSet::select ( const OdDbObjectId vpId,
int  nPoints,
const OdGePoint3d wcsPts,
OdDbVisualSelection::Mode  mode = OdDbVisualSelection::kCrossing,
OdDbVisualSelection::SubentSelectionMode  sm = OdDbVisualSelection::kDisableSubents,
const OdRxObject pFilter = 0 
)
static

Filter selection only.

Parameters
vpId[in] id of OdDbViewportTableRecord record or OdDbViewport entity in which to select.
nPoints[in]
wcsPts[in]
mode[in]
pFilter[in] object of type OdDbSelectionFilter or pointer to a OdResBuf chain defining the filter.

◆ subentCount()

virtual OdUInt32 OdDbSelectionSet::subentCount ( const OdDbObjectId entityId) const
pure virtual

Returns the number of subentities selected inside the entity with the given id. (analogous to acedSSSubentLength)

Parameters
entityId[in] entity id for the parent of the subentity
Remarks
Returns true if and only if not at the end of the list.

◆ TD_USING() [1/4]

OdDbSelectionSet::TD_USING ( OdSelectionSet::append  )

Returns the number of entities in this group.

Appends the specified entity to this SelectionSet object.

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

◆ TD_USING() [2/4]

OdDbSelectionSet::TD_USING ( OdSelectionSet::isMember  )

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

Parameters
entityId[in] Object ID of the OdDbEntity.

◆ TD_USING() [3/4]

OdDbSelectionSet::TD_USING ( OdSelectionSet::method  )

◆ TD_USING() [4/4]

OdDbSelectionSet::TD_USING ( OdSelectionSet::remove  )

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: