OdSiSpatialIndex Class Reference

#include <SiSpatialIndex.h>

Inheritance diagram for OdSiSpatialIndex:

Public Types
enum	CreationFlags {   kSiNoFlags = 0 , kSiPlanar = (1 << 0) , kSiModifyMtAware = (1 << 1) , kSiAccessMtAware = (1 << 2) ,   kSiFullMtAware = (kSiModifyMtAware | kSiAccessMtAware) }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdSiSpatialIndex)
virtual void	insert (OdSiEntity *entity)=0
virtual bool	remove (OdSiEntity *entity)=0
virtual void	query (const OdSiShape &shape, OdSiVisitor &visitor) const =0
virtual void	clear ()=0
virtual void	setMaxTreeDepth (unsigned char maxDepth)=0
virtual void	setMaxNodeSize (unsigned char maxCount)=0
virtual bool	extents (OdGeExtents3d &extents) const =0
virtual unsigned	maxTreeDepth () const =0
virtual unsigned	maxNodeSize () const =0
virtual const OdGeTol &	tolerance () const =0
virtual void	setTolerance (const OdGeTol &tol)=0
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () 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 OdSiSpatialIndexPtr	createObject (OdUInt32 flags, unsigned int initialNumEntity, unsigned int maxDepth=30, unsigned int maxCount=20, double eps=1e-10)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class represents SpatialIndex objects. Corresponding C++ library: SpatialIndex <group OdSi_Classes>

Definition at line 117 of file SiSpatialIndex.h.

Member Enumeration Documentation

CreationFlags

enum OdSiSpatialIndex::CreationFlags

Spatial Index creation flags.

Enumerator
kSiNoFlags
kSiPlanar
kSiModifyMtAware
kSiAccessMtAware
kSiFullMtAware

Definition at line 125 of file SiSpatialIndex.h.

Member Function Documentation

clear()

virtual void OdSiSpatialIndex::clear ( )

pure virtual

Clears this SpatialIndex object.

createObject()

static OdSiSpatialIndexPtr OdSiSpatialIndex::createObject ( OdUInt32  flags, unsigned int  initialNumEntity, unsigned int  maxDepth = 30, unsigned int  maxCount = 20, double  eps = 1e-10  )

static

Creates a SpatialIndex object with the specified parameters.

Parameters

flags	[in] Specifies set of flags for Spatial Index creation.
maxDepth	[in] Maximum depth of the Spatial Index.
maxCount	[in] Maximum number of nodes in the SpatialIndex.
eps	[in] Relative tolerance (equalVector).

Returns

Returns a SmartPointer to the new SpatialIndex object.

Remarks

maxDepth specifies the maximum number of times the tree-structured SpatialIndex can branch.

extents()

virtual bool OdSiSpatialIndex::extents ( OdGeExtents3d &  extents ) const

pure virtual

Returns the extents of this SpatialIndex object.

Parameters

extents

[out] Receives the extents.

Returns

Returns true if and only if this SpatialIndex object has extents.

insert()

virtual void OdSiSpatialIndex::insert ( OdSiEntity *  entity )

pure virtual

Inserts the specified SiEntity object into the this SpatialIndex object.

Parameters

entity

[in] Pointer to the OdSiEntity to insert.

maxNodeSize()

virtual unsigned OdSiSpatialIndex::maxNodeSize ( ) const

pure virtual

Returns the maxiumum number of nodes in this SpatialIndex object.

maxTreeDepth()

virtual unsigned OdSiSpatialIndex::maxTreeDepth ( ) const

pure virtual

Returns the maximum depth of this SpatialIndex object.

Remarks

maxDepth specifies the maximum number of times the tree-structured SpatialIndex can branch.

ODRX_DECLARE_MEMBERS()

OdSiSpatialIndex::ODRX_DECLARE_MEMBERS

(

OdSiSpatialIndex

)

query()

virtual void OdSiSpatialIndex::query ( const OdSiShape &  shape, OdSiVisitor &  visitor  ) const

pure virtual

Parameters

shape	[in] Any OdSiShape object.
visitor	[in] Any OdSiVisitor object.

remove()

virtual bool OdSiSpatialIndex::remove ( OdSiEntity *  entity )

pure virtual

Removes the specified SiEntity object into the this SpatialIndex object.

Parameters

entity

[in] Pointer to the OdSiEntity to remove.

Returns

Returns true if and only if the specified entity was in this SpatialIndex object.

setMaxNodeSize()

virtual void OdSiSpatialIndex::setMaxNodeSize ( unsigned char  maxCount )

pure virtual

Sets the maxiumum number of nodes in this SpatialIndex object.

Parameters

maxCount

[in] Maximum number of nodes.

setMaxTreeDepth()

virtual void OdSiSpatialIndex::setMaxTreeDepth ( unsigned char  maxDepth )

pure virtual

Sets the maximum depth of this SpatialIndex object.

Parameters

maxDepth

[in] Maximum depth.

Remarks

maxDepth specifies the maximum number of times the tree-structured SpatialIndex can branch.

setTolerance()

virtual void OdSiSpatialIndex::setTolerance ( const OdGeTol &  tol )

pure virtual

tolerance()

virtual const OdGeTol& OdSiSpatialIndex::tolerance ( ) const

pure virtual

Returns the tolerance of this SpatialIndex object.

Returns

Returns tolerance where equalPoint value is scaled by extents of SpatialIndex.

---

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

• SiSpatialIndex.h