makVrf::DtScenarioModificationHandler Class Reference

The class that will allow the user to edit scenario information that is part of a currently loaded scenario. More...

Inheritance diagram for makVrf::DtScenarioModificationHandler:

Public Types
enum	Modified {   CreateGlobalDynamicTerrain = 0x00000001, CreateGlobalEnvironment = 0x00000002, SimulationTerrain = 0x00000004, SimulationModelSet = 0x00000008,   FrontEndTerrain = 0x00000010, ComponentAttachmentTable = 0x00000020, RandomNumberSeed = 0x00000040, FrameMode = 0x00000080,   FrameTime = 0x00000100 }
	Flags that inidicate what has been modified. More...

Public Member Functions
	DtScenarioModificationHandler (makVrv::DtDe &)
virtual	~DtScenarioModificationHandler ()
virtual const DtScenario &	modifiedScenario () const
	The scenario as it has been modified. Initially it is set to whatever is in the current scenario.
virtual void	editScenarioInformation (const std::map< DtScenarioInformationWidget::DisplayElement, bool > &toEnable=std::map< DtScenarioInformationWidget::DisplayElement, bool >(), const std::map< DtScenarioInformationWidget::DisplayElement, bool > &toHide=std::map< DtScenarioInformationWidget::DisplayElement, bool >())
	Will start the process of showing the scenario description dialog and connecting to a signal when that dialog has been edited.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtScenarioModificationHandler &	instance (makVrv::DtDe &de)
	Returns instance of the messager.
static void	registerInstance (makVrv::DtDe &, DtScenarioModificationHandler *)

Protected Member Functions
virtual void	slot_scenarioInitialized (const DtScenario &)
	Called when scenario is set in scenario manager.
virtual void	completeDialogInitialization (DtScenarioDescriptionDialog *)
	Called before the dialog is shown.
virtual void	editingComplete (DtScenarioDescriptionDialog *)
	Called when the dialog is accepted.
virtual void	changeImmediately (const DtScenario &fromDialog)
	Determine which items can be changed immediately and do that.
virtual void	storePotentialChanges (const DtScenario &fromDialog)
	This will store changes that cannot be realized until the scenario is saved and reloaded. This method will also warn the user of such a thing.
virtual void	scenarioInformationAboutToBeSet (DtScenario &, DtScenarioDescriptionDialog *)
	Called when the scenario information is about to be set in the description dialog.
virtual void	slot_scenarioClosed ()
	Called when the scenario is closed. Clear out some flags.
virtual void	slot_scenarioAboutToBeSaved (DtScenario *)
	Signal sent right before the scenario is to be saved.

Protected Attributes
DtScenario	myModifiedScenario
makVrv::DtDe &	myDe
makVrv::DtSignalConnectionManager	myConnections
int	myHasModifications

Detailed Description

The class that will allow the user to edit scenario information that is part of a currently loaded scenario.

Since not all scenario information can be changed immediately, this class will keep track of the scenario information that has changed since the scenario was last loaded. When a scenario is saved the information contains will be used as part of that saved scenario, however, it will not take effect in a scenario until that saved scenario is reloaded

Member Enumeration Documentation

enum makVrf::DtScenarioModificationHandler::Modified

Flags that inidicate what has been modified.

Enumerator:

CreateGlobalDynamicTerrain
CreateGlobalEnvironment
SimulationTerrain
SimulationModelSet
FrontEndTerrain
ComponentAttachmentTable
RandomNumberSeed
FrameMode
FrameTime

Constructor & Destructor Documentation

makVrf::DtScenarioModificationHandler::DtScenarioModificationHandler

(

makVrv::DtDe &

)

virtual makVrf::DtScenarioModificationHandler::~DtScenarioModificationHandler ( )

virtual

Member Function Documentation

static DtScenarioModificationHandler& makVrf::DtScenarioModificationHandler::instance ( makVrv::DtDe &  de )

static

Returns instance of the messager.

static void makVrf::DtScenarioModificationHandler::registerInstance ( makVrv::DtDe &  , DtScenarioModificationHandler *    )

static

virtual const DtScenario& makVrf::DtScenarioModificationHandler::modifiedScenario ( ) const

virtual

The scenario as it has been modified. Initially it is set to whatever is in the current scenario.

virtual void makVrf::DtScenarioModificationHandler::editScenarioInformation ( const std::map< DtScenarioInformationWidget::DisplayElement, bool > &  toEnable = std::map< DtScenarioInformationWidget::DisplayElement, bool >(), const std::map< DtScenarioInformationWidget::DisplayElement, bool > &  toHide = std::map< DtScenarioInformationWidget::DisplayElement, bool >()  )

virtual

Will start the process of showing the scenario description dialog and connecting to a signal when that dialog has been edited.

Pass in variables that you want hidden/disabled beyond what already is as default when editing this information. Information currently not shown: DtScenarioInformationWidget::StartingDateAndTime DtScenarioInformationWidget::UseDayNightModel DtScenarioInformationWidget::StartingDateAndTime

When editing is complete the editingComplete method is called will the dialog such that custom changes to the scenario can be made. A signal is also sent before changes are made with the modified scenario as per what is in the dialog

virtual void makVrf::DtScenarioModificationHandler::slot_scenarioInitialized ( const DtScenario &  )

protectedvirtual

Called when scenario is set in scenario manager.

virtual void makVrf::DtScenarioModificationHandler::completeDialogInitialization ( DtScenarioDescriptionDialog *  )

protectedvirtual

Called before the dialog is shown.

virtual void makVrf::DtScenarioModificationHandler::editingComplete ( DtScenarioDescriptionDialog *  )

protectedvirtual

Called when the dialog is accepted.

virtual void makVrf::DtScenarioModificationHandler::changeImmediately ( const DtScenario &  fromDialog )

protectedvirtual

Determine which items can be changed immediately and do that.

virtual void makVrf::DtScenarioModificationHandler::storePotentialChanges ( const DtScenario &  fromDialog )

protectedvirtual

This will store changes that cannot be realized until the scenario is saved and reloaded. This method will also warn the user of such a thing.

virtual void makVrf::DtScenarioModificationHandler::scenarioInformationAboutToBeSet ( DtScenario &  , DtScenarioDescriptionDialog *    )

protectedvirtual

Called when the scenario information is about to be set in the description dialog.

This can change the scenario to show different information

virtual void makVrf::DtScenarioModificationHandler::slot_scenarioClosed ( )

protectedvirtual

Called when the scenario is closed. Clear out some flags.

virtual void makVrf::DtScenarioModificationHandler::slot_scenarioAboutToBeSaved ( DtScenario *  )

protectedvirtual

Signal sent right before the scenario is to be saved.

Can change the scenario and some information will get saved out to the scenario file on save. The items that can be changed will be in the scenario extras and will be removed before the scenario file is saved out. The items that can be modified are: ChangeOnSave_SimulationModelSet ChangeOnSave_SimulationTerrain ChangeOnSave_FrontEndTerrain ChangeOnSave_ComponentAttachmentTable ChangeOnSave_RandomNumberSeed ChangeOnSave_FrameMode ChangeOnSave_FrameTime

Member Data Documentation

DtScenario makVrf::DtScenarioModificationHandler::myModifiedScenario

protected

makVrv::DtDe& makVrf::DtScenarioModificationHandler::myDe

protected

makVrv::DtSignalConnectionManager makVrf::DtScenarioModificationHandler::myConnections

protected

int makVrf::DtScenarioModificationHandler::myHasModifications

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCoreQt/scenarioModificationHandler.h