layers_manager_interface.h

Go to the documentation of this file.

 
#ifndef SDK_VISMAN_LAYERS_MANAGER_INTERFACE_H_
#define SDK_VISMAN_LAYERS_MANAGER_INTERFACE_H_
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/geometry/geometry_base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/enum/enum_interface.h>
#include <base/inc/interfaces/stream/stream_interface.h>
 
#include <visualizationlayer/inc/scene/layer_interface.h>
#include <visualizationlayer/inc/scene/renderer_interface.h>
#include "layers_manager_base_interface.h"
 
namespace sdk {
namespace vis {
 
FWD_DECL_INTERFACE(ISceneLayersManager);
FWD_DECL_INTERFACE(ISceneLayersEnumerator);
FWD_DECL_INTERFACE(ISceneLayer);
FWD_DECL_INTERFACE(ISceneLayersManagerUpdateParameters);
 
typedef SDKUInt64 SceneLayerID;
const SceneLayerID kSceneLayerID_Undefined = -1;
const SceneLayerID kSceneLayerID_Root = kSceneLayerID_Undefined;
 
typedef sdk::vis::scene::LayerPriority SceneLayerPriority;
const SceneLayerPriority kSceneLayerPriority_Chart_Decoration  = kSceneLayerBasePriority_Chart_Decoration;     
const SceneLayerPriority kSceneLayerPriority_OverRadar_Text    = kSceneLayerBasePriority_OverRadar + 3000.0f;  
const SceneLayerPriority kSceneLayerPriority_OverRadar_Points  = kSceneLayerBasePriority_OverRadar + 2000.0f;  
const SceneLayerPriority kSceneLayerPriority_OverRadar_Lines   = kSceneLayerBasePriority_OverRadar + 1000.0f;  
const SceneLayerPriority kSceneLayerPriority_OverRadar_Areas   = kSceneLayerBasePriority_OverRadar;            
const SceneLayerPriority kSceneLayerPriority_Radar             = kSceneLayerBasePriority_Radar;                
const SceneLayerPriority kSceneLayerPriority_UnderRadar_Text   = kSceneLayerBasePriority_UnderRadar + 3000.0f; 
const SceneLayerPriority kSceneLayerPriority_UnderRadar_Points = kSceneLayerBasePriority_UnderRadar + 2000.0f; 
const SceneLayerPriority kSceneLayerPriority_UnderRadar_Lines  = kSceneLayerBasePriority_UnderRadar + 1000.0f; 
const SceneLayerPriority kSceneLayerPriority_UnderRadar_Areas  = kSceneLayerBasePriority_UnderRadar;           
const SceneLayerPriority kSceneLayerPriority_NoData            = kSceneLayerBasePriority_NoData;               
const SceneLayerPriority kSceneLayerPriority_Undefined         = kSceneLayerBasePriority_Undefined;            
 
struct SceneLayerPriority_DictionaryItem
{
  char m_name[64];
  SceneLayerPriority m_priority;
};
static const SceneLayerPriority_DictionaryItem kSceneLayerPriority_Dictionary[] =
{
  { "kSceneLayerPriority_NoData",            kSceneLayerPriority_NoData },
  { "kSceneLayerPriority_UnderRadar_Areas",  kSceneLayerPriority_UnderRadar_Areas },
  { "kSceneLayerPriority_UnderRadar_Lines",  kSceneLayerPriority_UnderRadar_Lines },
  { "kSceneLayerPriority_UnderRadar_Points", kSceneLayerPriority_UnderRadar_Points },
  { "kSceneLayerPriority_UnderRadar_Text",   kSceneLayerPriority_UnderRadar_Text },
  { "kSceneLayerPriority_Radar",             kSceneLayerPriority_Radar },
  { "kSceneLayerPriority_OverRadar_Areas",   kSceneLayerPriority_OverRadar_Areas },
  { "kSceneLayerPriority_OverRadar_Lines",   kSceneLayerPriority_OverRadar_Lines },
  { "kSceneLayerPriority_OverRadar_Points",  kSceneLayerPriority_OverRadar_Points },
  { "kSceneLayerPriority_OverRadar_Text",    kSceneLayerPriority_OverRadar_Text },
  { "kSceneLayerPriority_Chart_Decoration",  kSceneLayerPriority_Chart_Decoration },
};
 
enum SceneLayerFlags
{
  kSceneLayerFlag_NoFlags             = kSceneLayerBaseFlag_NoFlags,             
  kSceneLayerFlag_NoClipping          = kSceneLayerBaseFlag_NoClipping,          
  kSceneLayerFlag_PortrayalDependent  = kSceneLayerBaseFlag_PortrayalDependent,  
  kSceneLayerFlag_ProjectionDependent = kSceneLayerBaseFlag_ProjectionDependent, 
  kSceneLayerFlag_DeferredRender      = kSceneLayerBaseFlag_DeferredRender,      
  kSceneLayerFlag_BindToViewport      = kSceneLayerBaseFlag_BindToViewport,      
  kSceneLayerFlag_OpaqueLayer         = 0x0200, 
  kSceneLayerFlag_Background          = 0x0400, 
  kSceneLayerFlag_Hidden              = 0x0800, 
  kSceneLayerFlag_ClearBeforeRender   = 0x1000, 
 
  kSceneLayerFlag_Charts              = kSceneLayerFlag_PortrayalDependent | 
                                        kSceneLayerFlag_ProjectionDependent |
                                        kSceneLayerFlag_NoClipping,
  kSceneLayerFlag_Dynamic             = kSceneLayerFlag_Charts | 
                                        kSceneLayerFlag_NoClipping,      
  kSceneLayerFlag_DynamicDeferred     = kSceneLayerFlag_Dynamic | 
                                        kSceneLayerFlag_DeferredRender,  
                                        
  kSceneLayerFlag_Max                 = kSceneLayerBaseFlag_Max 
};
 
static const wchar_t* kSceneLayerSet_TypeName_Chart = L"chart";
 
static const wchar_t* kSceneLayerSet_Default = kSceneLayerBaseSet_Default;
static const wchar_t* kSceneLayerSet_Radar   = kSceneLayerBaseSet_Radar;
static const wchar_t* kSceneLayerSet_Desktop = kSceneLayerBaseSet_Desktop;
static const wchar_t* kSceneLayerSet_Print   = kSceneLayerBaseSet_Print;
 
static const wchar_t* kSceneLayer_ChartDecoration  = kSceneLayerBaseName_ChartDecoration;
static const wchar_t* kSceneLayer_TG1              = kSceneLayerBaseName_TG1;
static const wchar_t* kSceneLayer_Chart            = kSceneLayerBaseName_Chart;
static const wchar_t* kSceneLayer_OverRadar        = kSceneLayerBaseName_OverRadar;
static const wchar_t* kSceneLayer_UnderRadar       = kSceneLayerBaseName_UnderRadar;
static const wchar_t* kSceneLayer_NoData           = kSceneLayerBaseName_NoData;
static const wchar_t* kSceneLayer_Overview         = kSceneLayerBaseName_Overview;
 
static const wchar_t* kSceneLayerRenderer_Root           = L"root";  // Just clears background.
static const wchar_t* kSceneLayerRenderer_Chart          = kSceneLayerBaseRenderer_Chart;
static const wchar_t* kSceneLayerRenderer_GroundingCheck = kSceneLayerBaseRenderer_GroundingCheck;
static const wchar_t* kSceneLayerRenderer_RouteCheck     = kSceneLayerBaseRenderer_RouteCheck;
 
static const wchar_t* kSceneLayerDeconflicter_Text = kSceneLayerBaseTextDeconflicter;
 
enum SceneLayersManagerUpdateParametersID
{
  kSceneLayersManagerUpdateParameter_IsForPrinting, 
  kSceneLayersManagerUpdateParameter_DropNameList,  
  kSceneLayersManagerUpdateParameter_PosX,          
  kSceneLayersManagerUpdateParameter_PosY,          
  kSceneLayersManagerUpdateParameter_Width,         
  kSceneLayersManagerUpdateParameter_Height,        
};
 
class ISceneLayersManagerUpdateParameters : public sdk::ISDKParameters
{
public:
  // No own methods, only ISDKParameters methods
 
  SDK_IMPLEMENT_IID(ISceneLayersManagerUpdateParameters)
    SDK_END_INTERFACE(ISceneLayersManagerUpdateParameters)
};
SDK_DECLARE_IID(ISceneLayersManagerUpdateParameters)
 
enum SceneLayersManagerProperties
{
  kSceneLayersManagerProperty_StateVersion, 
};
 
class ISceneLayersManager : public ISceneLayersManagerBase
{
public:
  virtual SDKResult SDK_CALLTYPE CreateLayer(
    const SDKString& layer_name,            
    const scene::LayerPriority& priority,   
    const SDKPointF2D& pos,                 
    const SDKSizeF& size,                   
    SDKUInt64 flags,                        
    const SDKString& portrayal_layer_name,  
    const SDKString& display_groups_filter, 
    const SDKAny& renderer,                 
    ISceneLayerSP& created_layer,           
    SceneLayerID* created_layer_id          
    ) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddLayer(
    const ISceneLayerSP& new_layer, 
    const SceneLayerID& parent_layer_id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE DeleteLayer(
    const SceneLayerID& layer_id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetLayers(
    ISceneLayersEnumeratorSP& layers) const throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE FindLayerByID(
    const SceneLayerID& layer_id, 
    ISceneLayerSP& layer) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE FindLayerByName(
    const SDKString& layer_name, 
    ISceneLayerSP& layer) const throw() = 0;
 
  // Declared in ISceneLayersManagerBase
  virtual SDKResult SDK_CALLTYPE LoadLayerDescriptions(
    const base::ISDKStreamSP& data) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetAvailableLayerSets(
    IEnumSDKStringSP& layer_set_names) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddLayerSet(
    const SDKString& layer_set_name) throw() = 0;
  
  // Declared in ISceneLayersManagerBase
  virtual SDKResult SDK_CALLTYPE Clear() throw() = 0;
 
  virtual SDKResult UpdateLayersManagerState(
    const ISceneLayersManagerSP& layers_manager,
    const ISceneLayersManagerUpdateParametersSP& parameters) = 0;
 
  // Declared in 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(ISceneLayersManager)
  SDK_END_INTERFACE(ISceneLayersManager)
};
SDK_DECLARE_IID(ISceneLayersManager)
 
enum SceneLayerProperties
{
  kSceneLayerProperty_ID           = kSceneLayerBaseProperty_ID,                 
  kSceneLayerProperty_Name         = kSceneLayerBaseProperty_Name,               
  kSceneLayerProperty_Priority     = kSceneLayerBaseProperty_Priority,           
  kSceneLayerProperty_Flags        = kSceneLayerBaseProperty_Flags,              
  kSceneLayerProperty_RendererType = kSceneLayerBaseProperty_RendererType,       
  kSceneLayerProperty_Renderer     = kSceneLayerBaseProperty_Renderer,           
  kSceneLayerProperty_DGroupFilter = kSceneLayerBaseProperty_DisplayGroupFilter, 
  kSceneLayerProperty_Opacity      = kSceneLayerBaseProperty_Opacity,            
  kSceneLayerProperty_Data         = kSceneLayerBaseProperty_Data,               
  kSceneLayerProperty_SetTypeName,            
  kSceneLayerProperty_PosX,                   
  kSceneLayerProperty_PosY,                   
  kSceneLayerProperty_Width,                  
  kSceneLayerProperty_Height,                 
  kSceneLayerProperty_RenderingAreaType,      
  kSceneLayerProperty_RenderingAreaWidth,     
  kSceneLayerProperty_RenderingAreaHeight,    
  kSceneLayerProperty_DeconflicterType,       
  kSceneLayerProperty_RenderOrder,            
  kSceneLayerProperty_RenderPriority,         
  kSceneLayerProperty_GroupIndex,             
  kSceneLayerProperty_ParentID,               
  kSceneLayerProperty_RendererObjectPriority, 
  kSceneLayerProperty_StateVersion,           
};
 
enum SceneLayerRenderingAreaType
{
  kSceneLayerRenderingAreaType_AsSet,                 
  kSceneLayerRenderingAreaType_WholeLayer,            
  kSceneLayerRenderingAreaType_ViewportMaxBound,      
  kSceneLayerRenderingAreaType_ViewportWindowRotated, 
  kSceneLayerRenderingAreaType_ViewportWindow,        
};
 
class ISceneLayer : public ISceneLayerBase
{
public:
  // Defined in ISceneLayerBase
  virtual SDKResult SDK_CALLTYPE GetName(SDKString& name) const throw() = 0;
 
  // Defined in ISceneLayerBase
  virtual SDKResult SDK_CALLTYPE SetDirty(bool is_dirty) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetDirty() const throw() = 0;
 
  // Defined in ISceneLayerBase
  virtual SDKResult SDK_CALLTYPE SetVisibility(bool is_visible) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetVisibility() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSubLayers(
    ISceneLayersEnumeratorSP& layers_enum) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetRenderer(
    const scene::IRendererSP& renderer) 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(ISceneLayer)
  SDK_END_INTERFACE(ISceneLayer)
};
SDK_DECLARE_IID(ISceneLayer)
 
class ISceneLayersEnumerator : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Next(ISceneLayerSP& layer) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(ISceneLayersEnumerator)
  SDK_END_INTERFACE(ISceneLayersEnumerator)
};
SDK_DECLARE_IID(ISceneLayersEnumerator)
 
enum SceneRendererParameters
{
  kSceneRendererParameter_First               = kSceneLayerBaseRendererParameter_SceneManagerName,
  kSceneRendererParameter_SceneManagerName    = kSceneLayerBaseRendererParameter_SceneManagerName,    
  kSceneRendererParameter_Projection          = kSceneLayerBaseRendererParameter_Projection,          
  kSceneRendererParameter_RotationAngle       = kSceneLayerBaseRendererParameter_RotationAngle,       
  kSceneRendererParameter_DPM                 = kSceneLayerBaseRendererParameter_DPM,                 
  kSceneRendererParameter_ChartPortrayalName  = kSceneLayerBaseRendererParameter_SymbolizationName,   
  kSceneRendererParameter_Symbolization       = kSceneLayerBaseRendererParameter_Symbolization,       
  kSceneRendererParameter_PortrayalParameters = kSceneLayerBaseRendererParameter_PortrayalParameters, 
  kSceneRendererParameter_DisplayListRef      = kSceneLayerBaseRendererParameter_DisplayListRef,      
  kSceneRendererParameter_IsClipByCoverage    = kSceneLayerBaseRendererParameter_IsClipByCoverage,    
  kSceneRendererParameter_IsChart             = kSceneLayerBaseRendererParameter_IsChart,             
  kSceneRendererParameter_Deconflict_Flag,        
  kSceneRendererParameter_SymbolSetCatalog,       
  kSceneRendererParameter_ViewportRectWidth,      
  kSceneRendererParameter_ViewportRectHeight,     
  kSceneRendererParameter_ViewportBoundWidth,     
  kSceneRendererParameter_ViewportBoundHeight,    
  kSceneRendererParameter_ViewportPath,           
  kSceneRendererParameter_RenderAreaWidth,        
  kSceneRendererParameter_RenderAreaHeight,       
  kSceneRendererParameter_AA_Mode,                
  kSceneRendererParameter_Text_AA_Mode,           
  kSceneRendererParameter_DisplayListID,          
  kSceneRendererParameter_RenderTarget,           
  kSceneRendererParameter_Max,
};
 
enum SceneRendererProperties
{
  kSceneRendererProperty_First   = kSceneLayerBaseRendererProperty_IsDirty,
  kSceneRendererProperty_IsDirty = kSceneLayerBaseRendererProperty_IsDirty, 
  kSceneRendererProperty_Data    = kSceneLayerBaseRendererProperty_Data,    
  kSceneRendererProperty_ClearBackground, 
  kSceneRendererProperty_Max,
};
 
} // namespace vis
} // namespace sdk
 
#endif // SDK_VISMAN_LAYERS_MANAGER_INTERFACE_H_