VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes
makVrv::DtItemsListInterface Class Referenceabstract

Interface for display the objects, terrains, observers in the scene in a list. More...

Inheritance diagram for makVrv::DtItemsListInterface:
Inheritance graph
[legend]

Public Member Functions

virtual void addSubTypeTopLevelItem (const DtElementAttributes::ElementSubtypes &subType, const std::string &displayName, int index, const std::string &icon)=0
 Add a top level item which has subtype items as children(Friendly, Opposing, Munitions, etc). More...
 
virtual void addSubTypeTopLevelItem (const DtElementAttributes::ElementSubtypes &subType, const std::string &displayName, int index, double r, double g, double b)=0
 Add a top level item which has subtype items as children(Friendly, Opposing, Munitions, etc). More...
 
virtual void addSubTypeItem (const DtElementAttributes::ElementSubtypes &subType, DtElementID elementId, const std::string &displayName)=0
 Add a subtype item(Friendly, Opposing, Munitions, etc). More...
 
virtual bool hasSubTypeTopLevelItem (const DtElementAttributes::ElementSubtypes &subType)=0
 Check if the tree has a subtype top level item with the given subType. More...
 
virtual void addTypeTopLevelItem (const DtElementEntry::ElementType &type, const std::string &displayName, int index, const std::string &icon)=0
 Add a top level item which has type items as children(Observers, Tactical Graphics, etc). More...
 
virtual void addTypeItem (const DtElementEntry::ElementType &type, DtElementID elementId, const std::string &displayName)=0
 Add a tye item(Observers, Tactical Graphics, etc). More...
 
virtual bool hasTypeTopLevelItem (const DtElementEntry::ElementType &type)=0
 Check if the tree has a type top level item with the given type. More...
 
virtual void sortItems ()=0
 Sort all the tree widget items under subType top level item and type top level item. More...
 
virtual void removeItem (DtElementID id)=0
 Remove an item with the given element Id from the tree. More...
 
virtual void renameItem (DtElementID id, const std::string &newName)=0
 Rename an item with the new name. More...
 
virtual void updateItemDamageState (DtElementID id, int damageState)=0
 Update the damage state of the item, update the icon mostly. More...
 
virtual void updateItemSubType (DtElementID id, int subType)=0
 Update the subType of the item, change of force type etc. More...
 
virtual void setSelectedItems (const DtSelectionManager::IdSet &selected, const DtSelectionManager::IdSet &deselected)=0
 Update the current selection of the tree widget. More...
 

Public Attributes

boost::signal< void(DtElementID)> signal_itemAttachRequested
 
boost::signal< void(std::vector
< DtElementID >)> 
signal_itemSelectionChanged
 

Detailed Description

Interface for display the objects, terrains, observers in the scene in a list.

Used by DtObjectsListWidget, DtTerrainListWidget, DtObserversListWidget.

Member Function Documentation

virtual void makVrv::DtItemsListInterface::addSubTypeTopLevelItem ( const DtElementAttributes::ElementSubtypes subType,
const std::string &  displayName,
int  index,
const std::string &  icon 
)
pure virtual

Add a top level item which has subtype items as children(Friendly, Opposing, Munitions, etc).

Parameters
subTypeThe subtype of the child items.
displayNameThe display name of the top level item.
indexThe index of the top level item in the tree.
iconThe icon of the item, empty string means no icon.

Implemented in makVrv::DtItemsListWidget.

virtual void makVrv::DtItemsListInterface::addSubTypeTopLevelItem ( const DtElementAttributes::ElementSubtypes subType,
const std::string &  displayName,
int  index,
double  r,
double  g,
double  b 
)
pure virtual

Add a top level item which has subtype items as children(Friendly, Opposing, Munitions, etc).

Parameters
subTypeThe subtype of the child items.
displayNameThe display name of the top level item.
indexThe index of the top level item in the tree.
rThe red color of the icon if the icon is generated by the color.
gThe red color of the icon if the icon is generated by the color.
bThe red color of the icon if the icon is generated by the color.

Implemented in makVrv::DtItemsListWidget.

virtual void makVrv::DtItemsListInterface::addSubTypeItem ( const DtElementAttributes::ElementSubtypes subType,
DtElementID  elementId,
const std::string &  displayName 
)
pure virtual

Add a subtype item(Friendly, Opposing, Munitions, etc).

Parameters
subTypeThe subtype of the item
elementIdThe elementId of the item.
displayNameThe display name of the item.
iconThe icon of the item, empty string means no icon.
rThe red color of the icon[0,1].
gThe red color of the icon[0,1].
bThe red color of the icon[0,1].

Implemented in makVrv::DtItemsListWidget.

virtual bool makVrv::DtItemsListInterface::hasSubTypeTopLevelItem ( const DtElementAttributes::ElementSubtypes subType)
pure virtual

Check if the tree has a subtype top level item with the given subType.

Parameters
subTypeThe subtype of the item

Implemented in makVrv::DtItemsListWidget.

virtual void makVrv::DtItemsListInterface::addTypeTopLevelItem ( const DtElementEntry::ElementType type,
const std::string &  displayName,
int  index,
const std::string &  icon 
)
pure virtual

Add a top level item which has type items as children(Observers, Tactical Graphics, etc).

Parameters
typeThe type of the child items.
displayNameThe display name of the top level item.
indexThe index of the top level item in the tree.
iconThe icon of the item, empty string means no icon.

Implemented in makVrv::DtItemsListWidget.

virtual void makVrv::DtItemsListInterface::addTypeItem ( const DtElementEntry::ElementType type,
DtElementID  elementId,
const std::string &  displayName 
)
pure virtual

Add a tye item(Observers, Tactical Graphics, etc).

Parameters
typeThe type of the item
elementIdThe elementId of the item.
displayNameThe display name of the item.
iconThe icon of the item, empty string means no icon.
rThe red color of the icon[0,1].
gThe red color of the icon[0,1].
bThe red color of the icon[0,1].

Implemented in makVrv::DtItemsListWidget.

virtual bool makVrv::DtItemsListInterface::hasTypeTopLevelItem ( const DtElementEntry::ElementType type)
pure virtual

Check if the tree has a type top level item with the given type.

Parameters
typeThe type of the item

Implemented in makVrv::DtItemsListWidget.

virtual void makVrv::DtItemsListInterface::sortItems ( )
pure virtual

Sort all the tree widget items under subType top level item and type top level item.

Implemented in makVrv::DtItemsListWidget, makVrv::DtTerrainListWidget, makVrv::DtObjectsListWidget, and makVrv::DtObserversListWidget.

virtual void makVrv::DtItemsListInterface::removeItem ( DtElementID  id)
pure virtual

Remove an item with the given element Id from the tree.

Implemented in makVrv::DtItemsListWidget.

virtual void makVrv::DtItemsListInterface::renameItem ( DtElementID  id,
const std::string &  newName 
)
pure virtual

Rename an item with the new name.

Parameters
newNameThe new name of the item.

Implemented in makVrv::DtItemsListWidget.

virtual void makVrv::DtItemsListInterface::updateItemDamageState ( DtElementID  id,
int  damageState 
)
pure virtual

Update the damage state of the item, update the icon mostly.

Parameters
damageStateDtDamageState enum.

Implemented in makVrv::DtItemsListWidget.

virtual void makVrv::DtItemsListInterface::updateItemSubType ( DtElementID  id,
int  subType 
)
pure virtual

Update the subType of the item, change of force type etc.

Parameters
subTypeDtElementAttributes::ElementSubtypes enum.

Implemented in makVrv::DtItemsListWidget.

virtual void makVrv::DtItemsListInterface::setSelectedItems ( const DtSelectionManager::IdSet selected,
const DtSelectionManager::IdSet deselected 
)
pure virtual

Update the current selection of the tree widget.

Implemented in makVrv::DtItemsListWidget.

Member Data Documentation

boost::signal<void(DtElementID)> makVrv::DtItemsListInterface::signal_itemAttachRequested
boost::signal<void (std::vector<DtElementID>)> makVrv::DtItemsListInterface::signal_itemSelectionChanged

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)