Describes visualization layers interfaces. More...

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

Data Structures
class	ISceneLayersManagerUpdateParameters
	Scene layer manager update parameters. No own methods, only ISDKParameters methods. More...

class	ISceneLayersManager
	Allows to control scene overlays. More...

class	ISceneLayer
	Describes scene layer. More...

class	ISceneLayersEnumerator
	Enumerator of scene layers. More...

Typedefs
typedef SDKUInt64	SceneLayerID
	Scene layer identifier.

Enumerations
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_Dynamic, kSceneLayerFlag_DynamicDeferred, kSceneLayerFlag_Max = kSceneLayerBaseFlag_Max }
	Definition of the scene layer flags. More...

enum	SceneLayersManagerUpdateParametersID { kSceneLayersManagerUpdateParameter_IsForPrinting, kSceneLayersManagerUpdateParameter_DropNameList, kSceneLayersManagerUpdateParameter_PosX, kSceneLayersManagerUpdateParameter_PosY, kSceneLayersManagerUpdateParameter_Width, kSceneLayersManagerUpdateParameter_Height }
	Scene layer manager update parameters. More...

enum	SceneLayersManagerProperties { kSceneLayersManagerProperty_StateVersion }
	Scene layers manager properties. More...

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 }
	Scene layer properties. More...

enum	SceneLayerRenderingAreaType { kSceneLayerRenderingAreaType_AsSet, kSceneLayerRenderingAreaType_WholeLayer, kSceneLayerRenderingAreaType_ViewportMaxBound, kSceneLayerRenderingAreaType_ViewportWindowRotated, kSceneLayerRenderingAreaType_ViewportWindow }
	Scene layer rendering area calculation type. More...

enum	SceneRendererParameters { , 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 }
	Parameters which are accessible in renderer Render() method through IRenderContext parameter. More...

enum	SceneRendererProperties { , kSceneRendererProperty_IsDirty = kSceneLayerBaseRendererProperty_IsDirty, kSceneRendererProperty_Data = kSceneLayerBaseRendererProperty_Data, kSceneRendererProperty_ClearBackground }
	Parameters which are accessible in renderer Render() method through IRenderContext parameter. More...

Variables
static const wchar_t *	kSceneLayerSet_TypeName_Chart = L"chart"
	Predefined chart layer sets.

static const wchar_t *	kSceneLayerSet_Default = kSceneLayerBaseSet_Default
	Predefined chart layer sets.

static const wchar_t *	kSceneLayer_ChartDecoration = kSceneLayerBaseName_ChartDecoration
	Predefined layer names.

static const wchar_t *	kSceneLayerRenderer_Root = L"root"
	Predefined renderers.

static const wchar_t *	kSceneLayerDeconflicter_Text = kSceneLayerBaseTextDeconflicter
	Predefined text deconflicters.

const SceneLayerPriority	kSceneLayerPriority_Chart_Decoration = kSceneLayerBasePriority_Chart_Decoration
	Over chart decorations (scale-bar...).

const SceneLayerPriority	kSceneLayerPriority_OverRadar_Text = kSceneLayerBasePriority_OverRadar + 3000.0f
	Over radar texts.

const SceneLayerPriority	kSceneLayerPriority_OverRadar_Points = kSceneLayerBasePriority_OverRadar + 2000.0f
	Over radar points.

const SceneLayerPriority	kSceneLayerPriority_OverRadar_Lines = kSceneLayerBasePriority_OverRadar + 1000.0f
	Over radar lines.

const SceneLayerPriority	kSceneLayerPriority_OverRadar_Areas = kSceneLayerBasePriority_OverRadar
	Over radar areas.

const SceneLayerPriority	kSceneLayerPriority_Radar = kSceneLayerBasePriority_Radar
	The radar priority.

const SceneLayerPriority	kSceneLayerPriority_UnderRadar_Text = kSceneLayerBasePriority_UnderRadar + 3000.0f
	Under radar texts.

const SceneLayerPriority	kSceneLayerPriority_UnderRadar_Points = kSceneLayerBasePriority_UnderRadar + 2000.0f
	Under radar points.

const SceneLayerPriority	kSceneLayerPriority_UnderRadar_Lines = kSceneLayerBasePriority_UnderRadar + 1000.0f
	Under radar lines.

const SceneLayerPriority	kSceneLayerPriority_UnderRadar_Areas = kSceneLayerBasePriority_UnderRadar
	Under radar areas.

const SceneLayerPriority	kSceneLayerPriority_NoData = kSceneLayerBasePriority_NoData
	No data layer.

const SceneLayerPriority	kSceneLayerPriority_Undefined = kSceneLayerBasePriority_Undefined
	Undefined.

Detailed Description

Describes visualization layers interfaces.

Author: The NAVTOR SDK authors.

Date: 04/2012

Maintenance:: NAVTOR SDK authors.

Enumeration Type Documentation

◆ SceneLayerFlags

enum SceneLayerFlags

Definition of the scene layer flags.

Enumerator
kSceneLayerFlag_NoFlags	No flags.
kSceneLayerFlag_NoClipping	Data valid area clipping is not used.
kSceneLayerFlag_PortrayalDependent	Automatically re-render on portrayal change.
kSceneLayerFlag_ProjectionDependent	Automatically re-render if projection changed.
kSceneLayerFlag_DeferredRender	Render layer only if deferred rendering is asked.
kSceneLayerFlag_BindToViewport	Bind layer to scene viewport.
kSceneLayerFlag_OpaqueLayer	Layer does not used transparency (content can be copied).
kSceneLayerFlag_Background	Marks layer as being the one at the bottom.
kSceneLayerFlag_Hidden	Not visible by default.
kSceneLayerFlag_ClearBeforeRender	Clear layer before rendering.
kSceneLayerFlag_Charts	Charts.
kSceneLayerFlag_Dynamic	e.g. Route editor
kSceneLayerFlag_DynamicDeferred	e.g. OwnShip, AIS, ARPA
kSceneLayerFlag_Max	Flags greater than this value are used internally.

◆ SceneLayersManagerUpdateParametersID

enum SceneLayersManagerUpdateParametersID

Scene layer manager update parameters.

Enumerator
kSceneLayersManagerUpdateParameter_IsForPrinting	Is for printing.
kSceneLayersManagerUpdateParameter_DropNameList	Names of layers to leave out.
kSceneLayersManagerUpdateParameter_PosX	Layers top-left corner x position.
kSceneLayersManagerUpdateParameter_PosY	Layers top-left corner y position.
kSceneLayersManagerUpdateParameter_Width	Layers width.
kSceneLayersManagerUpdateParameter_Height	Layers height.

◆ SceneLayersManagerProperties

enum SceneLayersManagerProperties

Scene layers manager properties.

Enumerator
kSceneLayersManagerProperty_StateVersion	Current state version.

◆ SceneLayerProperties

enum SceneLayerProperties

Scene layer properties.

Enumerator
kSceneLayerProperty_ID	ID of the layer (scene::LayerID).
kSceneLayerProperty_Name	Name of the layer.
kSceneLayerProperty_Priority	Layer priority.
kSceneLayerProperty_Flags	Layer flags.
kSceneLayerProperty_RendererType	Name of the predefined renderer.
kSceneLayerProperty_Renderer	Layer renderer component.
kSceneLayerProperty_DGroupFilter	Display groups filter.
kSceneLayerProperty_Opacity	Sets layer opacity (from 0.0 to 1.0 - not transparent).
kSceneLayerProperty_Data	Allows to pass any data from the application to the layers renderer.
kSceneLayerProperty_SetTypeName	Type-name of the layer set.
kSceneLayerProperty_PosX	Layer top-left corner x position.
kSceneLayerProperty_PosY	Layer top-left corner y position.
kSceneLayerProperty_Width	Layer width.
kSceneLayerProperty_Height	Layer height.
kSceneLayerProperty_RenderingAreaType	Sets a way how rendering area is calculated (SceneLayerRenderingAreaType)
kSceneLayerProperty_RenderingAreaWidth	Rendering area width in pixels.
kSceneLayerProperty_RenderingAreaHeight	Rendering area height in pixels.
kSceneLayerProperty_DeconflicterType	Name of the predefined deconflicter.
kSceneLayerProperty_RenderOrder	Order of rendering.
kSceneLayerProperty_RenderPriority	Priority of rendering, see SceneLayerRenderPriorities.
kSceneLayerProperty_GroupIndex	Index of group layers belongs to, optional parameter.
kSceneLayerProperty_ParentID	Parent layer identifier.
kSceneLayerProperty_RendererObjectPriority	Layer priority.
kSceneLayerProperty_StateVersion	Current state version.

◆ SceneLayerRenderingAreaType

enum SceneLayerRenderingAreaType

Scene layer rendering area calculation type.

Enumerator
kSceneLayerRenderingAreaType_AsSet	Render area set by properties RenderingAreaWidth, RenderingAreaHeight.
kSceneLayerRenderingAreaType_WholeLayer	Render all layer surface.
kSceneLayerRenderingAreaType_ViewportMaxBound	Render only part covered by viewport maximal bounding.
kSceneLayerRenderingAreaType_ViewportWindowRotated	Render only part covered by viewport window taking into account rotation.
kSceneLayerRenderingAreaType_ViewportWindow	Render only part covered by viewport window.

◆ SceneRendererParameters

enum SceneRendererParameters

Parameters which are accessible in renderer Render() method through IRenderContext parameter.

Enumerator
kSceneRendererParameter_SceneManagerName	Scene manager name.
kSceneRendererParameter_Projection	Projection for rendering.
kSceneRendererParameter_RotationAngle	Scene rotation angle.
kSceneRendererParameter_DPM	Dots per meter.
kSceneRendererParameter_ChartPortrayalName	Chart portrayal name.
kSceneRendererParameter_Symbolization	ISymbolizationHelper (for internal use).
kSceneRendererParameter_PortrayalParameters	IPortrayalParameters.
kSceneRendererParameter_DisplayListRef	Reference to the main display list. (only for data-dependent layers in group 'chart')
kSceneRendererParameter_IsClipByCoverage	Clipping flag taken from layer.
kSceneRendererParameter_IsChart	True if renderer used for chart layer.
kSceneRendererParameter_Deconflict_Flag	Text de-conflicting flag.
kSceneRendererParameter_SymbolSetCatalog	Current ISymbolSetCatalog.
kSceneRendererParameter_ViewportRectWidth	Width of the not-rotated scene viewport.
kSceneRendererParameter_ViewportRectHeight	Height of the not-rotated scene viewport.
kSceneRendererParameter_ViewportBoundWidth	Width of the rotated scene viewport bound.
kSceneRendererParameter_ViewportBoundHeight	Height of the rotated scene viewport bound.
kSceneRendererParameter_ViewportPath	Rotated scene viewport geometry path.
kSceneRendererParameter_RenderAreaWidth	Width of the rendering area.
kSceneRendererParameter_RenderAreaHeight	Height of the rendering area.
kSceneRendererParameter_AA_Mode	Anti-aliasing mode.
kSceneRendererParameter_Text_AA_Mode	Texts anti-aliasing mode.
kSceneRendererParameter_DisplayListID	ID of display list index for the layer. (only for data-dependent layers in group 'chart')
kSceneRendererParameter_RenderTarget	Render target, when renderer is attached as external one to the parent layer.

◆ SceneRendererProperties

enum SceneRendererProperties