VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Protected Member Functions
exampleRangeLine::DtRangeLineDriver Class Reference

This driver will manage the creation, modification and removal of range line objects. More...

Inheritance diagram for exampleRangeLine::DtRangeLineDriver:
Inheritance graph
[legend]

Public Member Functions

 DtRangeLineDriver (makVrv::DtDe &)
 CTOR.
virtual ~DtRangeLineDriver ()
 DTOR.
virtual DtRangeLineElementcreate (const DtVector &start, const DtVector &end)
 Create and return a new range line with the given start and end points.
virtual void create (const AttachPoints &ap=AttachPoints())
 Use event processor to create.
- Public Member Functions inherited from makVrv::DtIntervisibilityDriver
 DtIntervisibilityDriver (DtDe &, const std::string &className)
 CTOR.
virtual ~DtIntervisibilityDriver ()
 DTOR.
virtual bool autoStart () const
 Override to return true (does not look at configuration)
DtIntervisibilityStateListenerfindListener (DtElementID id)
DtIntervisibilityElementfindElement (DtElementID id)
virtual DtIntervisibilityElementcreateIntervisibilityLine (const DtVector &startPoint, const DtVector &endPoint)
 Create and return a new intervisibility line with given start and end points.
virtual void createIntervisibilityLine (const AttachPoints &=AttachPoints())
 Creates a new intervisibility line object by using the event processor with the newly create element.
const DtUnicodeintervisibilityLine () const
 String which represents the internal keyword used to create an intervisibility line.
virtual DtIntervisibilityElementcreateIntervisibilityFan (const DtVector &startPoint, const DtVector &endPoint)
 Create and return a new intervisibility fan with given start and end points.
virtual void createIntervisibilityFan (const AttachPoints &=AttachPoints())
 Creates a new intervisibility fan object by using the event processor.
const DtUnicodeintervisibilityFan () const
 String which represents the internal keyword used to create an intervisibility fan.
virtual DtIntervisibilityElementcreateIntervisibilityEntityFan (const DtVector &startPoint, const DtVector &endPoint)
 Create and return a new intervisibility entity fan with given start and end points.
virtual void createIntervisibilityEntityFan (const AttachPoints &=AttachPoints())
 Creates a new intervisibility entity fan object by using the event processor.
const DtUnicodeintervisibilityEntityFan () const
 String which represents the internal keyword used to create an intervisibility entity fan.
void addListenerCreator (const std::string &, DtIntervisibilityStateListenerCreator *)
 Adds a new listener creator given the keyword.
virtual void cancelChanges ()
 Cancel current creation and remove temporary symbol.
virtual void destroy (DtElementID id)
 Given the particular ID, destroys (removes) the object and also removes from selection.
virtual void destroyAll ()
 Destroys all intervisibility elements.
virtual void setAllowCreating (bool)
 Sets whether or not the processor is enabled for creating.
virtual void setAllowEditing (bool)
 Sets whether or not the processor supports editing of objects.
virtual DtIntervisibilityElementcreate (const DtUnicode &definition, const DtVector &startPoint, const DtVector &endPoint)
 Create and return a new element with the points as the starting points.
virtual void intervisibilityObjectsShown (bool show)
const std::string & className () const
 Returns the driver's class name.
DtBaseConnectionconnection ()
 Returns the driver's connection.
const DtBaseConnectionconnection () const
 Returns the driver's connection (const).
- Public Member Functions inherited from makVrv::DtDriver
 DtDriver (DtAgentManager &agentManager, const std::string &instanceName)
 CTOR.
virtual ~DtDriver ()
 DTOR.
virtual void realizeConfiguration (const DtConfiguration &configuration)
 Realize the driver using the configuration.
virtual DtConfiguration createConfiguration () const
 Create a configuration for the driver.
DtAgentManageragentManager ()
 Get the master scene for this host.
virtual DtAgentManagerInterfacesceneInterface ()
 Get the scene manager interface for creating agents.
bool started () const
 Get this driver's active state.
virtual const std::string & instanceName () const
 Get this driver's instance name.
virtual void setAutoStart (bool autoStart)
 Set whether this driver automatically starts if it is persistent.
virtual bool isWindowDependent () const
 Get whether this driver is set to automatically start when the first window is created and stop when the last window is destroyed.
virtual void setIsWindowDependent (bool dep)
 Set whether this driver is set to automatically start when the first window is created and stop when the last window is destroyed.
virtual void setIsUserControllable (bool)
 Set whether this driver can be started and stopped by the user.
virtual bool isUserControllable () const
 Get whether this driver can be started and stopped by the user.
virtual void setIsPersistent (bool per)
 Set if the driver is persistent and should be saved between runs.
virtual bool isPersistent () const
 Get if the driver is persistent and should be saved between runs.
virtual bool isOnDriverSelectionList () const
 Returns whether or not this driver is to be automatically started/stopped from the driver selection list.
virtual void setOnDriverSelectionList (bool)
 Sets whether or not this item is on the driver selection list.
bool objectFromAgentManager (const DtUniqueID &id) const
 check to see if the object was created using this driver's agent manager.

Protected Member Functions

virtual
makVrv::DtBasicEditingEventProcessor
createEventProcessor () const
 Creates the event processor used for mouse and keyboard controls.
virtual
makVrv::DtIntervisibilityStateListener
createListener (const std::string &definition) const
 Creates a new listener to be used with the element being created.
virtual
makVrv::DtIntervisibilityElement
createElement (makVrv::DtIntervisibilityStateListener *, const makVrv::DtUnicode &definition) const
 Creates a new shape element for the given listener.
virtual bool isAttachableObjectType (makVrv::DtElementEntry::ObjectType t) const
 Return true if the object type can be used as an anchor for an range line point.
virtual bool isAttachableObjectType (makVrv::DtUniqueID id) const
virtual void slot_place (makVrv::DtUniqueID attachTo, DtVector v, double altAboveGround)
 Signal sent on left click of mouse on terrain or object.
virtual void completeSetup ()
 Makes final connections.
void installElementDefinitions (makVrv::DtElementDefinitionManager &manager)
 Creates and installed procedural element definitions into the manager.
void createVisualizerDefinitions (makVrv::DtElementDefinitionManager &manager, int modelSet)
- Protected Member Functions inherited from makVrv::DtIntervisibilityDriver
virtual void create (const DtUnicode &elementDefinitionName, const AttachPoints &=AttachPoints())
 Creates a new element object by using the event processor.
virtual bool onTick ()
 call for each tick
virtual bool onStart ()
 Start the host output.
virtual bool onStop ()
 Stop the host output.
virtual void slot_onCurrentSelectionChanged (const DtSelectionManager::IdSet &selected, const DtSelectionManager::IdSet &deselected)
 Select/deselect objects.
virtual void select (const DtSelectionManager::IdSet &, bool)
 Select/deselect all items in list.
virtual void connectProcessorSignals ()
 Connects up to event processor to handle signals.
virtual void slot_locationChanged (DtVector, double altAboveGround)
 Signal sent when the mouse location has changed via a mouse move.
virtual void slot_altitudeChanged (DtVector, double)
 Signal sent when the altitude has changed.
virtual void slot_altitudeIsDragging (bool)
 Called when altitude has entered/left dragging mode.
virtual void finishEditing ()
 Called to finish the current creation and make object permanent.
virtual void slot_dragStart (const DtSelectionManager::IdSet &set, const DtVector &)
 Called when a drag operation is about to start, stash off information about current objects (in case of cancel) and proceed to allow editing.
virtual void modifyEditingObjects (const DtVector &pos, double altAboveGround)
 Modifies all the objects being edited based on the new point and altitude.
virtual void resetSelectionForEditableObjects ()
 Called after complete or cancel to reset selection state to original state.
virtual DtVector clamp (const DtVector &, double altAboveGround) const
 Clamps point to terrain, then applies delta altitude.
virtual void elementsRemoved (const DtElementData::UniqueIdList &)
 Called when a simulation item is removed.
- Protected Member Functions inherited from makVrv::DtDriver
void applyChangesAndDelete (DtElementChanges *changes)
 Function for apply changes from a changes object and deleting it.
void reportElementCreated (DtElementID id, DtElementID parentId, DtElementEntry::ElementType type)
 Report an element created.
void reportElementAttribute (DtElementID id, DtElementAttribute *attribute)
 Report an element attribute changed.
void reportElementDestroyed (DtElementID id)
 Report an element destroyed.
void start ()
 Start the driver.
void stop ()
 Stop the driver.
bool tick ()
 Tick the host driver.
virtual void slot_displayEngineAdded (const DtDeRecord &igRecord)
 Called when a display engine is added.
virtual void setInstanceName (const std::string &name)
 set the Instance name.
virtual void installAccessories ()
 Installs accessories on this driver.
virtual void uninstallAccessories ()
 Removes accessories from this driver.

Additional Inherited Members

- Public Types inherited from makVrv::DtIntervisibilityDriver
typedef boost::unordered_map
< DtElementID,
DtIntervisibilityElement * > 
ElementMap
typedef boost::unordered_map
< DtElementID,
DtIntervisibilityStateListener * > 
ListenerMap
typedef std::pair< DtElementID,
DtVector
AttachPoint
typedef std::vector< AttachPointAttachPoints
- Static Public Member Functions inherited from makVrv::DtIntervisibilityDriver
static DtIntervisibilityDriverfindDriver (DtDe &de)
 Returns the current intervisibility driver in the driver manager.
static std::string theInstanceName ()
 Returns the driver's instance (display) name.
- Protected Types inherited from makVrv::DtIntervisibilityDriver
typedef boost::unordered_map
< DtElementID,
OriginalInformation
Editing
typedef std::map< std::string,
DtIntervisibilityStateListenerCreator * > 
ListenerCreatorMap
- Protected Attributes inherited from makVrv::DtIntervisibilityDriver
DtDemyDe
ElementMap myElements
ListenerMap myListeners
DtBasicEditingEventProcessormyProcessor
std::string myClassName
DtBaseConnectionmyConnection
bool myAllowEditing
bool myAllowCreating
bool myDistribute
DtSignalConnectionManager myConnections
DtIntervisibilityElementmyCreatingElement
 If creating an element via the mouse, these parameters will not not be NULL.
DtIntervisibilityStateListenermyCreationListener
DtSignalConnectionManager myProcessorConnections
Editing myEditing
DtVector myEditingAnchorLocation
ListenerCreatorMap myListenerCreatorMap
 Map that will keep track of listener creator by string type.
DtChannelmyHiddenChannel

Detailed Description

This driver will manage the creation, modification and removal of range line objects.

Will use the event processor for mouse and keyboard processing if necessary

Constructor & Destructor Documentation

exampleRangeLine::DtRangeLineDriver::DtRangeLineDriver ( makVrv::DtDe )

CTOR.

virtual exampleRangeLine::DtRangeLineDriver::~DtRangeLineDriver ( )
virtual

DTOR.

Member Function Documentation

virtual DtRangeLineElement* exampleRangeLine::DtRangeLineDriver::create ( const DtVector start,
const DtVector end 
)
virtual

Create and return a new range line with the given start and end points.

virtual void exampleRangeLine::DtRangeLineDriver::create ( const AttachPoints ap = AttachPoints())
virtual

Use event processor to create.

virtual makVrv::DtBasicEditingEventProcessor* exampleRangeLine::DtRangeLineDriver::createEventProcessor ( ) const
protectedvirtual

Creates the event processor used for mouse and keyboard controls.

Reimplemented from makVrv::DtIntervisibilityDriver.

virtual makVrv::DtIntervisibilityStateListener* exampleRangeLine::DtRangeLineDriver::createListener ( const std::string &  definition) const
protectedvirtual

Creates a new listener to be used with the element being created.

Reimplemented from makVrv::DtIntervisibilityDriver.

virtual makVrv::DtIntervisibilityElement* exampleRangeLine::DtRangeLineDriver::createElement ( makVrv::DtIntervisibilityStateListener ,
const makVrv::DtUnicode definition 
) const
protectedvirtual

Creates a new shape element for the given listener.

Reimplemented from makVrv::DtIntervisibilityDriver.

virtual bool exampleRangeLine::DtRangeLineDriver::isAttachableObjectType ( makVrv::DtElementEntry::ObjectType  t) const
protectedvirtual

Return true if the object type can be used as an anchor for an range line point.

virtual bool exampleRangeLine::DtRangeLineDriver::isAttachableObjectType ( makVrv::DtUniqueID  id) const
protectedvirtual
virtual void exampleRangeLine::DtRangeLineDriver::slot_place ( makVrv::DtUniqueID  ,
DtVector  ,
double  altAboveGround 
)
protectedvirtual

Signal sent on left click of mouse on terrain or object.

ID is the item clicked on. Vector is in local database coordinates

Reimplemented from makVrv::DtIntervisibilityDriver.

virtual void exampleRangeLine::DtRangeLineDriver::completeSetup ( )
protectedvirtual

Makes final connections.

Reimplemented from makVrv::DtIntervisibilityDriver.

void exampleRangeLine::DtRangeLineDriver::installElementDefinitions ( makVrv::DtElementDefinitionManager manager)
protected

Creates and installed procedural element definitions into the manager.

Reimplemented from makVrv::DtIntervisibilityDriver.

void exampleRangeLine::DtRangeLineDriver::createVisualizerDefinitions ( makVrv::DtElementDefinitionManager manager,
int  modelSet 
)
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)