DtRwSpatialFilter is an abstract base class for defining filters for sorting items into or out of a spatial region. More...

Inheritance diagram for DtRwSpatialFilter:

[legend]

Public Member Functions
	DtRwSpatialFilter ()
	default constructor
	DtRwSpatialFilter (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtRwSpatialFilter (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwSpatialFilter (const DtRwSpatialFilter &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
DtRwSpatialFilter &	operator= (const DtRwSpatialFilter &orig)
virtual DtRwSpatialFilter *	clone (DtReaderWriterRegistry *const parentRegistry=NULL) const =0
	Returns a copy of this class.
virtual	~DtRwSpatialFilter ()
virtual DtString	type () const
	Returns the string type of this filter.
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
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 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.

Static Public Member Functions
static void	setFactory (DtSpatialFilterFactory *factory)
	Sets the static factory member.
static DtRwSpatialFilter *	createSpatialFilter (const DtString &type)
	Uses the static factory assigned in setFactory to create the requested sensor filter type.
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 DtReaderWriterFactory *	factory ()

Static Protected Attributes
static DtSpatialFilterFactory *	theFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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

Detailed Description

DtRwSpatialFilter is an abstract base class for defining filters for sorting items into or out of a spatial region.

Derivatives of this class define RW variables used to define an area with respect to a sensor position and orientation.

This class does not do any evaluation. A separate hierarchy, derived from DtSpatialFilterEvaluator handles the evaluation of spatial filters.

For concrete implementations of this class and examples of how to specify them in the OPE files, see DtRwRangeSpatialFilter, DtRwFrustumSpatialFilter, DtRwNotSpatialFilter, DtRwAndSpatialFilter, DtRwOrSpatialFilter.

Custom spatial filters can be created and added to the system though the DtSpatialFilterFactory.

Constructor & Destructor Documentation

DtRwSpatialFilter::DtRwSpatialFilter ( )

default constructor

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

real constructor

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

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

copy constructor

virtual DtRwSpatialFilter::~DtRwSpatialFilter ( )

virtual

Member Function Documentation

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

virtual DtRwSpatialFilter* DtRwSpatialFilter::clone ( DtReaderWriterRegistry *const parentRegistry = NULL ) const

pure virtual

Returns a copy of this class.

Implemented in DtRwOrSpatialFilter, DtRwAndSpatialFilter, DtRwFrustumSpatialFilter, DtRwNotSpatialFilter, DtRwRangeSpatialFilter, and DtRwSpatialFilterContainer.

virtual DtString DtRwSpatialFilter::type ( ) const

virtual

Returns the string type of this filter.

Types listed in spatialFilterTypes.h. Since we store the type as the RW name for these objects, the default implementation just returns the RW name.

static void DtRwSpatialFilter::setFactory ( DtSpatialFilterFactory * factory )

static

Sets the static factory member.

static DtRwSpatialFilter* DtRwSpatialFilter::createSpatialFilter ( const DtString & type )

static

Uses the static factory assigned in setFactory to create the requested sensor filter type.

Member Data Documentation

DtSpatialFilterFactory* DtRwSpatialFilter::theFactory

staticprotected

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

include/vrfutil/rwSpatialFilter.h

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation