DtSimSector Class Reference

Description: DtSimSector is a readable/writable description of a sector of responsibility (center and size, both in radians), and some useful methods for using them. More...

Inheritance diagram for DtSimSector:

Public Member Functions
	DtSimSector ()
	default constructor
	DtSimSector (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtSimSector (const DtString &name, const DtSimSector &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimSector &	operator= (const DtSimSector &orig)
	assignment operator
virtual	~DtSimSector ()
virtual DtSimSector *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual int	operator== (const DtSimSector &rhs) const
	Returns 1 if sectors have the same size and same center; 0 otherwise.
virtual void	setSector (DtReal center, DtReal size)
	This can be called each simulation frame with the entity's current sector information.
virtual DtReal	sectorSize () const
	Size of the sector in radians.
virtual DtReal	sectorCenter () const
	Center of the sector's center in radians.
virtual const DtVector &	centerVector () const
	Gives the center of the sector as a normalized vector in body coordinates.
virtual bool	inSector (DtReal angle) const
	Is this angle within the sector.
virtual bool	inSector (DtVector bodyVector) const
	Is this vector (body coordinates) in the sector.
virtual bool	inSector (const DtVector &localPoint, const DtVector &parentLocation, const DtDcm &localToBody) const
	Is this point (world coordinates) in the sector.
virtual DtReal	bodyToSector (DtReal angle) const
	Converts an angle in body coordinates to an angle in sector coordinates.
virtual DtReal	sectorToBody (DtReal angle) const
	Converts an angle in sector coordinates to an angle in body coordinates.
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Override, so that after read can call setSector to set up variables.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtVector	myCenterVector
DtReal	myBodyToSectorOffset
DtReal	myCosineHalfSectorSize
parameters
These parameters are available for setting in the OPD files.
DtRwReal	mySectorCenter
	Parameter Name: sector-center Parameter Description: Specifies the center of the sector of responsibility relative to the entity's orientation.
DtRwReal	mySectorSize
	Parameter Name: sector-size Parameter Description: Specifies the width of the sector of responsibility.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static DtReaderWriterFactory *	factory ()
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Detailed Description

Description: DtSimSector is a readable/writable description of a sector of responsibility (center and size, both in radians), and some useful methods for using them.

Everything is projected onto the <x y>=""> plane (local), so the sector actually functions as a volume extending infinitely in both z directions.

Constructor & Destructor Documentation

DtSimSector::DtSimSector

(

)

default constructor

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

real constructor

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

copy constructor

virtual DtSimSector::~DtSimSector ( )

virtual

Member Function Documentation

const DtSimSector& DtSimSector::operator=

(

const DtSimSector &

orig

)

assignment operator

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

virtual

virtual int DtSimSector::operator== ( const DtSimSector &  rhs ) const

virtual

Returns 1 if sectors have the same size and same center; 0 otherwise.

virtual void DtSimSector::setSector ( DtReal  center, DtReal  size  )

virtual

This can be called each simulation frame with the entity's current sector information.

If it hasn't changed, the object will do nothing, but if it has, it will recalculate the sector vectors and bodyToSectorOffset. Values are in radians.

virtual DtReal DtSimSector::sectorSize ( ) const

virtual

Size of the sector in radians.

virtual DtReal DtSimSector::sectorCenter ( ) const

virtual

Center of the sector's center in radians.

virtual const DtVector& DtSimSector::centerVector ( ) const

virtual

Gives the center of the sector as a normalized vector in body coordinates.

virtual bool DtSimSector::inSector ( DtReal  angle ) const

virtual

Is this angle within the sector.

virtual bool DtSimSector::inSector ( DtVector  bodyVector ) const

virtual

Is this vector (body coordinates) in the sector.

virtual bool DtSimSector::inSector ( const DtVector &  localPoint, const DtVector &  parentLocation, const DtDcm &  localToBody  ) const

virtual

Is this point (world coordinates) in the sector.

virtual DtReal DtSimSector::bodyToSector ( DtReal  angle ) const

virtual

Converts an angle in body coordinates to an angle in sector coordinates.

virtual DtReal DtSimSector::sectorToBody ( DtReal  angle ) const

virtual

Converts an angle in sector coordinates to an angle in body coordinates.

virtual void DtSimSector::getSelf ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

Override, so that after read can call setSector to set up variables.

Member Data Documentation

DtRwReal DtSimSector::mySectorCenter

protected

Parameter Name: sector-center
Parameter Description: Specifies the center of the sector of responsibility relative to the entity's orientation.

Parameter Default Value: 0
Parameter Units: radians

DtRwReal DtSimSector::mySectorSize

protected

Parameter Name: sector-size
Parameter Description: Specifies the width of the sector of responsibility.

Parameter Default Value: 0
Parameter Units: radians

DtVector DtSimSector::myCenterVector

protected

DtReal DtSimSector::myBodyToSectorOffset

protected

DtReal DtSimSector::myCosineHalfSectorSize

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/simSector.h