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

Primary navigation console display for route and vessel tracking. More...

#include <concanv.h>

Inheritance diagram for ConsoleCanvas:

Public Member Functions

 ConsoleCanvas (wxWindow *frame)
 
void UpdateRouteData ()
 Updates route-related data displays.
 
void ShowWithFreshFonts (void)
 Recomputes and applies new fonts to console elements.
 
void UpdateFonts (void)
 
void SetColorScheme (ColorScheme cs)
 
void LegRoute ()
 
void OnContextMenu (wxContextMenuEvent &event)
 
void OnContextMenuSelection (wxCommandEvent &event)
 
void RefreshConsoleData (void)
 
void ToggleRouteTotalDisplay ()
 Toggles between route total and current leg display modes.
 

Public Attributes

wxWindow * m_pParent
 
wxStaticText * pThisLegText
 
wxBoxSizer * m_pitemBoxSizerLeg
 
AnnunTextpXTE
 
AnnunTextpBRG
 
AnnunTextpRNG
 
AnnunTextpTTG
 
AnnunTextpVMG
 
CDIpCDI
 
wxFont * pThisLegFont
 
bool m_bNeedClear
 
wxBrush * pbackBrush
 

Detailed Description

Primary navigation console display for route and vessel tracking.

Manages a dynamic interface that presents real-time navigation metrics during active route tracking. Provides detailed route information and interaction capabilities for maritime navigation.

Key Responsibilities:

  • Display current leg and total route navigation data
  • Render route-related information like XTE, bearing, range, TTG
  • Support user interactions for route display modes
  • Manage color scheme and font rendering

Navigation Display Modes:

  • Single Leg Mode: Focuses on current route segment
  • Total Route Mode: Displays cumulative route statistics
  • Speed Calculation: Supports VMG and SOG calculations

Interaction Features:

  • Context menu for route and display configuration
  • Toggleable route total/leg display
  • Dynamic font and color scheme adaptation

Definition at line 127 of file concanv.h.

Constructor & Destructor Documentation

◆ ConsoleCanvas()

ConsoleCanvas::ConsoleCanvas ( wxWindow *  frame)

Definition at line 81 of file concanv.cpp.

◆ ~ConsoleCanvas()

ConsoleCanvas::~ConsoleCanvas ( )

Definition at line 149 of file concanv.cpp.

Member Function Documentation

◆ LegRoute()

void ConsoleCanvas::LegRoute ( )

Definition at line 194 of file concanv.cpp.

◆ OnContextMenu()

void ConsoleCanvas::OnContextMenu ( wxContextMenuEvent &  event)

Definition at line 204 of file concanv.cpp.

◆ OnContextMenuSelection()

void ConsoleCanvas::OnContextMenuSelection ( wxCommandEvent &  event)

Definition at line 226 of file concanv.cpp.

◆ RefreshConsoleData()

void ConsoleCanvas::RefreshConsoleData ( void  )

Definition at line 429 of file concanv.cpp.

◆ SetColorScheme()

void ConsoleCanvas::SetColorScheme ( ColorScheme  cs)

Definition at line 151 of file concanv.cpp.

◆ ShowWithFreshFonts()

void ConsoleCanvas::ShowWithFreshFonts ( void  )

Recomputes and applies new fonts to console elements.

Ensures consistent font rendering across different platforms and display configurations. Triggers layout recalculation.

Definition at line 440 of file concanv.cpp.

◆ ToggleRouteTotalDisplay()

void ConsoleCanvas::ToggleRouteTotalDisplay ( )

Toggles between route total and current leg display modes.

Switches speed calculation method and route information presentation between:

  • Current leg metrics
  • Total route statistics

Definition at line 251 of file concanv.cpp.

◆ UpdateFonts()

void ConsoleCanvas::UpdateFonts ( void  )

Definition at line 449 of file concanv.cpp.

◆ UpdateRouteData()

void ConsoleCanvas::UpdateRouteData ( )

Updates route-related data displays.

Calculates and refreshes navigation metrics based on current route state, vessel position, and selected display mode.

Definition at line 261 of file concanv.cpp.

Member Data Documentation

◆ m_bNeedClear

bool ConsoleCanvas::m_bNeedClear

Definition at line 173 of file concanv.h.

◆ m_pitemBoxSizerLeg

wxBoxSizer* ConsoleCanvas::m_pitemBoxSizerLeg

Definition at line 163 of file concanv.h.

◆ m_pParent

wxWindow* ConsoleCanvas::m_pParent

Definition at line 161 of file concanv.h.

◆ pbackBrush

wxBrush* ConsoleCanvas::pbackBrush

Definition at line 174 of file concanv.h.

◆ pBRG

AnnunText* ConsoleCanvas::pBRG

Definition at line 166 of file concanv.h.

◆ pCDI

CDI* ConsoleCanvas::pCDI

Definition at line 170 of file concanv.h.

◆ pRNG

AnnunText* ConsoleCanvas::pRNG

Definition at line 167 of file concanv.h.

◆ pThisLegFont

wxFont* ConsoleCanvas::pThisLegFont

Definition at line 172 of file concanv.h.

◆ pThisLegText

wxStaticText* ConsoleCanvas::pThisLegText

Definition at line 162 of file concanv.h.

◆ pTTG

AnnunText* ConsoleCanvas::pTTG

Definition at line 168 of file concanv.h.

◆ pVMG

AnnunText* ConsoleCanvas::pVMG

Definition at line 169 of file concanv.h.

◆ pXTE

AnnunText* ConsoleCanvas::pXTE

Definition at line 165 of file concanv.h.


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