DtOverlayPublisherHandler Class Reference

Inheritance diagram for DtOverlayPublisherHandler:

List of all members.

Signals
void	creationSignal (const DtString &name, const DtEntityMapperKey &type, const DtList &vertices, const DtString &label, int appearance, int force, bool projection, bool closedFigure, DtReal heading, bool createSubObjects, DtSymbol *tempSymbol)
	Both signals are emitted if myEmitCreateSignal is true.
void	editSignal (const DtString &name, const DtEntityMapperKey &type, const DtList &vertices, const DtString &label, int appearance, int force, DtReal heading, DtSymbol *tempSymbol)
Public Member Functions
	DtOverlayPublisherHandler ()
	Default Constructor.
virtual	~DtOverlayPublisherHandler ()
	Destructor.
virtual void	create (const DtOverlaySymbolDescriptor *desc, QString name, QString label, QColor color, QVector< DtPoint > &pnts, const DtEntityMapperKey &key, int force, int appearance, bool publish, const QString &attachTo, DtArchivableObject *userData, const DtTerrainModelData *data=NULL)
	User data is a user defined structure that can be supplied in order to send or save additional information not provided for in the existing interface.
virtual void	edit (QString name, QString label, QColor color, QVector< DtPoint > &pnts, DtModelData *data, int force, int appearance, bool publish, DtArchivableObject *userData)
virtual bool	canPublish () const
virtual bool	isPublished (const DtModelData *data) const
virtual QString	generateName (const QString &baseName, const DtOverlaySymbolDescriptor *desc=NULL) const
	Generates a name and unique key for this environmental.
virtual void	getVertices (QVector< DtPoint > &modelPoints, const DtModelData *data) const
virtual void	reparentOverlayObject (const QString &oldParent, const QString &newParent, const DtModelKey &objectKey, int iIndex)
	Use this method to change the parent of the named object from the old to the new parent.
void	setEmitCreateSignal (bool)
	Emits a signal when a create is activated rather than actually creating the object.
bool	emitCreateSignal () const
void	setObjectType (const DtEntityMapperKey &)
virtual QStringList	parents (const DtEntityMapperKey &key, bool published, QString overlayName="")
	Returns the list of parents this overlay object should be added to Also assigns the object to an overlay, if overlayName equals "" the object will be placed in active overlay, otherwise the object will be placed in the named overlay.
Static Public Member Functions
static DtEventHandler *	create (DtEventController *owner, void *usr)
	Static creator.
static QString	generateKey ()
Protected Attributes
bool	myEmitCreateSignal
DtEntityMapperKey	myCurrentObjectType
	Used when there is no model data present.
Static Protected Attributes
static int	gNumObjectsCreated
static int	gNumKeysGenerated

---

Constructor & Destructor Documentation

DtOverlayPublisherHandler::DtOverlayPublisherHandler

(

)

Default Constructor.

virtual DtOverlayPublisherHandler::~DtOverlayPublisherHandler

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void DtOverlayPublisherHandler::create	(	const DtOverlaySymbolDescriptor *	desc,
		QString	name,
		QString	label,
		QColor	color,
		QVector< DtPoint > &	pnts,
		const DtEntityMapperKey &	key,
		int	force,
		int	appearance,
		bool	publish,
		const QString &	attachTo,
		DtArchivableObject *	userData,
		const DtTerrainModelData *	data = NULL
	)		[virtual]

User data is a user defined structure that can be supplied in order to send or save additional information not provided for in the existing interface.

By default will set in the environmental model data in either create or edit mode. If in edit mode a new instance is allocated, it must be freed from the existing model data else it will leak memory. If data is not NULL, this object is created from a terrain node

virtual void DtOverlayPublisherHandler::edit	(	QString	name,
		QString	label,
		QColor	color,
		QVector< DtPoint > &	pnts,
		DtModelData *	data,
		int	force,
		int	appearance,
		bool	publish,
		DtArchivableObject *	userData
	)		[virtual]

virtual bool DtOverlayPublisherHandler::canPublish

(

)

const [virtual]

virtual bool DtOverlayPublisherHandler::isPublished

(

const DtModelData *

data

)

const [virtual]

virtual QString DtOverlayPublisherHandler::generateName	(	const QString &	baseName,
		const DtOverlaySymbolDescriptor *	desc = NULL
	)		const [virtual]

Generates a name and unique key for this environmental.

Use only for local creates

virtual void DtOverlayPublisherHandler::getVertices	(	QVector< DtPoint > &	modelPoints,
		const DtModelData *	data
	)		const [virtual]

virtual void DtOverlayPublisherHandler::reparentOverlayObject	(	const QString &	oldParent,
		const QString &	newParent,
		const DtModelKey &	objectKey,
		int	iIndex
	)		[virtual]

Use this method to change the parent of the named object from the old to the new parent.

Will then let the application know that the model data with the given name has changed

void DtOverlayPublisherHandler::setEmitCreateSignal

(

bool

b

)

[inline]

Emits a signal when a create is activated rather than actually creating the object.

By default this is false. Currently this is only supported by the overlay publisher subclass at the VRF level

References myEmitCreateSignal.

bool DtOverlayPublisherHandler::emitCreateSignal

(

)

const [inline]

References myEmitCreateSignal.

void DtOverlayPublisherHandler::setObjectType

(

const DtEntityMapperKey &

t

)

[inline]

References myCurrentObjectType.

static DtEventHandler* DtOverlayPublisherHandler::create	(	DtEventController *	owner,
		void *	usr
	)		[static]

Static creator.

static QString DtOverlayPublisherHandler::generateKey

(

)

[static]

virtual QStringList DtOverlayPublisherHandler::parents	(	const DtEntityMapperKey &	key,
		bool	published,
		QString	overlayName = ""
	)		[virtual]

Returns the list of parents this overlay object should be added to Also assigns the object to an overlay, if overlayName equals "" the object will be placed in active overlay, otherwise the object will be placed in the named overlay.

If the named overlay does not exist, it will be created. At this time the named overlay becomes the active overlay on exit.

void DtOverlayPublisherHandler::creationSignal	(	const DtString &	name,
		const DtEntityMapperKey &	type,
		const DtList &	vertices,
		const DtString &	label,
		int	appearance,
		int	force,
		bool	projection,
		bool	closedFigure,
		DtReal	heading,
		bool	createSubObjects,
		DtSymbol *	tempSymbol
	)		[signal]

Both signals are emitted if myEmitCreateSignal is true.

void DtOverlayPublisherHandler::editSignal	(	const DtString &	name,
		const DtEntityMapperKey &	type,
		const DtList &	vertices,
		const DtString &	label,
		int	appearance,
		int	force,
		DtReal	heading,
		DtSymbol *	tempSymbol
	)		[signal]

---

Member Data Documentation

int DtOverlayPublisherHandler::gNumObjectsCreated [static, protected]

int DtOverlayPublisherHandler::gNumKeysGenerated [static, protected]

bool DtOverlayPublisherHandler::myEmitCreateSignal [protected]

Referenced by emitCreateSignal(), and setEmitCreateSignal().

DtEntityMapperKey DtOverlayPublisherHandler::myCurrentObjectType [protected]

Used when there is no model data present.

Referenced by setObjectType().

---

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

• include/tmEventHandler/overlayPublisherHandler.h