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.

Inheritance diagram for DtSimSector:

[legend]

Public Member Functions
	DtSimSector ()

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

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

const DtSimSector &	operator= (const DtSimSector &orig)

virtual	~DtSimSector ()

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

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

virtual void	setSector (DtReal center, DtReal size)

virtual DtReal	sectorSize () const

virtual DtReal	sectorCenter () const

virtual const DtVector &	centerVector () const

virtual bool	inSector (DtReal angle) const

virtual bool	inSector (DtVector bodyVector) const

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

virtual DtReal	bodyToSector (DtReal angle) const

virtual DtReal	sectorToBody (DtReal angle) const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

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

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

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

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

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

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Member Functions
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtVector	myCenterVector

DtReal	myBodyToSectorOffset

DtReal	myCosineHalfSectorSize

parameters
These parameters are available for setting in the OPD files.
DtRwReal	mySectorCenter

DtRwReal	mySectorSize

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

bool	myInvalid

bool	myChangedFlag

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

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

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)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

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

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 DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

protectedvirtual

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

Reimplemented from DtReaderWriter.

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjparam/simSector.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation