OCPNRegion Class Reference

A wrapper class for wxRegion with additional functionality. More...

#include <OCPNRegion.h>

Inheritance diagram for OCPNRegion:

Public Member Functions
	OCPNRegion (wxCoord x, wxCoord y, wxCoord w, wxCoord h)
	OCPNRegion (const wxPoint &topLeft, const wxPoint &bottomRight)
	OCPNRegion (const wxRect &rect)
	OCPNRegion (const wxRegion &region)
	OCPNRegion (size_t n, const wxPoint *points, int fillStyle=wxODDEVEN_RULE)
wxRegion *	GetNew_wxRegion () const
void	InitRect (wxCoord x, wxCoord y, wxCoord w, wxCoord h)
bool	operator== (const OCPNRegion &region) const
bool	operator!= (const OCPNRegion &region) const
bool	IsOk () const
bool	Ok () const
bool	GetBox (wxCoord &x, wxCoord &y, wxCoord &w, wxCoord &h) const
wxRect	GetBox () const
wxRegionContain	Contains (wxCoord x, wxCoord y) const
wxRegionContain	Contains (const wxPoint &pt) const
wxRegionContain	Contains (wxCoord x, wxCoord y, wxCoord w, wxCoord h) const
wxRegionContain	Contains (const wxRect &rect) const
bool	IsEqual (const OCPNRegion &region) const
virtual void	Clear ()
virtual bool	IsEmpty () const
bool	Empty () const
void *	GetRegion () const
bool	Offset (wxCoord x, wxCoord y)
bool	Offset (const wxPoint &pt)
bool	Intersect (const OCPNRegion &region)
bool	Union (const OCPNRegion &region)
bool	Union (wxCoord x, wxCoord y, wxCoord w, wxCoord h)
bool	Union (const wxRect &rect)
bool	Subtract (const OCPNRegion &region)

Protected Member Functions
virtual wxObjectRefData *	CreateRefData () const
virtual wxObjectRefData *	CloneRefData (const wxObjectRefData *data) const
virtual bool	ODoIsEqual (const OCPNRegion &region) const
virtual bool	ODoGetBox (wxCoord &x, wxCoord &y, wxCoord &w, wxCoord &h) const
virtual wxRegionContain	ODoContainsPoint (wxCoord x, wxCoord y) const
virtual wxRegionContain	ODoContainsRect (const wxRect &rect) const
virtual bool	ODoOffset (wxCoord x, wxCoord y)
virtual bool	ODoUnionWithRect (const wxRect &rect)
virtual bool	ODoUnionWithRegion (const OCPNRegion &region)
virtual bool	ODoIntersect (const OCPNRegion &region)
virtual bool	ODoSubtract (const OCPNRegion &region)

Detailed Description

A wrapper class for wxRegion with additional functionality.

Extends either wxObject or wxRegion (depending on compilation flags) to provide region-related operations for OpenCPN. Includes methods for creating, modifying, and querying regions.

Definition at line 50 of file OCPNRegion.h.

Constructor & Destructor Documentation

OCPNRegion() [1/6]

OCPNRegion::OCPNRegion ( )

inline

Definition at line 58 of file OCPNRegion.h.

OCPNRegion() [2/6]

OCPNRegion::OCPNRegion	(	wxCoord	x,
		wxCoord	y,
		wxCoord	w,
		wxCoord	h )

Definition at line 399 of file OCPNRegion.cpp.

OCPNRegion() [3/6]

OCPNRegion::OCPNRegion	(	const wxPoint &	topLeft,
		const wxPoint &	bottomRight )

Definition at line 404 of file OCPNRegion.cpp.

OCPNRegion() [4/6]

OCPNRegion::OCPNRegion

(

const wxRect &

rect

)

Definition at line 408 of file OCPNRegion.cpp.

OCPNRegion() [5/6]

OCPNRegion::OCPNRegion

(

const wxRegion &

region

)

Definition at line 411 of file OCPNRegion.cpp.

OCPNRegion() [6/6]

OCPNRegion::OCPNRegion	(	size_t	n,
		const wxPoint *	points,
		int	fillStyle = wxODDEVEN_RULE )

Definition at line 413 of file OCPNRegion.cpp.

Member Function Documentation

Contains() [1/4]

wxRegionContain OCPNRegion::Contains ( const wxPoint & pt ) const

inline

Definition at line 96 of file OCPNRegion.h.

Contains() [2/4]

wxRegionContain OCPNRegion::Contains ( const wxRect & rect ) const

inline

Definition at line 102 of file OCPNRegion.h.

Contains() [3/4]

wxRegionContain OCPNRegion::Contains ( wxCoord x, wxCoord y ) const

inline

Definition at line 93 of file OCPNRegion.h.

Contains() [4/4]

wxRegionContain OCPNRegion::Contains ( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) const

inline

Definition at line 99 of file OCPNRegion.h.

Empty()

bool OCPNRegion::Empty ( ) const

inline

Definition at line 112 of file OCPNRegion.h.

GetBox() [1/2]

wxRect OCPNRegion::GetBox ( ) const

inline

Definition at line 87 of file OCPNRegion.h.

GetBox() [2/2]

bool OCPNRegion::GetBox ( wxCoord & x, wxCoord & y, wxCoord & w, wxCoord & h ) const

inline

Definition at line 84 of file OCPNRegion.h.

GetNew_wxRegion()

wxRegion * OCPNRegion::GetNew_wxRegion

(

)

const

Definition at line 421 of file OCPNRegion.cpp.

Intersect()

bool OCPNRegion::Intersect ( const OCPNRegion & region )

inline

Definition at line 121 of file OCPNRegion.h.

IsOk()

bool OCPNRegion::IsOk ( ) const

inline

Definition at line 80 of file OCPNRegion.h.

Offset() [1/2]

bool OCPNRegion::Offset ( const wxPoint & pt )

inline

Definition at line 120 of file OCPNRegion.h.

Offset() [2/2]

bool OCPNRegion::Offset ( wxCoord x, wxCoord y )

inline

Definition at line 119 of file OCPNRegion.h.

Ok()

bool OCPNRegion::Ok ( ) const

inline

Definition at line 81 of file OCPNRegion.h.

operator!=()

bool OCPNRegion::operator!= ( const OCPNRegion & region ) const

inline

Definition at line 78 of file OCPNRegion.h.

operator==()

bool OCPNRegion::operator== ( const OCPNRegion & region ) const

inline

Definition at line 77 of file OCPNRegion.h.

Subtract()

bool OCPNRegion::Subtract ( const OCPNRegion & region )

inline

Definition at line 127 of file OCPNRegion.h.

Union() [1/3]

bool OCPNRegion::Union ( const OCPNRegion & region )

inline

Definition at line 122 of file OCPNRegion.h.

Union() [2/3]

bool OCPNRegion::Union ( const wxRect & rect )

inline

Definition at line 126 of file OCPNRegion.h.

Union() [3/3]

bool OCPNRegion::Union ( wxCoord x, wxCoord y, wxCoord w, wxCoord h )

inline

Definition at line 123 of file OCPNRegion.h.

---

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

• /home/mk/src/OpenCPN/gui/include/gui/OCPNRegion.h
• /home/mk/src/OpenCPN/gui/src/OCPNRegion.cpp