SAGA API: CSG_Map_Legend Class Reference

SAGA API Version 9.14

Loading...

Searching...

No Matches

#include <map_legend.h>

Public Types
enum	{ VERTICAL = 0 , HORIZONTAL }

Public Member Functions
	CSG_Map_Legend (class CSG_Map_Layer *pLayer)
wxSize	Get_Size (double Zoom, double Zoom_Map)
void	Draw (wxDC &dc, double Zoom, double Zoom_Map, wxPoint Position, wxSize *pSize=NULL)
int	Get_Orientation (void) const
void	Set_Orientation (int Orientation)

Public Attributes
wxString	m_Title
wxString	m_Subtitle

Protected Member Functions
void	_Set_Size (int xSet, int yAdd)
void	_Set_Font (wxDC &dc, int Style)
void	_Draw_Title (wxDC &dc, int Style, wxString Text)
void	_Draw_Label (wxDC &dc, int y, wxString Text, int yAlign)
void	_Draw_Box (wxDC &dc, int y, int dy, int Style, int LineColor, int FillColor, wxString Text)
void	_Draw_Box (wxDC &dc, int y, int dy, int Style, int iClass)
void	_Draw_Boxes (wxDC &dc, int y, int Style, double zFactor=1.0)
void	_Draw_Point (wxDC &dc, class CSG_Map_Shapes_Point *pLayer)
void	_Draw_Line (wxDC &dc, class CSG_Map_Shapes_Line *pLayer)
void	_Draw_Polygon (wxDC &dc, class CSG_Map_Shapes_Polygon *pLayer)
void	_Draw_TIN (wxDC &dc, class CSG_Map_TIN *pLayer)
void	_Draw_PointCloud (wxDC &dc, class CSG_Map_PointCloud *pLayer)
void	_Draw_Grid (wxDC &dc, class CSG_Map_Grid *pLayer)
void	_Draw_Grids (wxDC &dc, class CSG_Map_Grids *pLayer)
void	_Draw_CompositeBand (wxDC &dc, int y, int dy, int Style, int Band, class CSG_Map_Grid *pLayer)
void	_Draw_CompositeBand (wxDC &dc, int y, int dy, int Style, int Band, class CSG_Map_Grids *pLayer)
void	_Draw_CompositeBand (wxDC &dc, int y, int dy, int Style, int Band, const wxString &Text)
void	_Draw_Layer_Image (wxDC &dc, int y, class CSG_Map_Layer *pLayer)
void	_Draw_Continuum (wxDC &dc, int y, double zFactor)
void	_Draw_Continuum_V (wxDC &dc, int y, double zMin, double zMax, double zFactor, double dz, int dyFont)
void	_Draw_Continuum_H (wxDC &dc, int y, double zMin, double zMax, double zFactor, double dz, int dyFont)

Protected Attributes
int	m_Orientation = VERTICAL
int	m_xBox = 0
int	m_dxBox = 0
int	m_xTick = 0
int	m_dxTick = 0
int	m_xText = 0
double	m_Zoom = 1.
double	m_Zoom_Map = 1.
wxPoint	m_Position
wxSize	m_Size
wxPen	m_oldPen
wxBrush	m_oldBrush
wxFont	m_oldFont
class CSG_Map_Layer *	m_pLayer = NULL
class CSG_Map_Symbology *	m_pSymbology = NULL

Detailed Description

Definition at line 74 of file map_legend.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
VERTICAL
HORIZONTAL

Definition at line 79 of file map_legend.h.

Constructor & Destructor Documentation

◆ CSG_Map_Legend()

CSG_Map_Legend::CSG_Map_Legend ( class CSG_Map_Layer * pLayer )

Definition at line 108 of file map_legend.cpp.

References CSG_Map_Layer::Get_Symbology(), m_Orientation, m_pLayer, m_pSymbology, and VERTICAL.

Member Function Documentation

◆ _Draw_Box() [1/2]

void CSG_Map_Legend::_Draw_Box	(	wxDC &	dc,
		int	y,
		int	dy,
		int	Style,
		int	iClass )

inlineprotected

Definition at line 303 of file map_legend.cpp.

References _Draw_Box(), BOX_STYLE_FILL, BOX_STYLE_OUTL, m_pSymbology, and SG_Get_Color().

◆ _Draw_Box() [2/2]

void CSG_Map_Legend::_Draw_Box	(	wxDC &	dc,
		int	y,
		int	dy,
		int	Style,
		int	LineColor,
		int	FillColor,
		wxString	Text )

inlineprotected

Definition at line 269 of file map_legend.cpp.

References _Draw_Label(), _Set_Size(), BOX_SPACE, BOX_STYLE_FILL, BOX_STYLE_LINE, BOX_STYLE_OUTL, BOX_STYLE_RECT, BOX_STYLE_SYMB, m_dxBox, m_pLayer, m_xBox, SG_DC_TEXTALIGN_TOP, and SG_Get_wxColor().

Referenced by _Draw_Box(), _Draw_Boxes(), _Draw_Continuum(), and _Draw_Line().

◆ _Draw_Boxes()

void CSG_Map_Legend::_Draw_Boxes	(	wxDC &	dc,
		int	y,
		int	Style,
		double	zFactor = 1.0 )

protected

Definition at line 329 of file map_legend.cpp.

References _Draw_Box(), _Draw_Continuum(), BOX_HEIGHT, CSG_Map_Symbology::GRADUATED, m_Position, and m_pSymbology.

Referenced by _Draw_Grid(), _Draw_Grids(), _Draw_Line(), _Draw_Point(), _Draw_PointCloud(), _Draw_Polygon(), and _Draw_TIN().

◆ _Draw_CompositeBand() [1/3]

void CSG_Map_Legend::_Draw_CompositeBand	(	wxDC &	dc,
		int	y,
		int	dy,
		int	Style,
		int	Band,
		class CSG_Map_Grid *	pLayer )

protected

Definition at line 503 of file map_legend.cpp.

References _Draw_CompositeBand(), CSG_Map_Grid::Get_Composite_Band(), and CSG_Data_Object::Get_Name().

Referenced by _Draw_CompositeBand(), _Draw_CompositeBand(), _Draw_Grid(), and _Draw_Grids().

◆ _Draw_CompositeBand() [2/3]

void CSG_Map_Legend::_Draw_CompositeBand	(	wxDC &	dc,
		int	y,
		int	dy,
		int	Style,
		int	Band,
		class CSG_Map_Grids *	pLayer )

protected

Definition at line 512 of file map_legend.cpp.

References _Draw_CompositeBand(), CSG_Map_Grids::Get_Grid_Name(), and CSG_String::wx_str().

◆ _Draw_CompositeBand() [3/3]

void CSG_Map_Legend::_Draw_CompositeBand	(	wxDC &	dc,
		int	y,
		int	dy,
		int	Style,
		int	Band,
		const wxString &	Text )

protected

Definition at line 521 of file map_legend.cpp.

References _Draw_Label(), _Set_Size(), BOX_SPACE, BOX_STYLE_OUTL, m_dxBox, m_xBox, SG_COLORS_BLACK_BLUE, SG_COLORS_BLACK_GREEN, SG_COLORS_BLACK_RED, SG_DC_TEXTALIGN_TOP, and SG_Get_wxColor().

◆ _Draw_Continuum()

void CSG_Map_Legend::_Draw_Continuum	(	wxDC &	dc,
		int	y,
		double	zFactor )

protected

Definition at line 592 of file map_legend.cpp.

References _Draw_Box(), _Draw_Continuum_H(), _Draw_Continuum_V(), _Set_Font(), BOX_HEIGHT, BOX_STYLE_FILL, BOX_STYLE_OUTL, BOX_STYLE_RECT, FONT_LABEL, m_Orientation, m_pLayer, m_pSymbology, METRIC_HEIGHT, and VERTICAL.

Referenced by _Draw_Boxes().

◆ _Draw_Continuum_H()

void CSG_Map_Legend::_Draw_Continuum_H	(	wxDC &	dc,
		int	y,
		double	zMin,
		double	zMax,
		double	zFactor,
		double	dz,
		int	dyFont )

protected

Definition at line 724 of file map_legend.cpp.

References _Set_Size(), CSG_Scaler::DECREASING, CSG_Colors::Get_Count(), CSG_Scaler::INCREASING, CSG_Scaler::LINEAR, m_dxBox, m_dxTick, m_pSymbology, m_xBox, METRIC_GET_STRING, METRIC_HEIGHT, METRIC_POS_H, CSG_Colors::Set_Count(), SG_DC_Draw_Edge(), SG_DC_Draw_Text(), SG_DC_EDGE_STYLE_SIMPLE, SG_DC_TEXTALIGN_TOPCENTER, and SG_Get_wxColor().

Referenced by _Draw_Continuum().

◆ _Draw_Continuum_V()

void CSG_Map_Legend::_Draw_Continuum_V	(	wxDC &	dc,
		int	y,
		double	zMin,
		double	zMax,
		double	zFactor,
		double	dz,
		int	dyFont )

protected

Definition at line 635 of file map_legend.cpp.

References _Draw_Label(), _Set_Size(), CSG_Scaler::DECREASING, CSG_Colors::Get_Count(), CSG_Scaler::INCREASING, CSG_Scaler::LINEAR, m_pSymbology, m_xBox, m_xText, m_xTick, METRIC_GET_STRING, METRIC_HEIGHT, METRIC_POS_V, CSG_Colors::Set_Count(), SG_DC_Draw_Edge(), SG_DC_EDGE_STYLE_SIMPLE, SG_DC_TEXTALIGN_YCENTER, and SG_Get_wxColor().

Referenced by _Draw_Continuum().

◆ _Draw_Grid()

void CSG_Map_Legend::_Draw_Grid	(	wxDC &	dc,
		class CSG_Map_Grid *	pLayer )

protected

Definition at line 445 of file map_legend.cpp.

References _Draw_Boxes(), _Draw_CompositeBand(), _Draw_Layer_Image(), _Draw_Title(), CSG_Data_Object::asGrid(), BOX_HEIGHT, BOX_STYLE_FILL, BOX_STYLE_OUTL, BOX_STYLE_RECT, CSG_String::c_str(), CSG_Map_Symbology::COMPOSITE, CSG_Map_Symbology::DISCRETE, FONT_SUBTITLE, CSG_Map_Layer::Get_Object(), CSG_Grid::Get_Unit(), CSG_Map_Symbology::GRADUATED, CSG_String::is_Empty(), m_Position, m_pSymbology, and CSG_Map_Symbology::RGB.

Referenced by Draw().

◆ _Draw_Grids()

void CSG_Map_Legend::_Draw_Grids	(	wxDC &	dc,
		class CSG_Map_Grids *	pLayer )

protected

Definition at line 476 of file map_legend.cpp.

References _Draw_Boxes(), _Draw_CompositeBand(), _Draw_Title(), CSG_Data_Object::asGrids(), BOX_HEIGHT, BOX_STYLE_FILL, BOX_STYLE_OUTL, BOX_STYLE_RECT, CSG_Map_Symbology::COMPOSITE, CSG_Map_Symbology::DISCRETE, FONT_SUBTITLE, CSG_Map_Layer::Get_Object(), CSG_Grids::Get_Unit(), CSG_Map_Symbology::GRADUATED, m_Position, and m_pSymbology.

Referenced by Draw().

◆ _Draw_Label()

void CSG_Map_Legend::_Draw_Label	(	wxDC &	dc,
		int	y,
		wxString	Text,
		int	yAlign )

inlineprotected

Definition at line 247 of file map_legend.cpp.

References _Set_Font(), _Set_Size(), FONT_LABEL, m_xBox, m_xText, SG_DC_Draw_Text(), SG_DC_TEXTALIGN_BOTTOM, SG_DC_TEXTALIGN_BOTTOMLEFT, SG_DC_TEXTALIGN_CENTERLEFT, SG_DC_TEXTALIGN_TOP, SG_DC_TEXTALIGN_TOPLEFT, and SG_DC_TEXTALIGN_YCENTER.

Referenced by _Draw_Box(), _Draw_CompositeBand(), _Draw_Continuum_V(), _Draw_Line(), and _Draw_Point().

◆ _Draw_Layer_Image()

void CSG_Map_Legend::_Draw_Layer_Image	(	wxDC &	dc,
		int	y,
		class CSG_Map_Layer *	pLayer )

protected

Definition at line 555 of file map_legend.cpp.

References _Set_Size(), BOX_SPACE, CSG_Map_Layer::Get_Extent(), CSG_Map_Layer::Get_Thumbnail(), CSG_Rect::Get_XRange(), CSG_Rect::Get_YRange(), m_dxBox, m_xBox, SG_DC_Draw_Edge(), and SG_DC_EDGE_STYLE_SIMPLE.

Referenced by _Draw_Grid().

◆ _Draw_Line()

void CSG_Map_Legend::_Draw_Line	(	wxDC &	dc,
		class CSG_Map_Shapes_Line *	pLayer )

protected

Definition at line 390 of file map_legend.cpp.

References _Draw_Box(), _Draw_Boxes(), _Draw_Label(), _Draw_Title(), BOX_HEIGHT, BOX_STYLE_LINE, BOX_STYLE_OUTL, FONT_SUBTITLE, CSG_Map_Shapes::Get_Def_Pen(), CSG_Map_Shapes_Line::Get_Style_Size(), m_Position, m_pSymbology, m_Subtitle, SG_DC_TEXTALIGN_TOP, and CSG_Map_Symbology::SINGLE.

Referenced by Draw().

◆ _Draw_Point()

void CSG_Map_Legend::_Draw_Point	(	wxDC &	dc,
		class CSG_Map_Shapes_Point *	pLayer )

protected

Definition at line 352 of file map_legend.cpp.

References _Draw_Boxes(), _Draw_Label(), _Draw_Title(), _Set_Size(), BOX_HEIGHT, BOX_SPACE, BOX_STYLE_FILL, BOX_STYLE_OUTL, BOX_STYLE_RECT, CSG_Map_Shapes_Point::Draw_Symbol(), FONT_SUBTITLE, CSG_Map_Shapes::Get_Def_Brush(), CSG_Map_Shapes::Get_Def_Pen(), CSG_Map_Shapes_Point::Get_Outline(), CSG_Map_Shapes_Point::Get_Style_Size(), m_dxBox, m_Position, m_pSymbology, m_Subtitle, m_xBox, m_Zoom_Map, SG_DC_TEXTALIGN_TOP, CSG_Map_Symbology::SINGLE, and SIZE_HEIGHT.

Referenced by Draw().

◆ _Draw_PointCloud()

void CSG_Map_Legend::_Draw_PointCloud	(	wxDC &	dc,
		class CSG_Map_PointCloud *	pLayer )

protected

Definition at line 438 of file map_legend.cpp.

References _Draw_Boxes(), _Draw_Title(), BOX_STYLE_FILL, BOX_STYLE_OUTL, BOX_STYLE_RECT, FONT_SUBTITLE, m_Position, and m_Subtitle.

Referenced by Draw().

◆ _Draw_Polygon()

void CSG_Map_Legend::_Draw_Polygon	(	wxDC &	dc,
		class CSG_Map_Shapes_Polygon *	pLayer )

protected

Definition at line 424 of file map_legend.cpp.

References _Draw_Boxes(), _Draw_Title(), BOX_STYLE_FILL, BOX_STYLE_OUTL, BOX_STYLE_RECT, FONT_SUBTITLE, CSG_Map_Shapes_Polygon::Get_Outline(), m_Position, and m_Subtitle.

Referenced by Draw().

◆ _Draw_TIN()

void CSG_Map_Legend::_Draw_TIN	(	wxDC &	dc,
		class CSG_Map_TIN *	pLayer )

protected

Definition at line 431 of file map_legend.cpp.

References _Draw_Boxes(), _Draw_Title(), BOX_STYLE_FILL, BOX_STYLE_OUTL, BOX_STYLE_RECT, FONT_SUBTITLE, m_Position, and m_Subtitle.

Referenced by Draw().

◆ _Draw_Title()

void CSG_Map_Legend::_Draw_Title	(	wxDC &	dc,
		int	Style,
		wxString	Text )

inlineprotected

Definition at line 228 of file map_legend.cpp.

References _Set_Font(), _Set_Size(), m_Position, SG_DC_Draw_Text(), SG_DC_TEXTALIGN_TOPLEFT, and SPACE_VERTICAL.

Referenced by _Draw_Grid(), _Draw_Grids(), _Draw_Line(), _Draw_Point(), _Draw_PointCloud(), _Draw_Polygon(), _Draw_TIN(), and Draw().

◆ _Set_Font()

void CSG_Map_Legend::_Set_Font	(	wxDC &	dc,
		int	Style )

inlineprotected

Definition at line 213 of file map_legend.cpp.

References FONT_LABEL, FONT_SIZE_LABEL, FONT_SIZE_SUBTITLE, FONT_SIZE_TITLE, FONT_SUBTITLE, and FONT_TITLE.

Referenced by _Draw_Continuum(), _Draw_Label(), and _Draw_Title().

◆ _Set_Size()

void CSG_Map_Legend::_Set_Size	(	int	xSet,
		int	yAdd )

inlineprotected

Definition at line 201 of file map_legend.cpp.

References m_Position, and m_Size.

Referenced by _Draw_Box(), _Draw_CompositeBand(), _Draw_Continuum_H(), _Draw_Continuum_V(), _Draw_Label(), _Draw_Layer_Image(), _Draw_Point(), and _Draw_Title().

◆ Draw()

void CSG_Map_Legend::Draw	(	wxDC &	dc,
		double	Zoom,
		double	Zoom_Map,
		wxPoint	Position,
		wxSize *	pSize = NULL )

Definition at line 138 of file map_legend.cpp.

References _Draw_Grid(), _Draw_Grids(), _Draw_Line(), _Draw_Point(), _Draw_PointCloud(), _Draw_Polygon(), _Draw_TIN(), _Draw_Title(), BOX_WIDTH, FONT_TITLE, m_dxBox, m_dxTick, m_oldBrush, m_oldFont, m_oldPen, m_pLayer, m_Position, m_Size, m_Title, m_xBox, m_xText, m_xTick, m_Zoom, m_Zoom_Map, SG_DATAOBJECT_TYPE_Grid, SG_DATAOBJECT_TYPE_Grids, SG_DATAOBJECT_TYPE_PointCloud, SG_DATAOBJECT_TYPE_Shapes, SG_DATAOBJECT_TYPE_TIN, SHAPE_TYPE_Line, SHAPE_TYPE_Point, SHAPE_TYPE_Points, SHAPE_TYPE_Polygon, and TICK_WIDTH.

Referenced by CSG_Map_Grid::Get_Bitmap_Legend(), CSG_Map_Grids::Get_Bitmap_Legend(), and Get_Size().

◆ Get_Orientation()

int CSG_Map_Legend::Get_Orientation ( void ) const

inline

Definition at line 85 of file map_legend.h.

References m_Orientation.

◆ Get_Size()

wxSize CSG_Map_Legend::Get_Size	(	double	Zoom,
		double	Zoom_Map )

Definition at line 128 of file map_legend.cpp.

References Draw(), and m_Size.

◆ Set_Orientation()

void CSG_Map_Legend::Set_Orientation ( int Orientation )

Definition at line 122 of file map_legend.cpp.

References HORIZONTAL, m_Orientation, and VERTICAL.

Member Data Documentation

◆ m_dxBox

int CSG_Map_Legend::m_dxBox = 0

protected

Definition at line 93 of file map_legend.h.

Referenced by _Draw_Box(), _Draw_CompositeBand(), _Draw_Continuum_H(), _Draw_Layer_Image(), _Draw_Point(), and Draw().

◆ m_dxTick

int CSG_Map_Legend::m_dxTick = 0

protected

Definition at line 93 of file map_legend.h.

Referenced by _Draw_Continuum_H(), and Draw().

◆ m_oldBrush

wxBrush CSG_Map_Legend::m_oldBrush

protected

Definition at line 103 of file map_legend.h.

Referenced by Draw().

◆ m_oldFont

wxFont CSG_Map_Legend::m_oldFont

protected

Definition at line 105 of file map_legend.h.

Referenced by Draw().

◆ m_oldPen

wxPen CSG_Map_Legend::m_oldPen

protected

Definition at line 101 of file map_legend.h.

Referenced by Draw().

◆ m_Orientation

int CSG_Map_Legend::m_Orientation = VERTICAL

protected

Definition at line 93 of file map_legend.h.

Referenced by _Draw_Continuum(), CSG_Map_Legend(), Get_Orientation(), and Set_Orientation().

◆ m_pLayer

class CSG_Map_Layer* CSG_Map_Legend::m_pLayer = NULL

protected

Definition at line 107 of file map_legend.h.

Referenced by _Draw_Box(), _Draw_Continuum(), CSG_Map_Legend(), and Draw().

◆ m_Position

wxPoint CSG_Map_Legend::m_Position

protected

Definition at line 97 of file map_legend.h.

Referenced by _Draw_Boxes(), _Draw_Grid(), _Draw_Grids(), _Draw_Line(), _Draw_Point(), _Draw_PointCloud(), _Draw_Polygon(), _Draw_TIN(), _Draw_Title(), _Set_Size(), and Draw().

◆ m_pSymbology

class CSG_Map_Symbology* CSG_Map_Legend::m_pSymbology = NULL

protected

Definition at line 109 of file map_legend.h.

Referenced by _Draw_Box(), _Draw_Boxes(), _Draw_Continuum(), _Draw_Continuum_H(), _Draw_Continuum_V(), _Draw_Grid(), _Draw_Grids(), _Draw_Line(), _Draw_Point(), and CSG_Map_Legend().

◆ m_Size

wxSize CSG_Map_Legend::m_Size

protected

Definition at line 99 of file map_legend.h.

Referenced by _Set_Size(), Draw(), and Get_Size().

◆ m_Subtitle

wxString CSG_Map_Legend::m_Subtitle

Definition at line 88 of file map_legend.h.

Referenced by _Draw_Line(), _Draw_Point(), _Draw_PointCloud(), _Draw_Polygon(), and _Draw_TIN().

◆ m_Title

wxString CSG_Map_Legend::m_Title

Definition at line 88 of file map_legend.h.

Referenced by Draw().

◆ m_xBox

int CSG_Map_Legend::m_xBox = 0

protected

Definition at line 93 of file map_legend.h.

Referenced by _Draw_Box(), _Draw_CompositeBand(), _Draw_Continuum_H(), _Draw_Continuum_V(), _Draw_Label(), _Draw_Layer_Image(), _Draw_Point(), and Draw().

◆ m_xText

int CSG_Map_Legend::m_xText = 0

protected

Definition at line 93 of file map_legend.h.

Referenced by _Draw_Continuum_V(), _Draw_Label(), and Draw().

◆ m_xTick

int CSG_Map_Legend::m_xTick = 0

protected

Definition at line 93 of file map_legend.h.

Referenced by _Draw_Continuum_V(), and Draw().

◆ m_Zoom

double CSG_Map_Legend::m_Zoom = 1.

protected

Definition at line 95 of file map_legend.h.

Referenced by Draw().

◆ m_Zoom_Map

double CSG_Map_Legend::m_Zoom_Map = 1.

protected

Definition at line 95 of file map_legend.h.

Referenced by _Draw_Point(), and Draw().

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

CSG_Map_Legend
Generated on for SAGA API by 1.14.0