IS57DisplaySettings Interface Reference

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

import "_encxcom_encx.idl";

Inheritance diagram for IS57DisplaySettings:

List of all members.

Public Member Functions

HRESULT SetViewingGroupRange ([in] LONG Start,[in] LONG End,[in] VARIANT_BOOL bShow)
 Show or hide multiple viewing groups at once.
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.
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.
HRESULT Copy ([out, retval] IS57DisplaySettings **pVal)
 Get an identical copy of this object. Like the Clone() method but typesafe.

Properties

VARIANT_BOOL * TwoColourShadingForDepthZones [get]
 When true, two colours are used for non-drying depths; otherwise 4 colours are used.
VARIANT_BOOL TwoColourShadingForDepthZones [set]
 When true, two colours are used for non-drying depths; otherwise 4 colours are used.
VARIANT_BOOL * SymbolisedAreaBoundaries [get]
 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.
VARIANT_BOOL SymbolisedAreaBoundaries [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.
VARIANT_BOOL * SimplifiedSymbols [get]
 When true, alternative symbols designed to be distinguishable at low resolutions will be used; otherwsie symbols from chart 5001 will be used.
VARIANT_BOOL SimplifiedSymbols [set]
 When true, alternative symbols designed to be distinguishable at low resolutions will be used; otherwsie symbols from chart 5001 will be used.
VARIANT_BOOL * FullLengthLightSectorLines [get]
 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.
VARIANT_BOOL FullLengthLightSectorLines [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.
VARIANT_BOOL * FastScrolling [get]
 When true, drawing will be simplfied while scrolling; otherwise drawing will be normal while scrolling.
VARIANT_BOOL FastScrolling [set]
 When true, drawing will be simplfied while scrolling; otherwise drawing will be normal while scrolling.
VARIANT_BOOL * OverscaleIndicator [get]
VARIANT_BOOL OverscaleIndicator [set]
DATE * Date [get]
DATE Date [set]
DOUBLE * SafetyDepthMetres [get]
 Soundings deeper than this are displayed in a lighter colour. Units are metres.
DOUBLE SafetyDepthMetres [set]
 Soundings deeper than this are displayed in a lighter colour. Units are metres.
DOUBLE * SafetyContourMetres [get]
 The contour at this depth, or the next shallower depth, is emboldened.
DOUBLE SafetyContourMetres [set]
 The contour at this depth, or the next shallower depth, is emboldened.
DOUBLE * ShallowContourMetres [get]
 Separates depth colours when TwoColourShadingForDepthZones is false.
DOUBLE ShallowContourMetres [set]
 Separates depth colours when TwoColourShadingForDepthZones is false.
DOUBLE * DeepContourMetres [get]
 Separates depth colours when TwoColourShadingForDepthZones is false.
DOUBLE DeepContourMetres [set]
 Separates depth colours when TwoColourShadingForDepthZones is false.
VARIANT_BOOL * ViewingGroup ([in] LONG ID) [get]
 Object classes are organised into viewing groups. The drawing of each viewing group can be switched on and off individually.
VARIANT_BOOL ViewingGroup ([in] LONG ID) [set]
 Object classes are organised into viewing groups. The drawing of each viewing group can be switched on and off individually.
LONG * NumViewingGroups [get]
 Object classes are organised into viewing groups. The drawing of each viewing group can be switched on and off individually.
VARIANT_BOOL * TextGroup ([in] LONG ID) [get]
 Object classes are organised into text groups. The drawing of each text group can be switched on and off individually.
VARIANT_BOOL TextGroup ([in] LONG ID) [set]
 Object classes are organised into text groups. The drawing of each text group can be switched on and off individually.
LONG * NumTextGroups [get]
 Object classes are organised into text groups. The drawing of each text group can be switched on and off individually.
IS57ProductAndUsages ** Usages [get]
 The types of S-57 data that should be drawn.
IS57ProductAndUsagesUsages [set]
 The types of S-57 data that should be drawn.
IS57CellIdentifiers ** CellFilter [get]
 Specific cells that can be drawn (excluding all others) or must not be drawn.
IS57CellIdentifiersCellFilter [set]
 Specific cells that can be drawn (excluding all others) or must not be drawn.
VARIANT_BOOL * CellFilterInclusive [get]
 Controls the interpretation of CellFilter().
VARIANT_BOOL CellFilterInclusive [set]
 Controls the interpretation of CellFilter().
IS57FeatureIdentifiers ** FeatureFilter [get]
 Specific features that can be drawn (excluding all others) or must not be drawn.
IS57FeatureIdentifiersFeatureFilter [set]
 Specific features that can be drawn (excluding all others) or must not be drawn.
VARIANT_BOOL * FeatureFilterInclusive [get]
 Controls the interpretation of FeatureFilter().
VARIANT_BOOL FeatureFilterInclusive [set]
 Controls the interpretation of FeatureFilter().
LONG * NumDepthZones [get]
 Controls the number of colours used for depths. Superceeds the TwoColourShadingForDepthZones property.
LONG NumDepthZones [set]
 Controls the number of colours used for depths. Superceeds the TwoColourShadingForDepthZones property.
DOUBLE * VeryShallowContourMetres [get]
 Separates depth colours when NumberOfDepthZones is 8.
DOUBLE VeryShallowContourMetres [set]
 Separates depth colours when NumberOfDepthZones is 8.
DOUBLE * SlightlyShallowContourMetres [get]
 Separates depth colours when NumberOfDepthZones is 8.
DOUBLE SlightlyShallowContourMetres [set]
 Separates depth colours when NumberOfDepthZones is 8.
DOUBLE * SlightlyDeepContourMetres [get]
 Separates depth colours when NumberOfDepthZones is 8.
DOUBLE SlightlyDeepContourMetres [set]
 Separates depth colours when NumberOfDepthZones is 8.
DOUBLE * VeryDeepContourMetres [get]
 Separates depth colours when NumberOfDepthZones is 8.
DOUBLE VeryDeepContourMetres [set]
 Separates depth colours when NumberOfDepthZones is 8.
S57DepthDisplayUnitsDepthDisplayUnits [get]
 The display units for depths (contours and soundings).
S57DepthDisplayUnits DepthDisplayUnits [set]
 The display units for depths (contours and soundings).
LONG * CompilationScaleZoomFactor [get]
 The factor which determines how when a cell of a particular compilation scale is drawn.
LONG CompilationScaleZoomFactor [set]
 The factor which determines how when a cell of a particular compilation scale is drawn. Must be an integer in the range 1..10.


Detailed Description

Properties and methods for ENCX::S57DisplaySettings.

Viewing Groups

These are from S-52.

34051, non-dangerous rocks (UWTROC), wrecks (WRECKS) and obstructions (OBSTRN) which have a VALSOU attribute and are not a danger to own-ship’s navigation (these objects are all Display Base if a danger to own-ship

Text Groups

These are from S-52.

Definition at line 2534 of file _encxcom_encx.idl.


Member Function Documentation

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

Show or hide multiple viewing groups at once.

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.

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.

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

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


Property Documentation

VARIANT_BOOL* IS57DisplaySettings::TwoColourShadingForDepthZones [get]

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.

VARIANT_BOOL IS57DisplaySettings::TwoColourShadingForDepthZones [set]

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.

VARIANT_BOOL* IS57DisplaySettings::SymbolisedAreaBoundaries [get]

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.

VARIANT_BOOL IS57DisplaySettings::SymbolisedAreaBoundaries [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.

VARIANT_BOOL* IS57DisplaySettings::SimplifiedSymbols [get]

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

VARIANT_BOOL IS57DisplaySettings::SimplifiedSymbols [set]

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

VARIANT_BOOL* IS57DisplaySettings::FullLengthLightSectorLines [get]

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.

VARIANT_BOOL IS57DisplaySettings::FullLengthLightSectorLines [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.

VARIANT_BOOL* IS57DisplaySettings::FastScrolling [get]

When true, drawing will be simplfied while scrolling; otherwise drawing will be normal while scrolling.

An indication fo scrolling has to be passed into the IS57Draw::Draw method for this to work.

VARIANT_BOOL IS57DisplaySettings::FastScrolling [set]

When true, drawing will be simplfied while scrolling; otherwise drawing will be normal while scrolling.

An indication fo scrolling has to be passed into the IS57Draw::Draw method for this to work.

VARIANT_BOOL* IS57DisplaySettings::OverscaleIndicator [get]

VARIANT_BOOL IS57DisplaySettings::OverscaleIndicator [set]

DATE* IS57DisplaySettings::Date [get]

DATE IS57DisplaySettings::Date [set]

DOUBLE* IS57DisplaySettings::SafetyDepthMetres [get]

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

DOUBLE IS57DisplaySettings::SafetyDepthMetres [set]

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

DOUBLE* IS57DisplaySettings::SafetyContourMetres [get]

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

DOUBLE IS57DisplaySettings::SafetyContourMetres [set]

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

DOUBLE* IS57DisplaySettings::ShallowContourMetres [get]

Separates depth colours when TwoColourShadingForDepthZones is false.

DOUBLE IS57DisplaySettings::ShallowContourMetres [set]

Separates depth colours when TwoColourShadingForDepthZones is false.

DOUBLE* IS57DisplaySettings::DeepContourMetres [get]

Separates depth colours when TwoColourShadingForDepthZones is false.

DOUBLE IS57DisplaySettings::DeepContourMetres [set]

Separates depth colours when TwoColourShadingForDepthZones is false.

VARIANT_BOOL* IS57DisplaySettings::ViewingGroup([in] LONG ID) [get]

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

VARIANT_BOOL IS57DisplaySettings::ViewingGroup([in] LONG ID) [set]

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

LONG* IS57DisplaySettings::NumViewingGroups [get]

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

VARIANT_BOOL* IS57DisplaySettings::TextGroup([in] LONG ID) [get]

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

VARIANT_BOOL IS57DisplaySettings::TextGroup([in] LONG ID) [set]

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

LONG* IS57DisplaySettings::NumTextGroups [get]

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

IS57ProductAndUsages ** IS57DisplaySettings::Usages [get]

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

IS57ProductAndUsages * IS57DisplaySettings::Usages [set]

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

IS57CellIdentifiers ** IS57DisplaySettings::CellFilter [get]

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

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

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

IS57CellIdentifiers * IS57DisplaySettings::CellFilter [set]

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 all other cells will be drawn.

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

VARIANT_BOOL* IS57DisplaySettings::CellFilterInclusive [get]

Controls the interpretation of 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.

VARIANT_BOOL IS57DisplaySettings::CellFilterInclusive [set]

Controls the interpretation of 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.

IS57FeatureIdentifiers ** IS57DisplaySettings::FeatureFilter [get]

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.

IS57FeatureIdentifiers * IS57DisplaySettings::FeatureFilter [set]

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.

VARIANT_BOOL* IS57DisplaySettings::FeatureFilterInclusive [get]

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.

VARIANT_BOOL IS57DisplaySettings::FeatureFilterInclusive [set]

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.

LONG* IS57DisplaySettings::NumDepthZones [get]

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

Valid values are 2, 4 and 8

LONG IS57DisplaySettings::NumDepthZones [set]

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

Valid values are 2, 4 and 8

DOUBLE* IS57DisplaySettings::VeryShallowContourMetres [get]

Separates depth colours when NumberOfDepthZones is 8.

DOUBLE IS57DisplaySettings::VeryShallowContourMetres [set]

Separates depth colours when NumberOfDepthZones is 8.

DOUBLE* IS57DisplaySettings::SlightlyShallowContourMetres [get]

Separates depth colours when NumberOfDepthZones is 8.

DOUBLE IS57DisplaySettings::SlightlyShallowContourMetres [set]

Separates depth colours when NumberOfDepthZones is 8.

DOUBLE* IS57DisplaySettings::SlightlyDeepContourMetres [get]

Separates depth colours when NumberOfDepthZones is 8.

DOUBLE IS57DisplaySettings::SlightlyDeepContourMetres [set]

Separates depth colours when NumberOfDepthZones is 8.

DOUBLE* IS57DisplaySettings::VeryDeepContourMetres [get]

Separates depth colours when NumberOfDepthZones is 8.

DOUBLE IS57DisplaySettings::VeryDeepContourMetres [set]

Separates depth colours when NumberOfDepthZones is 8.

S57DepthDisplayUnits* IS57DisplaySettings::DepthDisplayUnits [get]

The display units for depths (contours and soundings).

S57DepthDisplayUnits IS57DisplaySettings::DepthDisplayUnits [set]

The display units for depths (contours and soundings).

LONG* IS57DisplaySettings::CompilationScaleZoomFactor [get]

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

LONG IS57DisplaySettings::CompilationScaleZoomFactor [set]

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