OpenCPN Partial API docs
Loading...
Searching...
No Matches
canvasConfig Class Reference

Encapsulates persistent canvas configuration. More...

#include <canvas_config.h>

Public Member Functions

 canvasConfig (int index)
 
void Reset ()
 Resets all configuration options to default values.
 
void LoadFromLegacyConfig (wxConfigBase *conf)
 

Public Attributes

int configIndex
 
ChartCanvascanvas
 Pointer to associated chart canvas.
 
double iLat
 Latitude of the center of the chart, in degrees.
 
double iLon
 Longitude of the center of the chart, in degrees.
 
double iScale
 Initial chart scale factor.
 
double iRotation
 Initial rotation angle in radians.
 
int DBindex
 
int GroupID
 
bool bFollow
 Enable vessel following mode.
 
bool bQuilt
 Enable chart quilting.
 
bool bShowTides
 Display tide information.
 
bool bShowCurrents
 Display current information.
 
wxSize canvasSize
 Canvas dimensions.
 
bool bShowGrid
 Display coordinate grid.
 
bool bShowOutlines
 Display chart outlines.
 
bool bShowDepthUnits
 Display depth unit indicators.
 
bool bCourseUp
 Orient display to course up.
 
bool bHeadUp
 Orient display to heading up.
 
bool bLookahead
 Enable lookahead mode.
 
bool bShowAIS
 Display AIS targets.
 
bool bAttenAIS
 Enable AIS target attenuation.
 
bool bShowENCText
 Display ENC text elements.
 
int nENCDisplayCategory
 
bool bShowENCDepths
 
bool bShowENCBuoyLabels
 
bool bShowENCLightDescriptions
 
bool bShowENCLights
 
bool bShowENCVisibleSectorLights
 
bool bShowENCAnchorInfo
 
bool bShowENCDataQuality
 

Detailed Description

Encapsulates persistent canvas configuration.

Stores various settings for a chart canvas, including position, scale, rotation, and display options for different chart elements.

Definition at line 43 of file canvas_config.h.

Constructor & Destructor Documentation

◆ canvasConfig()

canvasConfig::canvasConfig ( int  index)

Definition at line 46 of file canvas_config.cpp.

◆ ~canvasConfig()

canvasConfig::~canvasConfig ( )

Definition at line 56 of file canvas_config.cpp.

Member Function Documentation

◆ LoadFromLegacyConfig()

void canvasConfig::LoadFromLegacyConfig ( wxConfigBase *  conf)

Definition at line 74 of file canvas_config.cpp.

◆ Reset()

void canvasConfig::Reset ( void  )

Resets all configuration options to default values.

Initializes follow mode, tides, currents, orientation modes, and AIS settings.

Definition at line 58 of file canvas_config.cpp.

Member Data Documentation

◆ bAttenAIS

bool canvasConfig::bAttenAIS

Enable AIS target attenuation.

Definition at line 78 of file canvas_config.h.

◆ bCourseUp

bool canvasConfig::bCourseUp

Orient display to course up.

Definition at line 74 of file canvas_config.h.

◆ bFollow

bool canvasConfig::bFollow

Enable vessel following mode.

Definition at line 66 of file canvas_config.h.

◆ bHeadUp

bool canvasConfig::bHeadUp

Orient display to heading up.

Definition at line 75 of file canvas_config.h.

◆ bLookahead

bool canvasConfig::bLookahead

Enable lookahead mode.

Definition at line 76 of file canvas_config.h.

◆ bQuilt

bool canvasConfig::bQuilt

Enable chart quilting.

Definition at line 67 of file canvas_config.h.

◆ bShowAIS

bool canvasConfig::bShowAIS

Display AIS targets.

Definition at line 77 of file canvas_config.h.

◆ bShowCurrents

bool canvasConfig::bShowCurrents

Display current information.

Definition at line 69 of file canvas_config.h.

◆ bShowDepthUnits

bool canvasConfig::bShowDepthUnits

Display depth unit indicators.

Definition at line 73 of file canvas_config.h.

◆ bShowENCAnchorInfo

bool canvasConfig::bShowENCAnchorInfo

Definition at line 87 of file canvas_config.h.

◆ bShowENCBuoyLabels

bool canvasConfig::bShowENCBuoyLabels

Definition at line 83 of file canvas_config.h.

◆ bShowENCDataQuality

bool canvasConfig::bShowENCDataQuality

Definition at line 88 of file canvas_config.h.

◆ bShowENCDepths

bool canvasConfig::bShowENCDepths

Definition at line 82 of file canvas_config.h.

◆ bShowENCLightDescriptions

bool canvasConfig::bShowENCLightDescriptions

Definition at line 84 of file canvas_config.h.

◆ bShowENCLights

bool canvasConfig::bShowENCLights

Definition at line 85 of file canvas_config.h.

◆ bShowENCText

bool canvasConfig::bShowENCText

Display ENC text elements.

Definition at line 80 of file canvas_config.h.

◆ bShowENCVisibleSectorLights

bool canvasConfig::bShowENCVisibleSectorLights

Definition at line 86 of file canvas_config.h.

◆ bShowGrid

bool canvasConfig::bShowGrid

Display coordinate grid.

Definition at line 71 of file canvas_config.h.

◆ bShowOutlines

bool canvasConfig::bShowOutlines

Display chart outlines.

Definition at line 72 of file canvas_config.h.

◆ bShowTides

bool canvasConfig::bShowTides

Display tide information.

Definition at line 68 of file canvas_config.h.

◆ canvas

ChartCanvas* canvasConfig::canvas

Pointer to associated chart canvas.

Definition at line 59 of file canvas_config.h.

◆ canvasSize

wxSize canvasConfig::canvasSize

Canvas dimensions.

Definition at line 70 of file canvas_config.h.

◆ configIndex

int canvasConfig::configIndex

Definition at line 58 of file canvas_config.h.

◆ DBindex

int canvasConfig::DBindex

Definition at line 64 of file canvas_config.h.

◆ GroupID

int canvasConfig::GroupID

Definition at line 65 of file canvas_config.h.

◆ iLat

double canvasConfig::iLat

Latitude of the center of the chart, in degrees.

Definition at line 60 of file canvas_config.h.

◆ iLon

double canvasConfig::iLon

Longitude of the center of the chart, in degrees.

Definition at line 61 of file canvas_config.h.

◆ iRotation

double canvasConfig::iRotation

Initial rotation angle in radians.

Definition at line 63 of file canvas_config.h.

◆ iScale

double canvasConfig::iScale

Initial chart scale factor.

Definition at line 62 of file canvas_config.h.

◆ nENCDisplayCategory

int canvasConfig::nENCDisplayCategory

Definition at line 81 of file canvas_config.h.


The documentation for this class was generated from the following files: