A readable, writable type that holds an articulated part state. More...

Inheritance diagram for DtRwArtPartState:

Public Types
enum	MergeRule { AllSpecifiedValues, OnlyIfMyValueIsUnspecified, AllSpecifiedValuesExceptRates }

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 )()

Public Member Functions
	DtRwArtPartState ()
	Default constructor. More...

	DtRwArtPartState (const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor. More...

	DtRwArtPartState (const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor. More...

	DtRwArtPartState (const DtRwArtPartState &orig, const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor. More...

	DtRwArtPartState (const DtRwArtPartState &orig, const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor. More...

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

virtual	~DtRwArtPartState ()

virtual DtRwArtPartState *	clone (const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtRwArtPartState *	clone (const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual bool	mergeSpecifiedParameters (const DtRwArtPartState &other, MergeRule rule=AllSpecifiedValues)
	Sets local parameter values to that of the other part, as long as the other part has that parameter set. More...

virtual void	markMatchingFieldsUnspecified (const DtRwArtPartState &other)
	Sets all values that match the other part state to unspecified. More...

virtual bool	fullAzimuthRotation () const
	Returns true if the part can perform a full azimuth rotation. More...

bool	operator== (const DtRwArtPartState &rhs) const

bool	operator!= (const DtRwArtPartState &rhs) const


virtual void	setAttachPoint (const DtVector &attachPoint, bool isSpecified=true)
	Accessor/mutator for myAttachPoint. More...

virtual DtVector	attachPoint () const

virtual bool	attachPointSpecified () const


virtual DtVector	endPoint () const
	Accessor/mutator for myEndPoint. More...

virtual void	setEndPoint (const DtVector &loc, bool isSpecified=true)

virtual bool	endPointSpecified () const


virtual double	position () const
	Accessor/mutator for myPosition. More...

virtual void	setPosition (double val, bool isSpecified=true)

virtual bool	positionSpecified () const


virtual double	positionRate () const
	Accessor/mutator for myPositionRate. More...

virtual void	setPositionRate (double val, bool isSpecified=true)

virtual bool	positionRateSpecified () const


virtual double	maxPositionRate () const
	Accessor/mutator for myMaxPositionRate. More...

virtual void	setMaxPositionRate (double val, bool isSpecified=true)

virtual bool	maxPositionRateSpecified () const


virtual double	extension () const
	Accessor/mutator for myExtension. More...

virtual void	setExtension (double val, bool isSpecified=true)

virtual bool	extensionSpecified () const


virtual double	extensionRate () const
	Accessor/mutator for myExtensionRate. More...

virtual void	setExtensionRate (double val, bool isSpecified=true)

virtual bool	extensionRateSpecified () const


virtual double	maxExtensionRate () const
	Accessor/mutator for myMaxExtensionRate. More...

virtual void	setMaxExtensionRate (double val, bool isSpecified=true)

virtual bool	maxExtensionRateSpecified () const


virtual DtVector	translation () const
	Accessor/mutator for myTranslation. More...

virtual void	setTranslation (const DtVector &val, bool isSpecified=true)

virtual bool	translationSpecified () const


virtual DtVector	minTranslation () const
	Accessor/mutator for myMinTranslation. More...

virtual void	setMinTranslation (const DtVector &val, bool isSpecified=true)

virtual bool	minTranslationSpecified () const


virtual DtVector	maxTranslation () const
	Accessor/mutator for myMaxTranslation. More...

virtual void	setMaxTranslation (const DtVector &val, bool isSpecified=true)

virtual bool	maxTranslationSpecified () const


virtual DtVector	translationRate () const
	Accessor/mutator for myTranslationRate. More...

virtual void	setTranslationRate (const DtVector &val, bool isSpecified=true)

virtual bool	translationRateSpecified () const


virtual DtVector	maxTranslationRate () const
	Accessor/mutator for myMaxTranslationRate. More...

virtual void	setMaxTranslationRate (const DtVector &val, bool isSpecified=true)

virtual bool	maxTranslationRateSpecified () const


virtual double	azimuth () const
	Accessor/mutator for myAzimuth. More...

virtual void	setAzimuth (double angle, bool isSpecified=true)

virtual bool	azimuthSpecified () const


virtual double	minAzimuth () const
	Accessor/mutator for myMinAzimuth. More...

virtual void	setMinAzimuth (double angle, bool isSpecified=true)

virtual bool	minAzimuthSpecified () const


virtual double	maxAzimuth () const
	Accessor/mutator for myMaxAzimuth. More...

virtual void	setMaxAzimuth (double angle, bool isSpecified=true)

virtual bool	maxAzimuthSpecified () const


virtual double	azimuthRate () const
	Accessor/mutator for myAzimuthRate. More...

virtual void	setAzimuthRate (double rate, bool isSpecified=true)

virtual bool	azimuthRateSpecified () const


virtual double	maxAzimuthRate () const
	Accessor/mutator for myMaxAzimuthRate. More...

virtual void	setMaxAzimuthRate (double rate, bool isSpecified=true)

virtual bool	maxAzimuthRateSpecified () const


virtual double	elevation () const
	Accessor/mutator for myElevation. More...

virtual void	setElevation (double angle, bool isSpecified=true)

virtual bool	elevationSpecified () const


virtual double	minElevation () const
	Accessor/mutator for myMinElevation. More...

virtual void	setMinElevation (double angle, bool isSpecified=true)

virtual bool	minElevationSpecified () const


virtual double	maxElevation () const
	Accessor/mutator for myMaxElevation. More...

virtual void	setMaxElevation (double angle, bool isSpecified=true)

virtual bool	maxElevationSpecified () const


virtual double	elevationRate () const
	Accessor/mutator for myElevationRate. More...

virtual void	setElevationRate (double rate, bool isSpecified=true)

virtual bool	elevationRateSpecified () const


virtual double	maxElevationRate () const
	Accessor/mutator for myMaxElevationRate. More...

virtual void	setMaxElevationRate (double rate, bool isSpecified=true)

virtual bool	maxElevationRateSpecified () const


virtual double	rotation () const
	Accessor/mutator for myRotation. More...

virtual void	setRotation (double angle, bool isSpecified=true)

virtual bool	rotationSpecified () const


virtual double	minRotation () const
	Accessor/mutator for myMinRotation. More...

virtual void	setMinRotation (double angle, bool isSpecified=true)

virtual bool	minRotationSpecified () const


virtual double	maxRotation () const
	Accessor/mutator for myRotation. More...

virtual void	setMaxRotation (double angle, bool isSpecified=true)

virtual bool	maxRotationSpecified () const


virtual double	rotationRate () const
	Accessor/mutator for myRotationRate. More...

virtual void	setRotationRate (double rate, bool isSpecified=true)

virtual bool	rotationRateSpecified () const


virtual double	maxRotationRate () const
	Accessor/mutator for myMaxRotationRate. More...

virtual void	setMaxRotationRate (double rate, bool isSpecified=true)

virtual bool	maxRotationRateSpecified () const


virtual const DtString &	associatedComponent () const
	Accessor/mutator for myAssociatedComponent. More...

virtual void	setAssociatedComponent (const DtString &component, bool isSpecified=true)

virtual bool	associatedComponentSpecified () const


virtual const DtString &	comment () const
	Accessor/mutator for myComment. More...

virtual void	setComment (const DtString &component, bool isSpecified=true)

virtual bool	commentSpecified () const


virtual const std::set < DtString > &	configSources () const
	Accessor/mutator for #myConfigSource. More...

virtual void	setConfigSources (const std::set< DtString > &srcs)

virtual void	addConfigSource (const DtString &src)

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	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. 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...

Static Public Member Functions

static double	defaultRotationRate ()
	The rotation rate to be used when a part is not configured with one, in radians/sec. More...

static void	setDefaultRotationRate (double rate)


static double	defaultTranslationRate ()
	The rotation rate to be used when a part is not configured with one, in m/s. More...

static void	setDefaultTranslationRate (double rate)

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

Protected Attributes
std::set< DtString >	myConfigSources

parameters
These parameters are available for setting in the OPD files.
DtRwOffsetVector	myAttachPoint
	Parameter Name: attach-point Parameter Description: The point at which at the articulated or attached part is attached to another object. More...

DtRwOffsetVector	myEndPoint
	Parameter Name: end-point Parameter Description: The point at which at the articulated or attached part ends. More...

DtRwVector	myTranslation
	Parameter Name: translation Parameter Description: The current part translation value. More...

DtRwVector	myMinTranslation
	Parameter Name: min-translation Parameter Description: The minimum part translation value. More...

DtRwVector	myMaxTranslation
	Parameter Name: max-translation Parameter Description: The maximum part translation value. More...

DtRwVector	myTranslationRate
	Parameter Name: translation-rate Parameter Description: The current translation rate. More...

DtRwVector	myMaxTranslationRate
	Parameter Name: translation-rate Parameter Description: The maximum translation rate. More...

DtRwReal	myPosition
	Parameter Name: position Parameter Description: The current position of the part along a set path where 0 is fully retracted and 1 is fully extended. More...

DtRwReal	myPositionRate
	Parameter Name: position-rate Parameter Description: The current rate of change of the position of the part along a set path. More...

DtRwReal	myMaxPositionRate
	Parameter Name: position-rate Parameter Description: The maximum rate of change of the position of the part along a set path. More...

DtRwReal	myExtension
	Parameter Name: extension Parameter Description: The linear extension of the part in a single direction. More...

DtRwReal	myExtensionRate
	Parameter Name: extension-rate Parameter Description: The rate of change of the linear extension of the part in a single direction. More...

DtRwReal	myMaxExtensionRate
	Parameter Name: max-extension-rate Parameter Description: The maximum rate of change of the linear extension of the part in a single direction. More...

DtRwReal	myAzimuth
	Parameter Name: azimuth Parameter Description: The current or default azimuth. More...

DtRwReal	myMinAzimuth
	Parameter Name: min-azimuth Parameter Description: The minimum azimuth value. More...

DtRwReal	myMaxAzimuth
	Parameter Name: max-azimuth Parameter Description: The maximum azimuth value. More...

DtRwReal	myAzimuthRate
	Parameter Name: azimuth-rate Parameter Description: The current azimuth rate of change. More...

DtRwReal	myMaxAzimuthRate
	Parameter Name: max-azimuth-rate Parameter Description: The maximum azimuth rate of change. More...

DtRwReal	myElevation
	Parameter Name: elevation Parameter Description: The current or default elevation. More...

DtRwReal	myMinElevation
	Parameter Name: min-elevation Parameter Description: The minimum elevation value. More...

DtRwReal	myMaxElevation
	Parameter Name: max-elevation Parameter Description: The maximum elevation value. More...

DtRwReal	myElevationRate
	Parameter Name: elevation-rate Parameter Description: The current elevation rate of change. More...

DtRwReal	myMaxElevationRate
	Parameter Name: max-elevation-rate Parameter Description: The maximum elevation rate of change. More...

DtRwReal	myRotation
	Parameter Name: rotation Parameter Description: The current or default rotation. More...

DtRwReal	myMinRotation
	Parameter Name: min-rotation Parameter Description: The minimum rotation value. More...

DtRwReal	myMaxRotation
	Parameter Name: max-rotation Parameter Description: The maximum rotation value. More...

DtRwReal	myRotationRate
	Parameter Name: rotation-rate Parameter Description: The maximum rotation rate of change. More...

DtRwReal	myMaxRotationRate
	Parameter Name: max-rotation-rate Parameter Description: The maximum rotation rate of change. More...

DtRwString	myAssociatedComponent
	Parameter Name: associated-component Parameter Description: The name of the associated component. More...

DtRwString	myComment
	Parameter Name: comment Parameter Description: A comment a user can optionally save with the articulated part. 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...

Static Protected Attributes
static double	theDefaultRotationRate

static double	theDefaultTranslationRate

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

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

Detailed Description

A readable, writable type that holds an articulated part state.

Member Enumeration Documentation

enum DtRwArtPartState::MergeRule

Enumerator

AllSpecifiedValues

OnlyIfMyValueIsUnspecified

Takes all specified values in other state.

AllSpecifiedValuesExceptRates

Takes only specified values for those settings where my current value is unspecified.

Takes all specified values except for rates, which will only be taken if our own rate is unspecified.

Constructor & Destructor Documentation

DtRwArtPartState::DtRwArtPartState ( )

Default constructor.

DtRwArtPartState::DtRwArtPartState	(	const DtString &	partName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Constructor.

DtRwArtPartState::DtRwArtPartState	(	const DtSymbolString &	partName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Constructor.

DtRwArtPartState::DtRwArtPartState	(	const DtRwArtPartState &	orig,
		const DtString &	partName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Copy constructor.

DtRwArtPartState::DtRwArtPartState	(	const DtRwArtPartState &	orig,
		const DtSymbolString &	partName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Copy constructor.

virtual DtRwArtPartState::~DtRwArtPartState ( )

virtual

Member Function Documentation

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

assignment

virtual DtRwArtPartState* DtRwArtPartState::clone	(	const DtString &	partName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

Reimplemented in DtArticulatedPartStateRepository, and DtSimArtPartDescriptor.

virtual DtRwArtPartState* DtRwArtPartState::clone	(	const DtSymbolString &	partName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

Reimplemented in DtSimArtPartDescriptor.

virtual bool DtRwArtPartState::mergeSpecifiedParameters	(	const DtRwArtPartState &	other,
		MergeRule	rule = `AllSpecifiedValues`
	)

virtual

Sets local parameter values to that of the other part, as long as the other part has that parameter set.

Returns true if any parameters were updated.

virtual void DtRwArtPartState::markMatchingFieldsUnspecified ( const DtRwArtPartState & other )

virtual

Sets all values that match the other part state to unspecified.

virtual void DtRwArtPartState::setAttachPoint	(	const DtVector &	attachPoint,
		bool	isSpecified = `true`
	)

virtual

Accessor/mutator for myAttachPoint.

virtual DtVector DtRwArtPartState::attachPoint ( ) const

virtual

virtual bool DtRwArtPartState::attachPointSpecified ( ) const

virtual

virtual DtVector DtRwArtPartState::endPoint ( ) const

virtual

Accessor/mutator for myEndPoint.

virtual void DtRwArtPartState::setEndPoint	(	const DtVector &	loc,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::endPointSpecified ( ) const

virtual

virtual double DtRwArtPartState::position ( ) const

virtual

Accessor/mutator for myPosition.

virtual void DtRwArtPartState::setPosition	(	double	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::positionSpecified ( ) const

virtual

virtual double DtRwArtPartState::positionRate ( ) const

virtual

Accessor/mutator for myPositionRate.

virtual void DtRwArtPartState::setPositionRate	(	double	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::positionRateSpecified ( ) const

virtual

virtual double DtRwArtPartState::maxPositionRate ( ) const

virtual

Accessor/mutator for myMaxPositionRate.

virtual void DtRwArtPartState::setMaxPositionRate	(	double	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::maxPositionRateSpecified ( ) const

virtual

virtual double DtRwArtPartState::extension ( ) const

virtual

Accessor/mutator for myExtension.

virtual void DtRwArtPartState::setExtension	(	double	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::extensionSpecified ( ) const

virtual

virtual double DtRwArtPartState::extensionRate ( ) const

virtual

Accessor/mutator for myExtensionRate.

virtual void DtRwArtPartState::setExtensionRate	(	double	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::extensionRateSpecified ( ) const

virtual

virtual double DtRwArtPartState::maxExtensionRate ( ) const

virtual

Accessor/mutator for myMaxExtensionRate.

virtual void DtRwArtPartState::setMaxExtensionRate	(	double	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::maxExtensionRateSpecified ( ) const

virtual

virtual DtVector DtRwArtPartState::translation ( ) const

virtual

Accessor/mutator for myTranslation.

virtual void DtRwArtPartState::setTranslation	(	const DtVector &	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::translationSpecified ( ) const

virtual

virtual DtVector DtRwArtPartState::minTranslation ( ) const

virtual

Accessor/mutator for myMinTranslation.

virtual void DtRwArtPartState::setMinTranslation	(	const DtVector &	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::minTranslationSpecified ( ) const

virtual

virtual DtVector DtRwArtPartState::maxTranslation ( ) const

virtual

Accessor/mutator for myMaxTranslation.

virtual void DtRwArtPartState::setMaxTranslation	(	const DtVector &	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::maxTranslationSpecified ( ) const

virtual

virtual DtVector DtRwArtPartState::translationRate ( ) const

virtual

Accessor/mutator for myTranslationRate.

virtual void DtRwArtPartState::setTranslationRate	(	const DtVector &	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::translationRateSpecified ( ) const

virtual

virtual DtVector DtRwArtPartState::maxTranslationRate ( ) const

virtual

Accessor/mutator for myMaxTranslationRate.

virtual void DtRwArtPartState::setMaxTranslationRate	(	const DtVector &	val,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::maxTranslationRateSpecified ( ) const

virtual

virtual double DtRwArtPartState::azimuth ( ) const

virtual

Accessor/mutator for myAzimuth.

virtual void DtRwArtPartState::setAzimuth	(	double	angle,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::azimuthSpecified ( ) const

virtual

virtual double DtRwArtPartState::minAzimuth ( ) const

virtual

Accessor/mutator for myMinAzimuth.

virtual void DtRwArtPartState::setMinAzimuth	(	double	angle,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::minAzimuthSpecified ( ) const

virtual

virtual double DtRwArtPartState::maxAzimuth ( ) const

virtual

Accessor/mutator for myMaxAzimuth.

virtual void DtRwArtPartState::setMaxAzimuth	(	double	angle,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::maxAzimuthSpecified ( ) const

virtual

virtual double DtRwArtPartState::azimuthRate ( ) const

virtual

Accessor/mutator for myAzimuthRate.

virtual void DtRwArtPartState::setAzimuthRate	(	double	rate,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::azimuthRateSpecified ( ) const

virtual

virtual double DtRwArtPartState::maxAzimuthRate ( ) const

virtual

Accessor/mutator for myMaxAzimuthRate.

virtual void DtRwArtPartState::setMaxAzimuthRate	(	double	rate,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::maxAzimuthRateSpecified ( ) const

virtual

virtual bool DtRwArtPartState::fullAzimuthRotation ( ) const

virtual

Returns true if the part can perform a full azimuth rotation.

virtual double DtRwArtPartState::elevation ( ) const

virtual

Accessor/mutator for myElevation.

virtual void DtRwArtPartState::setElevation	(	double	angle,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::elevationSpecified ( ) const

virtual

virtual double DtRwArtPartState::minElevation ( ) const

virtual

Accessor/mutator for myMinElevation.

virtual void DtRwArtPartState::setMinElevation	(	double	angle,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::minElevationSpecified ( ) const

virtual

virtual double DtRwArtPartState::maxElevation ( ) const

virtual

Accessor/mutator for myMaxElevation.

virtual void DtRwArtPartState::setMaxElevation	(	double	angle,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::maxElevationSpecified ( ) const

virtual

virtual double DtRwArtPartState::elevationRate ( ) const

virtual

Accessor/mutator for myElevationRate.

virtual void DtRwArtPartState::setElevationRate	(	double	rate,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::elevationRateSpecified ( ) const

virtual

virtual double DtRwArtPartState::maxElevationRate ( ) const

virtual

Accessor/mutator for myMaxElevationRate.

virtual void DtRwArtPartState::setMaxElevationRate	(	double	rate,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::maxElevationRateSpecified ( ) const

virtual

virtual double DtRwArtPartState::rotation ( ) const

virtual

Accessor/mutator for myRotation.

virtual void DtRwArtPartState::setRotation	(	double	angle,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::rotationSpecified ( ) const

virtual

virtual double DtRwArtPartState::minRotation ( ) const

virtual

Accessor/mutator for myMinRotation.

virtual void DtRwArtPartState::setMinRotation	(	double	angle,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::minRotationSpecified ( ) const

virtual

virtual double DtRwArtPartState::maxRotation ( ) const

virtual

Accessor/mutator for myRotation.

virtual void DtRwArtPartState::setMaxRotation	(	double	angle,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::maxRotationSpecified ( ) const

virtual

virtual double DtRwArtPartState::rotationRate ( ) const

virtual

Accessor/mutator for myRotationRate.

virtual void DtRwArtPartState::setRotationRate	(	double	rate,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::rotationRateSpecified ( ) const

virtual

virtual double DtRwArtPartState::maxRotationRate ( ) const

virtual

Accessor/mutator for myMaxRotationRate.

virtual void DtRwArtPartState::setMaxRotationRate	(	double	rate,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::maxRotationRateSpecified ( ) const

virtual

virtual const DtString& DtRwArtPartState::associatedComponent ( ) const

virtual

Accessor/mutator for myAssociatedComponent.

virtual void DtRwArtPartState::setAssociatedComponent	(	const DtString &	component,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::associatedComponentSpecified ( ) const

virtual

virtual const DtString& DtRwArtPartState::comment ( ) const

virtual

Accessor/mutator for myComment.

virtual void DtRwArtPartState::setComment	(	const DtString &	component,
		bool	isSpecified = `true`
	)

virtual

virtual bool DtRwArtPartState::commentSpecified ( ) const

virtual

virtual const std::set<DtString>& DtRwArtPartState::configSources ( ) const

virtual

Accessor/mutator for #myConfigSource.

virtual void DtRwArtPartState::setConfigSources ( const std::set< DtString > & srcs )

virtual

virtual void DtRwArtPartState::addConfigSource ( const DtString & src )

virtual

bool DtRwArtPartState::operator== ( const DtRwArtPartState & rhs ) const

bool DtRwArtPartState::operator!= ( const DtRwArtPartState & rhs ) const

inline

static double DtRwArtPartState::defaultRotationRate ( )

static

The rotation rate to be used when a part is not configured with one, in radians/sec.

static void DtRwArtPartState::setDefaultRotationRate ( double rate )

static

static double DtRwArtPartState::defaultTranslationRate ( )

static

The rotation rate to be used when a part is not configured with one, in m/s.

static void DtRwArtPartState::setDefaultTranslationRate ( double rate )

static

Member Data Documentation

DtRwOffsetVector DtRwArtPartState::myAttachPoint

protected

Parameter Name: attach-point Parameter Description: The point at which at the articulated or attached part is attached to another object.

If this part is being attached to an entity, then the attach-point is is specified in the body coordinate system of the entity. If part is being attached to another attached or articulated part, then the attach-point is specified in the body coordinate system of the part it is being attached to. In a body coordinate system, the axes are specified as follows:

x-axis points out of the 'front' of the object
y-axis points out of the 'side' of the object
z-axis points out of the 'bottom' of the object Parameter Default Value: (0. 0. 0.) Parameter Units: meters

DtRwOffsetVector DtRwArtPartState::myEndPoint

protected

Parameter Name: end-point Parameter Description: The point at which at the articulated or attached part ends.

This value is relative the part itself, offset from the attach point. Can be used to determine things such as muzzle position on a gun. Parameter Default Value: (0. 0. 0.) Parameter Units: meters

DtRwVector DtRwArtPartState::myTranslation

protected

Parameter Name: translation Parameter Description: The current part translation value.

Parameter Default Value: (0. 0. 0.) Parameter Units: meters

DtRwVector DtRwArtPartState::myMinTranslation

protected

Parameter Name: min-translation Parameter Description: The minimum part translation value.

Parameter Default Value: (-max dbl -max dbl -max dbl) Parameter Units: meters

DtRwVector DtRwArtPartState::myMaxTranslation

protected

Parameter Name: max-translation Parameter Description: The maximum part translation value.

Parameter Default Value: (max dbl max dbl max dbl) Parameter Units: meters

DtRwVector DtRwArtPartState::myTranslationRate

protected

Parameter Name: translation-rate Parameter Description: The current translation rate.

Parameter Default Value: (0. 0. 0.) Parameter Units: meters/sec

DtRwVector DtRwArtPartState::myMaxTranslationRate

protected

Parameter Name: translation-rate Parameter Description: The maximum translation rate.

Parameter Default Value: (max dbl max dbl max dbl) Parameter Units: meters/sec

DtRwReal DtRwArtPartState::myPosition

protected

Parameter Name: position Parameter Description: The current position of the part along a set path where 0 is fully retracted and 1 is fully extended.

Parameter Default Value: 0 Parameter Units: n/a

DtRwReal DtRwArtPartState::myPositionRate

protected

Parameter Name: position-rate Parameter Description: The current rate of change of the position of the part along a set path.

Parameter Default Value: 0 Parameter Units: position change per second

DtRwReal DtRwArtPartState::myMaxPositionRate

protected

Parameter Name: position-rate Parameter Description: The maximum rate of change of the position of the part along a set path.

Parameter Default Value: 0 Parameter Units: position change per second

DtRwReal DtRwArtPartState::myExtension

protected

Parameter Name: extension Parameter Description: The linear extension of the part in a single direction.

Parameter Default Value: 0 (fully retracted) Parameter Units: meters

DtRwReal DtRwArtPartState::myExtensionRate

protected

Parameter Name: extension-rate Parameter Description: The rate of change of the linear extension of the part in a single direction.

Parameter Default Value: 0 Parameter Units: meters/sec

DtRwReal DtRwArtPartState::myMaxExtensionRate

protected

Parameter Name: max-extension-rate Parameter Description: The maximum rate of change of the linear extension of the part in a single direction.

Parameter Default Value: 0 Parameter Units: meters/sec

DtRwReal DtRwArtPartState::myAzimuth

protected

Parameter Name: azimuth Parameter Description: The current or default azimuth.

Parameter Default Value: 0.0 Parameter Units: radians

DtRwReal DtRwArtPartState::myMinAzimuth

protected

Parameter Name: min-azimuth Parameter Description: The minimum azimuth value.

Parameter Default Value: 0.0 Parameter Units: radians

DtRwReal DtRwArtPartState::myMaxAzimuth

protected

Parameter Name: max-azimuth Parameter Description: The maximum azimuth value.

Parameter Default Value: 0.0 Parameter Units: radians

DtRwReal DtRwArtPartState::myAzimuthRate

protected

Parameter Name: azimuth-rate Parameter Description: The current azimuth rate of change.

Parameter Default Value: 0.0 Parameter Units: radians/sec

DtRwReal DtRwArtPartState::myMaxAzimuthRate

protected

Parameter Name: max-azimuth-rate Parameter Description: The maximum azimuth rate of change.

Parameter Default Value: 0.0 Parameter Units: radians/sec

DtRwReal DtRwArtPartState::myElevation

protected

Parameter Name: elevation Parameter Description: The current or default elevation.

Parameter Default Value: 0.0 Parameter Units: radians

DtRwReal DtRwArtPartState::myMinElevation

protected

Parameter Name: min-elevation Parameter Description: The minimum elevation value.

Parameter Default Value: 0.0 Parameter Units: radians

DtRwReal DtRwArtPartState::myMaxElevation

protected

Parameter Name: max-elevation Parameter Description: The maximum elevation value.

Parameter Default Value: 0.0 Parameter Units: radians

DtRwReal DtRwArtPartState::myElevationRate

protected

Parameter Name: elevation-rate Parameter Description: The current elevation rate of change.

Parameter Default Value: 0.0 Parameter Units: radians/sec

DtRwReal DtRwArtPartState::myMaxElevationRate

protected

Parameter Name: max-elevation-rate Parameter Description: The maximum elevation rate of change.

Parameter Default Value: 0.0 Parameter Units: radians/sec

DtRwReal DtRwArtPartState::myRotation

protected

Parameter Name: rotation Parameter Description: The current or default rotation.

Parameter Default Value: 0.0 Parameter Units: radians

DtRwReal DtRwArtPartState::myMinRotation

protected

Parameter Name: min-rotation Parameter Description: The minimum rotation value.

Parameter Default Value: 0.0 Parameter Units: radians

DtRwReal DtRwArtPartState::myMaxRotation

protected

Parameter Name: max-rotation Parameter Description: The maximum rotation value.

Parameter Default Value: 0.0 Parameter Units: radians

DtRwReal DtRwArtPartState::myRotationRate

protected

Parameter Name: rotation-rate Parameter Description: The maximum rotation rate of change.

Parameter Default Value: 0.0 Parameter Units: radians/sec

DtRwReal DtRwArtPartState::myMaxRotationRate

protected

Parameter Name: max-rotation-rate Parameter Description: The maximum rotation rate of change.

Parameter Default Value: 0.0 Parameter Units: radians/sec

DtRwString DtRwArtPartState::myAssociatedComponent

protected

Parameter Name: associated-component Parameter Description: The name of the associated component.

Empty string if no associated component. Parameter Default Value: "" Parameter Units: n/a

DtRwString DtRwArtPartState::myComment

protected

Parameter Name: comment Parameter Description: A comment a user can optionally save with the articulated part.

Parameter Default Value: "" Parameter Units: n/a

std::set<DtString> DtRwArtPartState::myConfigSources

protected

double DtRwArtPartState::theDefaultRotationRate

staticprotected

double DtRwArtPartState::theDefaultTranslationRate

staticprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjparam/rwArtPartState.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation