makVrf::DtSpawnSinkGuiManager Class Reference

Represents the manager responsible for dealing with any GUI related stuff. More...

Inheritance diagram for makVrf::DtSpawnSinkGuiManager:

Classes
struct	TemplateInfo

Public Member Functions
	DtSpawnSinkGuiManager (makVrv::DtDe &)
virtual	~DtSpawnSinkGuiManager ()
virtual bool	init ()
virtual void	requestSpawnTemplateList ()
	Plugin options.
virtual const SpawnTemplateDescriptionList &	spawnPatternList () const
virtual bool	setPatternList (const SpawnTemplateDescriptionList &list)
	Returns true if pattern list is updated.
virtual const SpawnTemplateDescriptionList &	patternList () const
virtual SpawnTemplateDescriptionList &	patternList ()
virtual DtUUID	lookupUUIDByTemplateName (const DtString &) const
virtual void	slot_updateCreationPalette (DtEntityCreatePaletteInterface *palette)
virtual void	slot_spawnCreateObject (const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData &, QString, DtUUID)
	Once the spawn point has been placed this slot is called to send the create object message.
virtual void	slot_sinkCreateObject (const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData &, QString, DtUUID)
	Once the sink point has been placed this slot is called to send the create object message.
virtual int	nextSpawnNumber (const DtString &templateName)
	Returns the latest number in use for a spawn point then increments for next call.
virtual int	nextSinkNumber (const DtString &templateName)
	Returns the latest number in use for a sink point then increments for next call.
virtual void	slot_commandRequestToBeAddedToPlan (DtSimCommand &, bool forEdit)
	Called when the plan command is going to add an item, if adding a sink or spawn point add the addition data.
virtual DtString	sinkPointName (const DtString &templateName)
virtual DtString	spawnPointName (const DtString &templateName)
virtual int	indexOfTemplateWithUUID (const DtUUID &tempName) const
virtual DtString	templateName (const DtUUID &) const
virtual std::vector< DtUUID >	templatesWithSpawnPoint (const DtUUID &tempName) const
virtual std::vector< DtUUID >	templatesWithSinkPoint (const DtUUID &tempName) const
virtual DtSpawnSinkCreationDialog *	spawnSinkCreationDialog ()
	If does not exist, will create.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtSpawnSinkGuiManager &	instance (makVrv::DtDe &de)

Public Attributes
boost::signal< void(const SpawnTemplateDescriptionList &)>	signal_patternListUpdated
boost::signal< void(const SpawnTemplateDescriptionList &)>	signal_spawnSinkPointCountUpdated
boost::signal< void(const DtUUID &)>	signal_spawnPointAdded
boost::signal< void(const DtUUID &)>	signal_sinkPointAdded
boost::signal< void(const DtUUID &)>	signal_spawnPointRemoved
boost::signal< void(const DtUUID &)>	signal_sinkPointRemoved

Protected Types
typedef std::map < makVrv::DtUniqueID, TemplateInfo >	UniqueIdToTemplateInfo
typedef std::map< int, DtUUID >	ExtraMapToTemplateUUID
typedef std::map< DtString, int >	NextNumberMap

Protected Slots
virtual void	dialogDestroyed ()

Protected Member Functions
virtual void	updateCreateMenuWithSpawnAndSinkPoints (DtEntityCreatePaletteInterface *palette)
	Takes the current spawn and sink points and adds them into the create menu.
virtual void	removePaletteItems (DtEntityCreatePaletteInterface *iFace)
	Removes current pattern items from the entity palette.
virtual void	removeCreateMenuItems (DtEntityCreatePaletteInterface *palette)
	Remove created items from the create menu.
virtual void	slot_simStateAdded (makVrv::DtSimObjectEntry &e)
	Called when a sim state is added, if there is a marking text, then, parse it out to see if it is spawn/sink point.
virtual void	slot_simObjectEntryAboutToBeRemoved (makVrv::DtSimObjectEntry &e)
	Remove count if spawn/sink point.
virtual void	resetCounters (bool requestTemplates=true)
	Resets spawn/sink counters.
virtual DtModelSetEntry *	addModelSetEntryIfMissing (const DtString &label, const DtEntityMapperKey &, const DtString &category, bool recreateMenu=true)
	Adds an entry to the model set (entity) if missing. This will be used to support favorites.
virtual void	processTemplateList (DtSimMessage *rsp)
virtual void	completeInitialization ()
virtual bool	addPotentialSpawnSinkPoint (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)
virtual void	removePotentialSpawnSinkPoint (const DtUUID &templateName, const DtEntityType &t)
virtual void	slot_stateViewUpdated (makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *s)
virtual bool	isSpawnOrSinkPoint (const makVrv::DtVrlinkSimulatedBaseState &s) const
virtual bool	isSpawnPoint (const makVrv::DtVrlinkSimulatedBaseState &s) const
virtual bool	isSinkPoint (const makVrv::DtVrlinkSimulatedBaseState &s) const
virtual void	slot_uuidChanged (makVrv::DtUniqueID, const DtUUID &oldUUID, const DtUUID &newUUID)

Protected Attributes
makVrv::DtDe &	myDe
SpawnTemplateDescriptionList	myPatternList
makVrv::DtSignalConnectionManager	myConnectionManager
makVrv::DtSignalConnectionManager	myPaletteConnections
UniqueIdToTemplateInfo	myUniqueIdToTemplateInfo
bool	myRequestMade
DtSpawnSinkCreationDialog *	mySpawnSinkCreationDialog
ExtraMapToTemplateUUID	myExtraMapToTemplateUUID
NextNumberMap	myNextSinkNumber
NextNumberMap	myNextSpawnNumber

Detailed Description

Represents the manager responsible for dealing with any GUI related stuff.

Member Typedef Documentation

typedef std::map<makVrv::DtUniqueID, TemplateInfo> makVrf::DtSpawnSinkGuiManager::UniqueIdToTemplateInfo

protected

typedef std::map<int, DtUUID> makVrf::DtSpawnSinkGuiManager::ExtraMapToTemplateUUID

protected

typedef std::map<DtString, int> makVrf::DtSpawnSinkGuiManager::NextNumberMap

protected

Constructor & Destructor Documentation

makVrf::DtSpawnSinkGuiManager::DtSpawnSinkGuiManager

(

makVrv::DtDe &

)

virtual makVrf::DtSpawnSinkGuiManager::~DtSpawnSinkGuiManager ( )

virtual

Member Function Documentation

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

static

virtual bool makVrf::DtSpawnSinkGuiManager::init ( )

virtual

virtual void makVrf::DtSpawnSinkGuiManager::requestSpawnTemplateList ( )

virtual

Plugin options.

virtual const SpawnTemplateDescriptionList& makVrf::DtSpawnSinkGuiManager::spawnPatternList ( ) const

virtual

virtual bool makVrf::DtSpawnSinkGuiManager::setPatternList ( const SpawnTemplateDescriptionList &  list )

virtual

Returns true if pattern list is updated.

virtual const SpawnTemplateDescriptionList& makVrf::DtSpawnSinkGuiManager::patternList ( ) const

virtual

virtual SpawnTemplateDescriptionList& makVrf::DtSpawnSinkGuiManager::patternList ( )

virtual

virtual DtUUID makVrf::DtSpawnSinkGuiManager::lookupUUIDByTemplateName ( const DtString &  ) const

virtual

virtual void makVrf::DtSpawnSinkGuiManager::slot_updateCreationPalette ( DtEntityCreatePaletteInterface *  palette )

virtual

virtual void makVrf::DtSpawnSinkGuiManager::slot_spawnCreateObject ( const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData &  , QString  , DtUUID    )

virtual

Once the spawn point has been placed this slot is called to send the create object message.

virtual void makVrf::DtSpawnSinkGuiManager::slot_sinkCreateObject ( const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData &  , QString  , DtUUID    )

virtual

Once the sink point has been placed this slot is called to send the create object message.

virtual int makVrf::DtSpawnSinkGuiManager::nextSpawnNumber ( const DtString &  templateName )

virtual

Returns the latest number in use for a spawn point then increments for next call.

virtual int makVrf::DtSpawnSinkGuiManager::nextSinkNumber ( const DtString &  templateName )

virtual

Returns the latest number in use for a sink point then increments for next call.

virtual void makVrf::DtSpawnSinkGuiManager::slot_commandRequestToBeAddedToPlan ( DtSimCommand &  , bool  forEdit  )

virtual

Called when the plan command is going to add an item, if adding a sink or spawn point add the addition data.

virtual DtString makVrf::DtSpawnSinkGuiManager::sinkPointName ( const DtString &  templateName )

virtual

virtual DtString makVrf::DtSpawnSinkGuiManager::spawnPointName ( const DtString &  templateName )

virtual

virtual int makVrf::DtSpawnSinkGuiManager::indexOfTemplateWithUUID ( const DtUUID &  tempName ) const

virtual

virtual DtString makVrf::DtSpawnSinkGuiManager::templateName ( const DtUUID &  ) const

virtual

virtual std::vector<DtUUID> makVrf::DtSpawnSinkGuiManager::templatesWithSpawnPoint ( const DtUUID &  tempName ) const

virtual

virtual std::vector<DtUUID> makVrf::DtSpawnSinkGuiManager::templatesWithSinkPoint ( const DtUUID &  tempName ) const

virtual

virtual DtSpawnSinkCreationDialog* makVrf::DtSpawnSinkGuiManager::spawnSinkCreationDialog ( )

virtual

If does not exist, will create.

virtual void makVrf::DtSpawnSinkGuiManager::dialogDestroyed ( )

protectedvirtualslot

virtual void makVrf::DtSpawnSinkGuiManager::updateCreateMenuWithSpawnAndSinkPoints ( DtEntityCreatePaletteInterface *  palette )

protectedvirtual

Takes the current spawn and sink points and adds them into the create menu.

Will recreate the create menu as part of this process

virtual void makVrf::DtSpawnSinkGuiManager::removePaletteItems ( DtEntityCreatePaletteInterface *  iFace )

protectedvirtual

Removes current pattern items from the entity palette.

virtual void makVrf::DtSpawnSinkGuiManager::removeCreateMenuItems ( DtEntityCreatePaletteInterface *  palette )

protectedvirtual

Remove created items from the create menu.

virtual void makVrf::DtSpawnSinkGuiManager::slot_simStateAdded ( makVrv::DtSimObjectEntry &  e )

protectedvirtual

Called when a sim state is added, if there is a marking text, then, parse it out to see if it is spawn/sink point.

If no marking text, mark for update

virtual void makVrf::DtSpawnSinkGuiManager::slot_simObjectEntryAboutToBeRemoved ( makVrv::DtSimObjectEntry &  e )

protectedvirtual

Remove count if spawn/sink point.

virtual void makVrf::DtSpawnSinkGuiManager::resetCounters ( bool  requestTemplates = true )

protectedvirtual

Resets spawn/sink counters.

virtual DtModelSetEntry* makVrf::DtSpawnSinkGuiManager::addModelSetEntryIfMissing ( const DtString &  label, const DtEntityMapperKey &  , const DtString &  category, bool  recreateMenu = true  )

protectedvirtual

Adds an entry to the model set (entity) if missing. This will be used to support favorites.

virtual void makVrf::DtSpawnSinkGuiManager::processTemplateList ( DtSimMessage *  rsp )

protectedvirtual

virtual void makVrf::DtSpawnSinkGuiManager::completeInitialization ( )

protectedvirtual

virtual bool makVrf::DtSpawnSinkGuiManager::addPotentialSpawnSinkPoint ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  )

protectedvirtual

virtual void makVrf::DtSpawnSinkGuiManager::removePotentialSpawnSinkPoint ( const DtUUID &  templateName, const DtEntityType &  t  )

protectedvirtual

virtual void makVrf::DtSpawnSinkGuiManager::slot_stateViewUpdated ( makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  s )

protectedvirtual

virtual bool makVrf::DtSpawnSinkGuiManager::isSpawnOrSinkPoint ( const makVrv::DtVrlinkSimulatedBaseState &  s ) const

protectedvirtual

virtual bool makVrf::DtSpawnSinkGuiManager::isSpawnPoint ( const makVrv::DtVrlinkSimulatedBaseState &  s ) const

protectedvirtual

virtual bool makVrf::DtSpawnSinkGuiManager::isSinkPoint ( const makVrv::DtVrlinkSimulatedBaseState &  s ) const

protectedvirtual

virtual void makVrf::DtSpawnSinkGuiManager::slot_uuidChanged ( makVrv::DtUniqueID  , const DtUUID &  oldUUID, const DtUUID &  newUUID  )

protectedvirtual

Member Data Documentation

boost::signal<void (const SpawnTemplateDescriptionList &)> makVrf::DtSpawnSinkGuiManager::signal_patternListUpdated

boost::signal<void (const SpawnTemplateDescriptionList &)> makVrf::DtSpawnSinkGuiManager::signal_spawnSinkPointCountUpdated

boost::signal<void (const DtUUID&)> makVrf::DtSpawnSinkGuiManager::signal_spawnPointAdded

boost::signal<void (const DtUUID&)> makVrf::DtSpawnSinkGuiManager::signal_sinkPointAdded

boost::signal<void (const DtUUID&)> makVrf::DtSpawnSinkGuiManager::signal_spawnPointRemoved

boost::signal<void (const DtUUID&)> makVrf::DtSpawnSinkGuiManager::signal_sinkPointRemoved

makVrv::DtDe& makVrf::DtSpawnSinkGuiManager::myDe

protected

SpawnTemplateDescriptionList makVrf::DtSpawnSinkGuiManager::myPatternList

protected

makVrv::DtSignalConnectionManager makVrf::DtSpawnSinkGuiManager::myConnectionManager

protected

makVrv::DtSignalConnectionManager makVrf::DtSpawnSinkGuiManager::myPaletteConnections

protected

UniqueIdToTemplateInfo makVrf::DtSpawnSinkGuiManager::myUniqueIdToTemplateInfo

protected

bool makVrf::DtSpawnSinkGuiManager::myRequestMade

protected

DtSpawnSinkCreationDialog* makVrf::DtSpawnSinkGuiManager::mySpawnSinkCreationDialog

protected

ExtraMapToTemplateUUID makVrf::DtSpawnSinkGuiManager::myExtraMapToTemplateUUID

protected

NextNumberMap makVrf::DtSpawnSinkGuiManager::myNextSinkNumber

protected

NextNumberMap makVrf::DtSpawnSinkGuiManager::myNextSpawnNumber

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfGuiCoreQt/spawnSinkGuiManager.h