VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
makVrf::DtVrfSelectionHandler Class Reference

Functionality added to allow developers to more easily get information about currently selected items. More...

Inheritance diagram for makVrf::DtVrfSelectionHandler:
Inheritance graph
[legend]

Public Member Functions

 DtVrfSelectionHandler (makVrv::DtDe &)
virtual ~DtVrfSelectionHandler ()
virtual void currentSelectionChanged (const makVrv::DtSelectionManager::IdSet &selected)
 Calls down to specific managers to request information for current selection.
virtual std::vector< std::string > getSelectedNames () const
 Returns a list of the currently selected names.
virtual std::vector< std::string > getSelectedNames (const makVrv::DtSelectionManager::IdSet &) const
virtual std::vector
< makVrv::DtSimEntry * > 
getSelectedEntries () const
 Returns a list of the currently selected sim entries.
virtual std::vector
< makVrv::DtSimEntry * > 
getSelectedEntries (const makVrv::DtSelectionManager::IdSet &) const
virtual bool allObjectsAreVrfSimulated (const makVrv::DtSelectionManager::IdSet &) const
 Returns true if all objects in set are VRF simulated.
virtual bool objectIsVrfSimulated (makVrv::DtUniqueID) const
 Returns true if specified object is VRF simulated.
virtual const
makVrv::DtStateView
< makVrv::DtVrlinkSimulatedBaseState > * 
getVrlinkSimulatedState (makVrv::DtUniqueID id) const
virtual DtEntityType getEntityTypeFromUniqueID (makVrv::DtUniqueID id) const
 Returns the DtEntityType object associated with the DtUniqueID argument.
virtual void selectItemsInScreenBox (makVrv::DtChannel &channel, int minX, int minY, int maxX, int maxY, const makVrv::DtSelectionManager::IdSet &mergeWith=makVrv::DtSelectionManager::IdSet(), bool requestTaskSets=true)
 Selects all the items found within the bounding box as defined by the screen.
virtual bool isWithinScreenBounds (makVrv::DtChannel &, const makVrv::DtUniqueID &id, const makVrv::DtVrlinkSimulatedBaseState *, int minX, int minY, int maxX, int maxY) const
 Returns true if the current item is withing the supplied screen bounds.
virtual makVrv::DtUniqueID sceneObjectIdFromElementId (makVrv::DtChannel &channel, const makVrv::DtUniqueID &elementID) const
virtual void setLastDatabaseLocation (const DtVector &)
 Sets the last database location. Will also signal the last database location has been changed.
virtual const DtVectorlastDatabaseLocation () const
 Returns the last database location set.
virtual void setAllowNonVrfItemsToBeManipulated (bool)
 Set to true to allow non-Vrf items to be manipulated (act as simulated by vrf). Default is false.
virtual bool allowNonVrfItemsToBeManipulated () const
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor.
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor.

Static Public Member Functions

static DtVrfSelectionHandlerinstance (makVrv::DtDe &de)
 Returns instance of the DtVrfSelectionHandler.

Public Attributes

boost::signal< void(const
makVrv::DtSelectionManager::IdSet
&selected)> 
signal_currentSelectionChanged
boost::signal< void(const
DtVector &)> 
signal_lastDatabaseLocationSet

Protected Member Functions

virtual void slot_onCurrentSelectionChanged (const makVrv::DtSelectionManager::IdSet &selected, const makVrv::DtSelectionManager::IdSet &deselected)
virtual void slot_onObjectEntryAdded (makVrv::DtSimObjectEntry &)
virtual void slot_onSimStateAdded (makVrv::DtSimObjectEntry &entry)
 When a state is added, if there is a base vrlink state and it does not have the marking text or entity type, reforce the update.
virtual void slot_onStateViewUpdated (makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)
virtual void slot_deInitialized (makVrv::DtDe &)

Protected Attributes

makVrv::DtDemyDe
makVrv::DtSelectionManager::IdSet myLastSelection
DtVrfStateViewCollectionManagermyStateViewCollectionManager
DtVector myLastDatabaseLocation
bool myAllowNonVrfItemsToBeManipulated

Detailed Description

Functionality added to allow developers to more easily get information about currently selected items.

Constructor & Destructor Documentation

makVrf::DtVrfSelectionHandler::DtVrfSelectionHandler ( makVrv::DtDe )
virtual makVrf::DtVrfSelectionHandler::~DtVrfSelectionHandler ( )
virtual

Member Function Documentation

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

Returns instance of the DtVrfSelectionHandler.

virtual void makVrf::DtVrfSelectionHandler::currentSelectionChanged ( const makVrv::DtSelectionManager::IdSet selected)
virtual

Calls down to specific managers to request information for current selection.

virtual std::vector<std::string> makVrf::DtVrfSelectionHandler::getSelectedNames ( ) const
virtual

Returns a list of the currently selected names.

virtual std::vector<std::string> makVrf::DtVrfSelectionHandler::getSelectedNames ( const makVrv::DtSelectionManager::IdSet ) const
virtual
virtual std::vector<makVrv::DtSimEntry*> makVrf::DtVrfSelectionHandler::getSelectedEntries ( ) const
virtual

Returns a list of the currently selected sim entries.

virtual std::vector<makVrv::DtSimEntry*> makVrf::DtVrfSelectionHandler::getSelectedEntries ( const makVrv::DtSelectionManager::IdSet ) const
virtual
virtual bool makVrf::DtVrfSelectionHandler::allObjectsAreVrfSimulated ( const makVrv::DtSelectionManager::IdSet ) const
virtual

Returns true if all objects in set are VRF simulated.

virtual bool makVrf::DtVrfSelectionHandler::objectIsVrfSimulated ( makVrv::DtUniqueID  ) const
virtual

Returns true if specified object is VRF simulated.

virtual const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* makVrf::DtVrfSelectionHandler::getVrlinkSimulatedState ( makVrv::DtUniqueID  id) const
virtual
virtual DtEntityType makVrf::DtVrfSelectionHandler::getEntityTypeFromUniqueID ( makVrv::DtUniqueID  id) const
virtual

Returns the DtEntityType object associated with the DtUniqueID argument.

if no entity type is found, it returns a nullType entity type

virtual void makVrf::DtVrfSelectionHandler::selectItemsInScreenBox ( makVrv::DtChannel channel,
int  minX,
int  minY,
int  maxX,
int  maxY,
const makVrv::DtSelectionManager::IdSet mergeWith = makVrv::DtSelectionManager::IdSet(),
bool  requestTaskSets = true 
)
virtual

Selects all the items found within the bounding box as defined by the screen.

z coordinate is meaningless. If resetCurrentSelection is false, keeps selection and adds new items to it. Using the supplied ID set, will merge in selection by inverting selected items (i.e. if one would be selected in the screen box, and it is selected in the supplied selection box, it will be deselected), or add new items.

virtual bool makVrf::DtVrfSelectionHandler::isWithinScreenBounds ( makVrv::DtChannel ,
const makVrv::DtUniqueID id,
const makVrv::DtVrlinkSimulatedBaseState ,
int  minX,
int  minY,
int  maxX,
int  maxY 
) const
virtual

Returns true if the current item is withing the supplied screen bounds.

virtual makVrv::DtUniqueID makVrf::DtVrfSelectionHandler::sceneObjectIdFromElementId ( makVrv::DtChannel channel,
const makVrv::DtUniqueID elementID 
) const
virtual
virtual void makVrf::DtVrfSelectionHandler::setLastDatabaseLocation ( const DtVector )
virtual

Sets the last database location. Will also signal the last database location has been changed.

virtual const DtVector& makVrf::DtVrfSelectionHandler::lastDatabaseLocation ( ) const
virtual

Returns the last database location set.

virtual void makVrf::DtVrfSelectionHandler::setAllowNonVrfItemsToBeManipulated ( bool  )
virtual

Set to true to allow non-Vrf items to be manipulated (act as simulated by vrf). Default is false.

virtual bool makVrf::DtVrfSelectionHandler::allowNonVrfItemsToBeManipulated ( ) const
virtual
virtual void makVrf::DtVrfSelectionHandler::slot_onCurrentSelectionChanged ( const makVrv::DtSelectionManager::IdSet selected,
const makVrv::DtSelectionManager::IdSet deselected 
)
protectedvirtual
virtual void makVrf::DtVrfSelectionHandler::slot_onObjectEntryAdded ( makVrv::DtSimObjectEntry )
protectedvirtual
virtual void makVrf::DtVrfSelectionHandler::slot_onSimStateAdded ( makVrv::DtSimObjectEntry entry)
protectedvirtual

When a state is added, if there is a base vrlink state and it does not have the marking text or entity type, reforce the update.

virtual void makVrf::DtVrfSelectionHandler::slot_onStateViewUpdated ( makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  )
protectedvirtual
virtual void makVrf::DtVrfSelectionHandler::slot_deInitialized ( makVrv::DtDe )
protectedvirtual

Member Data Documentation

boost::signal<void (const makVrv::DtSelectionManager::IdSet& selected)> makVrf::DtVrfSelectionHandler::signal_currentSelectionChanged
boost::signal<void (const DtVector&)> makVrf::DtVrfSelectionHandler::signal_lastDatabaseLocationSet
makVrv::DtDe& makVrf::DtVrfSelectionHandler::myDe
protected
makVrv::DtSelectionManager::IdSet makVrf::DtVrfSelectionHandler::myLastSelection
protected
DtVrfStateViewCollectionManager* makVrf::DtVrfSelectionHandler::myStateViewCollectionManager
protected
DtVector makVrf::DtVrfSelectionHandler::myLastDatabaseLocation
protected
bool makVrf::DtVrfSelectionHandler::myAllowNonVrfItemsToBeManipulated
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)