NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
scene_manager_gl_interface.h File Reference

Describes all interfaces for controlling visualization. More...

#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>

Go to the source code of this file.

Data Structures

class  ISceneManagerGL
 Interface for scene manager setup. More...
 
class  ISceneControlGL
 Interface for scene manager control. More...
 
class  ISceneManagerGLCallback
 Scene manager callback interface. More...
 
class  IDatasetSelectionCallbackGL
 Scene manager dataset selection callback interface. More...
 
class  ISelectedDatasetsListGL
 Dataset list interface used with IDatasetSelectionCallbackGL. More...
 

Enumerations

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
}
 Initialization parameters for the SceneManagerGL (used with ISceneManagerGLInitialParameters). More...
 
enum  SceneManagerGLType { kSceneManagerGLType_Auto = 0, kSceneManagerGLType_OpenGL = 1, kSceneManagerGLType_OpenGL_ES2 = 2 }
 Scene Manager graphic library type. More...
 
enum  GLDataCacheType { kGLDataCacheType_Files = 1, kGLDataCacheType_SQL = 2 }
 Types of GL data cache. More...
 
enum  UpdateDisplayMode { kUpdateDisplayMode_Direct = 1, kUpdateDisplayMode_Buffered = 2 }
 List of possible UpdateDisplay modes. More...
 
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_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
}
 Scene Manager properties. More...
 
enum  SceneBuildFlags { kSceneBuildFlags_NoFlags = 0x0000, kSceneBuildFlags_SuppressTextDodging = 0x0001 }
 List of possible build flags (set through kSceneManagerGLProperty_SceneBuildFlags). More...
 
enum  SceneDisplayFlags { kSceneDisplayFlags_NoFlags = 0x0000 }
 List of possible display flags (set through kSceneManagerGLProperty_SceneDisplayFlags). More...
 
enum  SceneHighlightParameters {
  kSceneHighlightParameters_Feature = kSceneHighlightParametersBase_Feature, kSceneHighlightParameters_Geometry = kSceneHighlightParametersBase_Geometry, kSceneHighlightParameters_FullFeatureID = kSceneHighlightParametersBase_FullFeatureID, kSceneHighlightParameters_DatasourceName = kSceneHighlightParametersBase_DatasourceName,
  kSceneHighlightParameters_DatasetName = kSceneHighlightParametersBase_DatasetName, kSceneHighlightParameters_DatasetID = kSceneHighlightParametersBase_DatasetID, kSceneHighlightParameters_FeatureOID = kSceneHighlightParametersBase_FeatureOID, kSceneHighlightParameters_PointIndex = kSceneHighlightParametersBase_PointIndex,
  kSceneHighlightParameters_PointSymbolType = kSceneHighlightParametersBase_PointSymbolType, 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
}
 Scene highlight parameters. More...
 
enum  SceneGLHighlightPointSymbolType { kSceneGLHighlightPointSymbolType_Cross = sdk::vis::kSceneHighlightPointSymbolTypeBase_Cross, kSceneGLHighlightPointSymbolType_Open = sdk::vis::kSceneHighlightPointSymbolTypeBase_Open, kSceneGLHighlightPointSymbolType_Circle = sdk::vis::kSceneHighlightPointSymbolTypeBase_Circle }
 Scene highlight point symbol types. More...
 
enum  ProjectionCentralPointChangeMode { kProjectionCentralPointChangeMode_Off = 0, kProjectionCentralPointChangeMode_PosDiff = 1 }
 Scene projection central point automatic change modes. More...
 
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
}
 Scene parameters. More...
 
enum  SceneGLRenderingFlags { kSceneGLRenderingFlag_NoFlags = 0x0000, kSceneGLRenderingFlag_ForceRendering = 0x0001, kSceneGLRenderingFlag_WaitRendering = 0x0002 }
 Scene rendering flags. More...
 
enum  SceneGLUpdateDisplayFlags { kSceneGLUpdateDisplayFlag_NoFlags = 0x0000, kSceneGLUpdateDisplayFlag_ForceUpdate = 0x0001, kSceneGLUpdateDisplayFlag_NoBuffering = 0x0002, kSceneGLUpdateDisplayFlag_OnlyBuffered = 0x0004 }
 Update display flags. More...
 
enum  SceneGLUpdatedSceneStatus { kSceneGLUpdatedSceneStatus_NoStatus = 0x0000, kSceneGLUpdatedSceneStatus_Ready = 0x0001, kSceneGLUpdatedSceneStatus_Preparing = 0x0002, kSceneGLUpdatedSceneStatus_Skipped = 0x0100 }
 Updated scene statuses. More...
 
enum  SceneGLResetFlags {
  kSceneGLResetFlag_Datasources = 0x0001, kSceneGLResetFlag_SceneData = 0x0002, kSceneGLResetFlag_GraphicData = 0x0004, kSceneGLResetFlag_LastSceneInfo = 0x0008,
  kSceneGLResetFlag_GLDataDiskCache = 0x0010, kSceneGLResetFlag_GL2DCache = 0x0020, kSceneGLResetFlag_Data, kSceneGLResetFlag_WaitFinished = 0x0100
}
 Reset scene flags (specifies which cached data to release). More...
 
enum  SceneGLInfoFlags { kSceneGLInfoFlag_NoFlags = 0x0000 }
 Scene info retrieval flags. More...
 
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
}
 Scene manager event IDs. More...
 
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
}
 Scene manager SceneLayersUpdated event parameters. More...
 
enum  SceneManagerGLEventFlags { ,
  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
}
 Scene manager SceneManagerGLEvent event flags. More...
 
enum  SceneManagerGLEventState {
  kSceneManagerGLEventState_Undefined = 0, kSceneManagerGLEventState_SceneLayerBuildTaskStarted = 1, kSceneManagerGLEventState_DataViewRenderTaskStarted = 2, kSceneManagerGLEventState_DatasetsSelected = 3,
  kSceneManagerGLEventState_TaskStateChanged = 4, kSceneManagerGLEventState_DataViewRenderTaskFinished = 5, kSceneManagerGLEventState_SceneLayerBuildTaskFinished = 6
}
 Scene manager SceneManagerGLEvent SceneUpdated states. More...
 
enum  PortrayalsFoundAnswers {
  kPortrayalsFoundAnswer_Skip = 1, kPortrayalsFoundAnswer_Install = 2, kPortrayalsFoundAnswer_InstallAndApply = 3, kPortrayalsFoundAnswer_SkipAll = 4,
  kPortrayalsFoundAnswer_InstallAll = 5, kPortrayalsFoundAnswer_InstallAndApplyAll = 6, kPortrayalsFoundAnswer_Skip = 1, kPortrayalsFoundAnswer_Install = 2,
  kPortrayalsFoundAnswer_InstallAndApply = 3, kPortrayalsFoundAnswer_SkipAll = 4, kPortrayalsFoundAnswer_InstallAll = 5, kPortrayalsFoundAnswer_InstallAndApplyAll = 6
}
 Possible answers to 'NewPortrayalsFound' scene control event. More...
 
enum  SelectDatasetsParametersGL {
  kSelectDatasetsParameterGL_Region, kSelectDatasetsParameterGL_Scale, kSelectDatasetsParameterGL_DataSources, kSelectDatasetsParameterGL_PortrayalParameters,
  kSelectDatasetsParameterGL_Projection, kSelectDatasetsParameterGL_UserCookie, kSelectDatasetsParameterGL_SceneLayerName
}
 Parameters which can be read for each selected dataset. More...
 
enum  SelectedDatasetPropertyGL {
  kSelectedDatasetPropertyGL_DataSourceReference, kSelectedDatasetPropertyGL_DataSourceName, kSelectedDatasetPropertyGL_DatasetReference, kSelectedDatasetPropertyGL_Priority,
  kSelectedDatasetPropertyGL_DataSourcePriority, kSelectedDatasetPropertyGL_InternalRef, kSelectedDatasetPropertyGL_InternalSubRef
}
 Properties of a selected dataset. More...
 

Detailed Description

Describes all interfaces for controlling visualization.

Copyright © The Navtor SDK 2011-2018. All Rights Reserved.

Author
The NAVTOR SDK authors.
Date
01/2018
Maintenance:
The NAVTOR SDK authors.

Enumeration Type Documentation

◆ SceneManagerGLInitialParameter

Initialization parameters for the SceneManagerGL (used with ISceneManagerGLInitialParameters).

Enumerator
kSceneManagerGLInitialParameter_Name 

Name of the scene manager.

kSceneManagerGLInitialParameter_SceneWidth 

Scene width.

kSceneManagerGLInitialParameter_SceneHeight 

Scene height.

kSceneManagerGLInitialParameter_ResolutionDPM 

Scene resolution DPM.

kSceneManagerGLInitialParameter_Flags 

Flags.

kSceneManagerGLInitialParameter_LayerSetName 

Starting layers set.

kSceneManagerGLInitialParameter_GLType 

see SceneManagerGLType.

kSceneManagerGLInitialParameter_SharableContext 

Platform specific reference to an exiting GL context to share with.

kSceneManagerGLInitialParameter_ExtCtx_GL2DThread 

Own implementation of IGL2DThread interface to execute tasks in GL thread.

kSceneManagerGLInitialParameter_ExtCtx_xxxGetGlProcAddr 

Pointer to appropriate xxxGetProcAddress method (wglGetProcAddress/eglGetProcAddress/glXGetProcAddressARB/OSMesaGetProcAddress/etc)

kSceneManagerGLInitialParameter_ExtCtx_GlLibHandle 

Handle to appropriate OpenGL library (::GetModuleHandleA("opengl32.dll") for Windows, can be NULL for Linux)

kSceneManagerGLInitialParameter_ExtCreatedGlContext 

Own implementation of IGL2DExtCreatedGlCtx to create GL context by using external application API.

kSceneManagerGLInitialParameter_SceneManagerGL 

Earlier created scene manager GL instance.

kSceneManagerGLInitialParameter_TextureFormat 

Format of the scene texture.

kSceneManagerGLInitialParameter_Projection 

Data projection.

kSceneManagerGLInitialParameter_RootShadersFolder 

Root shaders folder.

kSceneManagerGLInitialParameter_GLDataCache_On 

GL data cache on and off.

kSceneManagerGLInitialParameter_GLDataCache_RootFolder 

Root folder for the GL data cache.

kSceneManagerGLInitialParameter_GLDataCache_MaxSizeMb 

GL data cache maximum size.

kSceneManagerGLInitialParameter_GLDataCache_ClearThreshold 

GL data cache clear threshold from max size.

kSceneManagerGLInitialParameter_GLDataCache_ClearMinRatio 

GL data cache clear min ratio from max size.

kSceneManagerGLInitialParameter_GLDataCache_Type 

GL data cache storage type (enum GLDataCacheType).

kSceneManagerGLInitialParameter_TextsBlurringOn 

Switches on/off text blurring mode.

kSceneManagerGLInitialParameter_UpdateDisplayMode 

Switches specified display mode (enum UpdateDisplayMode).

kSceneManagerGLInitialParameter_BufferedDisplay_ExtendPercents 

Specifies the size to extend buffered scene image in percents of the scene size (each side will get half of this value).

kSceneManagerGLInitialParameter_BufferedDisplay_ExtendPixels 

Specifies the size in pixels to extend buffered scene image (each side will get half of this value).

◆ SceneManagerGLType

Scene Manager graphic library type.

Enumerator
kSceneManagerGLType_Auto 

Auto select.

kSceneManagerGLType_OpenGL 

OpenGL.

kSceneManagerGLType_OpenGL_ES2 

OpenGL ES2.

◆ GLDataCacheType

Types of GL data cache.

Enumerator
kGLDataCacheType_Files 

Stores each GL data dataset in a separate file.

kGLDataCacheType_SQL 

Stores all GL data in one SQL database file.

◆ UpdateDisplayMode

List of possible UpdateDisplay modes.

Enumerator
kUpdateDisplayMode_Direct 

Tells to render all the graphic chart elements directly in Display call.

kUpdateDisplayMode_Buffered 

Tells to use prepared scene image at display call and prepares new image in background.

◆ SceneManagerGLProperty

Scene Manager properties.

Enumerator
kSceneManagerGLProperty_Name 

Name of the scene manager.

kSceneManagerGLProperty_MinScale 

Smallest scale limit. Default 300'000'000.

kSceneManagerGLProperty_MaxScale 

Largest scale limit. Default 10.

kSceneManagerGLProperty_SceneWidth 

Width of the scene in pixels.

kSceneManagerGLProperty_SceneHeight 

Height of the scene in pixels.

kSceneManagerGLProperty_SceneExtendPercents 

Expands scene covering area, in percents.

kSceneManagerGLProperty_BackgroundColorARGB 

Scene background color in ARGB format.

kSceneManagerGLProperty_Projection 

Scene projection.

kSceneManagerGLProperty_Canvas 

Used canvas (sdk::gl2d::IGL2DCanvas)

kSceneManagerGLProperty_SymbolCatalog 

Used symbol catalog (sdk::glsymb::IGLSymbCatalog)

kSceneManagerGLProperty_SymbolTypeFilter 

Provides a set of 2^glsymb::GLSymbolType flags to only leave the specified set of symbols.

kSceneManagerGLProperty_CollectBuildStat 

Switches on collecting of build statistics (can be retrieved through ISceneInformation).

kSceneManagerGLProperty_SceneBuildFlags 

Controls the way how building algorithms work. (see SceneBuildFlags enum).

kSceneManagerGLProperty_SceneDisplayFlags 

Controls the way how scene picture is painted. (see SceneDisplayFlags enum).

kSceneManagerGLProperty_LatLimitMin 

Minimal scene latitude limit.

kSceneManagerGLProperty_LatLimitMax 

Maximal scene latitude limit.

kSceneManagerGLProperty_GraphicCache_On 

Turns graphic containers cache on and off.

kSceneManagerGLProperty_GraphicCache_MaxAppMemoryMb 

Maximum app memory to start clearing cached graphic containers.

kSceneManagerGLProperty_GraphicCache_MaxDatasets 

Maximum number of graphic containers in memory (used when MaxAppMemoryMb = 0)

kSceneManagerGLProperty_GLDataCache_On 

Turns GL data cache on and off.

kSceneManagerGLProperty_GLDataCache_Path 

Gets GL data cache path.

kSceneManagerGLProperty_GLDataCache_MaxSizeMb 

Sets new or gets current GL data cache maximum size.

kSceneManagerGLProperty_GLDataCache_Type 

Gets the type of the used GL data cache storage (enum GLDataCacheType).

kSceneManagerGLProperty_DisplayMode 

Display mode set at initialization (enum DisplayMode) (Read-only).

kSceneManagerGLProperty_BufferedDisplay_ExtendPercents 

Specifies the size to extend buffered scene image in percents of the scene size (each side will get half of this value).

kSceneManagerGLProperty_BufferedDisplay_ExtendPixels 

Specifies the size in pixels to extend buffered scene image (each side will get half of this value).

kSceneManagerGLProperty_WaitRenderingTimeoutMs 

StartRendering timeout (when kSceneGLRenderingFlag_WaitRendering flag is used).

kSceneManagerGLProperty_LocalScaleLongitude 

Specifies the longitude which should be used when kPP_UseLocalScaleForChartsSelection_SceneProperty is set.

kSceneManagerGLProperty_LocalScaleLatitude 

Specifies the latitude which should be used when kPP_UseLocalScaleForChartsSelection_SceneProperty is set.

kSceneManagerGLProperty_ProjectionCentralLongitude 

Specifies central longitude for the projection (By default it is equal 0).

kSceneManagerGLProperty_ProjectionCentralLatitude 

Specifies central latitude for the projection (By default it is equal 0).

kSceneManagerGLProperty_ProjectionCentralPointChangeMode 

Specifies automatic projection central point change mode (By default it is off, see ProjectionCentralPointChangeMode).

kSceneManagerGLProperty_ProjectionCentralPointChangeMinScale 

Specifies minimal scale when automatic projection central point change is peformed (By default it is equal 1 mln).

kSceneManagerGLProperty_ProjectionCentralLongitudeMaxDiff 

Specifies max diffrence of projection central longitude from the current position (In degrees, by default the value is 0.0 degree).

kSceneManagerGLProperty_ProjectionCentralLatitudeMaxDiff 

Specifies max diffrence of projection central latitude from the current position (In degrees, by default the value is 1.0 degree).

kSceneManagerGLProperty_DonotCoverInPaint 

Suppresses covering the scene by cached data while rendering is in progress (needed when user data selection is used).

kSceneManagerGLProperty_PutObjectsAboveRadar 

Overrides objects symbols radar flag - places them over radar. Specifies a list of object class codes.

kSceneManagerGLProperty_User 

Offset for user properties which SceneManager may contain.

◆ SceneBuildFlags

List of possible build flags (set through kSceneManagerGLProperty_SceneBuildFlags).

Enumerator
kSceneBuildFlags_NoFlags 

No flags.

kSceneBuildFlags_SuppressTextDodging 

Suppresses moving texts out of the way in some cases (route legs, tide stations).

◆ SceneDisplayFlags

List of possible display flags (set through kSceneManagerGLProperty_SceneDisplayFlags).

Enumerator
kSceneDisplayFlags_NoFlags 

No flags.

◆ SceneHighlightParameters

Scene highlight parameters.

Enumerator
kSceneHighlightParameters_Feature 

A feature to highlight.

kSceneHighlightParameters_Geometry 

A geometry to highlight.

kSceneHighlightParameters_FullFeatureID 

ObjectID of target feature.

kSceneHighlightParameters_DatasourceName 

Name of the data source containing target feature.

kSceneHighlightParameters_DatasetName 

Name of the dataset containing target feature.

kSceneHighlightParameters_DatasetID 

ID of the dataset containing target feature.

kSceneHighlightParameters_FeatureOID 

Target feature OID.

kSceneHighlightParameters_PointIndex 

Index of specific point of the Multipoint or Grid feature.

kSceneHighlightParameters_PointSymbolType 

Point symbol type (see SceneGLHighlightPointSymbolType)

kSceneGLHighlightParameters_Feature 

A feature to highlight.

kSceneGLHighlightParameters_Geometry 

A geometry to highlight.

kSceneGLHighlightParameters_FullFeatureID 

ObjectID of target feature.

kSceneGLHighlightParameters_DatasourceName 

Name of the data source containing target feature.

kSceneGLHighlightParameters_DatasetName 

Name of the dataset containing target feature.

kSceneGLHighlightParameters_DatasetID 

ID of the dataset containing target feature.

kSceneGLHighlightParameters_FeatureOID 

Target feature OID.

kSceneGLHighlightParameters_PointIndex 

Index of specific point of the Multipoint or Grid feature.

kSceneGLHighlightParameters_PointSymbolType 

Point symbol type (see SceneGLHighlightPointSymbolType)

kSceneGLHighlightParameters_IsViewportData 

Maybe used together with 'Geometry' param, tells that geometry is projected to the viewport.

◆ SceneGLHighlightPointSymbolType

Scene highlight point symbol types.

Enumerator
kSceneGLHighlightPointSymbolType_Cross 

Full cross.

kSceneGLHighlightPointSymbolType_Open 

Cross with empty center.

kSceneGLHighlightPointSymbolType_Circle 

Cross with circle in the center.

◆ ProjectionCentralPointChangeMode

Scene projection central point automatic change modes.

Enumerator
kProjectionCentralPointChangeMode_Off 

Mode is off.

kProjectionCentralPointChangeMode_PosDiff 

Set projection central point close to the current position when the difference is bigger than specified value (see kSceneManagerGLProperty_ProjectionCentralLatitudeMaxDiff)

◆ SceneGLParameter

Scene parameters.

Enumerator
kSceneGLParameter_Lat 

Latitude of the scene center.

kSceneGLParameter_Lon 

Longitude of the scene center.

kSceneGLParameter_Scale 

Scene scale.

kSceneGLParameter_RotationAngle 

Scene rotation angle.

kSceneGLParameter_UseReferencePoint 

Use reference point flag.

kSceneGLParameter_ReferencePoint_X 

Scene reference point x (pixels from center).

kSceneGLParameter_ReferencePoint_Y 

Scene reference point y (pixels from center).

◆ SceneGLRenderingFlags

Scene rendering flags.

Enumerator
kSceneGLRenderingFlag_NoFlags 

No flags.

kSceneGLRenderingFlag_ForceRendering 

Forces the scene rendering process.

kSceneGLRenderingFlag_WaitRendering 

Waits until started rendering is finished.

◆ SceneGLUpdateDisplayFlags

Update display flags.

Enumerator
kSceneGLUpdateDisplayFlag_NoFlags 

No flags.

kSceneGLUpdateDisplayFlag_ForceUpdate 

Updates in any case (suppresses Update skipping algorithm).

kSceneGLUpdateDisplayFlag_NoBuffering 

Suppress display buffering.

kSceneGLUpdateDisplayFlag_OnlyBuffered 

Display buffered texture, do not start new Display update.

◆ SceneGLUpdatedSceneStatus

Updated scene statuses.

Enumerator
kSceneGLUpdatedSceneStatus_NoStatus 

No status.

kSceneGLUpdatedSceneStatus_Ready 

Scene is fully rendered.

kSceneGLUpdatedSceneStatus_Preparing 

Some data are still preparing.

kSceneGLUpdatedSceneStatus_Skipped 

The scene decided to skip the update.

◆ SceneGLResetFlags

Reset scene flags (specifies which cached data to release).

Enumerator
kSceneGLResetFlag_Datasources 

Removes all data-sources.

kSceneGLResetFlag_SceneData 

Clears all internal not graphic data.

kSceneGLResetFlag_GraphicData 

Clears all internal graphic data.

kSceneGLResetFlag_LastSceneInfo 

Clears last scene info.

kSceneGLResetFlag_GLDataDiskCache 

Clears persistent GL data cache on disk.

kSceneGLResetFlag_GL2DCache 

Clears gl2d subsystem cache.

kSceneGLResetFlag_Data 

Clears scene manager internal data.

kSceneGLResetFlag_WaitFinished 

Wait till reset is finished.

◆ SceneGLInfoFlags

Scene info retrieval flags.

Enumerator
kSceneGLInfoFlag_NoFlags 

No flags.

◆ SceneManagerGLEvent

Scene manager event IDs.

Enumerator
kSceneManagerGLEvent_RenderingStarted 

Tells that rendering started.

kSceneManagerGLEvent_RenderingPartlyFinished 

Tells that rendering of some new data is finished and the scene can be updated.

kSceneManagerGLEvent_RenderingFinished 

Tells that rendering of one of the scene layers is completed and the scene should be updated.

kSceneManagerGLEvent_RenderingFailed 

Tells that rendering of one of the scene layers is failed.

kSceneManagerGLEvent_RenderingSkipped 

Tells that rendering did not start, the scene is busy.

kSceneManagerGLEvent_DisplayFinished 

Tells that display in buffered mode is finished.

kSceneManagerGLEvent_DisplayFailed 

Tells that display in buffered mode is failed.

kSceneManagerGLEvent_DisplaySkipped 

Tells that display in buffered mode is skipped.

kSceneManagerGLEvent_NewPortrayalsFound 

Tells that new portrayals were found during the data-source view creation procedure.

kSceneManagerGLEvent_StateUpdated 

Tells that some rendering state information has been updated.

◆ SceneManagerGLEventParameter

Scene manager SceneLayersUpdated event parameters.

Enumerator
kSceneManagerGLEventParameter_Flags 

See SceneManagerGLEvent flags (SceneManagerGLEventFlags).

kSceneManagerGLEventParameter_SceneLayerName 

Name of the scene layer.

kSceneManagerGLEventParameter_DataViewName 

Name of the data view.

kSceneManagerGLEventParameter_BuildTime 

Time spent on layers building.

kSceneManagerGLEventParameter_BuildRound 

Number of the rendering cycle.

kSceneManagerGLEventParameter_UserCookie 

User cookie specified at the start of rendering.

kSceneManagerGLEventParameter_DisplayRound 

Number of the display cycle.

kSceneManagerGLEventParameter_StateID 

kSceneManagerGLEvent_StateUpdated state ids (SceneManagerGLEventState).

kSceneManagerGLEventParameter_StateInfo 

kSceneManagerGLEvent_StateUpdated state text.

kSceneManagerGLEventParameter_Ratio 

Common parameter, depends on event type (e.g. RenderingPartlyFinished - amount of dataset prepared data)

◆ SceneManagerGLEventFlags

Scene manager SceneManagerGLEvent event flags.

Enumerator
kSceneManagerGLEventFlags_ChartReady 

True, if chart is ready.

kSceneManagerGLEventFlags_RenderingStopped 

True, if rendering was interrupted by the client.

kSceneManagerGLEventFlags_RenderingFailed 

True, if rendering failed due to some error.

kSceneManagerGLEventFlags_RenderingDeferred 

True, if rendering was deferred because layer(s) is busy.

kSceneManagerGLEventFlags_OnlyParams 

True, if rendering only recreated some parameters, data not changed.

kSceneManagerGLEventFlags_NothingSelected 

True, if rendering is skipped because no data is selected.

kSceneManagerGLEventFlags_NothingCovered 

True, if rendering is skipped because no data covers the scene.

kSceneManagerGLEventFlags_SameCoverResults 

True, if rendering is skipped because data coverage is the same.

kSceneManagerGLEventFlags_RecoveredFromCache 

True, if rendering is skipped because results are recovered from cache.

kSceneManagerGLEventFlags_DataviewRendererFinished 

True, if data view / dataset renderer finished its work.

kSceneManagerGLEventFlags_SceneLayerRendererFinished 

True, if scene layer renderer finished its work.

kSceneManagerGLEventFlags_SomeGLDataPrepared 

True, if some VS GL rendering data has been prepared for the scene layer.

kSceneManagerGLEventFlags_AllGLDataPrepared 

True, if all VS GL rendering data has been prepared for the scene layer.

kSceneManagerGLEventFlags_BuilderManagerEvent 

True, if the event was initiated by the scene builder manager.

kSceneManagerGLEventFlags_DataviewEvent 

True, if the event was initiated by data view / dataset rendering.

kSceneManagerGLEventFlags_SceneLayerEvent 

True, if the event was initiated by scene layer rendering.

kSceneManagerGLEventFlags_GLDataPrepareEvent 

True, if the event was initiated by GL data preparing code.

◆ SceneManagerGLEventState

Scene manager SceneManagerGLEvent SceneUpdated states.

Enumerator
kSceneManagerGLEventState_Undefined 

Undefined state.

kSceneManagerGLEventState_SceneLayerBuildTaskStarted 

Scene layer build task started.

kSceneManagerGLEventState_DataViewRenderTaskStarted 

Data view render task started.

kSceneManagerGLEventState_DatasetsSelected 

List of selected datasets.

kSceneManagerGLEventState_TaskStateChanged 

State is changed, see details in state info.

kSceneManagerGLEventState_DataViewRenderTaskFinished 

Data view render task finished.

kSceneManagerGLEventState_SceneLayerBuildTaskFinished 

Scene layer build task finished.

◆ PortrayalsFoundAnswers

Possible answers to 'NewPortrayalsFound' scene control event.

Enumerator
kPortrayalsFoundAnswer_Skip 

Do not install new portrayal.

kPortrayalsFoundAnswer_Install 

Install new portrayal. Do not use them.

kPortrayalsFoundAnswer_InstallAndApply 

Install new portrayal and switch to it.

kPortrayalsFoundAnswer_SkipAll 

Do not install new portrayals.

kPortrayalsFoundAnswer_InstallAll 

Install new portrayals. Do not use them.

kPortrayalsFoundAnswer_InstallAndApplyAll 

Install new portrayals and switch to them.

kPortrayalsFoundAnswer_Skip 

Do not install new portrayal.

kPortrayalsFoundAnswer_Install 

Install new portrayal. Do not use them.

kPortrayalsFoundAnswer_InstallAndApply 

Install new portrayal and switch to it.

kPortrayalsFoundAnswer_SkipAll 

Do not install new portrayals.

kPortrayalsFoundAnswer_InstallAll 

Install new portrayals. Do not use them.

kPortrayalsFoundAnswer_InstallAndApplyAll 

Install new portrayals and switch to them.

◆ SelectDatasetsParametersGL

Parameters which can be read for each selected dataset.

Enumerator
kSelectDatasetsParameterGL_Region 

Region for datasets selection.

kSelectDatasetsParameterGL_Scale 

Current selection scale.

kSelectDatasetsParameterGL_DataSources 

Current list of data-sources.

kSelectDatasetsParameterGL_PortrayalParameters 

Current portrayal parameter.

kSelectDatasetsParameterGL_Projection 

Current scene projection.

kSelectDatasetsParameterGL_UserCookie 

StartRendering cookie.

kSelectDatasetsParameterGL_SceneLayerName 

Name of the scene layer being processed.

◆ SelectedDatasetPropertyGL

Properties of a selected dataset.

Enumerator
kSelectedDatasetPropertyGL_DataSourceReference 

Returns IDataSource, if possible.

kSelectedDatasetPropertyGL_DataSourceName 

DataSource name.

kSelectedDatasetPropertyGL_DatasetReference 

Reference to gdb::IDataset.

kSelectedDatasetPropertyGL_Priority 

Sort criteria.

kSelectedDatasetPropertyGL_DataSourcePriority 

DataSource priority.

kSelectedDatasetPropertyGL_InternalRef 

For internal use.

kSelectedDatasetPropertyGL_InternalSubRef 

For internal use.