VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Public Attributes
makVrf::DtCreateObjectPaletteInterface Class Referenceabstract

Abstract interface for the object creation palette.

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

Public Types

enum  Roles {
  DescriptionRole = Qt::UserRole, CategoriesRole = Qt::UserRole + 1, VisibilityRole = Qt::UserRole + 2, RankRole = Qt::UserRole + 3,
  TopLevelItemRole = Qt::UserRole + 4, ShortNameRole = Qt::UserRole + 5
}
 

Public Member Functions

virtual ~DtCreateObjectPaletteInterface () override
 
virtual QString currentForce () const =0
 
virtual int currentForceType () const =0
 
virtual int forceTypeAtIndex (int) const =0
 
virtual std::vector< std::string > currentCategories () const =0
 
virtual std::string currentDeployedCountry () const =0
 
virtual int numForces () const =0
 
virtual int numCategories () const =0
 
virtual void addForce (const QString &, int, const QColor &, const std::string &countryCode, bool forceLayout=false)=0
 
virtual QString force (int) const =0
 
virtual bool hasForce (int) const =0
 
virtual bool hasDeployedCountries () const =0
 
virtual bool hasCategory (const QString &) const =0
 
virtual void resetVisuals ()=0
 
virtual void setHideCountries (const std::set< std::string > &)=0
 
virtual void setCategoriesFromCounts (const std::map< std::string, int > &counts, const std::set< std::string > &categoriesReferenced, int totalItems, const std::vector< std::string > &categoriesToResetTo=std::vector< std::string >(), const std::set< std::string > &allCategories=std::set< std::string >())=0
 
virtual void setCategories (const DtTagSelectorWidget::Categories &)=0
 
virtual void selectDeployedCountry (const std::string &)=0
 
virtual void initializeCountries ()=0
 
virtual void selectDeployedCountry (int)=0
 
virtual void selectForce (const QString &)=0
 
virtual void selectForce (int)=0
 
virtual void showForce (bool)=0
 
virtual void selectCategories (const std::vector< std::string > &)=0
 
virtual void clearCreateList ()=0
 
virtual void sortItems ()=0
 
virtual DtString topLevelCategory (int) const =0
 
virtual QTreeWidgetItem * itemFor (const DtCreateObjectPaletteItem &paletteItem, int force) const =0
 
virtual void sizeColumns ()=0
 
virtual void addItem (const DtCreateObjectPaletteItem &, int force)=0
 
virtual void addPaletteItem (const DtCreateObjectPaletteItem &)=0
 
virtual void removePaletteItem (const DtEntityMapperKey &key, bool matchesPattern=false)=0
 
virtual void filterItems ()=0
 
virtual const std::string & pageClassName () const =0
 
virtual void clearForces ()=0
 
virtual void clearDeployedCountries ()=0
 
virtual void clearCategories ()=0
 
virtual DtEntityMapperKey selectedObjectType () const =0
 
virtual std::vector
< DtEntityMapperKey > 		selectedObjects () const =0
 
virtual void selectObject (const DtEntityMapperKey &key)=0
 
- Public Member Functions inherited from makVrf::DtGenericPaletteInterface
virtual ~DtGenericPaletteInterface ()
 
virtual void clear ()=0
 
virtual void update ()=0
 
virtual void setEnabled (bool)=0
 
virtual bool initiallyVisible () const =0
 
virtual void aboutToShow ()=0
 

Public Attributes

boost::signals2::signal< void()> signal_closeEvent
 
boost::signals2::signal< void()> signal_paletteCleared
 
boost::signals2::signal< void()> signal_forceChanged
 
boost::signals2::signal< void(std::vector
< std::string >)> 		signal_categoriesChanged
 
boost::signals2::signal< void(std::string)> signal_deployedCountryChanged
 
boost::signals2::signal< void(const
DtEntityMapperKey &)> 		signal_createObject
 
boost::signals2::signal< void(const
DtEntityMapperKey &)> 		signal_executedFilter
 
boost::signals2::signal< void()> signal_itemsAdded
 
boost::signals2::signal< void(std::string,
const DtEntityMapperKey &)> 		signal_itemSelected
 
boost::signals2::signal< void(DtCreateObjectPaletteInterface *)> signal_updated
 
boost::signals2::signal< void()> signal_modelSetChanged
 

Member Enumeration Documentation

enum makVrf::DtCreateObjectPaletteInterface::Roles
Enumerator
DescriptionRole 
CategoriesRole 
VisibilityRole 
RankRole 
TopLevelItemRole 
ShortNameRole 

Constructor & Destructor Documentation

virtual makVrf::DtCreateObjectPaletteInterface::~DtCreateObjectPaletteInterface ( )
overridevirtual

Virtual DTOR.

Member Function Documentation

virtual QString makVrf::DtCreateObjectPaletteInterface::currentForce ( ) const
pure virtual

Returns currently selected force.

Implemented in makVrf::DtCreateObjectPalette.

virtual int makVrf::DtCreateObjectPaletteInterface::currentForceType ( ) const
pure virtual

Returns the current force type selected.

Implemented in makVrf::DtCreateObjectPalette.

virtual int makVrf::DtCreateObjectPaletteInterface::forceTypeAtIndex ( int  ) const
pure virtual

Force type at index.

Implemented in makVrf::DtCreateObjectPalette.

virtual std::vector<std::string> makVrf::DtCreateObjectPaletteInterface::currentCategories ( ) const
pure virtual

Returns currently selected category.

Implemented in makVrf::DtCreateObjectPalette.

virtual std::string makVrf::DtCreateObjectPaletteInterface::currentDeployedCountry ( ) const
pure virtual

Returns currently selected deployed country.

Implemented in makVrf::DtCreateObjectPalette.

virtual int makVrf::DtCreateObjectPaletteInterface::numForces ( ) const
pure virtual

Returns number of forces.

Implemented in makVrf::DtCreateObjectPalette.

virtual int makVrf::DtCreateObjectPaletteInterface::numCategories ( ) const
pure virtual

Returns number of categories.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::addForce ( const QString &  ,
int  ,
const QColor &  ,
const std::string &  countryCode,
bool  forceLayout = false 
)
pure virtual

Adds new force and force type.

Implemented in makVrf::DtCreateObjectPalette.

virtual QString makVrf::DtCreateObjectPaletteInterface::force ( int  ) const
pure virtual

Returns the force string at the specified index.

Implemented in makVrf::DtCreateObjectPalette.

virtual bool makVrf::DtCreateObjectPaletteInterface::hasForce ( int  ) const
pure virtual

Returns true if the specified force exists.

Implemented in makVrf::DtCreateObjectPalette.

virtual bool makVrf::DtCreateObjectPaletteInterface::hasDeployedCountries ( ) const
pure virtual

Returns true if supports deployed countries.

Implemented in makVrf::DtCreateObjectPalette.

virtual bool makVrf::DtCreateObjectPaletteInterface::hasCategory ( const QString &  ) const
pure virtual

Returns true if the specified deployed country exists.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::resetVisuals ( )
pure virtual

Reset icon visuals.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::setHideCountries ( const std::set< std::string > &  )
pure virtual

If has a countries list, hides the given countries.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::setCategoriesFromCounts ( const std::map< std::string, int > &  counts,
const std::set< std::string > &  categoriesReferenced,
int  totalItems,
const std::vector< std::string > &  categoriesToResetTo = std::vector< std::string >(),
const std::set< std::string > &  allCategories = std::set< std::string >() 
)
pure virtual

Given a map of the counts of categories and how many there are for those counts, select them based on rank. The categoriesReferenced is the full set of categories.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::setCategories ( const DtTagSelectorWidget::Categories &  )
pure virtual

Sets the categories to be displayed to the vector of categories. If a category is used as a filter will keep that filter turned on. The map is a weighted order of how the items should be displayed.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::selectDeployedCountry ( const std::string &  )
pure virtual

Selects deployed country by name.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::initializeCountries ( )
pure virtual

Initializes the country list.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::selectDeployedCountry ( int  )
pure virtual

Selects deployed country by index.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::selectForce ( const QString &  )
pure virtual

Selects force by name.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::selectForce ( int  )
pure virtual

Selects force by index.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::showForce ( bool  )
pure virtual

Show/hide force.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::selectCategories ( const std::vector< std::string > &  )
pure virtual

Selects categories by name. If no categories are given then all are unselected.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::clearCreateList ( )
pure virtual

Clears the create list.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::sortItems ( )
pure virtual

Sorts the childrem of the top level items.

Implemented in makVrf::DtCreateObjectPalette.

virtual DtString makVrf::DtCreateObjectPaletteInterface::topLevelCategory ( int  ) const
pure virtual

Returns the category string selected at the level.

Implemented in makVrf::DtCreateObjectPalette.

virtual QTreeWidgetItem* makVrf::DtCreateObjectPaletteInterface::itemFor ( const DtCreateObjectPaletteItem &  paletteItem,
int  force 
) const
pure virtual

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::sizeColumns ( )
pure virtual

Sizes the columns to contents.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::addItem ( const DtCreateObjectPaletteItem &  ,
int  force 
)
pure virtual

If the object model key type and force is not already in the list, add it.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::addPaletteItem ( const DtCreateObjectPaletteItem &  )
pure virtual

Adds the new item into the logic. Be sure to re-execute filter if need be to get these items to show up in the dialog.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::removePaletteItem ( const DtEntityMapperKey &  key,
bool  matchesPattern = false 
)
pure virtual

Removes an item from the internal list for any key that matches (or matches pattern of) the supplied key.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::filterItems ( )
pure virtual

Filters items.

virtual const std::string& makVrf::DtCreateObjectPaletteInterface::pageClassName ( ) const
pure virtual

Get the class name of the page.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::clearForces ( )
pure virtual

Clear forces combo.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::clearDeployedCountries ( )
pure virtual

Clear deployed countries combo.

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::clearCategories ( )
pure virtual

Clear categories combo.

Implemented in makVrf::DtCreateObjectPalette.

virtual DtEntityMapperKey makVrf::DtCreateObjectPaletteInterface::selectedObjectType ( ) const
pure virtual

Currently selected object type.

Implemented in makVrf::DtCreateObjectPalette.

virtual std::vector<DtEntityMapperKey> makVrf::DtCreateObjectPaletteInterface::selectedObjects ( ) const
pure virtual

If there is more than one, all selected objects (or just the one)

Implemented in makVrf::DtCreateObjectPalette.

virtual void makVrf::DtCreateObjectPaletteInterface::selectObject ( const DtEntityMapperKey &  key)
pure virtual

Select the given object and force, if force is not -1, in which case leave the currently selected force set.

Implemented in makVrf::DtCreateObjectPalette.

Member Data Documentation

boost::signals2::signal<void ()> makVrf::DtCreateObjectPaletteInterface::signal_closeEvent
boost::signals2::signal<void ()> makVrf::DtCreateObjectPaletteInterface::signal_paletteCleared
boost::signals2::signal<void ()> makVrf::DtCreateObjectPaletteInterface::signal_forceChanged
boost::signals2::signal<void (std::vector<std::string>)> makVrf::DtCreateObjectPaletteInterface::signal_categoriesChanged
boost::signals2::signal<void (std::string)> makVrf::DtCreateObjectPaletteInterface::signal_deployedCountryChanged
boost::signals2::signal<void (const DtEntityMapperKey&)> makVrf::DtCreateObjectPaletteInterface::signal_createObject
boost::signals2::signal<void (const DtEntityMapperKey&)> makVrf::DtCreateObjectPaletteInterface::signal_executedFilter
boost::signals2::signal<void ()> makVrf::DtCreateObjectPaletteInterface::signal_itemsAdded
boost::signals2::signal<void (std::string, const DtEntityMapperKey&)> makVrf::DtCreateObjectPaletteInterface::signal_itemSelected
boost::signals2::signal<void (DtCreateObjectPaletteInterface*)> makVrf::DtCreateObjectPaletteInterface::signal_updated
boost::signals2::signal<void ()> makVrf::DtCreateObjectPaletteInterface::signal_modelSetChanged
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)