Specialized vector that can be used for the knowledge of an "offset" rather than location vector. More...

Inheritance diagram for DtRwOffsetVector:

Public Member Functions
	DtRwOffsetVector (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwOffsetVector (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwOffsetVector (double x, double y, double z, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	Real constructor from 3 doubles.
	DtRwOffsetVector (double x, double y, double z, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwOffsetVector (const DtVector &fromVec, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	Real constructor from DtVector.
	DtRwOffsetVector (const DtVector &fromVec, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwOffsetVector ()
	DtRwOffsetVector (const DtRwOffsetVector &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtRwOffsetVector &	operator= (const DtRwOffsetVector &orig)
	Assign to DtRwOffsetVector. Assigns value only.
DtRwOffsetVector &	operator= (const DtRwVector &orig)
	Assign to DtRwVector. Assigns value only.
DtRwOffsetVector &	operator= (const DtVector &orig)
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual void	setFront (double)
	Equivalent to X.
double	front () const
virtual void	setRight (double)
	Equivalent to Y.
double	right () const
virtual void	setUp (double)
	Equivalent to Z.
double	up () const
Public Member Functions inherited from DtRwVector
	DtRwVector (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwVector (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwVector (double x, double y, double z, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	Real constructor from 3 doubles.
	DtRwVector (double x, double y, double z, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwVector (const DtVector &fromVec, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	Real constructor from DtVector.
	DtRwVector (const DtVector &fromVec, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwVector (const DtRwVector &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtRwVector ()
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)
virtual double	distSquaredTo (const DtVector &point) const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of this variable.
bool	operator== (const DtRwVector &) const
bool	operator!= (const DtRwVector &rhs) 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 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.

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 ()
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 DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Detailed Description

Specialized vector that can be used for the knowledge of an "offset" rather than location vector.

Defined for use in scripted tasks such that tasks can know if they are taking an offset or a location. Units are in meters.

Constructor & Destructor Documentation

DtRwOffsetVector::DtRwOffsetVector	(	const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

real constructor

DtRwOffsetVector::DtRwOffsetVector	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtRwOffsetVector::DtRwOffsetVector	(	double	x,
		double	y,
		double	z,
		const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Real constructor from 3 doubles.

DtRwOffsetVector::DtRwOffsetVector	(	double	x,
		double	y,
		double	z,
		const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtRwOffsetVector::DtRwOffsetVector	(	const DtVector &	fromVec,
		const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Real constructor from DtVector.

DtRwOffsetVector::DtRwOffsetVector	(	const DtVector &	fromVec,
		const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

virtual DtRwOffsetVector::~DtRwOffsetVector ( )

virtual

DtRwOffsetVector::DtRwOffsetVector	(	const DtRwOffsetVector &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

Member Function Documentation

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

Assign to DtRwOffsetVector. Assigns value only.

DtRwOffsetVector& DtRwOffsetVector::operator= ( const DtRwVector & orig )

Assign to DtRwVector. Assigns value only.

Reimplemented from DtRwVector.

DtRwOffsetVector& DtRwOffsetVector::operator= ( const DtVector & orig )

Reimplemented from DtRwVector.

virtual const char* DtRwOffsetVector::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 DtRwVector.

virtual void DtRwOffsetVector::setFront ( double )

virtual

Equivalent to X.

double DtRwOffsetVector::front ( ) const

virtual void DtRwOffsetVector::setRight ( double )

virtual

Equivalent to Y.

double DtRwOffsetVector::right ( ) const

virtual void DtRwOffsetVector::setUp ( double )

virtual

Equivalent to Z.

double DtRwOffsetVector::up ( ) const

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/rwVector.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation