DtAttachedTerrain Class Reference

Inheritance diagram for DtAttachedTerrain:

Public Member Functions
	DtAttachedTerrain ()
	default constructor
	DtAttachedTerrain (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)
	real constructor
	DtAttachedTerrain (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=0)
	DtAttachedTerrain (const DtString &name, const DtAttachedTerrain &orig, DtReaderWriterRegistry *const parentRegistry=0)
	copy constructor
	DtAttachedTerrain (const DtSymbolString &name, const DtAttachedTerrain &from, DtReaderWriterRegistry *const parentRegistry=0)
virtual	~DtAttachedTerrain ()
	destructor
DtAttachedTerrain &	operator= (const DtAttachedTerrain &orig)
	Assign to DtRwBoundingVolume. Assigns value only.
DtAttachedTerrain &	operator= (const DtObjectGeometricModelEntry &orig)
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
DtAttachedTerrain &	operator= (const DtObjectType &type)
virtual const Coordinate_System *	coordinateSystem () const
virtual Coordinate_System *	coordinateSystem ()
virtual const Coordinate_System *	objectModelCoordinateSystem () const
virtual double	terrainHeight (const DtVector &localLocation, bool *dataAvailable=0, bool overrideBlockingAssert=false) const
virtual bool	terrainHeight (const DtVector &localLocation, double &terrainHeight, bool *dataAvailable=0, bool overrideBlockingAssert=false) const
virtual bool	terrainHeightAndSurface (const DtVector &localLocation, double &terrainHeight, DtSurface &surface, bool *dataAvailable=0, bool overrideBlockingAssert=false) const
virtual bool	closestIntersection (const DtVector &localLocation, DtPoint &intersectionPoint, bool *dataAvailable=0, bool overrideBlockingAssert=false) const
virtual bool	closestIntersection (const DtVector &localLocation, DtVector &intersectionPoint, bool *dataAvailable=0, bool overrideBlockingAssert=false) const
virtual bool	closestIntersection (const DtVector &localLocation, DtChordIntersectionRecord &record, DtIntersectionRecord::DtIntersectionType irtFlag=DtIntersectionRecord::INT_ALL_DATA, bool *dataAvailable=0, bool overrideBlockingAssert=false) const
virtual bool	intersect (const DtChord &chord, DtPoint &intersectionPoint, double &intersectionTime, bool *dataAvailable=0, bool overrideBlockingAssert=false) const
virtual bool	intersect (const DtChord &chord, DtChordIntersectionRecord &record, DtIntersectionRecord::DtIntersectionType irtFlag=DtIntersectionRecord::INT_ALL_DATA, bool *dataAvailable=0, bool overrideBlockingAssert=false) const
virtual bool	closestIntersection (const DtVector &curPosition, DtVector &intersection, bool ignoreWater, bool *dataAvailable=0, bool overrideBlockingAssert=false) const
	Returns true if a there is a terrain intersection at the given local position.
void	setObjectName (const DtString &)
const DtString	objectName () const
void	setObjectType (const DtObjectType &)
const DtObjectType &	objectType () const
void	addRef ()
void	removeRef ()
int	referenceCount () const
void	setObjectGeometricModel (const DtObjectGeometricModel *newObjGeomModel)
const DtObjectGeometricModel *	objectGeometricModel () const
void	setEntity (const DtVrfObject *)
const DtVrfObject *	entity () const
void	setPhysicalWorld (DtPhysicalWorld *newPhysicalWorld)
DtPhysicalWorld *	physicalWorld ()
const DtPhysicalWorld *	physicalWorld () const
void	clear ()
virtual DtAttachedTerrain *	clone (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0) const
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
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 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.
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
bool	testInvariant () const
virtual double	setOriginToDatabase ()
	Given the current entity, sets the geodetic origin in the terrain database to account for entity movement.
virtual const DtDcm &	rotateToDcm () const
	Creates a rotation Dcm based on current orientation.
virtual const DtDcm &	rotateBackDcm () const
virtual DtVector	rotateTerrainLocation (const DtVector &source) const
	Given the location, rotate it given the entity orientation.
virtual DtChord	convertAndRotateChordToLocal (const DtChord &source) const
	Converts the given chord from the simulation terrain database coordinate system into the current terrain database coordinate system.
virtual DtPoint	convertLocalToSimTerrain (const DtPoint &, double addHeight=0.) const
	Takes the local coordinates and converts it back to the simulation terrain. Adds height if supplied.
virtual void	convertLocalToSimTerrain (DtChordIntersectionRecord &, double addHeight=0.) const
	Converts both normal and intersection point.
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
DtRwString	myObjectName
DtRwObjectType	myObjectType
int	myReferenceCount
const DtObjectGeometricModel *	myObjectGeometricModel
	For now, this is the model that we get.
const DtVrfObject *	myEntity
	The entity this terrain represents.
DtPhysicalWorld *	myPhysicalWorld
	For now,just use the global terrain database to return the coordinate system and perform the intersection calls.
DtTaitBryan	myLastEntityOrientation
	Last local orientation of the referenced entity.
DtDcm	myRotateToDcm
DtDcm	myRotateBackDcm
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.

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
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 DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static DtReaderWriterFactory *	factory ()
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

Constructor & Destructor Documentation

DtAttachedTerrain::DtAttachedTerrain

(

)

default constructor

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

real constructor

DtAttachedTerrain::DtAttachedTerrain	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *const	parentRegistry = 0
	)

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

copy constructor

DtAttachedTerrain::DtAttachedTerrain	(	const DtSymbolString &	name,
		const DtAttachedTerrain &	from,
		DtReaderWriterRegistry *const	parentRegistry = 0
	)

virtual DtAttachedTerrain::~DtAttachedTerrain ( )

virtual

destructor

Member Function Documentation

DtAttachedTerrain& DtAttachedTerrain::operator=

(

const DtAttachedTerrain &

orig

)

Assign to DtRwBoundingVolume. Assigns value only.

DtAttachedTerrain& DtAttachedTerrain::operator=

(

const DtObjectGeometricModelEntry &

orig

)

virtual const char* DtAttachedTerrain::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtReaderWriter.

DtAttachedTerrain& DtAttachedTerrain::operator=

(

const DtObjectType &

type

)

virtual const Coordinate_System* DtAttachedTerrain::coordinateSystem ( ) const

virtual

virtual Coordinate_System* DtAttachedTerrain::coordinateSystem ( )

virtual

virtual const Coordinate_System* DtAttachedTerrain::objectModelCoordinateSystem ( ) const

virtual

virtual double DtAttachedTerrain::terrainHeight ( const DtVector &  localLocation, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

virtual

virtual bool DtAttachedTerrain::terrainHeight ( const DtVector &  localLocation, double &  terrainHeight, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

virtual

virtual bool DtAttachedTerrain::terrainHeightAndSurface ( const DtVector &  localLocation, double &  terrainHeight, DtSurface &  surface, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

virtual

virtual bool DtAttachedTerrain::closestIntersection ( const DtVector &  localLocation, DtPoint &  intersectionPoint, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

virtual

virtual bool DtAttachedTerrain::closestIntersection ( const DtVector &  localLocation, DtVector &  intersectionPoint, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

virtual

virtual bool DtAttachedTerrain::closestIntersection ( const DtVector &  localLocation, DtChordIntersectionRecord &  record, DtIntersectionRecord::DtIntersectionType  irtFlag = DtIntersectionRecord::INT_ALL_DATA, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

virtual

virtual bool DtAttachedTerrain::intersect ( const DtChord &  chord, DtPoint &  intersectionPoint, double &  intersectionTime, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

virtual

virtual bool DtAttachedTerrain::intersect ( const DtChord &  chord, DtChordIntersectionRecord &  record, DtIntersectionRecord::DtIntersectionType  irtFlag = DtIntersectionRecord::INT_ALL_DATA, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

virtual

virtual bool DtAttachedTerrain::closestIntersection ( const DtVector &  curPosition, DtVector &  intersection, bool  ignoreWater, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

virtual

Returns true if a there is a terrain intersection at the given local position.

The algorithm checks for intersections along a chord in the direction of gravity at that location (from halfHeightOfChord above to halfHeightOfChord below localPosition). If ignoreWaterSurface is true, advances through list of intersection returned until first DtSurface that is not a water surface is found.

bool DtAttachedTerrain::testInvariant ( ) const

protected

virtual double DtAttachedTerrain::setOriginToDatabase ( )

protectedvirtual

Given the current entity, sets the geodetic origin in the terrain database to account for entity movement.

Returns the entities height above the terrain

virtual const DtDcm& DtAttachedTerrain::rotateToDcm ( ) const

protectedvirtual

Creates a rotation Dcm based on current orientation.

virtual const DtDcm& DtAttachedTerrain::rotateBackDcm ( ) const

protectedvirtual

virtual DtVector DtAttachedTerrain::rotateTerrainLocation ( const DtVector &  source ) const

protectedvirtual

Given the location, rotate it given the entity orientation.

virtual DtChord DtAttachedTerrain::convertAndRotateChordToLocal ( const DtChord &  source ) const

protectedvirtual

Converts the given chord from the simulation terrain database coordinate system into the current terrain database coordinate system.

virtual DtPoint DtAttachedTerrain::convertLocalToSimTerrain ( const DtPoint &  , double  addHeight = 0.  ) const

protectedvirtual

Takes the local coordinates and converts it back to the simulation terrain. Adds height if supplied.

virtual void DtAttachedTerrain::convertLocalToSimTerrain ( DtChordIntersectionRecord &  , double  addHeight = 0.  ) const

protectedvirtual

Converts both normal and intersection point.

Note that the normal does not get height added on

void DtAttachedTerrain::setObjectName

(

const DtString &

)

const DtString DtAttachedTerrain::objectName

(

)

const

void DtAttachedTerrain::setObjectType

(

const DtObjectType &

)

const DtObjectType& DtAttachedTerrain::objectType

(

)

const

void DtAttachedTerrain::addRef

(

)

void DtAttachedTerrain::removeRef

(

)

int DtAttachedTerrain::referenceCount

(

)

const

void DtAttachedTerrain::setObjectGeometricModel

(

const DtObjectGeometricModel *

newObjGeomModel

)

const DtObjectGeometricModel* DtAttachedTerrain::objectGeometricModel

(

)

const

void DtAttachedTerrain::setEntity

(

const DtVrfObject *

)

const DtVrfObject* DtAttachedTerrain::entity

(

)

const

void DtAttachedTerrain::setPhysicalWorld

(

DtPhysicalWorld *

newPhysicalWorld

)

DtPhysicalWorld* DtAttachedTerrain::physicalWorld

(

)

const DtPhysicalWorld* DtAttachedTerrain::physicalWorld

(

)

const

void DtAttachedTerrain::clear

(

)

virtual DtAttachedTerrain* DtAttachedTerrain::clone ( const DtString &  name, DtReaderWriterRegistry *const  parentRegistry = 0  ) const

virtual

Member Data Documentation

DtRwString DtAttachedTerrain::myObjectName

protected

DtRwObjectType DtAttachedTerrain::myObjectType

protected

int DtAttachedTerrain::myReferenceCount

protected

const DtObjectGeometricModel* DtAttachedTerrain::myObjectGeometricModel

protected

For now, this is the model that we get.

const DtVrfObject* DtAttachedTerrain::myEntity

protected

The entity this terrain represents.

If 0, should mean to represent global terrain

DtPhysicalWorld* DtAttachedTerrain::myPhysicalWorld

protected

For now,just use the global terrain database to return the coordinate system and perform the intersection calls.

DtTaitBryan DtAttachedTerrain::myLastEntityOrientation

mutableprotected

Last local orientation of the referenced entity.

If different, then recalculates orientation matrix when orientationMatrix() is called.

DtDcm DtAttachedTerrain::myRotateToDcm

mutableprotected

DtDcm DtAttachedTerrain::myRotateBackDcm

mutableprotected

---

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

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