DtLocalVertexList Class Reference

class DtLocalVertexList: More...

Inheritance diagram for DtLocalVertexList:

Public Member Functions
	DtLocalVertexList ()
	default constructor
	DtLocalVertexList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
virtual	~DtLocalVertexList ()
	destructor
virtual bool	closedFigure () const
	Set / Get closed figure flag.
virtual void	setClosedFigure (bool closed)
virtual bool	projection () const
	Set / Get projection flag.
virtual void	setProjection (bool projection)
virtual const DtLocalVectorIterator &	localIterator () const
virtual bool	inside (const DtVector &point) const
	What follows is a number of methods for determining the relative geometry between this object and other 2D or 3D points.
virtual bool	leftOf (const DtVector &point) const
virtual double	headingAngleTo (const DtVector &point) const
virtual double	elevationAngleTo (const DtVector &point) const
virtual double	localDistSquaredTo (const DtVector &point) const
virtual double	distSquaredTo2D (const DtVector &point) const
virtual bool	intersects (const DtVector &point1, const DtVector &point2) const
virtual bool	getClosestVertex2D (const DtVector &point, DtVector &vertex) const
virtual DtListItem *	getClosestVertex2D (const DtVector &point) const
virtual bool	getClosestLine2D (const DtVector &point, DtVector &linePt1, DtVector &linePt2) const
Public Member Functions inherited from DtVertexList
	DtVertexList ()
	default constructor
	DtVertexList (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
virtual	~DtVertexList ()
	destructor
virtual DtRwVector &	operator[] (unsigned index) const
virtual int	index (const DtListItem *entry) const
virtual const DtRwVectorIterator &	witerator () const
virtual double	distSquaredTo (const DtVector &point) const
	Returns the squared distance to this.
virtual bool	getClosestVertex (const DtVector &point, DtVector &vertex) const
	Sets vertex to be the vertex closest to point in this object geometry.
virtual DtListItem *	getClosestVertex (const DtVector &point) const
	Returns a pointer to the item in this list which is closestto point.
virtual bool	getClosestLine (const DtVector &point, DtVector &linePt1, DtVector &linePt2) const
	Sets linePt1 and linePt2 to be the vertices of the line closest to point in this object geometry.
virtual void	translate (const DtVector &offset)
	Adds the given offset vector to each vertex in the list.
virtual void	copyList (const DtVertexList &)
	Deep copy of target list. Appends to existing list items.
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
	Remove an element from the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
	Add element to the list just after the indicated item.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static double	distanceSquaredPointToLine2D (const DtVector &point, const DtVector &linePt1, const DtVector &linePt2)
	Returns the distance^2 from point to linePt1-linePt2 in 2D.
static double	distanceSquaredPointToPoint2D (const DtVector &point1, const DtVector &point2)
	Returns the distance^2 from point1 to point2 in 2D.
Static Public Member Functions inherited from DtVertexList
static double	distanceSquaredPointToLine (const DtVector &point, const DtVector &linePt1, const DtVector &linePt2)
	Returns the distance^2 from point to linePt1-linePt2.
static double	distanceSquaredPointToPoint (const DtVector &point1, const DtVector &point2)
	Returns the distance^2 from point1 to point2.

Protected Attributes
bool	myClosedFigure
bool	myProjection
DtLocalVectorIterator *	myLocalVectorIterator
Protected Attributes inherited from DtVertexList
DtRwVectorIterator *	myVertexIterator

Private Member Functions
	DtLocalVertexList (const DtLocalVertexList &orig)
	copy constructor Not implemented.
DtLocalVertexList &	operator= (const DtLocalVertexList &orig)
	assignment operator Not implemented.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Member Functions inherited from DtVertexList
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Constructs a DtTreeNode item, and then retrieves it from the stream.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

class DtLocalVertexList:

Instances of DtLocalVertexList are lists of DtLocalVector vertices.

Constructor & Destructor Documentation

DtLocalVertexList::DtLocalVertexList

(

)

default constructor

DtLocalVertexList::DtLocalVertexList	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

virtual DtLocalVertexList::~DtLocalVertexList ( )

virtual

destructor

DtLocalVertexList::DtLocalVertexList ( const DtLocalVertexList &  orig )

private

copy constructor Not implemented.

Do not call.

Member Function Documentation

virtual bool DtLocalVertexList::closedFigure ( ) const

virtual

Set / Get closed figure flag.

If true, then the last vertex connects back to the first, forming a closed figure.

virtual void DtLocalVertexList::setClosedFigure ( bool  closed )

virtual

virtual bool DtLocalVertexList::projection ( ) const

virtual

Set / Get projection flag.

If true, then the Z values in the vertices should be ignored.

virtual void DtLocalVertexList::setProjection ( bool  projection )

virtual

virtual const DtLocalVectorIterator& DtLocalVertexList::localIterator ( ) const

virtual

virtual bool DtLocalVertexList::inside ( const DtVector &  point ) const

virtual

What follows is a number of methods for determining the relative geometry between this object and other 2D or 3D points.

---

The following public member functions are deprecated. They apply only when the given database coordinate system is UTM. To write coordinate system independent code, use the functions (with corresponding names) defined in kinTools.h. They will work for any of the supported

coordinates in VR-Forces (e.g. UTM, geocentric).

Deprecated:

VR-Forces 3.11. To be removed following this release. Returns true if point is inside this in 2D. always returns false if !closedFigure(). currently only supports convex polygons.

virtual bool DtLocalVertexList::leftOf ( const DtVector &  point ) const

virtual

Deprecated:

VR-Forces 3.11. To be removed following this release. Returns true if point is left of the geometry in 2D. always returns false if this has only one vertex. if this has more than two vertices (ie. more than one line segment), acts on the closest (infinite) line.

virtual double DtLocalVertexList::headingAngleTo ( const DtVector &  point ) const

virtual

Deprecated:

VR-Forces 3.11. To be removed following this release. Returns the angle at which point would proceed to arrive most quickly at this. if the object geometry has more than one vertex, then headingAngleTo() acts on the closest vertex (which is not always the closest *point* on this). all points are considered in 2D.

virtual double DtLocalVertexList::elevationAngleTo ( const DtVector &  point ) const

virtual

Deprecated:

VR-Forces 3.11. To be removed following this release. Returns the elevation angle in 3D at which point would proceed to arrive most quickly at this. if the object geometry has more than one vertex, then elevationAngleTo() acts on the closest vertex (which is not always the closest *point* on this).

virtual double DtLocalVertexList::localDistSquaredTo ( const DtVector &  point ) const

virtual

Deprecated:

VR-Forces 3.11. To be removed following this release. Returns the distance from localPoint to the closest vertex in this. If this is projected, calls distSquaredTo2D to find the the nearest vertex on this. Otherwise, calls closestLocalPosition() to determine the nearest vertex on this.

virtual double DtLocalVertexList::distSquaredTo2D ( const DtVector &  point ) const

virtual

Deprecated:

VR-Forces 3.11. To be removed following this release. Returns the squared distance to this. if this has more than two vertices (ie. more than one line segment), acts on the closest line segment. if projection() then distSquaredTo() calls distSquared2D.

virtual bool DtLocalVertexList::intersects ( const DtVector &  point1, const DtVector &  point2  ) const

virtual

Deprecated:

VR-Forces 3.11. To be removed following this release. Returns true if the line segment point1-point2 intersects any line segment in this object geometry, all in 2D. note: for purposes of this function, line segments don't intersect if they are colinear, even if they are partially coincident. this should be what a caller would want.

virtual bool DtLocalVertexList::getClosestVertex2D ( const DtVector &  point, DtVector &  vertex  ) const

virtual

Deprecated:

VR-Forces 3.11. To be removed following this release. Sets vertex to be the vertex closest in 2D to point in this object geometry.

virtual DtListItem* DtLocalVertexList::getClosestVertex2D ( const DtVector &  point ) const

virtual

Deprecated:

VR-Forces 3.11. To be removed following this release. Returns a pointer to the item in this list which is closest in 2D to point.

virtual bool DtLocalVertexList::getClosestLine2D ( const DtVector &  point, DtVector &  linePt1, DtVector &  linePt2  ) const

virtual

Deprecated:

VR-Forces 3.11. To be removed following this release. Sets linePt1 and linePt2 to be the vertices of the line closest in 2D to point in this object geometry.

static double DtLocalVertexList::distanceSquaredPointToLine2D ( const DtVector &  point, const DtVector &  linePt1, const DtVector &  linePt2  )

static

Returns the distance^2 from point to linePt1-linePt2 in 2D.

static double DtLocalVertexList::distanceSquaredPointToPoint2D ( const DtVector &  point1, const DtVector &  point2  )

static

Returns the distance^2 from point1 to point2 in 2D.

DtLocalVertexList& DtLocalVertexList::operator= ( const DtLocalVertexList &  orig )

private

assignment operator Not implemented.

Do not call.

Member Data Documentation

bool DtLocalVertexList::myClosedFigure

protected

bool DtLocalVertexList::myProjection

protected

DtLocalVectorIterator* DtLocalVertexList::myLocalVectorIterator

protected

---

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

• include/vrfutil/lclVtxList.h