DtVertexList Class Reference

class DtVertexList: More...

Inheritance diagram for DtVertexList:

Public Member Functions
	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	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 Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Constructs a DtTreeNode item, and then retrieves it from the stream.
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
	Add element to the list just after the indicated item.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtRwVectorIterator *	myVertexIterator

Private Member Functions
	DtVertexList (const DtVertexList &orig)
	copy constructor Not implemented.
DtVertexList &	operator= (const DtVertexList &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
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 DtVertexList:

Instances of DtVertexList are lists of RwVector vertices.

Constructor & Destructor Documentation

DtVertexList::DtVertexList

(

)

default constructor

DtVertexList::DtVertexList	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

virtual DtVertexList::~DtVertexList ( )

virtual

destructor

DtVertexList::DtVertexList ( const DtVertexList &  orig )

private

copy constructor Not implemented.

Do not call.

Member Function Documentation

virtual DtRwVector& DtVertexList::operator[] ( unsigned  index ) const

virtual

virtual int DtVertexList::index ( const DtListItem *  entry ) const

virtual

virtual const DtRwVectorIterator& DtVertexList::witerator ( ) const

virtual

virtual double DtVertexList::distSquaredTo ( const DtVector &  point ) const

virtual

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.

virtual bool DtVertexList::getClosestVertex ( const DtVector &  point, DtVector &  vertex  ) const

virtual

Sets vertex to be the vertex closest to point in this object geometry.

Referenced by DtLocalVectorIterator::setToClosest(), and DtRwVectorIterator::setToClosest().

virtual DtListItem* DtVertexList::getClosestVertex ( const DtVector &  point ) const

virtual

Returns a pointer to the item in this list which is closestto point.

virtual bool DtVertexList::getClosestLine ( const DtVector &  point, DtVector &  linePt1, DtVector &  linePt2  ) const

virtual

Sets linePt1 and linePt2 to be the vertices of the line closest to point in this object geometry.

virtual void DtVertexList::translate ( const DtVector &  offset )

virtual

Adds the given offset vector to each vertex in the list.

virtual void DtVertexList::copyList ( const DtVertexList &  )

virtual

Deep copy of target list. Appends to existing list items.

static double DtVertexList::distanceSquaredPointToLine ( const DtVector &  point, const DtVector &  linePt1, const DtVector &  linePt2  )

static

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

static double DtVertexList::distanceSquaredPointToPoint ( const DtVector &  point1, const DtVector &  point2  )

static

Returns the distance^2 from point1 to point2.

virtual DtlObjPtr DtVertexList::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

Constructs a DtTreeNode item, and then retrieves it from the stream.

Implements DtRwList.

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

private

assignment operator Not implemented.

Do not call.

Member Data Documentation

DtRwVectorIterator* DtVertexList::myVertexIterator

protected

---

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

• include/vrfutil/vertexList.h