portrayal_parameters_interface.h File Reference

Describes the interface that manages portrayal controlling parameters. More...

#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>

Go to the source code of this file.

Data Structures
union	PositionInScene
	Describes the position of a scene decoration element. More...
class	IPortrayalParameters
	Describes the interface that manages the parameters to control the portrayal. More...
class	IPortrayalParametersEnumerator
	Allows to enumerate all available portrayal parameters. More...

Enumerations
enum	PortrayalParameterEnum { ,   kPP_ShallowContour = kPP_First, kPP_DeepContour, kPP_SafetyContour, kPP_SafetyDepth,   kPP_ShallowPattern, kPP_PaperChartSymbols, kPP_SymbolisedBoundaries, kPP_ColourMode,   kPP_DisplayPalette, kPP_SymbolsAndTextScale, kPP_DangerInShallowWaters, kPP_AntiAliasingMode,   kPP_TextAntiAliasingMode, kPP_RealLengthLightSectorLegs, kPP_UseLocalScaleForChartsSelection, kPP_UsePeriodicAttributes,   kPP_UseScaminScamaxAttributes, kPP_TextDeconflicting, kPP_ShowGridlines, kPP_Flashing,   kPP_S101_Portrayal, kPP_ContextTime, kPP_TimeLimitedObjectsStartTime, kPP_TimeLimitedObjectsEndTime,   kPP_SafetyContourColor, kPP_OverscaleIndicationScaleFactor, kPP_OverscaleIndicationAlgorithm, kPP_ScaleBarPosition,   kPP_DepthUnitsPosition, kPP_NorthUpIndicatorPosition, kPP_ScaleIndicatorPosition, kPP_DangerSymbolOn,   kPP_DecorationTextColorName, kPP_DecorationTextHeight, kPP_SafeHazardsShown, kPP_SafeDepthsShown,   kPP_CentralSymbolsExcludeZone, kPP_CentralSymbolsExcludeVessel, kPP_CentralSymbolsAlgorithm, kPP_DepthUnits,   kPP_DistanceUnits, kPP_Gridlines_Flags, kPP_Gridlines_Parameters, kPP_VesselGeoPosition,   kPP_ReviewMode, kPP_DontUseTransparency, kPP_UseIEC62288ed2, kPP_HighlightDateDependentObjects,   kPP_UseNationalAttributes, kPP_FullLightsInfo, kPP_ReviewStartTime, kPP_ReviewEndTime,   kPP_RealLengthLightLegs_ExtraLightsOn, kPP_RealLengthLightLegs_ActivationScale, kPP_RealLengthLightLegs_ExtendSizeNM, kPP_GroundingCheck_CombineSCAreasHighlight,   kPP_Temp_MakeObstructionInUNSAREDangerous, kPP_ShowParallelIndexLinesOnActiveRoute, kPP_ShowPositionReferencesOnActiveRoute, kPP_WPNumbering,   kPP_DetailedNoticeMarks, kPP_UseOverRadarFlag, kPP_DontUseAIOHatches, kPP_VesselLength,   kPP_ShowEventMarkID }
	Parameters list to control the portrayal. More...
enum	DangerInShallowWatersEnum { kPP_DangerInShallowWaters_Not_Display = 0, kPP_DangerInShallowWaters_Display = 1 }
	Danger in shallow waters portrayal parameter values. More...
enum	PortrayalParameterColourModeEnum { kPP_ColourMode_4Colour = 0, kPP_ColourMode_2Colour = 1, kPP_ColourMode_1Colour = 2 }
	Color mode portrayal parameter values. More...
enum	PortrayalParameterBoundariesModeEnum { kPP_PlainBoundariesMode = 0, kPP_SymbolisedBoundariesMode }
enum	PortrayalParameterOverscaleIndicationAlgorithmEnum { , kPP_OverscaleIndicationAlgorithm_Alternative = 1 }
	Overscale indication parameter values. More...
enum	PortrayalParameterCentralSymbolsAlgorithmEnum { kPP_CentralSymbolsAlgorithm_Simple = 0, kPP_CentralSymbolsAlgorithm_Complex = 1 }
enum	GridlinesFlagsEnum {   kPP_GridlinesFlags_EqualStepLat = 0x0001, kPP_GridlinesFlags_EqualStepLon = 0x0002, kPP_GridlinesFlags_EqualStepMin = 0x0004, kPP_GridlinesFlags_HideRotated = 0x0010,   kPP_GridlinesFlags_RotatedLabelsAtCenter = 0x0020, kPP_GridlinesFlags_LabelsAtCenter = 0x0100, kPP_GridlinesFlags_LabelsBothSides = 0x0200 }
	Coordinate grid flags values. More...
enum	GridlinesParametersEnum {   kPP_GridlinesParameters_FixedLatStep, kPP_GridlinesParameters_FixedLonStep, kPP_GridlinesParameters_MaxStepInMeters, kPP_GridlinesParameters_MaxStepInPixels,   kPP_GridlinesParameters_MinLinesCount, kPP_GridlinesParameters_SideMarkerAlignLeft, kPP_GridlinesParameters_MarkerTextSize, kPP_GridlinesParameters_BottomBorderShiftPx,   kPP_GridlinesParameters_BottomBorderShiftTmm }
	Coordinate grid parameter values. More...
enum	ReviewModeEnum { kPP_ReviewMode_Off = 0, kPP_ReviewMode_DisplayReviewedOnly = 1, kPP_ReviewMode_HighlightReviewedOnly = 2 }
	Review mode parameter values. More...
enum	SymbolsAndTextScaleEnum {   kPP_SymbolsAndTextScale_AidsToNavigation = 0, kPP_SymbolsAndTextScale_LightDescription, kPP_SymbolsAndTextScale_NoteOnChart, kPP_SymbolsAndTextScale_NatureOfSeabed,   kPP_SymbolsAndTextScale_GeographicNames, kPP_SymbolsAndTextScale_MarinersText, kPP_SymbolsAndTextScale_ManufacturersText, kPP_SymbolsAndTextScale_AllTexts }
	Identifiers to control scale of symbols and texts. More...
enum	UseLocalScaleForChartsSelectionEnum { kPP_UseLocalScaleForChartsSelection_Off = 0, kPP_UseLocalScaleForChartsSelection_UserPosition, kPP_UseLocalScaleForChartsSelection_SceneCenter, kPP_UseLocalScaleForChartsSelection_SceneProperty }
	Specifies the options of the local scale positions used for charts selection and SCAMIN handling. More...

Variables
static const char *	kPortrayalParameterName []
	List of the portrayal parameters names.
static const char	kParametersCatalog_VersionKey []
	Parameters catalog constants.
static const SDKUInt32	kPortrayalParameters_OwnShip = 1000UL
	Own ship.
static const SDKUInt32	kPortrayalParameters_ARPA = 2000UL
	ARPA.
static const SDKUInt32	kPortrayalParameters_AIS = 3000UL
	AIS.
static const SDKUInt32	kPortrayalParameters_AIO = 4000UL
	AIO.
static const SDKUInt32	kPortrayalParameters_Other = 5000UL
	Other.
static const SDKUInt32	kPortrayalParameters_Internal = 100000UL
	For internal usage.
static const SDKUInt32	kPortrayalParameters_OwnShip = 1000UL
	Own ship.
static const SDKUInt32	kPortrayalParameters_ARPA = 2000UL
	ARPA.
static const SDKUInt32	kPortrayalParameters_AIS = 3000UL
	AIS.
static const SDKUInt32	kPortrayalParameters_AIO = 4000UL
	AIO.
static const SDKUInt32	kPortrayalParameters_Other = 5000UL
	Other.
static const SDKUInt32	kPortrayalParameters_Internal = 100000UL
	For internal usage.

Detailed Description

Describes the interface that manages portrayal controlling parameters.

Copyright (c) 2011 The NAVTOR SDK. All Rights Reserved.

Author

The NAVTOR SDK authors.

Date

04/2012

Maintenance:

The NAVTOR SDK authors.

Enumeration Type Documentation

PortrayalParameterEnum

enum PortrayalParameterEnum

Parameters list to control the portrayal.

Enumerator
kPP_ShallowContour	Shallow contour.
kPP_DeepContour	Deep contour.
kPP_SafetyContour	Safety contour.
kPP_SafetyDepth	Safety depth.
kPP_ShallowPattern	Shallow pattern on/off.
kPP_PaperChartSymbols	Paper chart symbols on/off.
kPP_SymbolisedBoundaries	Symbolized boundaries on/off.
kPP_ColourMode	Color mode, see PortrayalParameterColourModeEnum.
kPP_DisplayPalette	Display palette.
kPP_SymbolsAndTextScale	ISDKParameters expected, see SymbolsAndTextScaleEnum.
kPP_DangerInShallowWaters	see DangerInShallowWatersEnum.
kPP_AntiAliasingMode	see sdk::gfx::AntiAliasingMode.
kPP_TextAntiAliasingMode	see sdk::gfx::AntiAliasingMode.
kPP_RealLengthLightSectorLegs	Sector legs will be drawn with length based on VALNMR attribute.
kPP_UseLocalScaleForChartsSelection	Use projection local scale for charts selection. See UseLocalScaleForChartsSelectionEnum.
kPP_UsePeriodicAttributes	Using of periodic attributes on/off.
kPP_UseScaminScamaxAttributes	Using of SCAMIN & SCAMAX attributes.
kPP_TextDeconflicting	De-conflicting texts on/off.
kPP_ShowGridlines	Show grid-lines on/off.
kPP_Flashing	Flashing on/off period, boolean value.
kPP_S101_Portrayal	S101 portrayal name.
kPP_ContextTime	Time is read from this component and not from system time.
kPP_TimeLimitedObjectsStartTime	Start time for showing/using time limited objects.
kPP_TimeLimitedObjectsEndTime	End time for showing/using time limited objects.
kPP_SafetyContourColor	The safety contour S-52 color index.
kPP_OverscaleIndicationScaleFactor	Overscale indication scale factor 2.0 by default.
kPP_OverscaleIndicationAlgorithm	Overscale indication algorithm see PortrayalParameterOverscaleIndicationAlgorithmEnum.
kPP_ScaleBarPosition	The scale bar shifts from the left and bottom scene edges in tenth of millimeter.
kPP_DepthUnitsPosition	The depth units shifts from the left and bottom scene edges in tenth of millimeter.
kPP_NorthUpIndicatorPosition	The north-up indicator shifts from the left and top scene edges in tenth of millimeter, see description of PositionInScene.
kPP_ScaleIndicatorPosition	The scale indicator shifts from the left and top scene edges or from the NorthUp arrow if it exists in tenth of millimeter, see description of PositionInScene.
kPP_DangerSymbolOn	The hazard's danger symbol on/off.
kPP_DecorationTextColorName	The decoration text color name.
kPP_DecorationTextHeight	The decoration text height in tenth of millimeter.
kPP_SafeHazardsShown	Suppress display of hazards greater than safety contour.
kPP_SafeDepthsShown	Suppress display of soundings greater than safety depth.
kPP_CentralSymbolsExcludeZone	Do not place central symbols inside specified zone (in pixels from viewport center).
kPP_CentralSymbolsExcludeVessel	Do not place central symbols near vessel symbol (requires kPP_VesselGeoPosition to be specified).
kPP_CentralSymbolsAlgorithm	Central symbols algorithm see PortrayalParameterCentralSymbolsAlgorithmEnum.
kPP_DepthUnits	Current depth units selected for presentation of depth values (see DepthUnitTypes in base/inc/units/units_const.h).
kPP_DistanceUnits	Current distance units selected for presentation of distance values (see DistanceUnitTypes).
kPP_Gridlines_Flags	Grid flags (see GridlinesFlagsEnum).
kPP_Gridlines_Parameters	Grid parameters (see GridlinesParametersEnum).
kPP_VesselGeoPosition	Inform scene about current vessel position (expects IPoint).
kPP_ReviewMode	Switches on review mode (See ReviewModeEnum). Highlights the manual updates.
kPP_DontUseTransparency	Switches on/off symbols transparency.
kPP_UseIEC62288ed2	Use IEC62288 ed.2 for symbols presentation.
kPP_HighlightDateDependentObjects	Switches on/off highlight date dependent objects.
kPP_UseNationalAttributes	National attributes are used instead of ordinary ones (E.g. NOBJNM instead of OBJNAM).
kPP_FullLightsInfo	Show full lights description.
kPP_ReviewStartTime	Start time for showing manual updates.
kPP_ReviewEndTime	End time for showing manual updates.
kPP_RealLengthLightLegs_ExtraLightsOn	Collect lights which are not is scene but has long legs which intersect it.
kPP_RealLengthLightLegs_ActivationScale	Extra lights are collected on scales bigger than this activation scale.
kPP_RealLengthLightLegs_ExtendSizeNM	Request region is increased by this value for extra light collecting.
kPP_GroundingCheck_CombineSCAreasHighlight	Combine all safety contour area objects highlighting in one.
kPP_Temp_MakeObstructionInUNSAREDangerous	Obstructions inside UNSARE considered to be dangerous - missed change from deferred amendment 6 to PL3.2.
kPP_ShowParallelIndexLinesOnActiveRoute	Show parallel index lines on active route.
kPP_ShowPositionReferencesOnActiveRoute	Show position references on active route.
kPP_WPNumbering	Waypoint numbering on the route WP0/WP1.
kPP_DetailedNoticeMarks	Switches on/off detailed symbols for Notice marks.
kPP_UseOverRadarFlag	Switches on/off usage of the symbols over-radar flag. Need to be switched on to draw over-radar symbols at another level.
kPP_DontUseAIOHatches	Switches on/off AIO hatches.
kPP_VesselLength	Length of vessel in meters.
kPP_ShowEventMarkID	Show route event mark ID (CPT 1)

DangerInShallowWatersEnum

enum DangerInShallowWatersEnum

Danger in shallow waters portrayal parameter values.

Enumerator
kPP_DangerInShallowWaters_Not_Display	Do not display.
kPP_DangerInShallowWaters_Display	Display.

PortrayalParameterColourModeEnum

enum PortrayalParameterColourModeEnum

Color mode portrayal parameter values.

Enumerator
kPP_ColourMode_4Colour	Use 4 colors for depth areas coloring.
kPP_ColourMode_2Colour	Use 2 colors for depth areas coloring.
kPP_ColourMode_1Colour	Use 1 color for depth areas coloring.

PortrayalParameterBoundariesModeEnum

enum PortrayalParameterBoundariesModeEnum

\Portrayal Symbolized or plain boundaries portrayal parameter values.

Enumerator
kPP_PlainBoundariesMode	Plain boundaries.
kPP_SymbolisedBoundariesMode	Symbolized boundaries.

PortrayalParameterOverscaleIndicationAlgorithmEnum

enum PortrayalParameterOverscaleIndicationAlgorithmEnum

Overscale indication parameter values.

Enumerator
kPP_OverscaleIndicationAlgorithm_Alternative	Suppresses the overscale indication if all datasets covering the scene are overscaled.

PortrayalParameterCentralSymbolsAlgorithmEnum

enum PortrayalParameterCentralSymbolsAlgorithmEnum

Enumerator
kPP_CentralSymbolsAlgorithm_Simple	Uses simplified approach.
kPP_CentralSymbolsAlgorithm_Complex	Uses region covering scheme.

GridlinesFlagsEnum

enum GridlinesFlagsEnum

Coordinate grid flags values.

Enumerator
kPP_GridlinesFlags_EqualStepLat	Lat step the same as lon one.
kPP_GridlinesFlags_EqualStepLon	Lon step the same as lat one.
kPP_GridlinesFlags_EqualStepMin	Minimal step is used for lat and lon steps.
kPP_GridlinesFlags_HideRotated	Hide grid for rotated scene.
kPP_GridlinesFlags_RotatedLabelsAtCenter	Put labels at the center for rotated grid.
kPP_GridlinesFlags_LabelsAtCenter	Put labels at the center.
kPP_GridlinesFlags_LabelsBothSides	Put labels at the both sides.

GridlinesParametersEnum

enum GridlinesParametersEnum

Coordinate grid parameter values.

Enumerator
kPP_GridlinesParameters_FixedLatStep	User specified latitude grid step.
kPP_GridlinesParameters_FixedLonStep	User specified longitude grid step.
kPP_GridlinesParameters_MaxStepInMeters	Max grid step in meters.
kPP_GridlinesParameters_MaxStepInPixels	Max grid step in pixels.
kPP_GridlinesParameters_MinLinesCount	Min grid lines count.
kPP_GridlinesParameters_SideMarkerAlignLeft	Marker align side (true - left, false - right).
kPP_GridlinesParameters_MarkerTextSize	Marker text size.
kPP_GridlinesParameters_BottomBorderShiftPx	Shift from the bottom (in pixels).
kPP_GridlinesParameters_BottomBorderShiftTmm	Shift from the bottom (in tenth of millimeters).

ReviewModeEnum

enum ReviewModeEnum

Review mode parameter values.

Enumerator
kPP_ReviewMode_Off	Review mode is off (default value)
kPP_ReviewMode_DisplayReviewedOnly	Only reviewed highlighting is displayed.
kPP_ReviewMode_HighlightReviewedOnly	All updates are highlighted but reviewed highlighting is thicker.

SymbolsAndTextScaleEnum

enum SymbolsAndTextScaleEnum

Identifiers to control scale of symbols and texts.

Enumerator
kPP_SymbolsAndTextScale_AidsToNavigation	Aids to navigation symbols.
kPP_SymbolsAndTextScale_LightDescription	Light description.
kPP_SymbolsAndTextScale_NoteOnChart	Note on chart.
kPP_SymbolsAndTextScale_NatureOfSeabed	Nature of seabed.
kPP_SymbolsAndTextScale_GeographicNames	Geographic names.
kPP_SymbolsAndTextScale_MarinersText	Mariners text.
kPP_SymbolsAndTextScale_ManufacturersText	Manufacturers text.
kPP_SymbolsAndTextScale_AllTexts	All texts.

UseLocalScaleForChartsSelectionEnum

enum UseLocalScaleForChartsSelectionEnum

Specifies the options of the local scale positions used for charts selection and SCAMIN handling.

Enumerator
kPP_UseLocalScaleForChartsSelection_Off	Turn off this function.
kPP_UseLocalScaleForChartsSelection_UserPosition	Specifies to use the position set manually by the user directly into the projection.
kPP_UseLocalScaleForChartsSelection_SceneCenter	Specifies to use the scene center as the local scale position.
kPP_UseLocalScaleForChartsSelection_SceneProperty	Specifies to use the position set by kSceneManager*_LocalScale* properties.