DtOverlaySymbolMapper Class Reference

Inheritance diagram for DtOverlaySymbolMapper:

Signals
void	overlayDescriptorAdded (DtOverlaySymbolDescriptor *)
	Emitted when a descriptor is added via the addOverlayObject call.

Public Member Functions
	DtOverlaySymbolMapper ()
	DtOverlaySymbolMapper (DtBaseSymbolMapper *)
virtual	~DtOverlaySymbolMapper ()
virtual DtSymbol *	createSymbol (const DtModelData &d)
	createSymbol() this will invoke createSymbol(context) then add the model data points to the symbol that is returned from createSymbol(context) then it will return the symbol
virtual void	setColor (int currColor)
virtual void	setWidth (int currWidth)
virtual int	width ()
virtual bool	init ()
	Initialize system to add creator functions.
virtual void	addControlObjectCreator (int kind, DtControlObjectCreatorFcn fcn)
	Adds or replaces a creator used for control objects.
virtual QPixmap	getIcon (const DtModelData *d)
	Will return appropriate icon for supplied model.
virtual DtCompositeSymbol *	createPointSymbol (const DtEntityMapperKey &type, int force, DtSymbolCreatorFcn fcn=DtPointObjectSymbol::create)
virtual DtCompositeSymbol *	createLineObjectSymbol (const DtEntityMapperKey &type, int force, DtSymbolCreatorFcn fcn=DtLineObjectSymbol::create)
virtual DtCompositeSymbol *	createAreaObjectSymbol (const DtEntityMapperKey &type, int force, DtSymbolCreatorFcn fcn=DtAreaObjectSymbol::create)
virtual DtCompositeSymbol *	createCircleSymbol (const DtEntityMapperKey &type, int force, DtSymbolCreatorFcn fcn=DtCircleObjectSymbol::create)
virtual DtEnvironmentalModelData *	createObject (const QString &object, QVector< DtPoint > &points, const QString &name=QString::null)
	If a symbol descriptor has the given name, then, create an object based on that mapper key.
virtual DtOverlaySymbolDescriptor *	addOverlayObject (const DtEntityMapperKey &, const QString &tab, const QString &symbolName, const QString &iconFileName, const QString &minimumDataPoints, DtSymbolDescriptor *symbolType, bool addToMenu=true)
	This routine will add a new overlay symbol (and associated symbol) descriptor to the internal mappings.
const QList < DtOverlaySymbolDescriptor * > &	additionalMenuItems () const
virtual bool	creationKeyFor (const QString &name, DtEntityMapperKey &retKey) const
	Given an object name, fills in the retKey with the entity mapper key used to create the object.
Public Member Functions inherited from DtSymbolMapper
	DtSymbolMapper ()
	DtSymbolMapper (DtBaseSymbolMapper *)
virtual	~DtSymbolMapper ()
virtual DtSymbol *	processCreateSymbol (const DtTerrainModelData &data, void *usr)
	Creators.
Public Member Functions inherited from DtBaseSymbolMapper
	DtBaseSymbolMapper ()
	DtBaseSymbolMapper (DtBaseSymbolMapper *)
	Calls chainSymbolMapper to add this symbol mapper into a chain to call down to create a symbol if this mapper does not create it.
virtual	~DtBaseSymbolMapper ()
virtual void	setDrawerColl (DtDrawerColl *dc)
virtual DtDrawerColl *	drawerColl () const
virtual bool	load (const char *filename, bool replace=false)
	Loads a file, or multiple files if the file buffer has file separated by a ; (semi-colon).
virtual bool	save (const char *filename)
	Writes out contents to specified file.
virtual bool	addSymbolToList (DtDescriptor *sd, bool replace=false)
virtual bool	addSymbolToList (DtSymbolDescriptor *sd, bool replace=false)
virtual DtSymbolDescriptor *	getStringKeyedSymbolDesc (const QString &key) const
	Uses straight string key rather than an entity identifier.
virtual void	addStringKeyedSymbolToList (DtSymbolDescriptor *desc)
virtual void	getSymbolDescriptors (DtSDList *list) const
	Fills the list will all the symbol descriptors in the entity keyed and string keyed lists.
virtual DtSymbolDescriptor *	fullLookup (const QString &key) const
	Returns a descriptor by looking in both trees.
virtual DtSymbolDrawer *	lookupDrawer (const DtDrawerKey &key, DtSymbolDescriptor *symDesc)
virtual DtSymbolDrawer *	lookupDrawer (DtSymbolDescriptor *symDesc)
virtual DtTTSDrawer &	labelDrawer ()
virtual QColor	labelColor () const
virtual void	removeEntries (const DtBaseSymbolMapper &mapper)
	Removes symbols from entity list found in supplied mapper.
virtual void	removeAllEntries (const DtSDList &mapper)
virtual void	removeEntry (DtSymbolDescriptor *sd)
	Removes entry from all lists without deleting. To free memory, free descriptor.
virtual const DtSDList &	entities () const
virtual int	defaultTransparencyFor (const DtEntityMapperKey &key) const
virtual void	postLoadCleanup ()
	Does any post load cleanup of a new symbol map file.
virtual void	setIconSize (const QSize size)
virtual QSize	iconSize () const
virtual QPixmap	finalizeSymbolPixmap (const DtSymbol *) const
const QString &	filename () const
virtual void	clear ()
virtual void	addSymbolCreateCallback (int type, DtSymbolCreatorCallback fcn, void *usr=NULL)
	Accessors to add/remove callbacks for model data types.
virtual void	removeSymbolCreateCallback (int type)
virtual DtSymbolDescriptor *	getSymbolDesc (const DtEntityMapperKey &key) const
virtual DtSymbolDescriptor *	getSymbolDesc (const DtModelData &data) const
virtual DtCompositeSymbol *	createSymbolOfType (const DtEntityMapperKey &type, int force, DtSymbolCreatorFcn fcn)
virtual void	addPostCreateCallback (int iType, DtPostSymbolCreateCallbackFcn fcn, void *usr)
	Adds a callback to be invoked any time a symbol is created.
virtual void	removePostCreateCallback (int iType, DtPostSymbolCreateCallbackFcn fcn, void *usr)
	Removes the post create callback if all three items match.
virtual void	removeAllPostCreateCallbacks ()
	Removes all post update callbacks.
virtual DtSymbol *	createMainSymbol (const DtEntityMapperKey &emk, int force)
	Given the information, creates what would be the main symbol of the particular type.
virtual DtMapReader *	createReader (QString extension)
virtual QColor	defaultColorFor (const DtEntityMapperKey &key) const
	Returns default color based on type of object.
virtual QColor	defaultColorFor (const DtModelData &data) const
virtual DtTTSSymbol *	createLabelSymbol ()
virtual void	setMediaMapper (DtBaseMapper *map)
virtual void	addColor (const DtEntityMapperKey &, const QColor &)
	Adds default colors for object types.
virtual void	addNameLabel (DtNameLabelSymbol *symbol)
virtual void	addLabelLabel (DtNameLabelSymbol *symbol)
virtual void	chainSymbolMapper (DtBaseSymbolMapper *)
virtual void	clearCache ()
virtual void	setDeleteChainedMappers (bool)
	If true, delete chained symbol mappers when destroying this object. Default is false.
virtual bool	deleteChainedMappers () const
virtual void	setCacheSymbolOptions (int)
	Sets the options for how to signal to cache text objects as bitmap.
int	cacheSymbolOptions () const
virtual DtSymbol *	createSymbolFromDescription (DtSymbolDescriptor *symDesc, const DtEntityMapperKey &key)
Public Member Functions inherited from DtBaseMapper
	DtBaseMapper ()
virtual	~DtBaseMapper ()
Public Member Functions inherited from DtArchivableObject
	DtArchivableObject (QString name, DtArchivableObjectCreator fcn)
	This constructor will add this object to the archivable object factory.
	DtArchivableObject (QString name)
	DtArchivableObject ()
virtual	~DtArchivableObject ()
virtual QString	name () const
DtArchiver *	archiver ()
	Returns the archiver of this object.
virtual void	read (QTextStream &s)
	Reads/writes archiver.
virtual void	write (QTextStream &s)
virtual void	setLevel (int i)
virtual int	level () const
virtual DtArchivableObject *	clone ()
	Allows for cloning of this object.

Static Public Member Functions
static DtSymbol *	processCreateCircleSymbol (DtOverlaySymbolMapper *mapper, const DtEntityMapperKey &type, int force)
static DtSymbol *	processCreatePointSymbol (DtOverlaySymbolMapper *mapper, const DtEntityMapperKey &type, int force)
static DtSymbol *	processCreateLineSymbol (DtOverlaySymbolMapper *mapper, const DtEntityMapperKey &type, int force)
static DtSymbol *	processCreateAreaSymbol (DtOverlaySymbolMapper *mapper, const DtEntityMapperKey &type, int force)
static DtSymbol *	createNewSymbol (const DtBaseSymbolMapper *mapper, const DtModelData &data, void *usr)
static DtBaseSymbolMapper *	create ()
	Returns a newly created instance of a DtBaseSymbolMapper.
Static Public Member Functions inherited from DtSymbolMapper
static DtSymbol *	createSymbol (const DtBaseSymbolMapper *mapper, const DtModelData &data, void *usr)
	Static creators call creators in base symbol mapper for easier override.
Static Public Member Functions inherited from DtBaseSymbolMapper
static void	addReader (QString extension, DtMapReaderCreatorFcn fcn)
	Static functions to add instances of map readers.
static void	cleanupReaders ()
	Call to cleanup memory owned by myMapReaders member.

Protected Member Functions
virtual DtSymbol *	processCreateSymbol (const DtEnvironmentalModelData &data, void *usr)
virtual DtSymbol *	processCreateSymbol (const DtCompassModelData &data, void *usr)
virtual DtSymbol *	getControlObjectSymbol (const DtEntityMapperKey &type, int force, const DtEnvironmentalModelData &data)
virtual void	modifySymbol (DtSymbol *symbol, DtSymbolDescriptor *symDesc, int force, const DtEntityMapperKey &emk)
	Called after symbol is created, used to apply additional modifications to symbol.
virtual void	addLayerLabel (DtNameLabelSymbol *symbol)
virtual void	formatLabels (DtNameLabelSymbol *symbol, const DtEntityMapperKey &type)
virtual void	formatColor (DtNameLabelSymbol *color, const DtEnvironmentalModelData &type)
virtual DtCompositeSymbol *	createOverlaySymbol (const DtEntityMapperKey &type, int force, DtSymbolCreatorFcn fcn)
Protected Member Functions inherited from DtSymbolMapper
virtual DtSymbol *	createTerrainNodeSymbol (const DtTerrainModelData &data, void *usr)
virtual DtSymbol *	createTerrainEdgeSymbol (const DtTerrainModelData &data, void *usr)
Protected Member Functions inherited from DtBaseSymbolMapper
virtual void	removeEntry (DtSymbolDescriptor *sd, DtSDList &list)
virtual void	invokePostCreateCallbacks (DtSymbol *, const DtModelData &)
virtual bool	addEntry (DtSymbolDescriptor *sd, DtSDList &list, bool replace)

Protected Attributes
unsigned char	myCurrentColor
int	myCurrentWidth
DtMultiLineDrawer	myMultiLineDrawer
DtPolygonDrawer	myPolygonDrawer
QHash< int, DtControlObjectCreatorInfo >	myControlObjectCreators
QList < DtOverlaySymbolDescriptor * >	myAdditionalMenuItems

Private Member Functions
	DtOverlaySymbolMapper (const DtOverlaySymbolMapper &orig)
DtOverlaySymbolMapper &	operator= (const DtOverlaySymbolMapper orig)

Additional Inherited Members
Public Slots inherited from DtBaseSymbolMapper
virtual void	setLabelColor (const QColor &color)
virtual void	setUsingAnimation (bool b)
virtual void	removeChainedMapper (QObject *)
Static Protected Attributes inherited from DtBaseSymbolMapper
static DtMapReaders *	myMapReaders
static const QSize	theDefaultIconSize

Constructor & Destructor Documentation

DtOverlaySymbolMapper::DtOverlaySymbolMapper

(

)

DtOverlaySymbolMapper::DtOverlaySymbolMapper

(

DtBaseSymbolMapper *

)

virtual DtOverlaySymbolMapper::~DtOverlaySymbolMapper ( )

virtual

DtOverlaySymbolMapper::DtOverlaySymbolMapper ( const DtOverlaySymbolMapper &  orig )

private

Member Function Documentation

virtual DtSymbol* DtOverlaySymbolMapper::createSymbol ( const DtModelData &  d )

virtual

createSymbol() this will invoke createSymbol(context) then add the model data points to the symbol that is returned from createSymbol(context) then it will return the symbol

Reimplemented from DtBaseSymbolMapper.

virtual void DtOverlaySymbolMapper::setColor ( int  currColor )

virtual

virtual void DtOverlaySymbolMapper::setWidth ( int  currWidth )

virtual

virtual int DtOverlaySymbolMapper::width ( )

virtual

virtual bool DtOverlaySymbolMapper::init ( )

virtual

Initialize system to add creator functions.

Reimplemented from DtSymbolMapper.

virtual void DtOverlaySymbolMapper::addControlObjectCreator ( int  kind, DtControlObjectCreatorFcn  fcn  )

virtual

Adds or replaces a creator used for control objects.

virtual QPixmap DtOverlaySymbolMapper::getIcon ( const DtModelData *  d )

virtual

Will return appropriate icon for supplied model.

Reimplemented from DtBaseSymbolMapper.

virtual DtCompositeSymbol* DtOverlaySymbolMapper::createPointSymbol ( const DtEntityMapperKey &  type, int  force, DtSymbolCreatorFcn  fcn = DtPointObjectSymbol::create  )

virtual

virtual DtCompositeSymbol* DtOverlaySymbolMapper::createLineObjectSymbol ( const DtEntityMapperKey &  type, int  force, DtSymbolCreatorFcn  fcn = DtLineObjectSymbol::create  )

virtual

virtual DtCompositeSymbol* DtOverlaySymbolMapper::createAreaObjectSymbol ( const DtEntityMapperKey &  type, int  force, DtSymbolCreatorFcn  fcn = DtAreaObjectSymbol::create  )

virtual

virtual DtCompositeSymbol* DtOverlaySymbolMapper::createCircleSymbol ( const DtEntityMapperKey &  type, int  force, DtSymbolCreatorFcn  fcn = DtCircleObjectSymbol::create  )

virtual

static DtSymbol* DtOverlaySymbolMapper::processCreateCircleSymbol ( DtOverlaySymbolMapper *  mapper, const DtEntityMapperKey &  type, int  force  )

static

static DtSymbol* DtOverlaySymbolMapper::processCreatePointSymbol ( DtOverlaySymbolMapper *  mapper, const DtEntityMapperKey &  type, int  force  )

static

static DtSymbol* DtOverlaySymbolMapper::processCreateLineSymbol ( DtOverlaySymbolMapper *  mapper, const DtEntityMapperKey &  type, int  force  )

static

static DtSymbol* DtOverlaySymbolMapper::processCreateAreaSymbol ( DtOverlaySymbolMapper *  mapper, const DtEntityMapperKey &  type, int  force  )

static

static DtSymbol* DtOverlaySymbolMapper::createNewSymbol ( const DtBaseSymbolMapper *  mapper, const DtModelData &  data, void *  usr  )

static

static DtBaseSymbolMapper* DtOverlaySymbolMapper::create ( )

static

Returns a newly created instance of a DtBaseSymbolMapper.

Reimplemented from DtSymbolMapper.

virtual DtEnvironmentalModelData* DtOverlaySymbolMapper::createObject ( const QString &  object, QVector< DtPoint > &  points, const QString &  name = QString::null  )

virtual

If a symbol descriptor has the given name, then, create an object based on that mapper key.

Checks both entity and interaction lists

Reimplemented from DtBaseSymbolMapper.

virtual DtOverlaySymbolDescriptor* DtOverlaySymbolMapper::addOverlayObject ( const DtEntityMapperKey &  , const QString &  tab, const QString &  symbolName, const QString &  iconFileName, const QString &  minimumDataPoints, DtSymbolDescriptor *  symbolType, bool  addToMenu = true  )

virtual

This routine will add a new overlay symbol (and associated symbol) descriptor to the internal mappings.

The new item will be added to the menu system and the overlay palette. What will be returned is the new DtOverlaySymbolDescriptor and associated specific object descriptor: bmp - A bitmap image symbol (DtBmpSymbolDescriptor) ttf - A true type font image symbol (DtMMMSymbolDescriptor) uttf - A military standard font image symbol (DtUnicodeTTFSymbolDescriptor) box - A box symbol (DtBoxSymbolDescriptor) crc - A circle symbol (DtCircleSymbolDescriptor) tts - A resizable font image symbol. Used only for text blobs (DtTtsSymbolDescriptor) ply - A polygon symbol that can have textures and patterns applied to it (DtPolygonSymbolDescriptor)

You need to allocate one of the items above, filling in the correct information for the descriptor, and pass it into this method.

The DtOverlaySymbolDescriptor has an accessor symbolDescriptor() that will return an instance of the specific symbol you passed in.

Note that the iconFileName is the image to use in the menu when creating the item.

If addToMenu is true, emits the overlayDescriptorAdded message to add the item to the create menu and overlay palette. It will also add the descriptor to the myAdditionalMenuItems member variable which will be used if the overlay palette is created after the overlay object is added to allow it to pick up the new menu item

Note that the descriptor that is added will now be owned by this class. Do not delete the memory that has been passed into this method

const QList< DtOverlaySymbolDescriptor * > & DtOverlaySymbolMapper::additionalMenuItems ( ) const

inline

References myAdditionalMenuItems.

virtual bool DtOverlaySymbolMapper::creationKeyFor ( const QString &  name, DtEntityMapperKey &  retKey  ) const

virtual

Given an object name, fills in the retKey with the entity mapper key used to create the object.

If the object does not exist, returns false

virtual DtSymbol* DtOverlaySymbolMapper::processCreateSymbol ( const DtEnvironmentalModelData &  data, void *  usr  )

protectedvirtual

virtual DtSymbol* DtOverlaySymbolMapper::processCreateSymbol ( const DtCompassModelData &  data, void *  usr  )

protectedvirtual

virtual DtSymbol* DtOverlaySymbolMapper::getControlObjectSymbol ( const DtEntityMapperKey &  type, int  force, const DtEnvironmentalModelData &  data  )

protectedvirtual

virtual void DtOverlaySymbolMapper::modifySymbol ( DtSymbol *  symbol, DtSymbolDescriptor *  symDesc, int  force, const DtEntityMapperKey &  emk  )

protectedvirtual

Called after symbol is created, used to apply additional modifications to symbol.

Reimplemented from DtSymbolMapper.

virtual void DtOverlaySymbolMapper::addLayerLabel ( DtNameLabelSymbol *  symbol )

protectedvirtual

virtual void DtOverlaySymbolMapper::formatLabels ( DtNameLabelSymbol *  symbol, const DtEntityMapperKey &  type  )

protectedvirtual

virtual void DtOverlaySymbolMapper::formatColor ( DtNameLabelSymbol *  color, const DtEnvironmentalModelData &  type  )

protectedvirtual

virtual DtCompositeSymbol* DtOverlaySymbolMapper::createOverlaySymbol ( const DtEntityMapperKey &  type, int  force, DtSymbolCreatorFcn  fcn  )

protectedvirtual

void DtOverlaySymbolMapper::overlayDescriptorAdded ( DtOverlaySymbolDescriptor *  )

signal

Emitted when a descriptor is added via the addOverlayObject call.

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

private

Member Data Documentation

unsigned char DtOverlaySymbolMapper::myCurrentColor

protected

int DtOverlaySymbolMapper::myCurrentWidth

protected

DtMultiLineDrawer DtOverlaySymbolMapper::myMultiLineDrawer

protected

DtPolygonDrawer DtOverlaySymbolMapper::myPolygonDrawer

protected

QHash<int, DtControlObjectCreatorInfo> DtOverlaySymbolMapper::myControlObjectCreators

protected

QList<DtOverlaySymbolDescriptor*> DtOverlaySymbolMapper::myAdditionalMenuItems

protected

Referenced by additionalMenuItems().

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/symbolMapper/overlaySymbolMapper.h