This class is a DtSimKinematicState with the addition of another CS for local database coordinates. More...

Inheritance diagram for DtVrfKinematicState:

Public Member Functions
	DtVrfKinematicState (const Coordinate_System coordinateSystem, DtSimObjectStateRepository stateRep, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor. More...

	DtVrfKinematicState (const DtVrfKinematicState &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Copy Constructor. More...

const DtVrfKinematicState &	operator= (const DtVrfKinematicState &orig)
	Assignment Operator. More...

virtual	~DtVrfKinematicState ()
	Destructor. More...

virtual DtSimKinematicState *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	Clone. More...

virtual void	setCoordinateSystem (const Coordinate_System *coordinateSystem)
	Sets coordinate system used in converting between local (database) and other (geocentric or topocentric) coordinates. More...

virtual const Coordinate_System *	coordinateSystem () const

virtual const DtVector &	localPosition () const
	Position in local (database) coordinates, in meters. More...

virtual void	setLocalPosition (const DtVector &localPosition)

virtual void	setWorldVertices (const DtList &vertices, DtVector &newGeometricCenter)
	Override to set dirty flag for local. More...

virtual const DtVector &	localVelocity () const
	Velocity in local (database) coordinates, in meters/second. More...

virtual void	setLocalVelocity (const DtVector &localVelocity, bool recomputeSpeed=true)

virtual DtReal	localSpeed () const
	Speed, in meters/second. More...

virtual void	setLocalSpeed (DtReal localSpeed)

virtual const DtVector &	localAcceleration () const
	Acceleration in local (database) coordinates, in meters/second/second. More...

virtual void	setLocalAcceleration (const DtVector &localAcceleration)

virtual const DtVector &	relativeAcceleration () const
	Note that for both of the relative calls, the supplied acceleration or velocity should be in local (datbase) coordinates. More...

virtual void	setRelativeAcceleration (const DtVector &localAcceleration)

virtual const DtVector &	relativeVelocity () const
	If attached, returns parent and sets parent velocity, else returns/sets local. More...

virtual void	setRelativeVelocity (const DtVector &localVelocity, bool recomputeSpeed=true)

virtual DtVector	bodyVelocity () const
	Returns bodyVelocity if not attached, else relative velocity. More...

virtual void	invalidateRelativeVelocity ()

virtual void	invalidateRelativeAcceleration ()

virtual const DtTaitBryan &	localOrientationWrtDatabase () const
	Euler angles with respect to the local (database) coordinate system, in radians. More...

virtual void	setLocalOrientationWrtDatabase (const DtTaitBryan &localOrientation, DtKinematicStateCS::DtRotationConstraint recomputeMatrix=DtKinematicStateCS::RotateAboutX)

virtual const DtDcm &	localOrientationMatrix () const
	Directed cosine matrix for rotating from body coordinates to the local (database) coordinate system. More...

virtual void	setLocalOrientationMatrix (const DtDcm &localOrientationMatrix, bool recomputeEulers=true)

virtual void	setRotationConstraint (DtKinematicStateCS::DtRotationConstraint constraint)

virtual const DtVector &	worldPosition () const
	Position in geocentric coordinates, in meters. More...

virtual void	setWorldPosition (const DtVector &gecoentricPosition)

virtual const DtVector &	worldVelocity () const
	Velocity in geocentric coordinates, in meters/second. More...

virtual void	setWorldVelocity (const DtVector &gecoentricVelocity, bool recomputeSpeed=true)

virtual const DtVector &	worldAcceleration () const
	Acceleration in geocentric coordinates, in meters/second/second. More...

virtual void	setWorldAcceleration (const DtVector &gecoentricAcceleration)

virtual const DtTaitBryan &	worldOrientation () const
	Euler angles with respect to the geocentric coordinate system, in radians. More...

virtual void	setWorldOrientation (const DtTaitBryan &orientation, DtKinematicStateCS::DtRotationConstraint recomputeMatrix=DtKinematicStateCS::RotateAboutX)

virtual void	setParentOrientation (const DtTaitBryan &orientation, DtKinematicStateCS::DtRotationConstraint recomputeMatrix=DtKinematicStateCS::RotateAboutX)
	Overridden to invalidate the localVV. More...

virtual void	setParentPosition (const DtVector &position)
	Overridden to invalidate the localVV. More...

virtual void	setWorldOrientationMatrix (const DtDcm &orientationMatrix, bool recomputeEulers=true)
	Directed cosine matrix for rotating from body coordinates to the geocentric coordinate system. More...

virtual void	parentKinematicsChanged ()
	Overridden to invalidate the localVV. More...

DtCoordSysValidationVector &	localVV ()
	No user serviceable parts inside! This accessor makes the validation vectors accessible to the object manager so that it set them when reading from the Order of battle file... More...

virtual void	validateLocalState ()
	Called from validateState(), validates all local variables. Called from putSelf. More...

virtual void	validateState ()

virtual void	addLocalVertex (const DtVector &vertex, DtVector &newGeometricCenter)
	Object geometry methods – these methods reference some information in the world kinematic state. More...

virtual void	setIsEllipsoid (bool)
	Sets whether or not this geometry refernces an ellipsoid. More...

virtual bool	isEllipsoid () const

virtual const DtLocalVertexList &	localVertices () const
	Returns local vertex list and iterator. More...

virtual const DtLocalVectorIterator &	localVertexIterator () const

virtual void	removeVertex (int i)
	Removes vertex at the specified position. More...

virtual void	setGeometryNeedsUpdate (bool b)
	Sets flags to update vertices. More...

virtual void	invalidateLocalGeometry ()
	Sets the myLocalObjectGeometryInvalid flag to true. More...

virtual void	freezeSpatial ()

virtual void	thawSpatial ()


virtual const DtTaitBryan &	localOrientation () const

virtual void	setLocalOrientation (const DtTaitBryan &topoOrientation, DtKinematicStateCS::DtRotationConstraint recomputeMatrix=DtKinematicStateCS::RotateAboutX)


virtual void	setLocalVertices (const DtLocalVertexList &vertices, DtVector &newGeometricCenter)
	Sets local vertices and also translates to body coordinates. More...

virtual void	setLocalVertices (const DtList &vertices, DtVector &newGeometricCenter)

Public Member Functions inherited from DtSimKinematicState
	DtSimKinematicState (DtSimObjectStateRepository stateRep, const DtString &name=DtString::nullString(), DtReaderWriterRegistry parentRegistry=NULL)
	Constructor. More...

	DtSimKinematicState (DtSimObjectStateRepository stateRep, const DtSymbolString &name, DtReaderWriterRegistry parentRegistry=NULL)

	DtSimKinematicState (const DtSimKinematicState &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Copy Constructor. More...

	DtSimKinematicState (const DtSimKinematicState &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)

const DtSimKinematicState &	operator= (const DtSimKinematicState &orig)
	Assignment Operator. More...

virtual	~DtSimKinematicState ()
	Destructor. More...

virtual DtSimKinematicState *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual const DtVector &	parentPosition () const

virtual const DtVector &	parentVelocity () const

virtual void	setParentVelocity (const DtVector &velocity, bool recomputeSpeed=true)

virtual DtReal	parentSpeed () const

virtual const DtVector &	parentAcceleration () const

virtual void	setParentAcceleration (const DtVector &acceleration)

virtual const DtTaitBryan &	parentOrientation () const

virtual const DtDcm &	parentOrientationMatrix () const

virtual void	setParentOrientationMatrix (const DtDcm &orientationMatrix, bool recomputeEulers=true)

virtual DtReal	worldSpeed () const

virtual const DtDcm &	worldOrientationMatrix () const

virtual DtTaitBryan	topoEuler () const

virtual double	heading () const

virtual double	pitch () const

virtual double	roll () const

virtual const DtVector &	rotationalVelocity () const

virtual void	setRotationalVelocity (const DtVector &rotationalVelocity)

virtual void	setAffectAttachments (bool)
	Set to false if you do not want changes to the kinematic state to affect any attached objects. More...

bool	affectAttachments () const

virtual DtKinematicStateCS::DtRotationConstraint	rotationConstraint () const

virtual DtKinematicStateCS::DtSimOrientationType	orientationType () const
	Wrapper for DtKinematicStateCS functions. More...

virtual void	setOrientationType (DtKinematicStateCS::DtSimOrientationType orientationType)

virtual DtSimObjectStateRepository *	stateRepository () const

DtCoordSysValidationVector &	parentVV ()

DtCoordSysValidationVector &	worldVV ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to check for invalid parent and world state date before writing self to file. More...

virtual void	validateParentState ()
	Validates all values (if they are invalid) including world and parent. More...

virtual void	validateWorldState ()

virtual void	clearWorldVertices ()
	Clears out vertex list. More...

virtual void	copyWorldVertices (const DtList &)

virtual void	addWorldVertex (const DtVector &vertex, DtVector &newGeometricCenter)
	Object geometry methods – these methods reference some information in the world kinematic state. More...

virtual void	setWorldVertices (const DtVertexList &vertices, DtVector &newGeometricCenter)
	Sets world vertices and translates them to body coordinates. More...

virtual const DtVertexList &	worldVertices () const
	Returns world vertices and iterator of world vertices. More...

virtual const DtRwVectorIterator &	worldVertexIterator () const

virtual void	invalidateWorldGeometry ()
	Sets the myObjectGeometryInvalid flag to true. More...

virtual bool	calculateGeometricCenter (const DtList &vertices, DtVector &geometricCenter) const
	Given the list, finds the geometric center of the points in the list. More...

virtual const DtKinematicStateCS &	parentKinematicState () const
	Get / set kinematic state in parent coords. More...

virtual DtKinematicStateCS &	parentKinematicState ()

virtual void	setParentKinematicState (const DtKinematicStateCS &parentKinematicState)

virtual const DtKinematicStateCS &	worldKinematicState () const
	Get / set kinematic state in world coords. More...

virtual DtKinematicStateCS &	worldKinematicState ()

virtual void	setWorldKinematicState (const DtKinematicStateCS &worldKinematicState)

virtual void	setWorldPositionFromParent ()
	Update the world position from the parent's position. More...

virtual void	setWorldOrientationFromParent ()
	Update the world orientation from the parent's orientation. More...

virtual bool	isFrozen () const
	Use this method to check freeze movement rather than state data in vrfsim due to timing on when the actuators are called (setting of state data might be done before this is changed properly) More...

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

virtual void	writeSelf (std::string &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. More...

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

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. More...

bool	isReadonly () const

virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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. More...

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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. More...

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

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. More...

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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. More...

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. More...

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Protected Member Functions
virtual const DtKinematicStateCS &	localKinematicState () const
	Get / set kinematic state in local coords. More...

virtual DtKinematicStateCS &	localKinematicState ()

virtual void	setLocalKinematicState (const DtKinematicStateCS &localKinematicState)

virtual void	clearLocalVertices ()

Protected Member Functions inherited from DtSimKinematicState
virtual void	calculateBodyCoordinates (const DtList &worldVertices)
	Given the current world position and world orientation, calculate body coordinates. More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Attributes
DtKinematicStateCS	myLocalKinematicState
	Position, velocity, acceleration, orientation (Euler and DCM), and rotational velocity in database coordinate system (same as parent for base object). More...

DtCoordSysValidationVector	myLocalVV

const Coordinate_System *	myCoordinateSystemPtr

DtTaitBryan	myTopoOrientation
	This data member is used in localOrientation(), to provide a way to return a const reference to a DtTaitBryan representing topo Euler angles. More...

DtVector	myRelativeAcceleration

bool	myRelativeAccelerationInvalid

DtVector	myRelativeVelocity

bool	myRelativeVelocityInvalid

bool	myLocalObjectGeometryInvalid

DtLocalVertexList	myLocalVertexList

tbb::spin_mutex	myLocalVerticesMutex

Protected Attributes inherited from DtSimKinematicState
DtKinematicStateCS	myParentKinematicState
	position, velocity, acceleration, orientation (Euler and DCM), and rotational velocity in parent's coordinate system More...

DtKinematicStateCS	myWorldKinematicState
	position, velocity, acceleration, orientation (Euler and DCM), and rotational velocity in database coordinate system (same as parent for base object) More...

DtVertexList	myWorldVertices

DtCoordSysValidationVector	myParentVV
	XXX This will not be here... More...

DtCoordSysValidationVector	myWorldVV

DtRwVector	myRotationalVelocity
	this is the rate at which the object is rolling, pitching and yawing More...

DtSimObjectStateRepository *	myStateRepository

DtTaitBryan	myTopoEuler

bool	myTopoInvalid

bool	myObjectGeometryInvalid
	If true, and if this item is attached to a parent, redo object geometry. More...

bool	myAffectAttachments

bool	myFreezeMovement
	When set to true this will cause velocity, acceleration, and rotation velocity. More...

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. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

Private Member Functions
	DtVrfKinematicState ()

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 (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

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

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Detailed Description

This class is a DtSimKinematicState with the addition of another CS for local database coordinates.

Constructor & Destructor Documentation

DtVrfKinematicState::DtVrfKinematicState	(	const Coordinate_System *	coordinateSystem,
		DtSimObjectStateRepository *	stateRep,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Constructor.

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

Copy Constructor.

virtual DtVrfKinematicState::~DtVrfKinematicState ( )

virtual

Destructor.

DtVrfKinematicState::DtVrfKinematicState ( )

private

Member Function Documentation

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

Assignment Operator.

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

virtual

Clone.

Reimplemented from DtSimKinematicState.

virtual void DtVrfKinematicState::setCoordinateSystem ( const Coordinate_System * coordinateSystem )

virtual

Sets coordinate system used in converting between local (database) and other (geocentric or topocentric) coordinates.

Must be called with a valid coordinate system before any public member functions are called.

virtual const Coordinate_System* DtVrfKinematicState::coordinateSystem ( ) const

virtual

virtual const DtVector& DtVrfKinematicState::localPosition ( ) const

virtual

Position in local (database) coordinates, in meters.

virtual void DtVrfKinematicState::setLocalPosition ( const DtVector & localPosition )

virtual

virtual void DtVrfKinematicState::setWorldVertices	(	const DtList &	vertices,
		DtVector &	newGeometricCenter
	)

virtual

Override to set dirty flag for local.

Reimplemented from DtSimKinematicState.

virtual const DtVector& DtVrfKinematicState::localVelocity ( ) const

virtual

Velocity in local (database) coordinates, in meters/second.

virtual void DtVrfKinematicState::setLocalVelocity	(	const DtVector &	localVelocity,
		bool	recomputeSpeed = `true`
	)

virtual

virtual DtReal DtVrfKinematicState::localSpeed ( ) const

virtual

Speed, in meters/second.

virtual void DtVrfKinematicState::setLocalSpeed ( DtReal localSpeed )

virtual

virtual const DtVector& DtVrfKinematicState::localAcceleration ( ) const

virtual

Acceleration in local (database) coordinates, in meters/second/second.

virtual void DtVrfKinematicState::setLocalAcceleration ( const DtVector & localAcceleration )

virtual

virtual const DtVector& DtVrfKinematicState::relativeAcceleration ( ) const

virtual

Note that for both of the relative calls, the supplied acceleration or velocity should be in local (datbase) coordinates.

The returned values are also in local (database) coordinates If attached, returns parent and sets parent acceleration, else returns/sets local

virtual void DtVrfKinematicState::setRelativeAcceleration ( const DtVector & localAcceleration )

virtual

virtual const DtVector& DtVrfKinematicState::relativeVelocity ( ) const

virtual

If attached, returns parent and sets parent velocity, else returns/sets local.

virtual void DtVrfKinematicState::setRelativeVelocity	(	const DtVector &	localVelocity,
		bool	recomputeSpeed = `true`
	)

virtual

virtual DtVector DtVrfKinematicState::bodyVelocity ( ) const

virtual

Returns bodyVelocity if not attached, else relative velocity.

Reimplemented from DtSimKinematicState.

virtual void DtVrfKinematicState::invalidateRelativeVelocity ( )

virtual

virtual void DtVrfKinematicState::invalidateRelativeAcceleration ( )

virtual

virtual const DtTaitBryan& DtVrfKinematicState::localOrientationWrtDatabase ( ) const

virtual

Euler angles with respect to the local (database) coordinate system, in radians.

virtual void DtVrfKinematicState::setLocalOrientationWrtDatabase	(	const DtTaitBryan &	localOrientation,
		DtKinematicStateCS::DtRotationConstraint	recomputeMatrix = `DtKinematicStateCS::RotateAboutX`
	)

virtual

virtual const DtDcm& DtVrfKinematicState::localOrientationMatrix ( ) const

virtual

Directed cosine matrix for rotating from body coordinates to the local (database) coordinate system.

virtual void DtVrfKinematicState::setLocalOrientationMatrix	(	const DtDcm &	localOrientationMatrix,
		bool	recomputeEulers = `true`
	)

virtual

virtual void DtVrfKinematicState::setRotationConstraint ( DtKinematicStateCS::DtRotationConstraint constraint )

virtual

Reimplemented from DtSimKinematicState.

virtual const DtVector& DtVrfKinematicState::worldPosition ( ) const

virtual

Position in geocentric coordinates, in meters.

Reimplemented from DtSimKinematicState.

virtual void DtVrfKinematicState::setWorldPosition ( const DtVector & gecoentricPosition )

virtual

Reimplemented from DtSimKinematicState.

virtual const DtVector& DtVrfKinematicState::worldVelocity ( ) const

virtual

Velocity in geocentric coordinates, in meters/second.

Reimplemented from DtSimKinematicState.

virtual void DtVrfKinematicState::setWorldVelocity	(	const DtVector &	gecoentricVelocity,
		bool	recomputeSpeed = `true`
	)

virtual

Reimplemented from DtSimKinematicState.

virtual const DtVector& DtVrfKinematicState::worldAcceleration ( ) const

virtual

Acceleration in geocentric coordinates, in meters/second/second.

Reimplemented from DtSimKinematicState.

virtual void DtVrfKinematicState::setWorldAcceleration ( const DtVector & gecoentricAcceleration )

virtual

Reimplemented from DtSimKinematicState.

virtual const DtTaitBryan& DtVrfKinematicState::worldOrientation ( ) const

virtual

Euler angles with respect to the geocentric coordinate system, in radians.

Reimplemented from DtSimKinematicState.

virtual void DtVrfKinematicState::setWorldOrientation	(	const DtTaitBryan &	orientation,
		DtKinematicStateCS::DtRotationConstraint	recomputeMatrix = `DtKinematicStateCS::RotateAboutX`
	)

virtual

Reimplemented from DtSimKinematicState.

virtual void DtVrfKinematicState::setParentOrientation	(	const DtTaitBryan &	orientation,
		DtKinematicStateCS::DtRotationConstraint	recomputeMatrix = `DtKinematicStateCS::RotateAboutX`
	)

virtual

Overridden to invalidate the localVV.

Reimplemented from DtSimKinematicState.

virtual void DtVrfKinematicState::setParentPosition ( const DtVector & position )

virtual

Overridden to invalidate the localVV.

Reimplemented from DtSimKinematicState.

virtual void DtVrfKinematicState::setWorldOrientationMatrix	(	const DtDcm &	orientationMatrix,
		bool	recomputeEulers = `true`
	)

virtual

Directed cosine matrix for rotating from body coordinates to the geocentric coordinate system.

Reimplemented from DtSimKinematicState.

virtual void DtVrfKinematicState::parentKinematicsChanged ( )

virtual

Overridden to invalidate the localVV.

Reimplemented from DtSimKinematicState.

DtCoordSysValidationVector& DtVrfKinematicState::localVV ( )

No user serviceable parts inside! This accessor makes the validation vectors accessible to the object manager so that it set them when reading from the Order of battle file...

virtual void DtVrfKinematicState::validateLocalState ( )

virtual

Called from validateState(), validates all local variables. Called from putSelf.

virtual void DtVrfKinematicState::validateState ( )

virtual

Reimplemented from DtSimKinematicState.

virtual const DtTaitBryan& DtVrfKinematicState::localOrientation ( ) const

virtual

Deprecated:: To be removed after VR-Forces version 3.11 The following functions are only applicable for UTM databases. Set/get topocentric Euler angles (heading, pitch, and roll). Use localOrientationWrtDatabase() instead, to get Euler angles with respect to the local (database) coordinate system, independent of the particular type of coordinate system in use (e.g. UTM, geocentric).

virtual void DtVrfKinematicState::setLocalOrientation	(	const DtTaitBryan &	topoOrientation,
		DtKinematicStateCS::DtRotationConstraint	recomputeMatrix = `DtKinematicStateCS::RotateAboutX`
	)

virtual

virtual void DtVrfKinematicState::addLocalVertex	(	const DtVector &	vertex,
		DtVector &	newGeometricCenter
	)

virtual

Object geometry methods – these methods reference some information in the world kinematic state.

Adds a new vertex to the world geometry (translating to body)

virtual void DtVrfKinematicState::setLocalVertices	(	const DtLocalVertexList &	vertices,
		DtVector &	newGeometricCenter
	)

virtual

Sets local vertices and also translates to body coordinates.

The new newGeometricCenter parameter is updated based on the verticies provided.

virtual void DtVrfKinematicState::setLocalVertices	(	const DtList &	vertices,
		DtVector &	newGeometricCenter
	)

virtual

virtual void DtVrfKinematicState::setIsEllipsoid ( bool )

virtual

Sets whether or not this geometry refernces an ellipsoid.

virtual bool DtVrfKinematicState::isEllipsoid ( ) const

virtual

virtual const DtLocalVertexList& DtVrfKinematicState::localVertices ( ) const

virtual

Returns local vertex list and iterator.

virtual const DtLocalVectorIterator& DtVrfKinematicState::localVertexIterator ( ) const

virtual

virtual void DtVrfKinematicState::removeVertex ( int )

virtual

Removes vertex at the specified position.

Reimplemented from DtSimKinematicState.

void DtVrfKinematicState::setGeometryNeedsUpdate ( bool b )

inlinevirtual

Sets flags to update vertices.

Reimplemented from DtSimKinematicState.

References myLocalObjectGeometryInvalid, and DtSimKinematicState::setGeometryNeedsUpdate().

virtual void DtVrfKinematicState::invalidateLocalGeometry ( )

virtual

Sets the myLocalObjectGeometryInvalid flag to true.

Should be called by anyone who sets the object geometry without going though this class. Also calls invalidateWorldGeometry().

virtual void DtVrfKinematicState::freezeSpatial ( )

virtual

virtual void DtVrfKinematicState::thawSpatial ( )

virtual

virtual const DtKinematicStateCS& DtVrfKinematicState::localKinematicState ( ) const

protectedvirtual

Get / set kinematic state in local coords.

I don't expect the set version to be used, but it's included for completeness.

virtual DtKinematicStateCS& DtVrfKinematicState::localKinematicState ( )

protectedvirtual

virtual void DtVrfKinematicState::setLocalKinematicState ( const DtKinematicStateCS & localKinematicState )

protectedvirtual

virtual void DtVrfKinematicState::clearLocalVertices ( )

protectedvirtual

Member Data Documentation

DtKinematicStateCS DtVrfKinematicState::myLocalKinematicState

mutableprotected

Position, velocity, acceleration, orientation (Euler and DCM), and rotational velocity in database coordinate system (same as parent for base object).

DtCoordSysValidationVector DtVrfKinematicState::myLocalVV

protected

const Coordinate_System* DtVrfKinematicState::myCoordinateSystemPtr

protected

DtTaitBryan DtVrfKinematicState::myTopoOrientation

protected

This data member is used in localOrientation(), to provide a way to return a const reference to a DtTaitBryan representing topo Euler angles.

It is needed to provide a backwards compatible interface only.

DtVector DtVrfKinematicState::myRelativeAcceleration

protected

bool DtVrfKinematicState::myRelativeAccelerationInvalid

protected

DtVector DtVrfKinematicState::myRelativeVelocity

protected

bool DtVrfKinematicState::myRelativeVelocityInvalid

protected

bool DtVrfKinematicState::myLocalObjectGeometryInvalid

mutableprotected

Referenced by setGeometryNeedsUpdate().

DtLocalVertexList DtVrfKinematicState::myLocalVertexList

mutableprotected

tbb::spin_mutex DtVrfKinematicState::myLocalVerticesMutex

mutableprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjcore/vrfKinematicState.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation