scene_manager_gl_interface.h

Go to the documentation of this file.

 
#ifndef SDK_VISMAN_SCENE_MANAGER_GL_INTERFACE_H_
#define SDK_VISMAN_SCENE_MANAGER_GL_INTERFACE_H_
 
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>
#include <base/inc/interfaces/enum/enum_interface.h>
#include <base/inc/geometry/geometry_base_types.h>
#include <geometry/inc/geometry/geometry.h>
#include <geometry/inc/coordinate_systems/crs_projection.h>
#include <datalayer/inc/geodatabase/gdb_const.h>
#include <datalayer/inc/geodatabase/gdb_dataset.h>
#include <datalayer/inc/geodatabase/gdb_workspace.h>
#include <datalayer/inc/geodatabase/gdb_feature.h>
#include <visualizationlayer/inc/vis_const.h>
#include <visualizationlayer/inc/visman/scene_manager_base_interface.h>
#include <visualizationlayer/inc/visman/scene_control_base_interface.h>
#include <visualizationlayer/inc/visman/scene_highlight_base_interface.h>
#include <visualizationlayer/inc/vismangl/data_sources_manager_interface.h>
#include <visualizationlayer/inc/vismangl/scene_layers_manager_gl_interface.h>
#include <visualizationlayer/inc/gl2d/gl2d_texture_interface.h>
 
// Reuse Visman (software) interfaces.
SDK_VIS_BEGIN_NAMESPACE
 
// defined in visman scene_manager_base_interface.h
FWD_DECL_INTERFACE(ISceneManagerBase);
// defined in visman scene_control_base_interface.h
FWD_DECL_INTERFACE(ISceneControlBase);
// defined in visman scene_highlight_base_interface.h
FWD_DECL_INTERFACE(ISceneHighlightBase);
 
SDK_VIS_END_NAMESPACE
 
SDK_VISGL_BEGIN_NAMESPACE
 
// defined here
FWD_DECL_INTERFACE(ISceneManagerGL);
FWD_DECL_INTERFACE(ISceneControlGL);
FWD_DECL_INTERFACE(ISceneHighlightGL);
// callback interfaces
FWD_DECL_INTERFACE(ISceneManagerGLCallback);
FWD_DECL_INTERFACE(IDatasetSelectionCallbackGL);
FWD_DECL_INTERFACE(ISelectedDatasetsListGL);
 
// defined not here 
FWD_DECL_INTERFACE(IDataSourcesManager);
FWD_DECL_INTERFACE(ISceneInformationGL);
 
enum SceneManagerGLInitialParameter
{
  kSceneManagerGLInitialParameter_Name          = sdk::vis::kSceneManagerBaseInitialParameter_Name,          
  kSceneManagerGLInitialParameter_SceneWidth    = sdk::vis::kSceneManagerBaseInitialParameter_SceneWidth,    
  kSceneManagerGLInitialParameter_SceneHeight   = sdk::vis::kSceneManagerBaseInitialParameter_SceneHeight,   
  kSceneManagerGLInitialParameter_ResolutionDPM = sdk::vis::kSceneManagerBaseInitialParameter_ResolutionDPM, 
  kSceneManagerGLInitialParameter_Flags         = sdk::vis::kSceneManagerBaseInitialParameter_Flags,         
  kSceneManagerGLInitialParameter_LayerSetName  = sdk::vis::kSceneManagerBaseInitialParameter_LayerSetName,  
  kSceneManagerGLInitialParameter_GLType,                         
  kSceneManagerGLInitialParameter_SharableContext,                
  kSceneManagerGLInitialParameter_ExtCtx_GL2DThread,              
  kSceneManagerGLInitialParameter_ExtCtx_xxxGetGlProcAddr,        
  kSceneManagerGLInitialParameter_ExtCtx_GlLibHandle,             
  kSceneManagerGLInitialParameter_ExtCreatedGlContext,            
  kSceneManagerGLInitialParameter_SceneManagerGL,                 
  kSceneManagerGLInitialParameter_TextureFormat,                  
  kSceneManagerGLInitialParameter_Projection,                     
  kSceneManagerGLInitialParameter_RootShadersFolder,              
  kSceneManagerGLInitialParameter_GLDataCache_On,                 
  kSceneManagerGLInitialParameter_GLDataCache_RootFolder,         
  kSceneManagerGLInitialParameter_GLDataCache_MaxSizeMb,          
  kSceneManagerGLInitialParameter_GLDataCache_ClearThreshold,     
  kSceneManagerGLInitialParameter_GLDataCache_ClearMinRatio,      
  kSceneManagerGLInitialParameter_GLDataCache_Type,               
  kSceneManagerGLInitialParameter_TextsBlurringOn,                
  kSceneManagerGLInitialParameter_UpdateDisplayMode,              
  kSceneManagerGLInitialParameter_BufferedDisplay_ExtendPercents, 
  kSceneManagerGLInitialParameter_BufferedDisplay_ExtendPixels,   
};
 
enum SceneManagerGLType
{
  kSceneManagerGLType_Auto       = 0, 
  kSceneManagerGLType_OpenGL     = 1, 
  kSceneManagerGLType_OpenGL_ES2 = 2, 
};
 
enum GLDataCacheType
{
  kGLDataCacheType_Files = 1,                  
  kGLDataCacheType_SQL = 2,                    
};
 
enum UpdateDisplayMode
{
  kUpdateDisplayMode_Direct   = 1, 
  kUpdateDisplayMode_Buffered = 2, 
};
 
enum SceneManagerGLProperty
{
  kSceneManagerGLProperty_Name         = sdk::vis::kSceneManagerBaseProperty_Name,        
  kSceneManagerGLProperty_MinScale     = sdk::vis::kSceneManagerBaseProperty_MinScale,    
  kSceneManagerGLProperty_MaxScale     = sdk::vis::kSceneManagerBaseProperty_MaxScale,    
  kSceneManagerGLProperty_SceneWidth   = sdk::vis::kSceneManagerBaseProperty_SceneWidth,  
  kSceneManagerGLProperty_SceneHeight  = sdk::vis::kSceneManagerBaseProperty_SceneHeight, 
  kSceneManagerGLProperty_SceneExtendPercents,                  
  kSceneManagerGLProperty_BackgroundColorARGB,                  
  kSceneManagerGLProperty_Projection,                           
  kSceneManagerGLProperty_Canvas,                               
  kSceneManagerGLProperty_SymbolCatalog,                        
  //kSceneManagerGLProperty_FixedScales,                          ///< Set list of fixed scales to limit possible chart scale values.
  //kSceneManagerGLProperty_UseFixedScales,                       ///< When set only scales from list set through kSceneManagerPropertyID_FixedScales are used.
  //kSceneManagerGLProperty_CloneMode,                            ///< Allows to adjust scene manager clone behavior (enum SceneManagerCloneMode).
  kSceneManagerGLProperty_SymbolTypeFilter,                     
  kSceneManagerGLProperty_CollectBuildStat,                     
  kSceneManagerGLProperty_SceneBuildFlags,                      
  kSceneManagerGLProperty_SceneDisplayFlags,                    
  kSceneManagerGLProperty_LatLimitMin,                          
  kSceneManagerGLProperty_LatLimitMax,                          
  kSceneManagerGLProperty_GraphicCache_On,                      
  kSceneManagerGLProperty_GraphicCache_MaxAppMemoryMb,          
  kSceneManagerGLProperty_GraphicCache_MaxDatasets,             
  kSceneManagerGLProperty_GLDataCache_On,                       
  kSceneManagerGLProperty_GLDataCache_Path,                     
  kSceneManagerGLProperty_GLDataCache_MaxSizeMb,                
  kSceneManagerGLProperty_GLDataCache_Type,                     
  kSceneManagerGLProperty_DisplayMode,                          
  kSceneManagerGLProperty_BufferedDisplay_ExtendPercents,       
  kSceneManagerGLProperty_BufferedDisplay_ExtendPixels,         
  kSceneManagerGLProperty_WaitRenderingTimeoutMs,               
  kSceneManagerGLProperty_LocalScaleLongitude,                  
  kSceneManagerGLProperty_LocalScaleLatitude,                   
  kSceneManagerGLProperty_ProjectionCentralLongitude,           
  kSceneManagerGLProperty_ProjectionCentralLatitude,            
  kSceneManagerGLProperty_ProjectionCentralPointChangeMode,     
  kSceneManagerGLProperty_ProjectionCentralPointChangeMinScale, 
  kSceneManagerGLProperty_ProjectionCentralLongitudeMaxDiff,    
  kSceneManagerGLProperty_ProjectionCentralLatitudeMaxDiff,     
  kSceneManagerGLProperty_DonotCoverInPaint,                    
  kSceneManagerGLProperty_PutObjectsAboveRadar,                 
  kSceneManagerGLProperty_User = sdk::vis::kSceneManagerBaseProperty_User, 
};
 
enum SceneBuildFlags
{
  kSceneBuildFlags_NoFlags             = 0x0000, 
  kSceneBuildFlags_SuppressTextDodging = 0x0001, 
};
 
enum SceneDisplayFlags
{
  kSceneDisplayFlags_NoFlags = 0x0000, 
};
 
enum SceneHighlightParameters
{
  kSceneGLHighlightParameters_Feature         = sdk::vis::kSceneHighlightParametersBase_Feature,         
  kSceneGLHighlightParameters_Geometry        = sdk::vis::kSceneHighlightParametersBase_Geometry,        
  kSceneGLHighlightParameters_FullFeatureID   = sdk::vis::kSceneHighlightParametersBase_FullFeatureID,   
  kSceneGLHighlightParameters_DatasourceName  = sdk::vis::kSceneHighlightParametersBase_DatasourceName,  
  kSceneGLHighlightParameters_DatasetName     = sdk::vis::kSceneHighlightParametersBase_DatasetName,     
  kSceneGLHighlightParameters_DatasetID       = sdk::vis::kSceneHighlightParametersBase_DatasetID,       
  kSceneGLHighlightParameters_FeatureOID      = sdk::vis::kSceneHighlightParametersBase_FeatureOID,      
  kSceneGLHighlightParameters_PointIndex      = sdk::vis::kSceneHighlightParametersBase_PointIndex,      
  kSceneGLHighlightParameters_PointSymbolType = sdk::vis::kSceneHighlightParametersBase_PointSymbolType, 
  kSceneGLHighlightParameters_IsViewportData   
};
 
enum SceneGLHighlightPointSymbolType
{
  kSceneGLHighlightPointSymbolType_Cross  = sdk::vis::kSceneHighlightPointSymbolTypeBase_Cross,  
  kSceneGLHighlightPointSymbolType_Open   = sdk::vis::kSceneHighlightPointSymbolTypeBase_Open,   
  kSceneGLHighlightPointSymbolType_Circle = sdk::vis::kSceneHighlightPointSymbolTypeBase_Circle, 
};
 
enum ProjectionCentralPointChangeMode
{
  kProjectionCentralPointChangeMode_Off     = 0,  
  kProjectionCentralPointChangeMode_PosDiff = 1,  
};
 
class ISceneHighlightGL : public sdk::vis::ISceneHighlightBase
{};
 
class ISceneManagerGL : public sdk::vis::ISceneManagerBase
{
public:
  virtual SDKResult SDK_CALLTYPE Initialize(
    ISDKParameters* initial_parameters) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Shutdown(
    SDKUInt32 shutdown_timeout_ms) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetPortrayalManager(
    sdk::vis::IPortrayalManagerSP& portrayal_manager) const throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE GetDisplayGroupsManager(
    sdk::vis::ISceneDisplayGroupsManagerSP& dgroups_manager) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetDataSourceManager(
    sdk::visgl::IDataSourcesManagerSP& data_sources_manager) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSceneLayersManager(
    sdk::visgl::ISceneLayersManagerGLSP& layers_manager) const throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE GetSceneControl(
    sdk::visgl::ISceneControlGLSP& scene_control) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE GetSceneHighlight(
    sdk::visgl::ISceneHighlightGLSP& scene_highlight) 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(ISceneManagerGL)
  SDK_END_INTERFACE(ISceneManagerGL)
};
SDK_DECLARE_IID(ISceneManagerGL)
 
enum SceneGLParameter
{
  kSceneGLParameter_Lat   = sdk::vis::kSceneParametersBase_Lat,   
  kSceneGLParameter_Lon   = sdk::vis::kSceneParametersBase_Lon,   
  kSceneGLParameter_Scale = sdk::vis::kSceneParametersBase_Scale, 
  kSceneGLParameter_RotationAngle,                                
  kSceneGLParameter_UseReferencePoint,                            
  kSceneGLParameter_ReferencePoint_X,                             
  kSceneGLParameter_ReferencePoint_Y,                             
};
 
enum SceneGLRenderingFlags
{
  kSceneGLRenderingFlag_NoFlags        = 0x0000, 
  kSceneGLRenderingFlag_ForceRendering = 0x0001, 
  kSceneGLRenderingFlag_WaitRendering  = 0x0002, 
};
 
enum SceneGLUpdateDisplayFlags
{
  kSceneGLUpdateDisplayFlag_NoFlags      = 0x0000, 
  kSceneGLUpdateDisplayFlag_ForceUpdate  = 0x0001, 
  kSceneGLUpdateDisplayFlag_NoBuffering  = 0x0002, 
  kSceneGLUpdateDisplayFlag_OnlyBuffered = 0x0004, 
};
 
enum SceneGLUpdatedSceneStatus
{
  kSceneGLUpdatedSceneStatus_NoStatus  = 0x0000, 
  kSceneGLUpdatedSceneStatus_Ready     = 0x0001, 
  kSceneGLUpdatedSceneStatus_Preparing = 0x0002, 
  kSceneGLUpdatedSceneStatus_Skipped   = 0x0100, 
};
 
enum SceneGLResetFlags
{
  kSceneGLResetFlag_Datasources      = 0x0001, 
  kSceneGLResetFlag_SceneData        = 0x0002, 
  kSceneGLResetFlag_GraphicData      = 0x0004, 
  kSceneGLResetFlag_LastSceneInfo    = 0x0008, 
  kSceneGLResetFlag_GLDataDiskCache  = 0x0010, 
  kSceneGLResetFlag_GL2DCache        = 0x0020, 
  kSceneGLResetFlag_Data =                     
    kSceneGLResetFlag_SceneData |
    kSceneGLResetFlag_GraphicData |
    kSceneGLResetFlag_LastSceneInfo,
  kSceneGLResetFlag_WaitFinished  = 0x0100, 
};
 
enum SceneGLInfoFlags
{
  kSceneGLInfoFlag_NoFlags = 0x0000, 
};
 
class ISceneControlGL : public sdk::vis::ISceneControlBase
{
public:
  virtual SDKResult SDK_CALLTYPE GetSceneParameters(
    sdk::ISDKParametersSP& scene_parameters) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE SetSceneParameters(
    const sdk::ISDKParametersSP& scene_parameters) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE StartRendering(
    SDKUInt64 start_rendering_flags,
    const SDKAny* cookie) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE UpdateDisplay(
    SDKUInt64 update_display_flags,
    SDKUInt64& updated_scene_status) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE ResetScene(
    SDKUInt64 reset_scene_flags) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetLastSceneInfo(
    SDKUInt64 get_scene_info_flags,
    sdk::visgl::ISceneInformationGLSP& scene_info) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE LockCanvas() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE UnLockCanvas() const throw() = 0;
  
  SDK_IMPLEMENT_IID(ISceneControlGL)
  SDK_END_INTERFACE(ISceneControlGL)
};
SDK_DECLARE_IID(ISceneControlGL)
 
enum SceneManagerGLEvent
{
  kSceneManagerGLEvent_RenderingStarted        = 1, 
  kSceneManagerGLEvent_RenderingPartlyFinished = 2, 
  kSceneManagerGLEvent_RenderingFinished       = 3, 
  kSceneManagerGLEvent_RenderingFailed         = 4, 
  kSceneManagerGLEvent_RenderingSkipped        = 5, 
  kSceneManagerGLEvent_DisplayFinished         =  6, 
  kSceneManagerGLEvent_DisplayFailed           =  7, 
  kSceneManagerGLEvent_DisplaySkipped          =  8, 
  kSceneManagerGLEvent_NewPortrayalsFound      =  9, 
  kSceneManagerGLEvent_StateUpdated            = 10, 
};
 
enum SceneManagerGLEventParameter
{
  kSceneManagerGLEventParameter_Flags          = 0, 
  kSceneManagerGLEventParameter_SceneLayerName = 1, 
  kSceneManagerGLEventParameter_DataViewName   = 2, 
  kSceneManagerGLEventParameter_BuildTime      = 3, 
  kSceneManagerGLEventParameter_BuildRound     = 4, 
  kSceneManagerGLEventParameter_UserCookie     = 5, 
  kSceneManagerGLEventParameter_DisplayRound   = 6, 
  kSceneManagerGLEventParameter_StateID        = 7, 
  kSceneManagerGLEventParameter_StateInfo      = 8, 
  kSceneManagerGLEventParameter_Ratio          = 9, 
};
 
enum SceneManagerGLEventFlags
{
  kSceneManagerGLEventFlags_NoFlags                    = 0x00000000, 
  kSceneManagerGLEventFlags_ChartReady                 = 0x00000001, 
  kSceneManagerGLEventFlags_RenderingStopped           = 0x00000010, 
  kSceneManagerGLEventFlags_RenderingFailed            = 0x00000020, 
  kSceneManagerGLEventFlags_RenderingDeferred          = 0x00000040, 
  kSceneManagerGLEventFlags_OnlyParams                 = 0x00000080, 
  kSceneManagerGLEventFlags_NothingSelected            = 0x00000100, 
  kSceneManagerGLEventFlags_NothingCovered             = 0x00000200, 
  kSceneManagerGLEventFlags_SameCoverResults           = 0x00000400, 
  kSceneManagerGLEventFlags_RecoveredFromCache         = 0x00000800, 
  kSceneManagerGLEventFlags_DataviewRendererFinished   = 0x00001000, 
  kSceneManagerGLEventFlags_SceneLayerRendererFinished = 0x00002000, 
  kSceneManagerGLEventFlags_SomeGLDataPrepared         = 0x00004000, 
  kSceneManagerGLEventFlags_AllGLDataPrepared          = 0x00008000, 
  kSceneManagerGLEventFlags_BuilderManagerEvent        = 0x00010000, 
  kSceneManagerGLEventFlags_DataviewEvent              = 0x00020000, 
  kSceneManagerGLEventFlags_SceneLayerEvent            = 0x00040000, 
  kSceneManagerGLEventFlags_GLDataPrepareEvent         = 0x00080000, 
};
 
enum SceneManagerGLEventState
{
  kSceneManagerGLEventState_Undefined                   = 0, 
  kSceneManagerGLEventState_SceneLayerBuildTaskStarted  = 1, 
  kSceneManagerGLEventState_DataViewRenderTaskStarted   = 2, 
  kSceneManagerGLEventState_DatasetsSelected            = 3, 
  kSceneManagerGLEventState_TaskStateChanged            = 4, 
  kSceneManagerGLEventState_DataViewRenderTaskFinished  = 5, 
  kSceneManagerGLEventState_SceneLayerBuildTaskFinished = 6, 
};
 
enum PortrayalsFoundAnswers
{
  kPortrayalsFoundAnswer_Skip               = 1, 
  kPortrayalsFoundAnswer_Install            = 2, 
  kPortrayalsFoundAnswer_InstallAndApply    = 3, 
  kPortrayalsFoundAnswer_SkipAll            = 4, 
  kPortrayalsFoundAnswer_InstallAll         = 5, 
  kPortrayalsFoundAnswer_InstallAndApplyAll = 6, 
};
 
class ISceneManagerGLCallback : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE OnEvent(SDKUInt64 id, 
    const SDKAny& param, SDKAny& ret_value) throw() = 0;
  
  SDK_IMPLEMENT_IID(ISceneManagerGLCallback)
  SDK_END_INTERFACE(ISceneManagerGLCallback)
};
SDK_DECLARE_IID(ISceneManagerGLCallback)
 
enum SelectDatasetsParametersGL
{
  kSelectDatasetsParameterGL_Region,              
  kSelectDatasetsParameterGL_Scale,               
  kSelectDatasetsParameterGL_DataSources,         
  kSelectDatasetsParameterGL_PortrayalParameters, 
  kSelectDatasetsParameterGL_Projection,          
  kSelectDatasetsParameterGL_UserCookie,          
  kSelectDatasetsParameterGL_SceneLayerName,      
};
 
class IDatasetSelectionCallbackGL : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE SpecifySelection(
    const sdk::ISDKParametersSP& params, 
    sdk::visgl::ISelectedDatasetsListGLSP& list) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE FinalizeSelection(
    sdk::ISDKParametersSP& params, 
    sdk::visgl::ISelectedDatasetsListGLSP& list) throw() = 0;
 
  SDK_IMPLEMENT_IID(IDatasetSelectionCallbackGL)
  SDK_END_INTERFACE(IDatasetSelectionCallbackGL)
};
SDK_DECLARE_IID(IDatasetSelectionCallbackGL)
 
enum SelectedDatasetPropertyGL
{
  kSelectedDatasetPropertyGL_DataSourceReference, 
  kSelectedDatasetPropertyGL_DataSourceName,      
  kSelectedDatasetPropertyGL_DatasetReference,    
  kSelectedDatasetPropertyGL_Priority,            
  kSelectedDatasetPropertyGL_DataSourcePriority,  
  kSelectedDatasetPropertyGL_InternalRef,         
  kSelectedDatasetPropertyGL_InternalSubRef,      
};
 
class ISelectedDatasetsListGL : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Count(SDKUInt32& count) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetDataset(SDKUInt32 index, 
    sdk::ISDKPropertiesSP& props) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RemoveDataset(SDKUInt32 index) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddDataset(const sdk::ISDKComponentSP& dataset, 
    sdk::ISDKProperties** props) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE InsertDataset(const sdk::ISDKComponentSP& dataset, 
    double priority, sdk::ISDKProperties** props) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Clear() throw() = 0;
 
  SDK_IMPLEMENT_IID(ISelectedDatasetsListGL)
  SDK_END_INTERFACE(ISelectedDatasetsListGL)
};
SDK_DECLARE_IID(ISelectedDatasetsListGL)
 
SDK_VISGL_END_NAMESPACE
 
#endif // SDK_VISMAN_SCENE_MANAGER_GL_INTERFACE_H_