CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
OdSelectionSetIterator Class Referenceabstract

#include <SSet.h>

Inheritance diagram for OdSelectionSetIterator:
OdRxObject OdDbSelectionSetIterator

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdSelectionSetIterator)
 
virtual OdDbSelectionMethodPtr method () const =0
 
virtual bool done () const =0
 
virtual bool next ()=0
 
virtual OdUInt32 subentCount ()=0
 
virtual bool getSubentity (OdUInt32 i, OdDbBaseFullSubentPath &path)=0
 
virtual OdDbStub * id () 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
 

Protected Member Functions

 OdSelectionSetIterator ()
 

Additional Inherited Members

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

Detailed Description

This class implements iterators for OdSelectionSet objects.

Remarks

Instances are returned by OdSelectionSet::newIterator().

<group OdDb_Classes>

Definition at line 98 of file SSet.h.

Constructor & Destructor Documentation

◆ OdSelectionSetIterator()

OdSelectionSetIterator::OdSelectionSetIterator ( )
protected

Member Function Documentation

◆ done()

virtual bool OdSelectionSetIterator::done ( ) const
pure virtual

Returns true if and only if the traversal by this Iterator object is complete.

◆ getSubentity()

virtual bool OdSelectionSetIterator::getSubentity ( OdUInt32  i,
OdDbBaseFullSubentPath path 
)
pure virtual

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

Parameters
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.

◆ id()

virtual OdDbStub * OdSelectionSetIterator::id ( ) const
pure virtual

Returns the GiDrawable ID at the current position specified by this Iterator object.

◆ method()

virtual OdDbSelectionMethodPtr OdSelectionSetIterator::method ( ) const
pure virtual

◆ next()

virtual bool OdSelectionSetIterator::next ( )
pure virtual

Sets this Iterator object to reference the entry following the current entry.

Returns
Returns true if and only if not at the end of the list.

◆ ODRX_DECLARE_MEMBERS()

OdSelectionSetIterator::ODRX_DECLARE_MEMBERS ( OdSelectionSetIterator  )

◆ subentCount()

virtual OdUInt32 OdSelectionSetIterator::subentCount ( )
pure virtual

Returns the number of subentities selected inside the current entity. (analogous to acedSSSubentLength)

Returns
Returns true if and only if not at the end of the list.

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