scene_layers_manager_gl_interface.h

Go to the documentation of this file.

 
#ifndef SDK_VISMAN_SCENE_LAYERS_MANAGER_GL_INTERFACE_H_
#define SDK_VISMAN_SCENE_LAYERS_MANAGER_GL_INTERFACE_H_
 
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/enum/enum_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>
#include <base/inc/interfaces/stream/stream_interface.h>
#include <visualizationlayer/inc/vis_const.h>
#include <visualizationlayer/inc/visman/layers_manager_base_interface.h>
 
SDK_VISGL_BEGIN_NAMESPACE
 
// defined here
FWD_DECL_INTERFACE(ISceneLayersManagerGL);
FWD_DECL_INTERFACE(ISceneLayerGL);
FWD_DECL_INTERFACE(ISceneLayerGLEnumerator);
FWD_DECL_INTERFACE(ISceneGLRenderer)
 
typedef float SceneLayerGLPriority;
const SceneLayerGLPriority kSceneLayerGLPriority_Chart_Decoration  = sdk::vis::kSceneLayerBasePriority_Chart_Decoration; 
const SceneLayerGLPriority kSceneLayerGLPriority_Highlight         = sdk::vis::kSceneLayerBasePriority_Highlight       ; 
const SceneLayerGLPriority kSceneLayerGLPriority_OverChart         = sdk::vis::kSceneLayerBasePriority_OverChart       ; 
const SceneLayerGLPriority kSceneLayerGLPriority_OverRadar         = sdk::vis::kSceneLayerBasePriority_OverRadar       ; 
const SceneLayerGLPriority kSceneLayerGLPriority_Radar             = sdk::vis::kSceneLayerBasePriority_Radar           ; 
const SceneLayerGLPriority kSceneLayerGLPriority_UnderRadar        = sdk::vis::kSceneLayerBasePriority_UnderRadar      ; 
const SceneLayerGLPriority kSceneLayerGLPriority_Chart             = sdk::vis::kSceneLayerBasePriority_Chart           ; 
const SceneLayerGLPriority kSceneLayerGLPriority_TG1               = sdk::vis::kSceneLayerBasePriority_TG1             ; 
const SceneLayerGLPriority kSceneLayerGLPriority_Overview          = sdk::vis::kSceneLayerBasePriority_Overview        ; 
const SceneLayerGLPriority kSceneLayerGLPriority_NoData            = sdk::vis::kSceneLayerBasePriority_NoData          ; 
const SceneLayerGLPriority kSceneLayerGLPriority_Undefined         = sdk::vis::kSceneLayerBasePriority_Undefined       ; 
 
struct SceneLayerGLPriority_DictionaryItem
{
  char                 m_name[64];
  SceneLayerGLPriority m_priority;
};
 
static const SceneLayerGLPriority_DictionaryItem kSceneLayerGLPriority_Dictionary[] =
{
  { "kSceneLayerGLPriority_NoData",            kSceneLayerGLPriority_NoData },           
  { "kSceneLayerGLPriority_Overview",          kSceneLayerGLPriority_Overview },       
  { "kSceneLayerGLPriority_TG1",               kSceneLayerGLPriority_TG1 },           
  { "kSceneLayerGLPriority_Chart",             kSceneLayerGLPriority_Chart },        
  { "kSceneLayerGLPriority_UnderRadar",        kSceneLayerGLPriority_UnderRadar },       
  { "kSceneLayerGLPriority_Radar",             kSceneLayerGLPriority_Radar },            
  { "kSceneLayerGLPriority_OverRadar",         kSceneLayerGLPriority_OverRadar },         
  { "kSceneLayerGLPriority_OverChart",         kSceneLayerGLPriority_OverChart },        
  { "kSceneLayerGLPriority_Highlight",         kSceneLayerGLPriority_Highlight },        
  { "kSceneLayerGLPriority_Chart_Decoration",  kSceneLayerGLPriority_Chart_Decoration },
};
 
enum SceneLayerGLTypes
{
  kSceneLayerGLType_Default           = 0, 
  kSceneLayerGLType_Radar             = 1, 
  kSceneLayerGLType_RadarBitmap       = 2, 
  kSceneLayerGLType_GroundingCheck    = 3, 
};
 
enum SceneLayerGLFlags
{
  kSceneLayerGLFlag_NoFlags              = sdk::vis::kSceneLayerBaseFlag_NoFlags,             
  kSceneLayerGLFlag_NoClipping           = sdk::vis::kSceneLayerBaseFlag_NoClipping,          
  kSceneLayerGLFlag_PortrayalDependent   = sdk::vis::kSceneLayerBaseFlag_PortrayalDependent,  
  kSceneLayerGLFlag_ProjectionDependent  = sdk::vis::kSceneLayerBaseFlag_ProjectionDependent, 
  kSceneLayerGLFlag_DeferredRender       = sdk::vis::kSceneLayerBaseFlag_DeferredRender,      
  kSceneLayerGLFlag_BindToViewport       = sdk::vis::kSceneLayerBaseFlag_BindToViewport,      
  kSceneLayerGLFlag_UsePortrayal         = 0x00001000, 
  kSceneLayerGLFlag_OwnshipDependent     = 0x00002000, 
  kSceneLayerGLFlag_ProgressiveRendering = 0x00010000, 
  kSceneLayerGLFlag_PrepareAtPaint       = 0x00020000, 
  kSceneLayerGLFlag_Overview             = 0x00100000, 
  kSceneLayerGLFlag_MainChart            = 0x00200000, 
  kSceneLayerGLFlag_Max                  = 0x10000000  
};
 
enum SceneLayerGLParameters
{
  kSceneLayerGLParameter_DatasourceName = 0, 
};
 
static const wchar_t* kSceneLayerSet_Default = L"default-gl";
 
static const wchar_t* kSceneLayerName_Chart    = L"chart";
static const wchar_t* kSceneLayerName_Overview = L"overview";
static const wchar_t* kSceneLayerName_NoData   = L"nodata";
 
static const wchar_t* kSceneRenderer_Default = L"default";
 
class ISceneLayersManagerGL : public sdk::vis::ISceneLayersManagerBase
{
public:
  virtual SDKResult SDK_CALLTYPE LoadLayerDescriptions(
    const sdk::base::ISDKStreamSP& data) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Clear() throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddLayer(
    const SDKString&            scene_layer_name,      
    SDKUInt32                   scene_layer_type,      
    const SceneLayerGLPriority& priority,              
    SDKUInt64                   flags,                 
    const SDKAny&               renderer,              
    const ISDKParametersSP&     additional_params,     
    ISceneLayerGL**             scene_layer            
  ) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE DeleteLayer(
    const SDKString& scene_layer_name) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetLayers(
    ISceneLayerGLEnumeratorSP& scene_layers) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE FindLayer(
    const SDKString& scene_layer_name,
    ISceneLayerGLSP& scene_layer) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SwitchChartLayerSet(
    const SDKString& layer_set_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(ISceneLayersManagerGL)
  SDK_END_INTERFACE(ISceneLayersManagerGL)
};
SDK_DECLARE_IID(ISceneLayersManagerGL)
 
enum SceneLayerGLProperties
{
  kSceneLayerGLProperty_ID                 = sdk::vis::kSceneLayerBaseProperty_ID,                 
  kSceneLayerGLProperty_Name               = sdk::vis::kSceneLayerBaseProperty_Name,               
  kSceneLayerGLProperty_Type               = sdk::vis::kSceneLayerBaseProperty_Type,               
  kSceneLayerGLProperty_Priority           = sdk::vis::kSceneLayerBaseProperty_Priority,           
  kSceneLayerGLProperty_Flags              = sdk::vis::kSceneLayerBaseProperty_Flags,              
  kSceneLayerGLProperty_RendererType       = sdk::vis::kSceneLayerBaseProperty_RendererType,       
  kSceneLayerGLProperty_Renderer           = sdk::vis::kSceneLayerBaseProperty_Renderer,           
  kSceneLayerGLProperty_DisplayGroupFilter = sdk::vis::kSceneLayerBaseProperty_DisplayGroupFilter, 
  kSceneLayerGLProperty_Opacity            = sdk::vis::kSceneLayerBaseProperty_Opacity,            
  kSceneLayerGLProperty_Data               = sdk::vis::kSceneLayerBaseProperty_Data,               
  kSceneLayerGLProperty_OverRadarPriority  = 10, 
  kSceneLayerGLProperty_PortrayData        = 11, 
  kSceneLayerGLProperty_LayerSetName       = 12, 
  kSceneLayerGLProperty_LayerTypeName      = 13, 
  kSceneLayerGLProperty_DataSourceNames    = 14, 
  kSceneLayerGLProperty_DataSources        = 15, 
  kSceneLayerGLProperty_Max,                     
};
 
struct SceneLayerGLProperty_DictionaryItem
{
  char                   m_name[64];
  SceneLayerGLProperties m_property;
};
 
static const SceneLayerGLProperty_DictionaryItem kSceneLayerGLProperty_Dictionary[] =
{
  { "kSceneLayerGLProperty_ID",                  kSceneLayerGLProperty_ID                 },
  { "kSceneLayerGLProperty_Name",                kSceneLayerGLProperty_Name               },
  { "kSceneLayerGLProperty_Type",                kSceneLayerGLProperty_Type               },
  { "kSceneLayerGLProperty_Priority",            kSceneLayerGLProperty_Priority           },
  { "kSceneLayerGLProperty_Flags",               kSceneLayerGLProperty_Flags              },
  { "kSceneLayerGLProperty_RendererType",        kSceneLayerGLProperty_RendererType       },
  { "kSceneLayerGLProperty_Renderer",            kSceneLayerGLProperty_Renderer           }, 
  { "kSceneLayerGLProperty_DisplayGroupFilter",  kSceneLayerGLProperty_DisplayGroupFilter },
  { "kSceneLayerGLProperty_Opacity",             kSceneLayerGLProperty_Opacity            },
  { "kSceneLayerGLProperty_Data",                kSceneLayerGLProperty_Data               },
  { "kSceneLayerGLProperty_OverRadarPriority",   kSceneLayerGLProperty_OverRadarPriority  },
  { "kSceneLayerGLProperty_PortrayData",         kSceneLayerGLProperty_PortrayData        },
  { "kSceneLayerGLProperty_LayerSetName",        kSceneLayerGLProperty_LayerSetName       }, 
  { "kSceneLayerGLProperty_LayerTypeName",       kSceneLayerGLProperty_LayerTypeName      },
  { "kSceneLayerGLProperty_DataSourceNames",     kSceneLayerGLProperty_DataSourceNames    },
  { "kSceneLayerGLProperty_DataSources",         kSceneLayerGLProperty_DataSources        }
};
 
class ISceneLayerGL : public sdk::vis::ISceneLayerBase
{
public:
  virtual SDKResult SDK_CALLTYPE GetName(SDKString& name) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDirty(bool is_dirty) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetDirty() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetVisibility(bool is_visible) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetVisibility() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE BindDataSource(
    const SDKString& data_source_name) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE UnbindDataSource(
    const SDKString& data_source_name) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE EnumDataSources(
    IEnumSDKStringSP& data_source_names) 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(ISceneLayerGL)
  SDK_END_INTERFACE(ISceneLayerGL)
};
SDK_DECLARE_IID(ISceneLayerGL)
 
class ISceneLayerGLEnumerator : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Next(ISceneLayerGLSP& scene_layer) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(ISceneLayerGLEnumerator)
  SDK_END_INTERFACE(ISceneLayerGLEnumerator)
};
SDK_DECLARE_IID(ISceneLayerGLEnumerator)
 
enum SceneGLRendererInitializeParameters
{
  kSceneGLRendererInitializeParameter_SymbolizationFactory, 
};
 
enum SceneGLRendererParameters
{
  kSceneGLRendererParameter_First               = sdk::vis::kSceneLayerBaseRendererParameter_SceneManagerName,
  kSceneGLRendererParameter_SceneManagerName    = sdk::vis::kSceneLayerBaseRendererParameter_SceneManagerName,    
  kSceneGLRendererParameter_SceneLayerName      = sdk::vis::kSceneLayerBaseRendererParameter_SceneLayerName,      
  kSceneGLRendererParameter_Projection          = sdk::vis::kSceneLayerBaseRendererParameter_Projection,          
  kSceneGLRendererParameter_RotationAngle       = sdk::vis::kSceneLayerBaseRendererParameter_RotationAngle,       
  kSceneGLRendererParameter_DPM                 = sdk::vis::kSceneLayerBaseRendererParameter_DPM,                 
  kSceneGLRendererParameter_SymbolizationName   = sdk::vis::kSceneLayerBaseRendererParameter_SymbolizationName,   
  kSceneGLRendererParameter_Symbolization       = sdk::vis::kSceneLayerBaseRendererParameter_Symbolization,       
  kSceneGLRendererParameter_PortrayalParameters = sdk::vis::kSceneLayerBaseRendererParameter_PortrayalParameters, 
  kSceneGLRendererParameter_DisplayListRef      = sdk::vis::kSceneLayerBaseRendererParameter_DisplayListRef,      
  kSceneGLRendererParameter_IsClipByCoverage    = sdk::vis::kSceneLayerBaseRendererParameter_IsClipByCoverage,    
  kSceneGLRendererParameter_IsChart             = sdk::vis::kSceneLayerBaseRendererParameter_IsChart,             
  kSceneGLRendererParameter_SceneRectWidth,   
  kSceneGLRendererParameter_SceneRectHeight,  
  kSceneGLRendererParameter_SceneBoundWidth,  
  kSceneGLRendererParameter_SceneBoundHeight, 
  kSceneGLRendererParameter_Max,
};
 
enum SceneGLRendererProperties
{
  kSceneGLRendererProperty_First   = sdk::vis::kSceneLayerBaseRendererProperty_IsDirty,
  kSceneGLRendererProperty_IsDirty = sdk::vis::kSceneLayerBaseRendererProperty_IsDirty, 
  kSceneGLRendererProperty_Data    = sdk::vis::kSceneLayerBaseRendererProperty_Data,    
  kSceneGLRendererProperty_Max,
};
 
class ISceneGLRenderer : public ISDKProperties
{
public:
  virtual SDKResult GetName(SDKString& name) const = 0;
  virtual SDKResult Initialize(const ISDKParametersSP& params) = 0;
  virtual SDKResult Render(const ISDKParametersSP& params) = 0;
  virtual SDKResult Cancel() = 0;
  virtual SDKResult ClearCachedData() = 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(ISceneGLRenderer)
  SDK_END_INTERFACE(ISceneGLRenderer)
};
SDK_DECLARE_IID(ISceneGLRenderer)
 
SDK_VISGL_END_NAMESPACE
 
#endif // SDK_VISMAN_SCENE_LAYERS_MANAGER_GL_INTERFACE_H_