makVrf::DtVrfSimulationObjectGroupHandler Class Reference

The class will handle the saving of new simulation object groups. Call the saveSimulationObjectGroup method to show a dialog which will allow the user to create the selection group from all the information in the current scenario.

Inheritance diagram for makVrf::DtVrfSimulationObjectGroupHandler:

Public Member Functions
	DtVrfSimulationObjectGroupHandler (makVrv::DtDe &)
virtual	~DtVrfSimulationObjectGroupHandler ()
virtual void	saveSimulationObjectGroup ()
virtual void	saveSimulationObjectGroup (const DtSimulationObjectGroupSaveInformation &, bool quitOnSave=false, bool saveAsZip=false)
virtual void	setDataDirectory (const DtFilename &)
virtual const DtFilename &	dataDirectory () const
virtual DtSimulationObjectGroupSaveInformation	simulationObjectGroupSaveInformation () const
virtual void	loadFailed ()
virtual bool	loadSimulationObjectGroup (const std::string &terrain)
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtVrfSimulationObjectGroupHandler &	instance (makVrv::DtDe &de)
static void	registerInstance (makVrv::DtDe &, DtVrfSimulationObjectGroupHandler *)

Public Attributes
boost::signals2::signal< void(const std::string &)>	signal_savedSimulationObjectGroup
boost::signals2::signal< void()>	signal_simulationObjectGroupLoaded

Protected Member Functions
virtual void	completeObjectGroupLoad ()
virtual void	scenarioJustLoaded ()
DtSimulationObjectGroupSaveDialog *	createSimulationObjectGroupSaveDialog () const
virtual void	processSimulationObjectGroupSaveResults (const DtSimMessage *)
virtual void	addObjectStates (DtSimulationObjectGroupModelSetEntry *, const std::set< DtUUID > &) const
virtual void	completeExit ()

Protected Attributes
makVrv::DtDe &	myDe
DtSimulationObjectGroupSaveInformation *	mySimulationObjectGroupSaveInformation
DtFilename	myDataDirectory
bool	myQuitOnSave

Constructor & Destructor Documentation

makVrf::DtVrfSimulationObjectGroupHandler::DtVrfSimulationObjectGroupHandler

(

makVrv::DtDe &

)

CTOR.

virtual makVrf::DtVrfSimulationObjectGroupHandler::~DtVrfSimulationObjectGroupHandler ( )

virtual

DTOR.

Member Function Documentation

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

static

Returns instance of the handler.

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

static

virtual void makVrf::DtVrfSimulationObjectGroupHandler::saveSimulationObjectGroup ( )

virtual

Shows a dialog to the user for gathering information about the saving of the simulation object group, and, if the user accepts the dialog, calls the saveSimulationObjectGroup method that supplies the information provided to create the simulation object group.

virtual void makVrf::DtVrfSimulationObjectGroupHandler::saveSimulationObjectGroup ( const DtSimulationObjectGroupSaveInformation &  , bool  quitOnSave = false, bool  saveAsZip = false  )

virtual

Saves the simulation object group by sending a message to the back-end.

virtual void makVrf::DtVrfSimulationObjectGroupHandler::setDataDirectory ( const DtFilename &  )

virtual

Where to save the sog files.

virtual const DtFilename& makVrf::DtVrfSimulationObjectGroupHandler::dataDirectory ( ) const

virtual

virtual DtSimulationObjectGroupSaveInformation makVrf::DtVrfSimulationObjectGroupHandler::simulationObjectGroupSaveInformation ( ) const

virtual

virtual void makVrf::DtVrfSimulationObjectGroupHandler::loadFailed ( )

virtual

Call if the scenario load has failed to do some cleanup.

virtual bool makVrf::DtVrfSimulationObjectGroupHandler::loadSimulationObjectGroup ( const std::string &  terrain )

virtual

Loads the given simulation object group as found in the specified .sog file and saves off the information found in mySimulationObjectGroupSaveInformation. Will return true if the .sog file is found, else will return false. Will also create a new scenario to place this simulation object group on using the simulation object group terrain.

virtual void makVrf::DtVrfSimulationObjectGroupHandler::completeObjectGroupLoad ( )

protectedvirtual

Called when new scenario is completed loading, create simulation object group at 0, 0, 0.

virtual void makVrf::DtVrfSimulationObjectGroupHandler::scenarioJustLoaded ( )

protectedvirtual

DtSimulationObjectGroupSaveDialog* makVrf::DtVrfSimulationObjectGroupHandler::createSimulationObjectGroupSaveDialog ( ) const

protected

Creates the dialog that is used to request selection group information from the user.

virtual void makVrf::DtVrfSimulationObjectGroupHandler::processSimulationObjectGroupSaveResults ( const DtSimMessage *  )

protectedvirtual

Process the results of the simulation object group creation if we are the ones that started it.

virtual void makVrf::DtVrfSimulationObjectGroupHandler::addObjectStates ( DtSimulationObjectGroupModelSetEntry *  , const std::set< DtUUID > &    ) const

protectedvirtual

Saves out the object states tha are part of the simulation group for future use when creating this simulation group to be able to display information when creating.

virtual void makVrf::DtVrfSimulationObjectGroupHandler::completeExit ( )

protectedvirtual

Member Data Documentation

boost::signals2::signal<void (const std::string&)> makVrf::DtVrfSimulationObjectGroupHandler::signal_savedSimulationObjectGroup

Signal sent when a simulation object group has been saved.

boost::signals2::signal<void ()> makVrf::DtVrfSimulationObjectGroupHandler::signal_simulationObjectGroupLoaded

makVrv::DtDe& makVrf::DtVrfSimulationObjectGroupHandler::myDe

protected

DtSimulationObjectGroupSaveInformation* makVrf::DtVrfSimulationObjectGroupHandler::mySimulationObjectGroupSaveInformation

protected

DtFilename makVrf::DtVrfSimulationObjectGroupHandler::myDataDirectory

protected

bool makVrf::DtVrfSimulationObjectGroupHandler::myQuitOnSave

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfGuiCommonQt/vrfSimulationObjectGroupHandler.h