ENCX SDK  5.5.0.926
Public Member Functions | Properties | List of all members
IS57DisplaySettings Interface Reference

Properties and methods for ENCX::S57DisplaySettings. More...

import"encxcom.idl";

Inheritance diagram for IS57DisplaySettings:
Inheritance graph
[legend]

Public Member Functions

HRESULT SetViewingGroupRange ([in] LONG Start, [in] LONG End, [in] VARIANT_BOOL bShow)
 Show or hide multiple viewing groups at once. More...
 
HRESULT SetScaminForObjectClass ([in] IS57ObjectClass *cr, [in] LONG scamin)
 Setting the SCAMIN value overrides any SCAMIN in individual features of that object class. 0 will remove the override. More...
 
HRESULT ScaminForObjectClass ([in] IS57ObjectClass *cr, [out, retval] LONG *scamin)
 Obtaining the SCAMIN value for an object class. Returns 0 if there is no override value. More...
 
HRESULT Copy ([out, retval] IS57DisplaySettings **pVal)
 Get an identical copy of this object. Like the Clone() method but type safe. More...
 
HRESULT MergeXML ([in] BSTR xml)
 Merge XML string into existing settings. More...
 

Properties

VARIANT_BOOL TwoColourShadingForDepthZones [get, set]
 When true, two colours are used for non-drying depths; otherwise 4 colours are used. More...
 
VARIANT_BOOL SymbolisedAreaBoundaries [get, set]
 When true, the edges of some areas (e.g. anchorages) will be drawn with appropriate symbols (e.g. anchors); otherwise a simple line (e.g. dashes) will be used. More...
 
VARIANT_BOOL SimplifiedSymbols [get, set]
 When true, alternative symbols designed to be distinguishable at low resolutions will be used; otherwise symbols from chart 5001 will be used. More...
 
VARIANT_BOOL FullLengthLightSectorLines [get, set]
 When true, the rays indicating the limits of a light sector will be extended to their true range (or 9 Nm if the true range is not known); otherwise the ray will be 1" long. More...
 
VARIANT_BOOL OverscaleIndicator [get, set]
 Draw the overscale indicator. More...
 
DATE Date [get, set]
 Date for chart display which affects seasonal S-57 features (which used PERSTA,PEREND,DATSTA,DATEND). Defaults to now. DateMode must be set to S57DateMode_UseSetDate. More...
 
DOUBLE SafetyDepthMetres [get, set]
 Soundings deeper than this are displayed in a lighter colour. Units are metres. More...
 
DOUBLE SafetyContourMetres [get, set]
 The contour at this depth, or the next shallower depth, is emboldened. More...
 
DOUBLE ShallowContourMetres [get, set]
 Separates depth colours when TwoColourShadingForDepthZones is false. More...
 
DOUBLE DeepContourMetres [get, set]
 Separates depth colours when TwoColourShadingForDepthZones is false. More...
 
VARIANT_BOOL ViewingGroup ([in] LONG ID) [get, set]
 Object classes are organised into viewing groups. The drawing of each viewing group can be switched on and off individually. More...
 
LONG NumViewingGroups [get]
 Object classes are organised into viewing groups. The drawing of each viewing group can be switched on and off individually. More...
 
VARIANT_BOOL TextGroup ([in] LONG ID) [get, set]
 Object classes are organised into text groups. The drawing of each text group can be switched on and off individually. More...
 
LONG NumTextGroups [get]
 Object classes are organised into text groups. The drawing of each text group can be switched on and off individually. More...
 
IS57ProductAndUsages Usages [get, set]
 The types of S-57 data that should be drawn. More...
 
IS57CellIdentifiers CellFilter [get, set]
 Specific cells that can be drawn (excluding all others) or must not be drawn. More...
 
VARIANT_BOOL CellFilterInclusive [get, set]
 Controls the interpretation of CellFilter(). More...
 
IS57FeatureIdentifiers FeatureFilter [get, set]
 Specific features that can be drawn (excluding all others) or must not be drawn. More...
 
VARIANT_BOOL FeatureFilterInclusive [get, set]
 Controls the interpretation of FeatureFilter(). More...
 
LONG NumDepthZones [get, set]
 Controls the number of colours used for depths. Supersedes the TwoColourShadingForDepthZones property. More...
 
DOUBLE VeryShallowContourMetres [get, set]
 Separates depth colours when NumberOfDepthZones is 8. More...
 
DOUBLE SlightlyShallowContourMetres [get, set]
 Separates depth colours when NumberOfDepthZones is 8. More...
 
DOUBLE SlightlyDeepContourMetres [get, set]
 Separates depth colours when NumberOfDepthZones is 8. More...
 
DOUBLE VeryDeepContourMetres [get, set]
 Separates depth colours when NumberOfDepthZones is 8. More...
 
S57DepthDisplayUnits DepthDisplayUnits [get, set]
 The display units for depths (contours and soundings). More...
 
LONG CompilationScaleZoomFactor [get, set]
 The factor which determines when a cell of a particular compilation scale is drawn. More...
 
DOUBLE FontScaleFactor [get, set]
 Affects size of text. Range 0.4 to 4. Default 1. More...
 
S57DisplayImprovements ImprovementsLevel [get, set]
 Controls non-standard ENC display improvements. Associated with decluttering ENC displays. More...
 
BSTR XML [get, set]
 XML string representing settings. More...
 
VARIANT_BOOL IgnoreScamin [get, set]
 When set to true ignore the SCAMIN property on any features so they are drawn. More...
 
VARIANT_BOOL DeclutterOverlappingCells [get, set]
 When set to true where cells with the same navigational purpose overlap, only draw one of them. More...
 
VARIANT_BOOL ShowOverlappingCellAreas [get, set]
 When set to true where cells with the same navigational purpose overlap, and DeclutterOverlapping is true, highlight the overlapping area. More...
 
VARIANT_BOOL HighlightDateDependent [get, set]
 When set to true, draw symbol CHDATD01 with date dependent objects. More...
 
S57DateMode DateMode [get, set]
 Change between system date, user date or ignore date when handling drawing of features with date dependent attributes. More...
 
VARIANT_BOOL ShowIsolatedDangersInShallowWater [get, set]
 When set to true underwater or above water dangers are highlighted with the isolated danger symbol. More...
 

Detailed Description

Properties and methods for ENCX::S57DisplaySettings.

Viewing Groups

These are from S-52.

AML Viewing Groups

Text Groups

These are from S-52.

Definition at line 2885 of file encxcom.idl.

Member Function Documentation

◆ Copy()

HRESULT IS57DisplaySettings::Copy ( [out, retval] IS57DisplaySettings **  pVal)

Get an identical copy of this object. Like the Clone() method but type safe.

◆ MergeXML()

HRESULT IS57DisplaySettings::MergeXML ( [in] BSTR  xml)

Merge XML string into existing settings.

◆ ScaminForObjectClass()

HRESULT IS57DisplaySettings::ScaminForObjectClass ( [in] IS57ObjectClass cr,
[out, retval] LONG *  scamin 
)

Obtaining the SCAMIN value for an object class. Returns 0 if there is no override value.

◆ SetScaminForObjectClass()

HRESULT IS57DisplaySettings::SetScaminForObjectClass ( [in] IS57ObjectClass cr,
[in] LONG  scamin 
)

Setting the SCAMIN value overrides any SCAMIN in individual features of that object class. 0 will remove the override.

◆ SetViewingGroupRange()

HRESULT IS57DisplaySettings::SetViewingGroupRange ( [in] LONG  Start,
[in] LONG  End,
[in] VARIANT_BOOL  bShow 
)

Show or hide multiple viewing groups at once.

Property Documentation

◆ CellFilter

IS57CellIdentifiers IS57DisplaySettings::CellFilter
getsetproperty

Specific cells that can be drawn (excluding all others) or must not be drawn.

If CellFilterInclusive == true, then only these cells will be drawn. If CellFilterInclusive == false, then these cells are not drawn. If CellFilter is empty and CellFilterInclusive is true , then no cells are drawn.

◆ CellFilterInclusive

VARIANT_BOOL IS57DisplaySettings::CellFilterInclusive
getsetproperty

Controls the interpretation of CellFilter().

Set to true to only drawn the cells specified in CellFilter. Set to false to draw all cells apart from the ones in CellFilter.

If CellFilterInclusive == true, then only these cells will be drawn.

If CellFilterInclusive == false, then all other cells will be drawn.

However, if CellFilter is empty, then all cells are drawn regardless of the CellFilterInclusive setting.

◆ CompilationScaleZoomFactor

LONG IS57DisplaySettings::CompilationScaleZoomFactor
getsetproperty

The factor which determines when a cell of a particular compilation scale is drawn.

The factor which determines when a cell of a particular compilation scale is drawn. Must be an integer in the range 1..10.

◆ Date

DATE IS57DisplaySettings::Date
getsetproperty

Date for chart display which affects seasonal S-57 features (which used PERSTA,PEREND,DATSTA,DATEND). Defaults to now. DateMode must be set to S57DateMode_UseSetDate.

◆ DateMode

S57DateMode IS57DisplaySettings::DateMode
getsetproperty

Change between system date, user date or ignore date when handling drawing of features with date dependent attributes.

◆ DeclutterOverlappingCells

VARIANT_BOOL IS57DisplaySettings::DeclutterOverlappingCells
getsetproperty

When set to true where cells with the same navigational purpose overlap, only draw one of them.

◆ DeepContourMetres

DOUBLE IS57DisplaySettings::DeepContourMetres
getsetproperty

Separates depth colours when TwoColourShadingForDepthZones is false.

◆ DepthDisplayUnits

S57DepthDisplayUnits IS57DisplaySettings::DepthDisplayUnits
getsetproperty

The display units for depths (contours and soundings).

◆ FeatureFilter

IS57FeatureIdentifiers IS57DisplaySettings::FeatureFilter
getsetproperty

Specific features that can be drawn (excluding all others) or must not be drawn.

If FeatureFilterInclusive == true, then only these features will be drawn.

If FeatureFilterInclusive == false, then all other features will be drawn.

However, if FeatureFilter is empty, then all features are drawn regardless of the FeatureFilterInclusive setting.

◆ FeatureFilterInclusive

VARIANT_BOOL IS57DisplaySettings::FeatureFilterInclusive
getsetproperty

Controls the interpretation of FeatureFilter().

If FeatureFilterInclusive == true, then only these features will be drawn.

If FeatureFilterInclusive == false, then all other features will be drawn.

However, if FeatureFilter is empty, then all features are drawn regardless of the FeatureFilterInclusive setting.

◆ FontScaleFactor

DOUBLE IS57DisplaySettings::FontScaleFactor
getset

Affects size of text. Range 0.4 to 4. Default 1.

◆ FullLengthLightSectorLines

VARIANT_BOOL IS57DisplaySettings::FullLengthLightSectorLines
getsetproperty

When true, the rays indicating the limits of a light sector will be extended to their true range (or 9 Nm if the true range is not known); otherwise the ray will be 1" long.

◆ HighlightDateDependent

VARIANT_BOOL IS57DisplaySettings::HighlightDateDependent
getsetproperty

When set to true, draw symbol CHDATD01 with date dependent objects.

◆ IgnoreScamin

VARIANT_BOOL IS57DisplaySettings::IgnoreScamin
getsetproperty

When set to true ignore the SCAMIN property on any features so they are drawn.

◆ ImprovementsLevel

S57DisplayImprovements IS57DisplaySettings::ImprovementsLevel
getset

Controls non-standard ENC display improvements. Associated with decluttering ENC displays.

Decluttering approaches include: Scaling text and symbols better when display is zooming out from compilation scale. Scaling area text labels to fit inside relevant area. Scaling some symbols that work better slightly smaller. Scaling soundings.

Values: S57DisplayImprovements_Nothing: means turn it all off. This is correct if you are developing an ECDIS. Sorry. S57DisplayImprovements_Max: this is the state of the art. Probably also used in Nuno Navigator (http://www.nunonavigator.com) S57DisplayImprovements_Level1: the state as at Q1 2012. The same as _Max at currently _Max may change in the future and Level1 will not.

◆ NumDepthZones

LONG IS57DisplaySettings::NumDepthZones
getsetproperty

Controls the number of colours used for depths. Supersedes the TwoColourShadingForDepthZones property.

Valid values are 2, 4 and 8

◆ NumTextGroups

LONG IS57DisplaySettings::NumTextGroups
getproperty

Object classes are organised into text groups. The drawing of each text group can be switched on and off individually.

◆ NumViewingGroups

LONG IS57DisplaySettings::NumViewingGroups
getproperty

Object classes are organised into viewing groups. The drawing of each viewing group can be switched on and off individually.

◆ OverscaleIndicator

VARIANT_BOOL IS57DisplaySettings::OverscaleIndicator
getsetproperty

Draw the overscale indicator.

◆ SafetyContourMetres

DOUBLE IS57DisplaySettings::SafetyContourMetres
getsetproperty

The contour at this depth, or the next shallower depth, is emboldened.

◆ SafetyDepthMetres

DOUBLE IS57DisplaySettings::SafetyDepthMetres
getsetproperty

Soundings deeper than this are displayed in a lighter colour. Units are metres.

◆ ShallowContourMetres

DOUBLE IS57DisplaySettings::ShallowContourMetres
getsetproperty

Separates depth colours when TwoColourShadingForDepthZones is false.

◆ ShowIsolatedDangersInShallowWater

VARIANT_BOOL IS57DisplaySettings::ShowIsolatedDangersInShallowWater
getsetproperty

When set to true underwater or above water dangers are highlighted with the isolated danger symbol.

◆ ShowOverlappingCellAreas

VARIANT_BOOL IS57DisplaySettings::ShowOverlappingCellAreas
getsetproperty

When set to true where cells with the same navigational purpose overlap, and DeclutterOverlapping is true, highlight the overlapping area.

◆ SimplifiedSymbols

VARIANT_BOOL IS57DisplaySettings::SimplifiedSymbols
getsetproperty

When true, alternative symbols designed to be distinguishable at low resolutions will be used; otherwise symbols from chart 5001 will be used.

◆ SlightlyDeepContourMetres

DOUBLE IS57DisplaySettings::SlightlyDeepContourMetres
getsetproperty

Separates depth colours when NumberOfDepthZones is 8.

◆ SlightlyShallowContourMetres

DOUBLE IS57DisplaySettings::SlightlyShallowContourMetres
getsetproperty

Separates depth colours when NumberOfDepthZones is 8.

◆ SymbolisedAreaBoundaries

VARIANT_BOOL IS57DisplaySettings::SymbolisedAreaBoundaries
getsetproperty

When true, the edges of some areas (e.g. anchorages) will be drawn with appropriate symbols (e.g. anchors); otherwise a simple line (e.g. dashes) will be used.

◆ TextGroup

VARIANT_BOOL IS57DisplaySettings::TextGroup
getsetproperty

Object classes are organised into text groups. The drawing of each text group can be switched on and off individually.

◆ TwoColourShadingForDepthZones

VARIANT_BOOL IS57DisplaySettings::TwoColourShadingForDepthZones
getsetproperty

When true, two colours are used for non-drying depths; otherwise 4 colours are used.

When true, depth areas greater than and less than the SafetyDepthMetres (or the next shallower contour) will be distinguished by colour.

When false, depth areas less than the ShallowContourMetres, between ShallowContourMetres and SafetyDepthMetres, between SafetyDepthMetres and DeepContourMetres, and greater than DeepContourMetres will be distinguished by colour.

◆ Usages

IS57ProductAndUsages IS57DisplaySettings::Usages
getsetproperty

The types of S-57 data that should be drawn.

◆ VeryDeepContourMetres

DOUBLE IS57DisplaySettings::VeryDeepContourMetres
getsetproperty

Separates depth colours when NumberOfDepthZones is 8.

◆ VeryShallowContourMetres

DOUBLE IS57DisplaySettings::VeryShallowContourMetres
getsetproperty

Separates depth colours when NumberOfDepthZones is 8.

◆ ViewingGroup

VARIANT_BOOL IS57DisplaySettings::ViewingGroup
getsetproperty

Object classes are organised into viewing groups. The drawing of each viewing group can be switched on and off individually.

◆ XML

BSTR IS57DisplaySettings::XML
getset

XML string representing settings.