VR-Forces 4.1.1 Class Documentation
List of all members | Signals | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes
DtOverlayPublisherHandler Class Reference
Inheritance diagram for DtOverlayPublisherHandler:
Inheritance graph
[legend]

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)
- Signals inherited from DtEventHandler
void closedDialog ()

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.
- Public Member Functions inherited from DtEventHandler
 DtEventHandler ()
 Default Constructor.
virtual ~DtEventHandler ()
 Destructor.
virtual void setEventController (DtEventController *)
virtual void setInitialSelection (const QVector< DtModelKey > &d)
virtual void showDialog (bool b)
virtual QWidgetcreateDialog (QWidget *w)
 Creates the dialog associated with this handler (if there is one)
virtual QWidgetdialog (bool createIfMissing=true, QWidget *parent=NULL)
 If createIfMissing is true, will create the dialog based on the supplied parent window, else will simply return the dialog pointer.
virtual void reset ()
virtual DtBaseWindowbaseWindow () const
 Returns the base window of the event controller.
virtual void activate ()
 Called when this event handler first becomes active.
virtual void deactivate ()
 Called when this event handler is removed as the current event.
virtual void setBaseWindow (DtBaseWindow *w)
 Called when the base window is set for the event controller.
virtual void init ()
 Called when the handler is first created, initialize context.
void setSuspended (bool)
 Set when something wants to suspend some aspect of this handler without deactivating it.
bool suspended () const
virtual void dialogDestroyedEvent ()
 Called when dialog is destroyed.
- 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
DtArchiverarchiver ()
 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 DtArchivableObjectclone ()
 Allows for cloning of this object.

Static Public Member Functions

static DtEventHandlercreate (DtEventController *owner, void *usr)
 Static creator.
static QString generateKey ()

Protected Attributes

bool myEmitCreateSignal
DtEntityMapperKey myCurrentObjectType
 Used when there is no model data present.
- Protected Attributes inherited from DtEventHandler
QWidgetmyEventDlg
DtEventControllermyEventController
bool mySuspended
- Protected Attributes inherited from DtArchivableObject
DtArchivermyArchiver

Static Protected Attributes

static int gNumObjectsCreated
static int gNumKeysGenerated

Additional Inherited Members

- Public Slots inherited from DtEventHandler
virtual bool mouseEvent (DtTMMapArea *, QMouseEvent *evnt, const DtPoint &pnt)
virtual bool keyboardEvent (DtTMMapArea *, QKeyEvent *evnt)
virtual bool symbolsSelected (DtTMMapArea *area, DtSymbolList *sl)
virtual bool selectionUpdated (DtTMMapArea *area, const QVector< DtModelKey > &d)
virtual bool selectionInProgress (DtTMMapArea *area, DtSymbolSelector &d)
virtual bool focusEvent (DtTMMapArea *, QEvent *evnt)
virtual bool enterEvent (DtTMMapArea *area, QEvent *evnt)
virtual bool leaveEvent (DtTMMapArea *area, QEvent *evnt)
virtual bool dropEvent (DtTMMapArea *area, QDropEvent *evnt)
virtual bool dragEnterEvent (DtTMMapArea *area, QDragEnterEvent *evnt)
virtual bool dragMoveEvent (DtTMMapArea *area, QDragMoveEvent *evnt)
virtual bool dragLeaveEvent (DtTMMapArea *area, QDragLeaveEvent *evnt)
virtual bool userDefinedAction (DtUserDefinedType iAction, void *usr)
virtual bool aboutToDraw (DtTMMapArea *area, QPainter *)
virtual bool mapActivated (DtTMMapArea *area)
virtual bool selectedModelDataUpdated (DtTMMapArea *area)
virtual bool symbolAdded (DtTMMapArea *area, const DtModelKey &)
virtual bool symbolRemoved (DtTMMapArea *area, const DtModelKey &)
virtual bool disconnecting (DtTMMapArea *area)
 Called when a map is being disconnect from an event handler.
virtual bool connecting (DtTMMapArea *area)
 Called when a map is being connected to an event handler.
virtual void tick ()
virtual void clearDialog ()

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
staticprotected
int DtOverlayPublisherHandler::gNumKeysGenerated
staticprotected
bool DtOverlayPublisherHandler::myEmitCreateSignal
protected
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:

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)