DtAggregateSymbolFilter Class Reference

A filter that hides/shows or modifies symbols based on their position and status within a echelon hierarchy and hierarchy view. More...

Inheritance diagram for DtAggregateSymbolFilter:

Public Member Functions
	DtAggregateSymbolFilter (const char *name=0, DtLensArea *parent=0)
	constructor, parent must be a Lens area
virtual	~DtAggregateSymbolFilter ()
	destructor
virtual void	setMapArea (DtTMArea *)
	Set the map area for this filter.
virtual void	setEchelonView (const DtEchelonView *view)
	Set the force type of the filter.
virtual const DtEchelonView *	echelonView () const
virtual void	setEmbarkationView (const DtEchelonView *view)
virtual const DtEchelonView *	embarkationView () const
virtual void	initSelectionManagement ()
	Connects up the selection management features of this filter which will maintain that selection of aggregates and their components changes as they are expanded and collapsed.
virtual bool	modifyConditional (DtSymbol *newSymbol)
	Override this function to modify new symbols.
virtual bool	checkConditional (DtSymbol *newSymbol)
	Checks if this symbol will be modified without actually modifying the symbol.
virtual DtTMArea *	area ()
	Returns the area associated with this filter.
virtual bool	addToToolbar () const
Public Member Functions inherited from DtReorderingSymbolFilterLens
	DtReorderingSymbolFilterLens (const char *name=0, DtLensArea *parent=0)
	constructor, parent must be a Lens area
virtual	~DtReorderingSymbolFilterLens ()
	destructor
virtual void	grabRelevantData (DtSymbolList *original, DtSymbolList *modified, QPixmap *background=0, bool isGlobal=false)
	Overridden to call reorderLists() before returning.
virtual void	setNumberOfLayers (int numLayers)
	Sets the number of layers.
virtual int	numberOfLayers () const
virtual void	setDefaultLayer (int index)
	Sets/Gets the index of the layer into which all unmodified symbols will be put.
virtual int	defaultLayer () const
virtual void	reorderLayers (DtSymbolList *list)
	This will reorder the layers into an internally kept list.
virtual bool	updateLayers () const
Public Member Functions inherited from DtSymbolFilterLens
	DtSymbolFilterLens (const char *name=0, DtLensArea *parent=0)
	constructor, parent must be a Lens area
virtual	~DtSymbolFilterLens ()
	destructor
virtual void	filterOriginals (DtSymbolList *symbolList)
	This function filter through all the symbols on the list and modifies them as if they were a part of the filter.
virtual DtSymbol *	modifySymbol (DtSymbol *orig, bool createClone=false)
	This either modifies the current symbol, or creates a copy of the symbol and modifies the copy (if the createClone bit is set)
Public Member Functions inherited from DtFilterLens
	DtFilterLens (const char *name=0, DtLensArea *parent=0)
	constructor, parent must be a Lens area
virtual	~DtFilterLens ()
	destructor

Protected Slots
virtual void	hierarchyNodeExpanded (const DtModelKey &key, QVector< DtModelKey > *remove=NULL, QVector< DtModelKey > *add=NULL)
virtual void	hierarchyNodeCollapsed (const DtModelKey &key, QVector< DtModelKey > *remove=NULL, QVector< DtModelKey > *add=NULL)
virtual void	echelonViewDestroyed ()

Protected Member Functions
virtual bool	applySymbolModifications (DtSymbol *symbol, const DtModelKey &key)
	This is called by modifyConditional if the symbol is in the echelon hierarchy.
virtual bool	applyNonHierarchyModifications (DtSymbol *symbol, const DtModelKey &key)
	This routine will be called when a non-hierarchy symbol is discovered.
virtual void	applyGhosting (DtSymbol *symbol)
	This is called by applySymbolModifications() if the symbol needs to be ghosted.
virtual void	removeGhosting (DtSymbol *symbol)
virtual bool	isDisplayRoot (const DtModelKey &key)
	Returns true if this model should be displayed as a root symbol.
virtual bool	isDisplayComponent (const DtModelKey &key)
	Returns true if this model should be displayed as a component symbol of another symbol.
virtual void	addHiddenSymbol (DtSymbol *symb)
virtual void	showHiddenSymbol (DtSymbol *symb)
virtual bool	isEmbarkedItem (const DtModelKey &) const
	Returns true if this item is embarked on another object and then calls applyEmbarkationModifications.
virtual void	applyEmbarkationModifications (DtSymbol *, const DtModelKey &)
	Currently no-ops.
virtual void	displayRootsDecendedFrom (const DtModelKey &key, QVector< DtModelKey > &resultList)
	Recursivly builds a list of all node keys which are decendet of key and pass the isDisplayRoot test.
Protected Member Functions inherited from DtReorderingSymbolFilterLens
virtual void	resetLayers ()
	Clears out the layer lists, and sets the correct number of layer lists.
virtual void	reorderLists (DtSymbolList *origianlList, DtSymbolList *modifiedList)
	Reorders the objects in these lists based on the layer lists.
virtual void	addSymbolToLayer (DtSymbol *sym, int layer)
	Adds the given symbol to the specified layer.
virtual bool	createClone () const
	Do not create clone but rather work with original symbol for performance gains.
virtual bool	deleteModifiedList ()
	Return true if you want to know when the modified list should be deleted.
virtual void	modifiedListAboutToBeFreed (DtSymbolList *sl)
	Override to handle modified list being deleted and having autoDelete turned on (which means that all symbols internally will be deleted as well).

Protected Attributes
const DtEchelonView *	myEchelonView
const DtEchelonView *	myEmbarkationView
DtTMArea *	myArea
DtTMMapArea *	myMapArea
Protected Attributes inherited from DtReorderingSymbolFilterLens
int	myNumberOfLayers
int	myDefaultLayerIndex
DtPtrQList< DtSymbolList * >	myLayerList
	List of lists of symbols.
DtSymbolList *	myOrderedList
bool	myUpdateLayers
Protected Attributes inherited from DtSymbolFilterLens
DtSymbolList	myModifiedSymbolList
	This is a list of protected symbols.

Additional Inherited Members
Public Slots inherited from DtReorderingSymbolFilterLens
virtual void	setUpdateLayers (bool b=true)
	Set to true if there needs to be an internal update of the layers.
virtual void	reorderSymbolDestroyed (QObject *)

Detailed Description

A filter that hides/shows or modifies symbols based on their position and status within a echelon hierarchy and hierarchy view.

Constructor & Destructor Documentation

DtAggregateSymbolFilter::DtAggregateSymbolFilter	(	const char *	name = 0,
		DtLensArea *	parent = 0
	)

constructor, parent must be a Lens area

virtual DtAggregateSymbolFilter::~DtAggregateSymbolFilter ( )

virtual

destructor

Member Function Documentation

virtual void DtAggregateSymbolFilter::setMapArea ( DtTMArea *  )

virtual

Set the map area for this filter.

THIS IS REQUIRED for the filter to work If this is a DtTMMapArea, this filter will also manage selection of aggregates/components as they are expanded and collapsed.

virtual void DtAggregateSymbolFilter::setEchelonView ( const DtEchelonView *  view )

virtual

Set the force type of the filter.

virtual const DtEchelonView* DtAggregateSymbolFilter::echelonView ( ) const

virtual

virtual void DtAggregateSymbolFilter::setEmbarkationView ( const DtEchelonView *  view )

virtual

virtual const DtEchelonView* DtAggregateSymbolFilter::embarkationView ( ) const

virtual

virtual void DtAggregateSymbolFilter::initSelectionManagement ( )

virtual

Connects up the selection management features of this filter which will maintain that selection of aggregates and their components changes as they are expanded and collapsed.

You must have set the map area to a DtTMMapArea, and set the echelon view for this to work.

virtual bool DtAggregateSymbolFilter::modifyConditional ( DtSymbol *  newSymbol )

virtual

Override this function to modify new symbols.

Reimplemented from DtSymbolFilterLens.

Reimplemented in DtFormationSymbolFilter.

virtual bool DtAggregateSymbolFilter::checkConditional ( DtSymbol *  newSymbol )

virtual

Checks if this symbol will be modified without actually modifying the symbol.

Reimplemented from DtSymbolFilterLens.

virtual DtTMArea* DtAggregateSymbolFilter::area ( )

virtual

Returns the area associated with this filter.

virtual bool DtAggregateSymbolFilter::addToToolbar ( ) const

virtual

virtual bool DtAggregateSymbolFilter::applySymbolModifications ( DtSymbol *  symbol, const DtModelKey &  key  )

protectedvirtual

This is called by modifyConditional if the symbol is in the echelon hierarchy.

This function applies any modifications to the symbol necessary. (show/hide/ghost) Returns true if any modifications were made.

virtual bool DtAggregateSymbolFilter::applyNonHierarchyModifications ( DtSymbol *  symbol, const DtModelKey &  key  )

protectedvirtual

This routine will be called when a non-hierarchy symbol is discovered.

This, in combination with applySymbolModifications, will cover all symbols on the map. By default this function does nothing

virtual void DtAggregateSymbolFilter::applyGhosting ( DtSymbol *  symbol )

protectedvirtual

This is called by applySymbolModifications() if the symbol needs to be ghosted.

This function applies the ghosting changes. The default implementation provides a dithered effect only if the symbol is a DtMMMSymbol. All other symbol types are shown without any effects. Override to apply your own ghosting techniques.

virtual void DtAggregateSymbolFilter::removeGhosting ( DtSymbol *  symbol )

protectedvirtual

virtual bool DtAggregateSymbolFilter::isDisplayRoot ( const DtModelKey &  key )

protectedvirtual

Returns true if this model should be displayed as a root symbol.

(i.e. displayed as a standard, selectable symbol).

virtual bool DtAggregateSymbolFilter::isDisplayComponent ( const DtModelKey &  key )

protectedvirtual

Returns true if this model should be displayed as a component symbol of another symbol.

(i.e. a possibly ghosted, non-selectable symbol) for either the echelon or embarkation view

virtual void DtAggregateSymbolFilter::addHiddenSymbol ( DtSymbol *  symb )

protectedvirtual

virtual void DtAggregateSymbolFilter::showHiddenSymbol ( DtSymbol *  symb )

protectedvirtual

virtual bool DtAggregateSymbolFilter::isEmbarkedItem ( const DtModelKey &  ) const

protectedvirtual

Returns true if this item is embarked on another object and then calls applyEmbarkationModifications.

virtual void DtAggregateSymbolFilter::applyEmbarkationModifications ( DtSymbol *  , const DtModelKey &    )

protectedvirtual

Currently no-ops.

virtual void DtAggregateSymbolFilter::hierarchyNodeExpanded ( const DtModelKey &  key, QVector< DtModelKey > *  remove = NULL, QVector< DtModelKey > *  add = NULL  )

protectedvirtualslot

virtual void DtAggregateSymbolFilter::hierarchyNodeCollapsed ( const DtModelKey &  key, QVector< DtModelKey > *  remove = NULL, QVector< DtModelKey > *  add = NULL  )

protectedvirtualslot

virtual void DtAggregateSymbolFilter::echelonViewDestroyed ( )

protectedvirtualslot

virtual void DtAggregateSymbolFilter::displayRootsDecendedFrom ( const DtModelKey &  key, QVector< DtModelKey > &  resultList  )

protectedvirtual

Recursivly builds a list of all node keys which are decendet of key and pass the isDisplayRoot test.

Member Data Documentation

const DtEchelonView* DtAggregateSymbolFilter::myEchelonView

protected

const DtEchelonView* DtAggregateSymbolFilter::myEmbarkationView

protected

DtTMArea* DtAggregateSymbolFilter::myArea

protected

DtTMMapArea* DtAggregateSymbolFilter::myMapArea

protected

---

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

• include/entityEditorImpl/aggSymbolFilter.h