DtVrfObjectGeometry Class Reference

Class Description: DtVrfObjectGeometry adds a vertex list maintained in the local database coordinate system. More...

Inheritance diagram for DtVrfObjectGeometry:

Public Member Functions
	DtVrfObjectGeometry (DtSimObjectStateRepository *sr, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor for readable/writable object.
	DtVrfObjectGeometry (const DtVrfObjectGeometry &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Copy Constructor.
const DtVrfObjectGeometry &	operator= (DtVrfObjectGeometry &orig)
	Assignment Operator.
virtual	~DtVrfObjectGeometry ()
	Destructor.
virtual DtVrfObjectGeometry *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	Clone.
virtual const DtSimBoundingGeometry &	boundingGeometry () const
	Set / Get Bounding Geometry.
virtual DtSimBoundingGeometry &	boundingGeometry ()
virtual void	setBoundingGeometry (const DtSimBoundingGeometry &bounds)
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 void	removeAllObjectVertices ()
	Removes all vertices in the object's geometry.
virtual const DtLocalVectorIterator &	objectVertexIterator () const
const DtVertexList &	oldWorld () const
virtual bool	worldPointInsideBoundingGeometry (const DtVector &worldPoint, const DtVector &objectWorldLocation, const DtTaitBryan &objectWorldOrientation) const
	Returns true if the point, in world coordinates, is inside the object's bounding geometry.
virtual double	worldDistSquaredTo (const DtVector &point) const
	Returns the squared distance from a given point in world coordinates, to the object.
virtual bool	worldGetClosestVertex (const DtVector &point, DtVector &vertex) const
	Determines the closest vertex in the object’s geometry to a given point, in world coordinates.
virtual bool	localGetClosestVertex (const DtVector &point, DtVector &vertex) const
	Determines the closest vertex in the object’s geometry to a given point, in local coordinates.
virtual bool	worldGetClosestLine (const DtVector &point, DtVector &linePt1, DtVector &linePt2) const
	Determines the closest line segment in the object’s geometry to a given point, in world coordinates.
virtual bool	localGetClosestLine (const DtVector &point, DtVector &linePt1, DtVector &linePt2) const
	Determines the closest line segment in the object’s geometry to a given point, in local coordinates.
virtual void	removeVertex (int iIndex)
virtual bool	calculateBoundingVolume (const DtVertexList &vertices, DtSimBoundingGeometry &boundingGeometry)
	Calculates the bounding volume of the object.
virtual const DtSimBoundingGeometry &	localBoundingGeometry () const
	These first 3 forms are useful if you: don't need the new location back and heading is 0.
virtual DtSimBoundingGeometry &	localBoundingGeometry ()
virtual void	setLocalBoundingGeometry (const DtSimBoundingGeometry &bounds)
virtual double	distSquaredTo (const DtVector &testPoint) const
virtual void	setObjectVertices (const DtLocalVertexList &vertices)
	Set / Get vertex list.
virtual void	setObjectVertices (const DtList &vertices)
	Set / Get vertex list.
virtual const DtLocalVertexList &	objectVertices () const
	Set / Get vertex list.
virtual DtLocalVertexList &	objectVertices ()
	Set / Get vertex list.
virtual const std::vector < DtVector > &	objectVerticesAsVector () const
	Set / Get vertex list.
virtual const DtSimBoundingGeometry &	worldBoundingGeometry () const
virtual DtSimBoundingGeometry &	worldBoundingGeometry ()
virtual void	setWorldBoundingGeometry (const DtSimBoundingGeometry &bounds)
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
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	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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 void	addAlias (const DtString &alias)
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 void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
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.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Member Functions
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Override to read old world and local vertices.
void	removeAllOldWorldVertices ()
	Non-virtual – it is called by the destructor.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtLocalVertexList	myObjectVertices
DtSimBoundingGeometry	myBoundingGeometry
DtRwBoolean	myClosedFigure
DtRwBoolean	myProjection
DtVertexList	myOldWorld
	modelVertices – note, these are no longer used.
DtSimObjectStateRepository *	myStateRep
std::vector< DtVector >	myObjectVerticesAsVector
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtVrfObjectGeometry ()
	Default constructor. Do not use.

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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Detailed Description

Class Description: DtVrfObjectGeometry adds a vertex list maintained in the local database coordinate system.

Constructor & Destructor Documentation

DtVrfObjectGeometry::DtVrfObjectGeometry ( )

private

Default constructor. Do not use.

DtVrfObjectGeometry::DtVrfObjectGeometry	(	DtSimObjectStateRepository *	sr,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Constructor for readable/writable object.

DtVrfObjectGeometry::DtVrfObjectGeometry	(	const DtVrfObjectGeometry &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Copy Constructor.

virtual DtVrfObjectGeometry::~DtVrfObjectGeometry ( )

virtual

Destructor.

Member Function Documentation

const DtVrfObjectGeometry& DtVrfObjectGeometry::operator=

(

DtVrfObjectGeometry &

orig

)

Assignment Operator.

Reimplemented in DtVrfSimulationObjectGroupGeometry.

virtual DtVrfObjectGeometry* DtVrfObjectGeometry::clone ( const DtString &  rwName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

Clone.

Reimplemented in DtVrfSimulationObjectGroupGeometry.

virtual const DtSimBoundingGeometry& DtVrfObjectGeometry::boundingGeometry ( ) const

virtual

Set / Get Bounding Geometry.

virtual DtSimBoundingGeometry& DtVrfObjectGeometry::boundingGeometry ( )

virtual

virtual void DtVrfObjectGeometry::setBoundingGeometry ( const DtSimBoundingGeometry &  bounds )

virtual

virtual bool DtVrfObjectGeometry::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 DtVrfObjectGeometry::setClosedFigure ( bool  closed )

virtual

virtual bool DtVrfObjectGeometry::projection ( ) const

virtual

Set / Get projection flag.

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

virtual void DtVrfObjectGeometry::setProjection ( bool  projection )

virtual

virtual void DtVrfObjectGeometry::removeAllObjectVertices ( )

virtual

Removes all vertices in the object's geometry.

virtual void DtVrfObjectGeometry::setObjectVertices ( const DtLocalVertexList &  vertices )

virtual

Set / Get vertex list.

Note that this represents the body coordinates stored in myObjectVertices, and not the vertices stored in the kinematic state which determine the network representation.

virtual void DtVrfObjectGeometry::setObjectVertices ( const DtList &  vertices )

virtual

Set / Get vertex list.

Note that this represents the body coordinates stored in myObjectVertices, and not the vertices stored in the kinematic state which determine the network representation.

virtual const DtLocalVertexList& DtVrfObjectGeometry::objectVertices ( ) const

virtual

Set / Get vertex list.

Note that this represents the body coordinates stored in myObjectVertices, and not the vertices stored in the kinematic state which determine the network representation.

virtual DtLocalVertexList& DtVrfObjectGeometry::objectVertices ( )

virtual

Set / Get vertex list.

Note that this represents the body coordinates stored in myObjectVertices, and not the vertices stored in the kinematic state which determine the network representation.

virtual const std::vector<DtVector>& DtVrfObjectGeometry::objectVerticesAsVector ( ) const

virtual

Set / Get vertex list.

Note that this represents the body coordinates stored in myObjectVertices, and not the vertices stored in the kinematic state which determine the network representation.

virtual const DtLocalVectorIterator& DtVrfObjectGeometry::objectVertexIterator ( ) const

virtual

const DtVertexList & DtVrfObjectGeometry::oldWorld ( ) const

inline

References myOldWorld.

virtual bool DtVrfObjectGeometry::worldPointInsideBoundingGeometry ( const DtVector &  worldPoint, const DtVector &  objectWorldLocation, const DtTaitBryan &  objectWorldOrientation  ) const

virtual

Returns true if the point, in world coordinates, is inside the object's bounding geometry.

virtual double DtVrfObjectGeometry::worldDistSquaredTo ( const DtVector &  point ) const

virtual

Returns the squared distance from a given point in world coordinates, to the object.

If the object has more than two vertices (that is, more than one line segment), it acts on the closest line segment.

virtual bool DtVrfObjectGeometry::worldGetClosestVertex ( const DtVector &  point, DtVector &  vertex  ) const

virtual

Determines the closest vertex in the object’s geometry to a given point, in world coordinates.

virtual bool DtVrfObjectGeometry::localGetClosestVertex ( const DtVector &  point, DtVector &  vertex  ) const

virtual

Determines the closest vertex in the object’s geometry to a given point, in local coordinates.

virtual bool DtVrfObjectGeometry::worldGetClosestLine ( const DtVector &  point, DtVector &  linePt1, DtVector &  linePt2  ) const

virtual

Determines the closest line segment in the object’s geometry to a given point, in world coordinates.

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

virtual bool DtVrfObjectGeometry::localGetClosestLine ( const DtVector &  point, DtVector &  linePt1, DtVector &  linePt2  ) const

virtual

Determines the closest line segment in the object’s geometry to a given point, in local coordinates.

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

virtual const DtSimBoundingGeometry& DtVrfObjectGeometry::worldBoundingGeometry ( ) const

virtual

Deprecated:

To be removed after VR-Forces 3.11. These 3 functions are here for backward compatibility. There is now just "boundingGeometry"; not a world vs. local version.

virtual DtSimBoundingGeometry& DtVrfObjectGeometry::worldBoundingGeometry ( )

virtual

Deprecated:

To be removed after VR-Forces 3.11. These 3 functions are here for backward compatibility. There is now just "boundingGeometry"; not a world vs. local version.

virtual void DtVrfObjectGeometry::setWorldBoundingGeometry ( const DtSimBoundingGeometry &  bounds )

virtual

Deprecated:

To be removed after VR-Forces 3.11. These 3 functions are here for backward compatibility. There is now just "boundingGeometry"; not a world vs. local version.

virtual void DtVrfObjectGeometry::removeVertex ( int  iIndex )

virtual

virtual bool DtVrfObjectGeometry::calculateBoundingVolume ( const DtVertexList &  vertices, DtSimBoundingGeometry &  boundingGeometry  )

virtual

Calculates the bounding volume of the object.

Parameters

vertices

The geocentric vertices of the object.

Note

The bounding volume is calculated in geocentric coordinates.

Parameters

boundingGeometry

The type of bounding geometry created. This parameter is set by this function, if it is able to calculate the bounding volume. If it is not, then this parameter is left unchanged.

Returns

A boolean indicating success or failure in calculating the bounding volume.

Note

The object must have more than one vertex to create a bounding volume.

virtual const DtSimBoundingGeometry& DtVrfObjectGeometry::localBoundingGeometry ( ) const

virtual

These first 3 forms are useful if you: don't need the new location back and heading is 0.

Note though that calling them effectively changes the position of the object; usually you want to call the other forms (that return the new location) and call vrfKinematicState()->setLocalPosition() explicitly.

virtual DtSimBoundingGeometry& DtVrfObjectGeometry::localBoundingGeometry ( )

virtual

virtual void DtVrfObjectGeometry::setLocalBoundingGeometry ( const DtSimBoundingGeometry &  bounds )

virtual

virtual double DtVrfObjectGeometry::distSquaredTo ( const DtVector &  testPoint ) const

virtual

virtual void DtVrfObjectGeometry::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

Override to read old world and local vertices.

Reimplemented in DtVrfSimulationObjectGroupGeometry.

void DtVrfObjectGeometry::removeAllOldWorldVertices ( )

protected

Non-virtual – it is called by the destructor.

Member Data Documentation

DtLocalVertexList DtVrfObjectGeometry::myObjectVertices

protected

DtSimBoundingGeometry DtVrfObjectGeometry::myBoundingGeometry

protected

DtRwBoolean DtVrfObjectGeometry::myClosedFigure

protected

DtRwBoolean DtVrfObjectGeometry::myProjection

protected

DtVertexList DtVrfObjectGeometry::myOldWorld

protected

modelVertices – note, these are no longer used.

This is only kept around to read in to use for restoring pre VR-Forces 3.8 order of battle files

Referenced by oldWorld().

DtSimObjectStateRepository* DtVrfObjectGeometry::myStateRep

protected

std::vector<DtVector> DtVrfObjectGeometry::myObjectVerticesAsVector

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/vrfObjectGeometry.h