Wrapper class for plugin-based charts. More...

#include <chartimg.h>

Inheritance diagram for ChartPlugInWrapper:

Public Member Functions
	ChartPlugInWrapper (const wxString &chart_class)
virtual wxString	GetFileSearchMask (void)
virtual InitReturn	Init (const wxString &name, ChartInitFlag init_flags)
virtual ThumbData *	GetThumbData (int tnx, int tny, float lat, float lon)
virtual ThumbData *	GetThumbData ()
virtual bool	UpdateThumbData (double lat, double lon)
double	GetNormalScaleMin (double canvas_scale_factor, bool b_allow_overzoom)
double	GetNormalScaleMax (double canvas_scale_factor, int canvas_width)
virtual bool	GetChartExtent (Extent *pext)
virtual bool	RenderRegionViewOnDC (wxMemoryDC &dc, const ViewPort &VPoint, const OCPNRegion &Region)
virtual bool	RenderRegionViewOnGL (const wxGLContext &glc, const ViewPort &VPoint, const OCPNRegion &RectRegion, const LLRegion &Region)
virtual bool	AdjustVP (ViewPort &vp_last, ViewPort &vp_proposed)
virtual void	GetValidCanvasRegion (const ViewPort &VPoint, OCPNRegion *pValidRegion)
virtual void	SetColorScheme (ColorScheme cs, bool bApplyImmediate)
virtual double	GetNearestPreferredScalePPM (double target_scale_ppm)
	Find the nearest preferred viewport scale (in pixels/meter) for this chart.
virtual PlugInChartBase *	GetPlugInChart (void)
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)
virtual void	ComputeSourceRectangle (const ViewPort &vp, wxRect *pSourceRect)
virtual double	GetRasterScaleFactor (const ViewPort &vp)
virtual bool	GetChartBits (wxRect &source, unsigned char *pPix, int sub_samp)
virtual int	GetSize_X ()
virtual int	GetSize_Y ()
virtual void	latlong_to_chartpix (double lat, double lon, double &pixx, double &pixy)
virtual void	chartpix_to_latlong (double pixx, double pixy, double plat, double plon)
virtual bool	RenderRegionViewOnDCNoText (wxMemoryDC &dc, const ViewPort &VPoint, const OCPNRegion &Region)
virtual bool	RenderRegionViewOnDCTextOnly (wxMemoryDC &dc, const ViewPort &VPoint, const OCPNRegion &Region)
virtual bool	RenderRegionViewOnGLNoText (const wxGLContext &glc, const ViewPort &VPoint, const OCPNRegion &RectRegion, const LLRegion &Region)
virtual bool	RenderRegionViewOnGLTextOnly (const wxGLContext &glc, const ViewPort &VPoint, const OCPNRegion &RectRegion)
virtual void	ClearPLIBTextList ()
Public Member Functions inherited from ChartBaseBSB
void	FreeLineCacheRows (int start=0, int end=-1)
bool	HaveLineCacheRow (int row)
int	GetNativeScale ()
virtual int	latlong_to_pix_vp (double lat, double lon, double &pixx, double &pixy, ViewPort &vp)
virtual int	vp_pix_to_latlong (ViewPort &vp, double pixx, double pixy, double lat, double lon)
virtual LLRegion	GetValidRegion ()
wxImage *	GetImage ()
void	SetVPRasterParms (const ViewPort &vpt)
double	GetPPM ()
Public Member Functions inherited from ChartBase
virtual void	Activate (void)
virtual void	Deactivate (void)
virtual OcpnProjType	GetChartProjectionType ()
virtual wxDateTime	GetEditionDate (void)
virtual wxString	GetPubDate ()
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 ()

Additional Inherited Members
Protected Member Functions inherited from ChartBaseBSB
wxRect	GetSourceRect ()
virtual bool	GetAndScaleData (unsigned char *ppn, size_t data_size, wxRect &source, int source_stride, wxRect &dest, int dest_stride, double scale_factor, ScaleTypeEnum scale_type)
bool	RenderViewOnDC (wxMemoryDC &dc, const ViewPort &VPoint)
bool	IsCacheValid ()
void	InvalidateCache ()
bool	IsRenderCacheable (wxRect &source, wxRect &dest)
void	CreatePaletteEntry (char *buffer, int palette_index)
PaletteDir	GetPaletteDir (void)
int *	GetPalettePtr (BSB_Color_Capability)
double	GetClosestValidNaturalScalePPM (double target_scale, double scale_factor_min, double scale_factor_max)
	Find closest valid scale that's a power of 2 multiple of chart's native scale.
virtual void	InvalidateLineCache ()
virtual bool	CreateLineIndex (void)
virtual wxBitmap *	CreateThumbnail (int tnx, int tny, ColorScheme cs)
virtual int	BSBGetScanline (unsigned char *pLineBuf, int y, int xs, int xl, int sub_samp)
bool	GetViewUsingCache (wxRect &source, wxRect &dest, const OCPNRegion &Region, ScaleTypeEnum scale_type)
bool	GetView (wxRect &source, wxRect &dest, ScaleTypeEnum scale_type)
virtual int	BSBScanScanline (wxInputStream *pinStream)
virtual int	ReadBSBHdrLine (wxInputStream , char , int)
virtual int	AnalyzeRefpoints (bool b_testSolution=true)
virtual bool	AnalyzeSkew (void)
virtual bool	SetMinMax (void)
InitReturn	PreInit (const wxString &name, ChartInitFlag init_flags, ColorScheme cs)
InitReturn	PostInit (void)
double	AdjustLongitude (double lon)
Protected Attributes inherited from ChartBaseBSB
PixelCache *	pPixCache
int	Size_X
int	Size_Y
int	m_Chart_DU
double	m_cph
double	m_proj_parameter
double	m_dx
double	m_dy
wxString	m_bsb_ver
bool	m_b_SHOM
bool	m_b_apply_dtm
int	m_datum_index
double	m_dtm_lat
double	m_dtm_lon
wxRect	cache_rect
wxRect	cache_rect_scaled
bool	cached_image_ok
ScaleTypeEnum	cache_scale_method
double	m_cached_scale_ppm
wxRect	m_last_vprect
wxRect	Rsrc
double	m_raster_scale_factor
int	nRefpoint
Refpoint *	pRefTable
int	nColorSize
int *	pline_table
CachedLine *	pLineCache
wxInputStream *	ifs_hdr
wxInputStream *	ifss_bitmap
wxBufferedInputStream *	ifs_bitmap
wxString *	pBitmapFilePath
unsigned char *	ifs_buf
unsigned char *	ifs_bufend
int	ifs_bufsize
unsigned char *	ifs_lp
int	ifs_file_offset
int	nFileOffsetDataStart
int	m_nLineOffset
GeoRef	cPoints
double	wpx [12]
double	wpy [12]
double	pwx [12]
double	pwy [12]
int	wpx_type
int	wpy_type
int	pwx_type
int	pwy_type
int	n_wpx
int	n_wpy
int	n_pwx
int	n_pwy
bool	bHaveEmbeddedGeoref
opncpnPalette *	pPalettes [N_BSB_COLORS]
BSB_Color_Capability	m_mapped_color_index
int	m_bilinear_limit
bool	bUseLineCache
float	m_LonMax
float	m_LonMin
float	m_LatMax
float	m_LatMin
int *	pPalette
PaletteDir	palette_direction
bool	bGeoErrorSent
double	m_ppm_avg
OCPNRegion	m_last_region
int	m_b_cdebug
double	m_proj_lat
double	m_proj_lon
ViewPort	m_vp_render_last
wxCriticalSection	m_critSect
wxULongLong	m_filesize
Protected Attributes inherited from ChartBase
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

Wrapper class for plugin-based charts.

Serves as an interface between the main application and plugin-provided charts. Allows seamless integration of charts from external plugins into the main chart handling system.

Definition at line 389 of file chartimg.h.

Constructor & Destructor Documentation

◆ ChartPlugInWrapper() [1/2]

ChartPlugInWrapper::ChartPlugInWrapper ( )

Definition at line 3662 of file pluginmanager.cpp.

◆ ChartPlugInWrapper() [2/2]

ChartPlugInWrapper::ChartPlugInWrapper ( const wxString & chart_class )

Definition at line 3664 of file pluginmanager.cpp.

◆ ~ChartPlugInWrapper()

ChartPlugInWrapper::~ChartPlugInWrapper ( )

virtual

Definition at line 3669 of file pluginmanager.cpp.

Member Function Documentation

◆ AdjustVP()

bool ChartPlugInWrapper::AdjustVP	(	ViewPort &	vp_last,
		ViewPort &	vp_proposed )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4191 of file pluginmanager.cpp.

◆ chartpix_to_latlong()

void ChartPlugInWrapper::chartpix_to_latlong	(	double	pixx,
		double	pixy,
		double *	plat,
		double *	plon )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4277 of file pluginmanager.cpp.

◆ ClearPLIBTextList()

void ChartPlugInWrapper::ClearPLIBTextList ( )

virtual

Definition at line 4183 of file pluginmanager.cpp.

◆ ComputeSourceRectangle()

void ChartPlugInWrapper::ComputeSourceRectangle	(	const ViewPort &	vp,
		wxRect *	pSourceRect )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4232 of file pluginmanager.cpp.

◆ GetChartBits()

bool ChartPlugInWrapper::GetChartBits	(	wxRect &	source,
		unsigned char *	pPix,
		int	sub_samp )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4247 of file pluginmanager.cpp.

◆ GetChartExtent()

bool ChartPlugInWrapper::GetChartExtent ( Extent * pext )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 3822 of file pluginmanager.cpp.

◆ GetCOVREntries()

int ChartPlugInWrapper::GetCOVREntries ( )

virtual

Reimplemented from ChartBase.

Definition at line 3749 of file pluginmanager.cpp.

◆ GetCOVRTableHead()

float * ChartPlugInWrapper::GetCOVRTableHead ( int iTable )

virtual

Reimplemented from ChartBase.

Definition at line 3770 of file pluginmanager.cpp.

◆ GetCOVRTablenPoints()

int ChartPlugInWrapper::GetCOVRTablenPoints ( int iTable )

virtual

Reimplemented from ChartBase.

Definition at line 3763 of file pluginmanager.cpp.

◆ GetCOVRTablePoints()

int ChartPlugInWrapper::GetCOVRTablePoints ( int iTable )

virtual

Reimplemented from ChartBase.

Definition at line 3756 of file pluginmanager.cpp.

◆ GetFileSearchMask()

wxString ChartPlugInWrapper::GetFileSearchMask ( void )

virtual

Definition at line 3673 of file pluginmanager.cpp.

◆ GetNearestPreferredScalePPM()

double ChartPlugInWrapper::GetNearestPreferredScalePPM ( double target_scale_ppm )

virtual

Find the nearest preferred viewport scale (in pixels/meter) for this chart.

The function aims to find a scale within 5% of the requested scale while staying between 1/0.01x and 64x of the chart's native scale.

Parameters

target_scale_ppm Desired viewport scale in physical pixels per meter.

Returns: Closest preferred scale in physical pixels per meter

Reimplemented from ChartBaseBSB.

Definition at line 4224 of file pluginmanager.cpp.

◆ GetNoCOVREntries()

int ChartPlugInWrapper::GetNoCOVREntries ( )

virtual

Reimplemented from ChartBase.

Definition at line 3782 of file pluginmanager.cpp.

◆ GetNoCOVRTableHead()

float * ChartPlugInWrapper::GetNoCOVRTableHead ( int iTable )

virtual

Reimplemented from ChartBase.

Definition at line 3812 of file pluginmanager.cpp.

◆ GetNoCOVRTablenPoints()

int ChartPlugInWrapper::GetNoCOVRTablenPoints ( int iTable )

virtual

Reimplemented from ChartBase.

Definition at line 3802 of file pluginmanager.cpp.

◆ GetNoCOVRTablePoints()

int ChartPlugInWrapper::GetNoCOVRTablePoints ( int iTable )

virtual

Reimplemented from ChartBase.

Definition at line 3792 of file pluginmanager.cpp.

◆ GetNormalScaleMax()

double ChartPlugInWrapper::GetNormalScaleMax	(	double	canvas_scale_factor,
		int	canvas_width )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 3903 of file pluginmanager.cpp.

◆ GetNormalScaleMin()

double ChartPlugInWrapper::GetNormalScaleMin	(	double	canvas_scale_factor,
		bool	b_allow_overzoom )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 3895 of file pluginmanager.cpp.

◆ GetPlugInChart()

virtual PlugInChartBase * ChartPlugInWrapper::GetPlugInChart ( void )

inlinevirtual

Definition at line 426 of file chartimg.h.

◆ GetRasterScaleFactor()

double ChartPlugInWrapper::GetRasterScaleFactor ( const ViewPort & vp )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4240 of file pluginmanager.cpp.

◆ GetSize_X()

int ChartPlugInWrapper::GetSize_X ( )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4258 of file pluginmanager.cpp.

◆ GetSize_Y()

int ChartPlugInWrapper::GetSize_Y ( )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4265 of file pluginmanager.cpp.

◆ GetThumbData() [1/2]

ThumbData * ChartPlugInWrapper::GetThumbData ( )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 3889 of file pluginmanager.cpp.

◆ GetThumbData() [2/2]

ThumbData * ChartPlugInWrapper::GetThumbData	(	int	tnx,
		int	tny,
		float	lat,
		float	lon )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 3838 of file pluginmanager.cpp.

◆ GetValidCanvasRegion()

void ChartPlugInWrapper::GetValidCanvasRegion	(	const ViewPort &	VPoint,
		OCPNRegion *	pValidRegion )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4200 of file pluginmanager.cpp.

◆ Init()

InitReturn ChartPlugInWrapper::Init	(	const wxString &	name,
		ChartInitFlag	init_flags )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 3680 of file pluginmanager.cpp.

◆ latlong_to_chartpix()

void ChartPlugInWrapper::latlong_to_chartpix	(	double	lat,
		double	lon,
		double &	pixx,
		double &	pixy )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4272 of file pluginmanager.cpp.

◆ RenderRegionViewOnDC()

bool ChartPlugInWrapper::RenderRegionViewOnDC	(	wxMemoryDC &	dc,
		const ViewPort &	VPoint,
		const OCPNRegion &	Region )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4101 of file pluginmanager.cpp.

◆ RenderRegionViewOnDCNoText()

bool ChartPlugInWrapper::RenderRegionViewOnDCNoText	(	wxMemoryDC &	dc,
		const ViewPort &	VPoint,
		const OCPNRegion &	Region )

virtual

Definition at line 4135 of file pluginmanager.cpp.

◆ RenderRegionViewOnDCTextOnly()

bool ChartPlugInWrapper::RenderRegionViewOnDCTextOnly	(	wxMemoryDC &	dc,
		const ViewPort &	VPoint,
		const OCPNRegion &	Region )

virtual

Definition at line 4162 of file pluginmanager.cpp.

◆ RenderRegionViewOnGL()

bool ChartPlugInWrapper::RenderRegionViewOnGL	(	const wxGLContext &	glc,
		const ViewPort &	VPoint,
		const OCPNRegion &	RectRegion,
		const LLRegion &	Region )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 3943 of file pluginmanager.cpp.

◆ RenderRegionViewOnGLNoText()

bool ChartPlugInWrapper::RenderRegionViewOnGLNoText	(	const wxGLContext &	glc,
		const ViewPort &	VPoint,
		const OCPNRegion &	RectRegion,
		const LLRegion &	Region )

virtual

Definition at line 4000 of file pluginmanager.cpp.

◆ RenderRegionViewOnGLTextOnly()

bool ChartPlugInWrapper::RenderRegionViewOnGLTextOnly	(	const wxGLContext &	glc,
		const ViewPort &	VPoint,
		const OCPNRegion &	RectRegion )

virtual

Definition at line 4068 of file pluginmanager.cpp.

◆ SetColorScheme()

void ChartPlugInWrapper::SetColorScheme	(	ColorScheme	cs,
		bool	bApplyImmediate )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 4215 of file pluginmanager.cpp.

◆ UpdateThumbData()

bool ChartPlugInWrapper::UpdateThumbData	(	double	lat,
		double	lon )

virtual

Reimplemented from ChartBaseBSB.

Definition at line 3891 of file pluginmanager.cpp.

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

/home/runner/work/main/main/opencpn/gui/include/gui/chartimg.h
/home/runner/work/main/main/opencpn/gui/src/pluginmanager.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ChartPlugInWrapper() [1/2]

◆ ChartPlugInWrapper() [2/2]

◆ ~ChartPlugInWrapper()

Member Function Documentation

◆ AdjustVP()

◆ chartpix_to_latlong()

◆ ClearPLIBTextList()

◆ ComputeSourceRectangle()

◆ GetChartBits()

◆ GetChartExtent()

◆ GetCOVREntries()

◆ GetCOVRTableHead()

◆ GetCOVRTablenPoints()

◆ GetCOVRTablePoints()

◆ GetFileSearchMask()

◆ GetNearestPreferredScalePPM()

◆ GetNoCOVREntries()

◆ GetNoCOVRTableHead()

◆ GetNoCOVRTablenPoints()

◆ GetNoCOVRTablePoints()

◆ GetNormalScaleMax()

◆ GetNormalScaleMin()

◆ GetPlugInChart()

◆ GetRasterScaleFactor()

◆ GetSize_X()

◆ GetSize_Y()

◆ GetThumbData() [1/2]

◆ GetThumbData() [2/2]

◆ GetValidCanvasRegion()

◆ Init()

◆ latlong_to_chartpix()

◆ RenderRegionViewOnDC()

◆ RenderRegionViewOnDCNoText()

◆ RenderRegionViewOnDCTextOnly()

◆ RenderRegionViewOnGL()

◆ RenderRegionViewOnGLNoText()

◆ RenderRegionViewOnGLTextOnly()

◆ SetColorScheme()

◆ UpdateThumbData()