RVC::QSEARCHTREE Class Reference

Manages RVC::OBJTYPE_QuadSearchTree. More...

#include <rvc/quadtree.h>

Inheritance diagram for RVC::QSEARCHTREE:

[legend]

List of all members.

Classes
class	FILTER_EXISTING
	Filter to test for existing QSEARCHTREE object of specific OBJTYPE associated with specific ELEMTYPE. More...
class	FILTER_EXISTING_CURRENT
	Filter to test for existing current QSEARCHTREE object. More...
class	FILTER_VALID
	Filter to test for "valid" QSEARCHTREE object. More...
class	MAKEPARMS
Public Member Functions
	QSEARCHTREE (const RVC::QSEARCHTREE &rhs)
	QSEARCHTREE ()
virtual	~QSEARCHTREE ()
ERRVALUE	AddElement (INT32 ElemNum, const DPOINT2D &Point)
ERRVALUE	AddElement (INT32 ElemNum, const DRECT2D &Extents)
ERRVALUE	ChangeElement (INT32 OldElemNum, INT32 NewElemNum, const DPOINT2D &Point)
ERRVALUE	ChangeElement (INT32 OldElemNum, INT32 NewElemNum, const DRECT2D &Extents)
ERRVALUE	Clear (const MAKEPARMS &MakeParms)
ERRVALUE	CreateFromLegacy (QSEARCHTREE &DestObj)
ERRVALUE	DeleteElement (INT32 ElemNum, const DPOINT2D &Point)
ERRVALUE	DeleteElement (INT32 ElemNum, const DRECT2D &Extents)
ELEMTYPE	GetElemType () const
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const MAKEPARMS &MakeParms, const char *Source=0, const CREDENTIALS *pCredentials=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const MAKEPARMS &MakeParms, const CREDENTIALS *pCredentials RVC_DEFAULT_CREDENTIALS)
RVC::QSEARCHTREE &	operator= (const RVC::QSEARCHTREE &rhs)
ERRVALUE	Search (const DRECT2D &Extents, UNSIGNEDSET &ElemSet) const
ERRVALUE	Search (const DRECT2D &Extents, SIMPLE_ARRAY< INT32 > &ElemArray) const
ERRVALUE	Validate () const
Static Public Member Functions
static void	GenerateDftDescriptor (ELEMTYPE ElemType, OBJTYPE ParentObjType, DESCRIPTOR &Descriptor, const char *Source=0)

---

Detailed Description

Manages RVC::OBJTYPE_QuadSearchTree.

.. objects.

RVC Object Types that this class supports: RVC::OBJTYPE_QuadSearchTree_Legacy, RVC::OBJTYPE_QuadSearchTree_List, RVC::OBJTYPE_QuadSearchTree_Set.

Default RVC Object Type for this class: RVC::OBJTYPE_QuadSearchTree_List.

Valid parents for this class:

• RVC::OBJTYPE_Vector
• RVC::OBJTYPE_CAD
• RVC::OBJTYPE_TIN
• RVC::OBJTYPE_SHAPE

---

Constructor & Destructor Documentation

RVC::QSEARCHTREE::QSEARCHTREE

(

)

Default Constructor.

RVC::QSEARCHTREE::QSEARCHTREE

(

const RVC::QSEARCHTREE &

rhs

)

Copy Constructor.

virtual RVC::QSEARCHTREE::~QSEARCHTREE

(

)

[virtual]

Destructor.

---

Member Function Documentation

ERRVALUE RVC::QSEARCHTREE::AddElement	(	INT32	ElemNum,
		const DPOINT2D &	Point
	)

Add an element to the search tree.

Parameters:

	ElemNum	Element number to add to search tree.
	Point	Location of element to add

ERRVALUE RVC::QSEARCHTREE::AddElement	(	INT32	ElemNum,
		const DRECT2D &	Extents
	)

Add an element to the search tree.

Parameters:

	ElemNum	Element number to add to search tree.
	Extents	Extents of element to add

ERRVALUE RVC::QSEARCHTREE::ChangeElement	(	INT32	OldElemNum,
		INT32	NewElemNum,
		const DPOINT2D &	Point
	)

Change an element from the search tree.

Parameters:

	OldElemNum	Old element number
	NewElemNum	New element number
	Point	Location of element to change

ERRVALUE RVC::QSEARCHTREE::ChangeElement	(	INT32	OldElemNum,
		INT32	NewElemNum,
		const DRECT2D &	Extents
	)

Change an element from the search tree.

Parameters:

	OldElemNum	Old element number
	NewElemNum	New element number
	Extents	Extents of element to change

ERRVALUE RVC::QSEARCHTREE::Clear

(

const MAKEPARMS &

MakeParms

)

Clear all elements out of quadtree object and make a new initial quadtree setup.

ERRVALUE RVC::QSEARCHTREE::CreateFromLegacy

(

QSEARCHTREE &

DestObj

)

ERRVALUE RVC::QSEARCHTREE::DeleteElement	(	INT32	ElemNum,
		const DPOINT2D &	Point
	)

Remove an element from the search tree.

Parameters:

	ElemNum	Element to remove
	Point	Location of element to remove

ERRVALUE RVC::QSEARCHTREE::DeleteElement	(	INT32	ElemNum,
		const DRECT2D &	Extents
	)

Remove an element from the search tree.

Parameters:

	ElemNum	Element to remove
	Extents	Extents of element to remove

static void RVC::QSEARCHTREE::GenerateDftDescriptor	(	ELEMTYPE	ElemType,
		OBJTYPE	ParentObjType,
		DESCRIPTOR &	Descriptor,
		const char *	Source = 0
	)			[static]

Fill in the DESCRIPTOR with defaults based on the ELEMTYPE.

ELEMTYPE RVC::QSEARCHTREE::GetElemType

(

)

const [inline]

Obtain the ELEMTYPE associated with this search tree.

ERRVALUE RVC::QSEARCHTREE::Make	(	RVC::OBJITEM &	ObjItem,
		const MAKEPARMS &	MakeParms,
		const char *	Source = 0,
		const CREDENTIALS *	pCredentials = 0
	)

Make a search tree object.

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	Source	Source of new spatial tree object, default is application name
	pCredentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::QSEARCHTREE::Make	(	const RVC::OBJECT &	parent,
		const RVC::DESCRIPTOR &	Descriptor,
		const MAKEPARMS &	MakeParms,
		const CREDENTIALS *pCredentials	RVC_DEFAULT_CREDENTIALS
	)

Make a search tree object.

Parameters:

RVC_DEFAULT_CREDENTIALS

User credentials passed in, NULL for default behavior

RVC::QSEARCHTREE& RVC::QSEARCHTREE::operator=

(

const RVC::QSEARCHTREE &

rhs

)

Assignment.

Reimplemented from RVC::OBJECT.

ERRVALUE RVC::QSEARCHTREE::Search	(	const DRECT2D &	Extents,
		UNSIGNEDSET &	ElemSet
	)			const

Find set of elements that fall within rectangle.

Parameters:

	Extents	Extents to search with
	ElemSet	Set of element numbers returned

ERRVALUE RVC::QSEARCHTREE::Search	(	const DRECT2D &	Extents,
		SIMPLE_ARRAY< INT32 > &	ElemArray
	)			const

Find array of elements that fall within rectangle.

Parameters:

	Extents	Extents to search with
	ElemArray	Array of element numbers returned.

ERRVALUE RVC::QSEARCHTREE::Validate

(

)

const

---

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

• rvc/quadtree.h