OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
ChartBase Class Referenceabstract

Base class for all chart types. More...

#include <chartbase.h>

Inheritance diagram for ChartBase:
AbstractChart ChartBaseBSB ChartDummy ChartMbTiles s57chart ChartGEO ChartKAP ChartPlugInWrapper cm93chart cm93compchart

Public Member Functions

virtual InitReturn Init (const wxString &name, ChartInitFlag init_flags)=0
 
virtual void Activate (void)
 
virtual void Deactivate (void)
 
virtual ThumbData * GetThumbData (int tnx, int tny, float lat, float lon)=0
 
virtual ThumbData * GetThumbData ()=0
 
virtual bool UpdateThumbData (double lat, double lon)=0
 
virtual double GetNormalScaleMin (double canvas_scale_factor, bool b_allow_overzoom)=0
 
virtual double GetNormalScaleMax (double canvas_scale_factor, int canvas_width)=0
 
virtual bool GetChartExtent (Extent *pext)=0
 
virtual OcpnProjType GetChartProjectionType ()
 
virtual wxDateTime GetEditionDate (void)
 
virtual wxString GetPubDate ()
 
virtual int GetNativeScale ()
 
wxString GetFullPath () const
 
wxString GetHashKey () const
 
wxString GetName ()
 
wxString GetDescription ()
 
wxString GetID ()
 
wxString GetSE ()
 
wxString GetDepthUnits ()
 
wxString GetSoundingsDatum ()
 
wxString GetDatumString ()
 
wxString GetExtraInfo ()
 
double GetChart_Error_Factor ()
 
ChartTypeEnum GetChartType ()
 
ChartFamilyEnum GetChartFamily ()
 
double GetChartSkew ()
 
virtual ChartDepthUnitType GetDepthUnitType (void)
 
virtual bool IsReadyToRender ()
 
virtual bool RenderRegionViewOnDC (wxMemoryDC &dc, const ViewPort &VPoint, const OCPNRegion &Region)=0
 
virtual bool RenderRegionViewOnGL (const wxGLContext &glc, const ViewPort &VPoint, const OCPNRegion &RectRegion, const LLRegion &Region)=0
 
virtual bool AdjustVP (ViewPort &vp_last, ViewPort &vp_proposed)=0
 
virtual void GetValidCanvasRegion (const ViewPort &VPoint, OCPNRegion *pValidRegion)=0
 
virtual LLRegion GetValidRegion ()=0
 
virtual void SetColorScheme (ColorScheme cs, bool bApplyImmediate=true)=0
 
virtual double GetNearestPreferredScalePPM (double target_scale_ppm)=0
 
virtual int GetCOVREntries ()
 
virtual int GetCOVRTablePoints (int iTable)
 
virtual int GetCOVRTablenPoints (int iTable)
 
virtual float * GetCOVRTableHead (int iTable)
 
virtual int GetNoCOVREntries ()
 
virtual int GetNoCOVRTablePoints (int iTable)
 
virtual int GetNoCOVRTablenPoints (int iTable)
 
virtual float * GetNoCOVRTableHead (int iTable)
 

Protected Attributes

int m_Chart_Scale
 
ChartTypeEnum m_ChartType
 
ChartFamilyEnum m_ChartFamily
 
wxString m_FullPath
 
wxString m_Name
 
wxString m_Description
 
wxString m_ID
 
wxString m_SE
 
wxString m_SoundingsDatum
 
wxString m_datum_str
 
wxString m_ExtraInfo
 
wxString m_PubYear
 
wxString m_DepthUnits
 
OcpnProjType m_projection
 
ChartDepthUnitType m_depth_unit_id
 
wxDateTime m_EdDate
 
ThumbData * pThumbData
 
ColorScheme m_global_color_scheme
 
bool bReadyToRender
 
double Chart_Error_Factor
 
double m_lon_datum_adjust
 
double m_lat_datum_adjust
 
double m_Chart_Skew
 
int m_nCOVREntries
 
int * m_pCOVRTablePoints
 
float ** m_pCOVRTable
 
int m_nNoCOVREntries
 
int * m_pNoCOVRTablePoints
 
float ** m_pNoCOVRTable
 

Detailed Description

Base class for all chart types.

Defines the interface and common functionality for all chart types in OpenCPN. Provides methods for initialization, rendering, and querying chart properties and data.

Definition at line 126 of file chartbase.h.

Constructor & Destructor Documentation

◆ ChartBase()

ChartBase::ChartBase ( )

Definition at line 122 of file chartimg.cpp.

◆ ~ChartBase()

ChartBase::~ChartBase ( )
pure virtual

Definition at line 152 of file chartimg.cpp.

Member Function Documentation

◆ Activate()

virtual void ChartBase::Activate ( void  )
inlinevirtual

Definition at line 133 of file chartbase.h.

◆ Deactivate()

virtual void ChartBase::Deactivate ( void  )
inlinevirtual

Definition at line 134 of file chartbase.h.

◆ GetChart_Error_Factor()

double ChartBase::GetChart_Error_Factor ( )
inline

Definition at line 163 of file chartbase.h.

◆ GetChartFamily()

ChartFamilyEnum ChartBase::GetChartFamily ( )
inline

Definition at line 165 of file chartbase.h.

◆ GetChartProjectionType()

virtual OcpnProjType ChartBase::GetChartProjectionType ( )
inlinevirtual

Definition at line 148 of file chartbase.h.

◆ GetChartSkew()

double ChartBase::GetChartSkew ( )
inline

Definition at line 166 of file chartbase.h.

◆ GetChartType()

ChartTypeEnum ChartBase::GetChartType ( )
inline

Definition at line 164 of file chartbase.h.

◆ GetCOVREntries()

virtual int ChartBase::GetCOVREntries ( )
inlinevirtual

Definition at line 189 of file chartbase.h.

◆ GetCOVRTableHead()

virtual float * ChartBase::GetCOVRTableHead ( int  iTable)
inlinevirtual

Definition at line 196 of file chartbase.h.

◆ GetCOVRTablenPoints()

virtual int ChartBase::GetCOVRTablenPoints ( int  iTable)
inlinevirtual

Definition at line 193 of file chartbase.h.

◆ GetCOVRTablePoints()

virtual int ChartBase::GetCOVRTablePoints ( int  iTable)
inlinevirtual

Definition at line 190 of file chartbase.h.

◆ GetDatumString()

wxString ChartBase::GetDatumString ( )
inline

Definition at line 161 of file chartbase.h.

◆ GetDepthUnits()

wxString ChartBase::GetDepthUnits ( )
inline

Definition at line 159 of file chartbase.h.

◆ GetDepthUnitType()

virtual ChartDepthUnitType ChartBase::GetDepthUnitType ( void  )
inlinevirtual

Definition at line 168 of file chartbase.h.

◆ GetDescription()

wxString ChartBase::GetDescription ( )
inline

Definition at line 156 of file chartbase.h.

◆ GetEditionDate()

virtual wxDateTime ChartBase::GetEditionDate ( void  )
inlinevirtual

Definition at line 149 of file chartbase.h.

◆ GetExtraInfo()

wxString ChartBase::GetExtraInfo ( )
inline

Definition at line 162 of file chartbase.h.

◆ GetFullPath()

wxString ChartBase::GetFullPath ( ) const
inline

Definition at line 153 of file chartbase.h.

◆ GetHashKey()

wxString ChartBase::GetHashKey ( ) const

Definition at line 172 of file chartimg.cpp.

◆ GetID()

wxString ChartBase::GetID ( )
inline

Definition at line 157 of file chartbase.h.

◆ GetName()

wxString ChartBase::GetName ( )
inline

Definition at line 155 of file chartbase.h.

◆ GetNativeScale()

virtual int ChartBase::GetNativeScale ( void  )
inlinevirtual

Definition at line 152 of file chartbase.h.

◆ GetNearestPreferredScalePPM()

virtual double ChartBase::GetNearestPreferredScalePPM ( double  target_scale_ppm)
pure virtual

Implemented in ChartBaseBSB, and ChartPlugInWrapper.

◆ GetNoCOVREntries()

virtual int ChartBase::GetNoCOVREntries ( )
inlinevirtual

Definition at line 198 of file chartbase.h.

◆ GetNoCOVRTableHead()

virtual float * ChartBase::GetNoCOVRTableHead ( int  iTable)
inlinevirtual

Definition at line 205 of file chartbase.h.

◆ GetNoCOVRTablenPoints()

virtual int ChartBase::GetNoCOVRTablenPoints ( int  iTable)
inlinevirtual

Definition at line 202 of file chartbase.h.

◆ GetNoCOVRTablePoints()

virtual int ChartBase::GetNoCOVRTablePoints ( int  iTable)
inlinevirtual

Definition at line 199 of file chartbase.h.

◆ GetNormalScaleMax()

virtual double ChartBase::GetNormalScaleMax ( double  canvas_scale_factor,
int  canvas_width 
)
pure virtual

Implemented in ChartMbTiles.

◆ GetNormalScaleMin()

virtual double ChartBase::GetNormalScaleMin ( double  canvas_scale_factor,
bool  b_allow_overzoom 
)
pure virtual

Implemented in ChartMbTiles.

◆ GetPubDate()

virtual wxString ChartBase::GetPubDate ( )
inlinevirtual

Definition at line 151 of file chartbase.h.

◆ GetSE()

wxString ChartBase::GetSE ( )
inline

Definition at line 158 of file chartbase.h.

◆ GetSoundingsDatum()

wxString ChartBase::GetSoundingsDatum ( )
inline

Definition at line 160 of file chartbase.h.

◆ GetThumbData()

virtual ThumbData * ChartBase::GetThumbData ( int  tnx,
int  tny,
float  lat,
float  lon 
)
pure virtual

Implemented in ChartMbTiles.

◆ IsReadyToRender()

virtual bool ChartBase::IsReadyToRender ( )
inlinevirtual

Definition at line 170 of file chartbase.h.

Member Data Documentation

◆ bReadyToRender

bool ChartBase::bReadyToRender
protected

Definition at line 233 of file chartbase.h.

◆ Chart_Error_Factor

double ChartBase::Chart_Error_Factor
protected

Definition at line 235 of file chartbase.h.

◆ m_Chart_Scale

int ChartBase::m_Chart_Scale
protected

Definition at line 210 of file chartbase.h.

◆ m_Chart_Skew

double ChartBase::m_Chart_Skew
protected

Definition at line 241 of file chartbase.h.

◆ m_ChartFamily

ChartFamilyEnum ChartBase::m_ChartFamily
protected

Definition at line 212 of file chartbase.h.

◆ m_ChartType

ChartTypeEnum ChartBase::m_ChartType
protected

Definition at line 211 of file chartbase.h.

◆ m_datum_str

wxString ChartBase::m_datum_str
protected

Definition at line 220 of file chartbase.h.

◆ m_depth_unit_id

ChartDepthUnitType ChartBase::m_depth_unit_id
protected

Definition at line 226 of file chartbase.h.

◆ m_DepthUnits

wxString ChartBase::m_DepthUnits
protected

Definition at line 223 of file chartbase.h.

◆ m_Description

wxString ChartBase::m_Description
protected

Definition at line 216 of file chartbase.h.

◆ m_EdDate

wxDateTime ChartBase::m_EdDate
protected

Definition at line 228 of file chartbase.h.

◆ m_ExtraInfo

wxString ChartBase::m_ExtraInfo
protected

Definition at line 221 of file chartbase.h.

◆ m_FullPath

wxString ChartBase::m_FullPath
protected

Definition at line 214 of file chartbase.h.

◆ m_global_color_scheme

ColorScheme ChartBase::m_global_color_scheme
protected

Definition at line 232 of file chartbase.h.

◆ m_ID

wxString ChartBase::m_ID
protected

Definition at line 217 of file chartbase.h.

◆ m_lat_datum_adjust

double ChartBase::m_lat_datum_adjust
protected

Definition at line 239 of file chartbase.h.

◆ m_lon_datum_adjust

double ChartBase::m_lon_datum_adjust
protected

Definition at line 237 of file chartbase.h.

◆ m_Name

wxString ChartBase::m_Name
protected

Definition at line 215 of file chartbase.h.

◆ m_nCOVREntries

int ChartBase::m_nCOVREntries
protected

Definition at line 252 of file chartbase.h.

◆ m_nNoCOVREntries

int ChartBase::m_nNoCOVREntries
protected

Definition at line 258 of file chartbase.h.

◆ m_pCOVRTable

float** ChartBase::m_pCOVRTable
protected

Definition at line 255 of file chartbase.h.

◆ m_pCOVRTablePoints

int* ChartBase::m_pCOVRTablePoints
protected

Definition at line 253 of file chartbase.h.

◆ m_pNoCOVRTable

float** ChartBase::m_pNoCOVRTable
protected

Definition at line 261 of file chartbase.h.

◆ m_pNoCOVRTablePoints

int* ChartBase::m_pNoCOVRTablePoints
protected

Definition at line 259 of file chartbase.h.

◆ m_projection

OcpnProjType ChartBase::m_projection
protected

Definition at line 225 of file chartbase.h.

◆ m_PubYear

wxString ChartBase::m_PubYear
protected

Definition at line 222 of file chartbase.h.

◆ m_SE

wxString ChartBase::m_SE
protected

Definition at line 218 of file chartbase.h.

◆ m_SoundingsDatum

wxString ChartBase::m_SoundingsDatum
protected

Definition at line 219 of file chartbase.h.

◆ pThumbData

ThumbData* ChartBase::pThumbData
protected

Definition at line 230 of file chartbase.h.

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