RVC::SPATIALTREE Class Reference

Manager for RVC::OBJTYPE_SpatialTree objects. More...

#include <rvc/spattree.h>

Inheritance diagram for RVC::SPATIALTREE:

[legend]

List of all members.

Classes
struct	TIERINFO
	Spatial Tree tier information structure. More...
Public Member Functions
	SPATIALTREE (const RVC::SPATIALTREE &rhs)
	SPATIALTREE ()
virtual	~SPATIALTREE ()
INT32	GetMaxNodeArrayElems (ELEMTYPE elemtype)
INT32	GetNumTiers (ELEMTYPE elemtype)
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const char *Source=0, const CREDENTIALS *Credentials=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::SPATIALTREE &	operator= (const RVC::SPATIALTREE &rhs)
ERRVALUE	ReadTier (ELEMTYPE elemtype, int tier, TIERINFO &tierinfo, INT32 *firstelemarray)
ERRVALUE	Search (ELEMTYPE elemtype, const DRECT2D &rect, UNSIGNEDSET &ElemSet)
ERRVALUE	Search (ELEMTYPE elemtype, const DRECT2D &rect, SIMPLE_ARRAY< INT32_RANGE > &elemranges)
ERRVALUE	WriteTier (ELEMTYPE elemtype, int tier, TIERINFO &tierinfo, INT32 *firstelemarray)

---

Detailed Description

Manager for RVC::OBJTYPE_SpatialTree objects.

RVC Object Types that this class supports: RVC::OBJTYPE_SpatialTree.

Valid parents for this class:

• RVC::OBJTYPE_Vector

---

Constructor & Destructor Documentation

RVC::SPATIALTREE::SPATIALTREE

(

)

Default constructor.

RVC::SPATIALTREE::SPATIALTREE

(

const RVC::SPATIALTREE &

rhs

)

Copy constructor.

virtual RVC::SPATIALTREE::~SPATIALTREE

(

)

[virtual]

Destructor.

---

Member Function Documentation

INT32 RVC::SPATIALTREE::GetMaxNodeArrayElems

(

ELEMTYPE

elemtype

)

Get maximum number of node array elements in spatial tree for specified element type.

Returns:

Maximum number of node array elements or error < 0.

Parameters:

elemtype

Element type

INT32 RVC::SPATIALTREE::GetNumTiers

(

ELEMTYPE

elemtype

)

Get number of tiers in spatial tree for specified element type.

Returns:

Number of tiers, 0 if none or error < 0.

Parameters:

elemtype

Element type

ERRVALUE RVC::SPATIALTREE::Make	(	RVC::OBJITEM &	ObjItem,
		const char *	Source = 0,
		const CREDENTIALS *	Credentials = 0
	)

Create new spatial 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

ERRVALUE RVC::SPATIALTREE::Make	(	const RVC::OBJECT &	parent,
		const RVC::DESCRIPTOR &	Descriptor,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create new spatial tree object.

Parameters:

	parent	Parent object to create spatial tree object under
	Descriptor	Name of new spatial tree object
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

RVC::SPATIALTREE& RVC::SPATIALTREE::operator=

(

const RVC::SPATIALTREE &

rhs

)

Assignment.

Reimplemented from RVC::OBJECT.

ERRVALUE RVC::SPATIALTREE::ReadTier	(	ELEMTYPE	elemtype,
		int	tier,
		TIERINFO &	tierinfo,
		INT32 *	firstelemarray
	)

Read tier from spatial tree.

Parameters:

	elemtype	Element type
	tier	Tier index
	tierinfo	Tier information returned
	firstelemarray	Array of "first elements" by node index returned, caller must allocate

ERRVALUE RVC::SPATIALTREE::Search	(	ELEMTYPE	elemtype,
		const DRECT2D &	rect,
		UNSIGNEDSET &	ElemSet
	)

Search spatial tree for elements which may overlap specified rectangle.

Parameters:

	elemtype	Element type
	rect	Rectangle in spatial tree coordinates to search
	ElemSet	Element set returned

ERRVALUE RVC::SPATIALTREE::Search	(	ELEMTYPE	elemtype,
		const DRECT2D &	rect,
		SIMPLE_ARRAY< INT32_RANGE > &	elemranges
	)

Search spatial tree for elements which may overlap specified rectangle.

Parameters:

	elemtype	Element type
	rect	Rectangle in spatial tree coordinates to search
	elemranges	Array of element ranges returned

ERRVALUE RVC::SPATIALTREE::WriteTier	(	ELEMTYPE	elemtype,
		int	tier,
		TIERINFO &	tierinfo,
		INT32 *	firstelemarray
	)

Write tier to spatial tree.

Parameters:

	elemtype	Element type
	tier	Tier index
	tierinfo	Tier information to write
	firstelemarray	Array of "first elements" by node index, caller must allocate

---

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

• rvc/spattree.h