casa::RSHandle Class Reference

A "handle" is a four-point structure (usually a rectangle) that describes the boundaries in screen pixels that a RegionShape takes on a canvas. More...

#include <RSUtils.qo.h>

List of all members.

Public Member Functions
	RSHandle ()
	Constructor which makes an invalid handle.
	RSHandle (const vector< double > &x, const vector< double > &y, int markerHeight=DEFAULT_MARKER_HEIGHT, const String &markerColor=DEFAULT_MARKER_COLOR, Display::Marker markerType=DEFAULT_MARKER_TYPE)
	Constructor which takes x and y vectors.
	RSHandle (const Vector< double > &x, const Vector< double > &y, int markerHeight=DEFAULT_MARKER_HEIGHT, const String &markerColor=DEFAULT_MARKER_COLOR, Display::Marker markerType=DEFAULT_MARKER_TYPE)
	Constructor which takes x and y Vectors.
	~RSHandle ()
	Destructor.
int	getMarkerHeight () const
	Gets/sets the marker height/color/type.
void	setMarkerHeight (int height)
String	getMarkerColor () const
void	setMarkerColor (const String &color)
Display::Marker	getMarkerType () const
void	setMarkerType (Display::Marker type)
bool	isValid () const
	Returns whether the handle is valid (has four valid points) or not.
bool	containsPoint (double x, double y) const
	Returns true if the handle is valid and the given point is inside.
bool	getVertices (vector< double > &x, vector< double > &y) const
	Gets the handle vertices coordinates and returns whether the operation succeeded or not (i.e.
bool	draw (PixelCanvas *canvas) const
	Draws the handles on the given canvas and returns whether the operation succeeded or not (i.e.
Static Public Attributes
static const int	DEFAULT_MARKER_HEIGHT
	Defaults.
static const String	DEFAULT_MARKER_COLOR
static const Display::Marker	DEFAULT_MARKER_TYPE
Private Attributes
bool	m_isValid
vector< double >	m_x
vector< double >	m_y
int	m_markerHeight
String	m_markerColor
Display::Marker	m_markerType

Detailed Description

A "handle" is a four-point structure (usually a rectangle) that describes the boundaries in screen pixels that a RegionShape takes on a canvas.

In the future, this will be used for selecting/editing/moving/resizing shapes on the canvas using the mouse.

Definition at line 441 of file RSUtils.qo.h.

Constructor & Destructor Documentation

casa::RSHandle::RSHandle ( )

Constructor which makes an invalid handle.

casa::RSHandle::RSHandle	(	const vector< double > &	x,
		const vector< double > &	y,
		int	markerHeight = `DEFAULT_MARKER_HEIGHT`,
		const String &	markerColor = `DEFAULT_MARKER_COLOR`,
		Display::Marker	markerType = `DEFAULT_MARKER_TYPE`
	)

Constructor which takes x and y vectors.

x and y MUST be length 4 or the handle is invalid.

casa::RSHandle::RSHandle	(	const Vector< double > &	x,
		const Vector< double > &	y,
		int	markerHeight = `DEFAULT_MARKER_HEIGHT`,
		const String &	markerColor = `DEFAULT_MARKER_COLOR`,
		Display::Marker	markerType = `DEFAULT_MARKER_TYPE`
	)