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 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)
	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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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.

Protected Member Functions
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, 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.
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.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtLocalVertexList	myObjectVertices
DtSimBoundingGeometry	myBoundingGeometry
DtRwBoolean	myClosedFigure
DtRwBoolean	myProjection
DtVertexList	myOldWorld
	modelVertices – note, these are no longer used.
DtSimObjectStateRepository *	myStateRep
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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::pair < DtSymbolString, DtString >	DtVariableNameType
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 DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()
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 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.

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

virtual

Clone.

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 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 DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

Override to read old world and local vertices.

Reimplemented from DtReaderWriter.

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

---

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

• include/vrfobjcore/vrfObjGeom.h