display_groups_manager_interface.h

Go to the documentation of this file.

 
#ifndef SDK_VISMAN_DISPLAY_GROUPS_MANAGER_INTERFACE_H_
#define SDK_VISMAN_DISPLAY_GROUPS_MANAGER_INTERFACE_H_
 
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
 
namespace sdk {
namespace vis {
FWD_DECL_INTERFACE(ISceneDisplayGroupsManager);
FWD_DECL_INTERFACE(ISceneDisplayGroup);
 
enum DisplayGroupProperties
{
  kDisplayGroupProperty_ShortDescription, 
  kDisplayGroupProperty_FullDescription,  
  kDisplayGroupProperty_Name,             
  kDisplayGroupProperty_TypeName,         
  kDisplayGroupProperty_IsVisible,        
  kDisplayGroupProperty_SymbolScale,      
  kDisplayGroupProperty_DLIndex,          
  kDisplayGroupProperty_IsCovered,        
};
 
enum DisplayGroupCovered
{
  kDisplayGroupCovered_NotCovered,        
  kDisplayGroupCovered_PartiallyCovered,  
  kDisplayGroupCovered_FullyCovered,      
};
 
static const char kDisplayGroupView_Default[]              = "default";
static const char kDisplayGroupView_Default_Root[]         = "default.display_category";
static const char kDisplayGroupView_Default_Base[]         = "default.display_category.base";
static const char kDisplayGroupView_Default_Standard[]     = "default.display_category.standard";
static const char kDisplayGroupView_Default_Other[]        = "default.display_category.other";
static const char kDisplayGroupView_Default_RoutesInfo[]   = "default.routes_information";
static const char kDisplayGroupView_Default_MarinersInfo[] = "default.mariners_information";
static const char kDisplayGroupView_Default_Additional[]   = "default.additional_information";
static const char kDisplayGroupView_Default_Texts[]        = "default.texts";
 
static const wchar_t* kDisplayGroupType_ViewingGroupName = L"viewing_group";
static const wchar_t* kDisplayGroupType_TextGroupName    = L"texts";
 
class ISceneDisplayGroup : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetChildrenCount(SDKUInt32& count) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetChildGroup(SDKUInt32 idx, ISceneDisplayGroupSP& group) const throw() = 0;
 
  // ISDKProperties
  //virtual SDKResult SDK_CALLTYPE SetProperty(const SDKPropertyID& id, const SDKAny& value) throw() = 0;
  //virtual SDKResult SDK_CALLTYPE GetProperty(const SDKPropertyID& id, SDKAny& value) const throw() = 0;
 
  SDK_IMPLEMENT_IID(ISceneDisplayGroup)
  SDK_END_INTERFACE(ISceneDisplayGroup)
};
SDK_DECLARE_IID(ISceneDisplayGroup)
 
enum DisplayGroupsManagerProperties
{
  kDisplayGroupsManagerProperty_DisplayMode_Short, 
  kDisplayGroupsManagerProperty_DisplayMode,       
};
 
enum DisplayModeEnum
{
  kDisplayMode_Base_Minus    = 0, 
  kDisplayMode_Base          = 1, 
  kDisplayMode_Base_Plus     = 2, 
  kDisplayMode_Standard      = 3, 
  kDisplayMode_Standard_Plus = 4, 
  kDisplayMode_Full          = 5, 
  kDisplayMode_Unknown       = -1,
  kDisplayMode_Custom        = kDisplayMode_Unknown,
};
 
class ISceneDisplayGroupsManager : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetRoot(const SDKString& view_name,
    ISceneDisplayGroupSP& group) const throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE FindDisplayGroup(const SDKString& view_name,
    const SDKString& display_group_name, ISceneDisplayGroupSP& group) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddDisplayGroup(const SDKString& view_name, 
    const SDKString& display_group_name, const SDKString& parent_display_group_name,
    ISDKPropertiesSP& group) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RemoveDisplayGroup(const SDKString& view_name, 
    const SDKString& display_group_name) throw() = 0;
 
  // ISDKProperties
  //virtual SDKResult SDK_CALLTYPE SetProperty(const SDKPropertyID& id, const SDKAny& value) throw() = 0;
  //virtual SDKResult SDK_CALLTYPE GetProperty(const SDKPropertyID& id, SDKAny& value) const throw() = 0;
  
  SDK_IMPLEMENT_IID(ISceneDisplayGroupsManager)
  SDK_END_INTERFACE(ISceneDisplayGroupsManager)
};
SDK_DECLARE_IID(ISceneDisplayGroupsManager)
 
} // namespace vis
} // namespace sdk
 
#endif // SDK_VISMAN_DISPLAY_GROUPS_MANAGER_INTERFACE_H_