Extended chart base class with separated text rendering. More...

#include <ocpn_plugin.h>

Inheritance diagram for PlugInChartBaseExtended:

Public Member Functions
virtual int	RenderRegionViewOnGL (const wxGLContext &glc, const PlugIn_ViewPort &VPoint, const wxRegion &Region, bool b_use_stencil)
	OpenGL rendering with combined text and graphics.

virtual wxBitmap &	RenderRegionViewOnDCNoText (const PlugIn_ViewPort &VPoint, const wxRegion &Region)
	Standard DC rendering without text.

virtual bool	RenderRegionViewOnDCTextOnly (wxMemoryDC &dc, const PlugIn_ViewPort &VPoint, const wxRegion &Region)
	Standard DC text-only rendering.

virtual int	RenderRegionViewOnGLNoText (const wxGLContext &glc, const PlugIn_ViewPort &VPoint, const wxRegion &Region, bool b_use_stencil)
	OpenGL rendering without text.

virtual int	RenderRegionViewOnGLTextOnly (const wxGLContext &glc, const PlugIn_ViewPort &VPoint, const wxRegion &Region, bool b_use_stencil)
	OpenGL text-only rendering.

virtual ListOfPI_S57Obj *	GetObjRuleListAtLatLon (float lat, float lon, float select_radius, PlugIn_ViewPort *VPoint)

virtual wxString	CreateObjDescriptions (ListOfPI_S57Obj *obj_list)

virtual int	GetNoCOVREntries ()

virtual int	GetNoCOVRTablePoints (int iTable)

virtual int	GetNoCOVRTablenPoints (int iTable)

virtual float *	GetNoCOVRTableHead (int iTable)

virtual void	ClearPLIBTextList ()
	Clears any cached text elements.

Public Member Functions inherited from PlugInChartBase
virtual wxString	GetFileSearchMask (void)
	Returns file pattern(s) for chart files this plugin can handle.

virtual int	Init (const wxString &full_path, int init_flags)
	Initializes a chart instance from a file.

virtual void	SetColorScheme (int cs, bool bApplyImmediate)
	Sets the color scheme for chart display.

virtual double	GetNormalScaleMin (double canvas_scale_factor, bool b_allow_overzoom)
	Returns the minimum recommended scale for this chart.

virtual double	GetNormalScaleMax (double canvas_scale_factor, int canvas_width)
	Returns the maximum recommended scale for this chart.

virtual double	GetNearestPreferredScalePPM (double target_scale_ppm)
	Returns the nearest preferred scale value for this chart.

virtual bool	GetChartExtent (ExtentPI *pext)
	Gets the geographic boundaries of the chart.

virtual wxBitmap &	RenderRegionView (const PlugIn_ViewPort &VPoint, const wxRegion &Region)
	Renders a region of the chart for display.

virtual bool	AdjustVP (PlugIn_ViewPort &vp_last, PlugIn_ViewPort &vp_proposed)
	Adjusts viewport parameters for chart-specific requirements.

virtual void	GetValidCanvasRegion (const PlugIn_ViewPort &VPoint, wxRegion *pValidRegion)
	Determines the valid display area for this chart.

virtual int	GetCOVREntries ()
	Returns the number of coverage table entries for this chart.

virtual int	GetCOVRTablePoints (int iTable)
	Returns the number of points in a specific coverage table entry.

virtual int	GetCOVRTablenPoints (int iTable)
	Alternative method to get the number of points in a coverage table entry.

virtual float *	GetCOVRTableHead (int iTable)
	Returns a pointer to the coverage table data for a specific entry.

virtual wxBitmap *	GetThumbnail (int tnx, int tny, int cs)
	Generates a thumbnail image of the chart.

virtual wxString	GetFullPath () const
	Returns the full file path of the chart.

virtual ChartTypeEnumPI	GetChartType ()
	Returns the chart type identifier.

virtual ChartFamilyEnumPI	GetChartFamily ()
	Returns the chart family classification.

virtual OcpnProjTypePI	GetChartProjection ()
	Returns the projection type used by the chart.

virtual wxString	GetName ()
	Returns the chart's name or title.

virtual wxString	GetDescription ()
	Returns a descriptive text about the chart.

virtual wxString	GetID ()
	Returns a unique identifier for the chart.

virtual wxString	GetSE ()
	Returns the chart's source edition identifier.

virtual wxString	GetDepthUnits ()
	Returns the depth units used in the chart.

virtual wxString	GetSoundingsDatum ()
	Returns the vertical datum used for soundings in the chart.

virtual wxString	GetDatumString ()
	Returns the horizontal geodetic datum of the chart.

virtual wxString	GetExtraInfo ()
	Returns additional information about the chart.

virtual wxString	GetPubDate ()
	Returns the publication date/year of the chart.

virtual double	GetChartErrorFactor ()
	Returns the error factor for the chart.

virtual ChartDepthUnitTypePI	GetDepthUnitId ()
	Returns the depth unit type identifier.

virtual bool	IsReadyToRender ()
	Indicates whether the chart is ready for rendering.

virtual int	GetNativeScale ()
	Returns the native scale of the chart.

virtual double	GetChartSkew ()
	Returns the skew/rotation angle of the chart.

virtual wxDateTime	GetEditionDate (void)
	Returns the edition date of the chart.

virtual void	ComputeSourceRectangle (const PlugIn_ViewPort &vp, wxRect *pSourceRect)
	Computes the source rectangle for the chart based on a given viewport.

virtual double	GetRasterScaleFactor ()
	Returns the scale factor for raster chart rendering.

virtual bool	GetChartBits (wxRect &source, unsigned char *pPix, int sub_samp)
	Gets pixel data for a portion of a raster chart.

virtual int	GetSize_X ()
	Gets the width of the chart in pixels.

virtual int	GetSize_Y ()
	Gets the height of the chart in pixels.

virtual void	latlong_to_chartpix (double lat, double lon, double &pixx, double &pixy)
	Converts geographic coordinates to chart pixel coordinates.

virtual void	chartpix_to_latlong (double pixx, double pixy, double plat, double plon)
	Converts chart pixel coordinates to geographic coordinates.

Additional Inherited Members
Protected Attributes inherited from PlugInChartBase
ChartTypeEnumPI	m_ChartType

ChartFamilyEnumPI	m_ChartFamily

wxString	m_FullPath

OcpnProjTypePI	m_projection

int	m_Chart_Scale

double	m_Chart_Skew

wxDateTime	m_EdDate

bool	m_bReadyToRender

wxString	m_Name

wxString	m_Description

wxString	m_ID

wxString	m_SE

wxString	m_SoundingsDatum

wxString	m_datum_str

wxString	m_PubYear

wxString	m_DepthUnits

wxString	m_ExtraInfo

ChartDepthUnitTypePI	m_depth_unit_id

double	m_Chart_Error_Factor

Detailed Description

Extended chart base class with separated text rendering.

Derived from PlugInChartBase, this class adds methods to separate text and graphic rendering for both standard DC and OpenGL contexts. This separation allows for more efficient rendering and better control over text placement.

Examples: /home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 3350 of file ocpn_plugin.h.

Constructor & Destructor Documentation

◆ PlugInChartBaseExtended()

PlugInChartBaseExtended::PlugInChartBaseExtended ( )

Definition at line 3541 of file pluginmanager.cpp.

◆ ~PlugInChartBaseExtended()

PlugInChartBaseExtended::~PlugInChartBaseExtended ( )

virtual

Definition at line 3543 of file pluginmanager.cpp.

Member Function Documentation

◆ ClearPLIBTextList()

void PlugInChartBaseExtended::ClearPLIBTextList ( )

virtual

Clears any cached text elements.

Removes all cached text elements, forcing them to be regenerated on next render.

Definition at line 3592 of file pluginmanager.cpp.

◆ CreateObjDescriptions()

wxString PlugInChartBaseExtended::CreateObjDescriptions ( ListOfPI_S57Obj * obj_list )

virtual

Definition at line 3579 of file pluginmanager.cpp.

◆ GetNoCOVREntries()

int PlugInChartBaseExtended::GetNoCOVREntries ( )

virtual

Definition at line 3584 of file pluginmanager.cpp.

◆ GetNoCOVRTableHead()

float * PlugInChartBaseExtended::GetNoCOVRTableHead ( int iTable )

virtual

Definition at line 3590 of file pluginmanager.cpp.

◆ GetNoCOVRTablenPoints()

int PlugInChartBaseExtended::GetNoCOVRTablenPoints ( int iTable )

virtual

Definition at line 3588 of file pluginmanager.cpp.

◆ GetNoCOVRTablePoints()

int PlugInChartBaseExtended::GetNoCOVRTablePoints ( int iTable )

virtual

Definition at line 3586 of file pluginmanager.cpp.

◆ GetObjRuleListAtLatLon()

ListOfPI_S57Obj * PlugInChartBaseExtended::GetObjRuleListAtLatLon	(	float	lat,
		float	lon,
		float	select_radius,
		PlugIn_ViewPort *	VPoint
	)

virtual

Definition at line 3574 of file pluginmanager.cpp.

◆ RenderRegionViewOnDCNoText()

wxBitmap & PlugInChartBaseExtended::RenderRegionViewOnDCNoText	(	const PlugIn_ViewPort &	VPoint,
		const wxRegion &	Region
	)

virtual

Standard DC rendering without text.

Renders only the graphical elements of the chart (no text) using standard device context.

Parameters

VPoint	Current viewport
Region	Region to render

Returns: Bitmap containing rendered graphics

Definition at line 3564 of file pluginmanager.cpp.

◆ RenderRegionViewOnDCTextOnly()

bool PlugInChartBaseExtended::RenderRegionViewOnDCTextOnly	(	wxMemoryDC &	dc,
		const PlugIn_ViewPort &	VPoint,
		const wxRegion &	Region
	)

virtual

Standard DC text-only rendering.

Renders only text elements on top of previously rendered graphics.

Parameters

dc	Memory DC to draw text into
VPoint	Current viewport
Region	Region to render

Returns: True if text was rendered

Definition at line 3569 of file pluginmanager.cpp.

◆ RenderRegionViewOnGL()

int PlugInChartBaseExtended::RenderRegionViewOnGL	(	const wxGLContext &	glc,
		const PlugIn_ViewPort &	VPoint,
		const wxRegion &	Region,
		bool	b_use_stencil
	)

virtual

OpenGL rendering with combined text and graphics.

Legacy full rendering method that draws both chart graphics and text in a single pass using OpenGL.

Parameters

glc	OpenGL context for rendering
VPoint	Current viewport settings
Region	Region to render
b_use_stencil	True to enable stencil buffer

Returns: Status code (0 = success)

Definition at line 3545 of file pluginmanager.cpp.

◆ RenderRegionViewOnGLNoText()

int PlugInChartBaseExtended::RenderRegionViewOnGLNoText	(	const wxGLContext &	glc,
		const PlugIn_ViewPort &	VPoint,
		const wxRegion &	Region,
		bool	b_use_stencil
	)

virtual

OpenGL rendering without text.

Renders only graphical elements using OpenGL.

Parameters

glc	OpenGL context
VPoint	Current viewport
Region	Region to render
b_use_stencil	True to enable stencil buffer

Returns: Status code (0 = success)

Definition at line 3552 of file pluginmanager.cpp.

◆ RenderRegionViewOnGLTextOnly()

int PlugInChartBaseExtended::RenderRegionViewOnGLTextOnly	(	const wxGLContext &	glc,
		const PlugIn_ViewPort &	VPoint,
		const wxRegion &	Region,
		bool	b_use_stencil
	)

virtual

OpenGL text-only rendering.

Renders only text elements using OpenGL on top of graphics.

Parameters

glc	OpenGL context
VPoint	Current viewport
Region	Region to render
b_use_stencil	True to enable stencil buffer

Returns: Status code (0 = success)

Definition at line 3558 of file pluginmanager.cpp.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PlugInChartBaseExtended()

◆ ~PlugInChartBaseExtended()

Member Function Documentation

◆ ClearPLIBTextList()

◆ CreateObjDescriptions()

◆ GetNoCOVREntries()

◆ GetNoCOVRTableHead()

◆ GetNoCOVRTablenPoints()

◆ GetNoCOVRTablePoints()

◆ GetObjRuleListAtLatLon()

◆ RenderRegionViewOnDCNoText()

◆ RenderRegionViewOnDCTextOnly()

◆ RenderRegionViewOnGL()

◆ RenderRegionViewOnGLNoText()

◆ RenderRegionViewOnGLTextOnly()