OpenCPN Partial API docs
Loading...
Searching...
No Matches
canvas_options.h File Reference

Class CanvasOptions and helpers – Canvas options Window/Dialog. More...

#include <wx/checkbox.h>
#include <wx/dialog.h>
#include <wx/event.h>
#include <wx/scrolwin.h>
#include <wx/string.h>

Go to the source code of this file.

Classes

class  CanvasOptions
 Represents the Canvas Options dialog. More...
 

Enumerations

enum  {
  IDCO_SHOWDEPTHUNITSBOX1 = 31000 , IDCO_OUTLINECHECKBOX1 , IDCO_CHECK_DISPLAYGRID , IDCO_ZTCCHECKBOX ,
  IDCO_SMOOTHPANZOOMBOX , IDCO_PRESERVECHECKBOX , IDCO_QUILTCHECKBOX1 , IDCO_CHECK_LOOKAHEAD ,
  IDCO_COURSEUPCHECKBOX , IDCO_HEADUPCHECKBOX , IDCO_TIDES_CHECKBOX , IDCO_CURRENTS_CHECKBOX ,
  IDCO_ENCTEXT_CHECKBOX1 , ID_TOOLBARCHECKBOX , ID_CODISPCAT , IDCO_ENCDEPTH_CHECKBOX1 ,
  IDCO_ENCBUOY_CHECKBOX1 , IDCO_ENCBUOYLABEL_CHECKBOX1 , IDCO_ENCANCHOR_CHECKBOX1 , IDCO_SHOW_AIS_CHECKBOX ,
  IDCO_ATTEN_AIS_CHECKBOX , IDCO_ENCVISIBLESECTORS_CHECKBOX1 , IDCO_ENCDATAQUALITY_CHECKBOX
}
 Control IDs used in the CanvasOptions dialog. More...
 

Detailed Description

Class CanvasOptions and helpers – Canvas options Window/Dialog.

Definition in file canvas_options.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Control IDs used in the CanvasOptions dialog.

Enumerator
IDCO_SHOWDEPTHUNITSBOX1 

ID for checkbox to show depth units.

IDCO_OUTLINECHECKBOX1 

ID for checkbox to show chart outlines.

IDCO_CHECK_DISPLAYGRID 

ID for checkbox to display grid.

IDCO_ZTCCHECKBOX 

ID for checkbox related to zoom-to-cursor functionality.

IDCO_SMOOTHPANZOOMBOX 

ID for checkbox to enable smooth pan/zoom.

IDCO_PRESERVECHECKBOX 

ID for checkbox to preserve scale during operations.

IDCO_QUILTCHECKBOX1 

ID for checkbox to enable chart quilting.

Chart quilting combines multiple electronic charts into a seamless display. When enabled, the system automatically selects and blends the most appropriate charts based on the current view and zoom level. This provides a continuous navigation experience without visible chart boundaries, potentially combining charts of different scales or from different sources.

IDCO_CHECK_LOOKAHEAD 

ID for checkbox to enable look-ahead mode.

Look-ahead mode automatically adjusts the chart view to show more of the area ahead of the vessel based on its current course and speed. This feature helps navigators anticipate upcoming navigational challenges or points of interest. When enabled, the chart view is typically shifted so that the vessel's position is not centered but offset towards the bottom of the screen, showing more of the area ahead.

IDCO_COURSEUPCHECKBOX 

ID for checkbox to set course-up orientation.

In course-up mode, the chart is rotated so that the vessel's current course is always pointing towards the top of the screen. This orientation changes dynamically as the vessel changes course. It's particularly useful for navigation as it aligns the chart view with the vessel's direction of travel, making it easier to interpret upcoming features or obstacles.

IDCO_HEADUPCHECKBOX 

ID for checkbox to set head-up orientation.

In head-up mode, the chart is rotated so that the vessel's current heading (the direction the bow is pointing) is always at the top of the screen. This mode updates in real-time based on data from a compass or heading sensor. It's useful for understanding the vessel's orientation relative to charted objects, especially in situations with strong currents where heading and course might differ significantly.

IDCO_TIDES_CHECKBOX 

ID for checkbox to show tides.

IDCO_CURRENTS_CHECKBOX 

ID for checkbox to show currents.

IDCO_ENCTEXT_CHECKBOX1 

ID for checkbox to show ENC (Electronic Navigational Chart) text.

ID_TOOLBARCHECKBOX 

ID for checkbox to show/hide toolbar.

ID_CODISPCAT 

ID for control to set ENC display category.

IDCO_ENCDEPTH_CHECKBOX1 

ID for checkbox to show ENC depths.

IDCO_ENCBUOY_CHECKBOX1 

ID for checkbox to show ENC buoys.

IDCO_ENCBUOYLABEL_CHECKBOX1 

ID for checkbox to show ENC buoy labels.

IDCO_ENCANCHOR_CHECKBOX1 

ID for checkbox to show ENC anchor details.

IDCO_SHOW_AIS_CHECKBOX 

ID for checkbox to show AIS (Automatic Identification System) targets.

IDCO_ATTEN_AIS_CHECKBOX 

ID for checkbox to attenuate AIS targets.

IDCO_ENCVISIBLESECTORS_CHECKBOX1 

ID for checkbox to show ENC visible light sectors.

IDCO_ENCDATAQUALITY_CHECKBOX 

ID for checkbox to show ENC data quality indicators.

Definition at line 36 of file canvas_options.h.