RVC::HYPERINDEX Class Reference

Manages RVC::OBJTYPE_HyperIndex RVC objects. More...

#include <rvc/hyperidx.h>

Inheritance diagram for RVC::HYPERINDEX:

[legend]

Classes
class	LINK
class	SHAPE
Public Member Functions
	HYPERINDEX (const RVC::HYPERINDEX &obj)
	HYPERINDEX ()
virtual	~HYPERINDEX ()
INT32	AddLink (const LINK &link)
ERRVALUE	AddLinkToShape (INT32 ShapeNum, INT32 LinkNum)
INT32	AddShape (const SHAPE &shape, const POLYLINE &Points)
INT32	AddShape (const SHAPE &shape)
ERRVALUE	ChangeShape (INT32 ShapeNum, const SHAPE &shape, const POLYLINE &Points)
ERRVALUE	ClearLink (INT32 LinkNum)
ERRVALUE	ClearShapePoints (INT32 ShapeNum)
ERRVALUE	DeleteShape (INT32 ShapeNum)
INT32	FindShape (ELEMTYPE ElemType, INT32 ElemNum)
ERRVALUE	GetExtents (DRECT3D &rect)
INT32	GetNumLinks ()
INT32	GetNumShapes ()
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::HYPERINDEX &	operator= (const RVC::HYPERINDEX &rhs)
ERRVALUE	ReadLink (INT32 LinkNum, LINK &link)
ERRVALUE	ReadShape (INT32 ShapeNum, SHAPE &shape, POLYLINE &Points, SIMPLE_ARRAY< INT32 > &Links)
ERRVALUE	ReadShape (INT32 ShapeNum, SHAPE &shape, SIMPLE_ARRAY< INT32 > &Links)
ERRVALUE	ReadShape (INT32 ShapeNum, SHAPE &shape, POLYLINE &Points)
ERRVALUE	ReadShape (INT32 ShapeNum, SHAPE &shape)
ERRVALUE	RemoveLinkFromShape (INT32 ShapeNum, INT32 LinkNum)
ERRVALUE	WriteLink (INT32 LinkNum, const LINK &link)
ERRVALUE	WriteShape (INT32 ShapeNum, const SHAPE &shape, const POLYLINE &Points, const SIMPLE_ARRAY< INT32 > &Links)
ERRVALUE	WriteShape (INT32 ShapeNum, const SHAPE &shape, const SIMPLE_ARRAY< INT32 > &Links)
ERRVALUE	WriteShape (INT32 ShapeNum, const SHAPE &shape, const POLYLINE &Points)
ERRVALUE	WriteShape (INT32 ShapeNum, const SHAPE &shape)

Detailed Description

Manages RVC::OBJTYPE_HyperIndex RVC objects.

RVC Object Types that this class supports: RVC::OBJTYPE_HyperIndex

Valid parents for this class:

RVC::OBJTYPE_Vector RVC::OBJTYPE_TIN RVC::OBJTYPE_CAD RVC::OBJTYPE_Raster RVC::OBJTYPE_RasterSet RVC::OBJTYPE_Hyperspectral

Constructor & Destructor Documentation

RVC::HYPERINDEX::HYPERINDEX ( )

Default constructor.

RVC::HYPERINDEX::HYPERINDEX ( const RVC::HYPERINDEX & obj )

Copy constructor.

virtual RVC::HYPERINDEX::~HYPERINDEX ( ) [virtual]

Destructor.

Member Function Documentation

INT32 RVC::HYPERINDEX::AddLink ( const LINK & link )

Add a link to the rvc hyperindex object, do not use WriteLink() since multiple people can be trying to add a link at the same time.

Returns:: Index of new link object of error if < 0

Parameters:

link

Link to add

ERRVALUE RVC::HYPERINDEX::AddLinkToShape	(	INT32	ShapeNum,
		INT32	LinkNum
	)

Add a link to a hyper shape.

Parameters:

	ShapeNum	Shape number to add to
	LinkNum	Stored link to add

INT32 RVC::HYPERINDEX::AddShape	(	const SHAPE &	shape,
		const POLYLINE &	Points
	)

Add a shape to the rvc hyperindex object, do not use WriteShape() since multiple people can be trying to add a shape at the same time.

Returns:: Index of new shape object of error if < 0

Parameters:

	shape	Shape parameters to write
	Points	Shape boundary

INT32 RVC::HYPERINDEX::AddShape ( const SHAPE & shape )

Add a shape to the rvc hyperindex object, do not use WriteShape() since multiple people can be trying to add a shape at the same time.

Returns:: Index of new shape object of error if < 0

Parameters:

shape

Shape to add

ERRVALUE RVC::HYPERINDEX::ChangeShape	(	INT32	ShapeNum,
		const SHAPE &	shape,
		const POLYLINE &	Points
	)

Change the characteristics of a hypershape.

Parameters:

	ShapeNum	Number of shape to change
	shape	New description of shape
	Points	Shape boundary points, if needed

ERRVALUE RVC::HYPERINDEX::ClearLink ( INT32 LinkNum )

Clear a link entry The entry still exists but is now blank.

Parameters:

LinkNum

Link index to erase

ERRVALUE RVC::HYPERINDEX::ClearShapePoints ( INT32 ShapeNum )

Clear shape points.

Parameters:

ShapeNum

Shape points index to erase

ERRVALUE RVC::HYPERINDEX::DeleteShape ( INT32 ShapeNum )

Delete given shape from the list of shapes.

This method deletes a shape by swapping the last shape with 'ShapeNum', then it resizes the number of shapes by -1.

Parameters:

ShapeNum

Shape number to delete

INT32 RVC::HYPERINDEX::FindShape	(	ELEMTYPE	ElemType,
		INT32	ElemNum
	)

Find hyperindex shape that corresponds with the element given.

Returns:: : Shape number if >= 0, -1 if none found, < -1 error.

Parameters:

	ElemType	Type of element to find shape for
	ElemNum	Element number to find shape for

ERRVALUE RVC::HYPERINDEX::GetExtents ( DRECT3D & rect )

Obtain the extents of the hyperindex rvc object.

Parameters:

rect

Extents of rvc hyperindex object shapes returned

INT32 RVC::HYPERINDEX::GetNumLinks ( )

Obtain the number of links in a rvc hyperindex object.

Returns:: number of links

INT32 RVC::HYPERINDEX::GetNumShapes ( )

Obtain the number of shapes in a rvc hyperindex object.

Returns:: number of shapes

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

Create a new rvc style object under a specified parent rvc object with name, description, and source.

Parameters:

	ObjItem	Name, Desc of object to create, Created object location RETURNED
	Source	Source of new style object, default is application name
	Credentials	User credentials passed in, NULL for default behavior

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

Create a new rvc hyperindex object under a specified parent rvc object with name, description, and source.

Parameters:

	parent	Parent object to create style object under
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

RVC::HYPERINDEX& RVC::HYPERINDEX::operator= ( const RVC::HYPERINDEX & rhs )

Assignment.

Reimplemented from RVC::OBJECT.

ERRVALUE RVC::HYPERINDEX::ReadLink	(	INT32	LinkNum,
		LINK &	link
	)

Read a rvc hyperindex object link element.

Parameters:

	LinkNum	The link index to read
	link	The link storage instance

ERRVALUE RVC::HYPERINDEX::ReadShape	(	INT32	ShapeNum,
		SHAPE &	shape,
		POLYLINE &	Points,
		SIMPLE_ARRAY< INT32 > &	Links
	)

Read a rvc hyperindex object shape element.

Parameters:

	ShapeNum	Shape to read
	shape	Shape parmeters returned
	Points	Shape points read in
	Links	HyperLink indexes returned

ERRVALUE RVC::HYPERINDEX::ReadShape	(	INT32	ShapeNum,
		SHAPE &	shape,
		SIMPLE_ARRAY< INT32 > &	Links
	)

Read a rvc hyperindex object shape element.

Parameters:

	ShapeNum	Shape to read
	shape	Shape parmeters returned
	Links	HyperLink indexes returned

ERRVALUE RVC::HYPERINDEX::ReadShape	(	INT32	ShapeNum,
		SHAPE &	shape,
		POLYLINE &	Points
	)

Read a rvc hyperindex object shape element.

Parameters:

	ShapeNum	Shape to read
	shape	Shape parmeters returned
	Points	Shape points read in

ERRVALUE RVC::HYPERINDEX::ReadShape	(	INT32	ShapeNum,
		SHAPE &	shape
	)

Read a rvc hyperindex object shape element.

Parameters:

	ShapeNum	Shape to read
	shape	Shape parmeters returned

ERRVALUE RVC::HYPERINDEX::RemoveLinkFromShape	(	INT32	ShapeNum,
		INT32	LinkNum
	)

Remove a link from a hyper shape.

Parameters:

	ShapeNum	Shape number to add to
	LinkNum	Stored link to add

ERRVALUE RVC::HYPERINDEX::WriteLink	(	INT32	LinkNum,
		const LINK &	link
	)

Write a rvc hyperindex object link, use AddLink() to add a link.

Parameters:

	LinkNum	Link index to write
	link	Link to write

ERRVALUE RVC::HYPERINDEX::WriteShape	(	INT32	ShapeNum,
		const SHAPE &	shape,
		const POLYLINE &	Points,
		const SIMPLE_ARRAY< INT32 > &	Links
	)

Write a rvc hyperindex object shape.

Parameters:

	ShapeNum	Shape index to write
	shape	Shape parameters to write
	Points	Shape boundary
	Links	Link indexes for this shape to contain

ERRVALUE RVC::HYPERINDEX::WriteShape	(	INT32	ShapeNum,
		const SHAPE &	shape,
		const SIMPLE_ARRAY< INT32 > &	Links
	)

Write a rvc hyperindex object shape.

Parameters:

	ShapeNum	Shape index to write
	shape	Shape parameters to write
	Links	Link indexes for this shape to contain

ERRVALUE RVC::HYPERINDEX::WriteShape	(	INT32	ShapeNum,
		const SHAPE &	shape,
		const POLYLINE &	Points
	)

Write a rvc hyperindex object shape.

Parameters:

	ShapeNum	Shape index to write
	shape	Shape parameters to write
	Points	Shape boundary

ERRVALUE RVC::HYPERINDEX::WriteShape	(	INT32	ShapeNum,
		const SHAPE &	shape
	)

Read a rvc hyperindex object shape element.

Parameters:

	ShapeNum	Shape to write
	shape	Shape parmeters to write

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

rvc/hyperidx.h

RVC::HYPERINDEX Class Reference

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation