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

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

#include <concanv.h>

Inheritance diagram for ConsoleCanvasWin:

Public Member Functions

 ConsoleCanvasWin (wxWindow *parent)
 
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 ToggleShowHighway ()
 
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

◆ ConsoleCanvasWin()

ConsoleCanvasWin::ConsoleCanvasWin ( wxWindow *  parent)

Definition at line 80 of file concanv.cpp.

◆ ~ConsoleCanvasWin()

ConsoleCanvasWin::~ConsoleCanvasWin ( )

Definition at line 147 of file concanv.cpp.

Member Function Documentation

◆ LegRoute()

void ConsoleCanvasWin::LegRoute ( )

Definition at line 190 of file concanv.cpp.

◆ OnContextMenu()

void ConsoleCanvasWin::OnContextMenu ( wxContextMenuEvent &  event)

Definition at line 200 of file concanv.cpp.

◆ OnContextMenuSelection()

void ConsoleCanvasWin::OnContextMenuSelection ( wxCommandEvent &  event)

Definition at line 222 of file concanv.cpp.

◆ RefreshConsoleData()

void ConsoleCanvasWin::RefreshConsoleData ( void  )

Definition at line 442 of file concanv.cpp.

◆ SetColorScheme()

void ConsoleCanvasWin::SetColorScheme ( ColorScheme  cs)

Definition at line 149 of file concanv.cpp.

◆ ShowWithFreshFonts()

void ConsoleCanvasWin::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 453 of file concanv.cpp.

◆ ToggleRouteTotalDisplay()

void ConsoleCanvasWin::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 258 of file concanv.cpp.

◆ ToggleShowHighway()

void ConsoleCanvasWin::ToggleShowHighway ( )

Definition at line 247 of file concanv.cpp.

◆ UpdateFonts()

void ConsoleCanvasWin::UpdateFonts ( void  )

Definition at line 460 of file concanv.cpp.

◆ UpdateRouteData()

void ConsoleCanvasWin::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 275 of file concanv.cpp.

Member Data Documentation

◆ m_bNeedClear

bool ConsoleCanvasWin::m_bNeedClear

Definition at line 175 of file concanv.h.

◆ m_pitemBoxSizerLeg

wxBoxSizer* ConsoleCanvasWin::m_pitemBoxSizerLeg

Definition at line 165 of file concanv.h.

◆ m_pParent

wxWindow* ConsoleCanvasWin::m_pParent

Definition at line 163 of file concanv.h.

◆ pbackBrush

wxBrush* ConsoleCanvasWin::pbackBrush

Definition at line 176 of file concanv.h.

◆ pBRG

AnnunText* ConsoleCanvasWin::pBRG

Definition at line 168 of file concanv.h.

◆ pCDI

CDI* ConsoleCanvasWin::pCDI

Definition at line 172 of file concanv.h.

◆ pRNG

AnnunText* ConsoleCanvasWin::pRNG

Definition at line 169 of file concanv.h.

◆ pThisLegFont

wxFont* ConsoleCanvasWin::pThisLegFont

Definition at line 174 of file concanv.h.

◆ pThisLegText

wxStaticText* ConsoleCanvasWin::pThisLegText

Definition at line 164 of file concanv.h.

◆ pTTG

AnnunText* ConsoleCanvasWin::pTTG

Definition at line 170 of file concanv.h.

◆ pVMG

AnnunText* ConsoleCanvasWin::pVMG

Definition at line 171 of file concanv.h.

◆ pXTE

AnnunText* ConsoleCanvasWin::pXTE

Definition at line 167 of file concanv.h.


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