casa::RSLine Class Reference

Subclass of RegionShape used for drawing lines. More...

#include <RegionShapes.h>

Inheritance diagram for casa::RSLine:

Public Types
enum	ArrowType { FilledTriangle, Triangle, V, FilledDoubleV }
	Static Members //. More...
Public Member Functions
	RSLine (double x1, double y1, double x2, double y2, MDirection::Types worldSystem, int arrowLength, bool arrow1=false, bool arrow2=false, ArrowType type1=FilledDoubleV, ArrowType type2=FilledDoubleV)
	Non-Static Members //.
	RSLine (double x1, double y1, double x2, double y2, int arrowLength, bool arrow1=false, bool arrow2=false, ArrowType type1=FilledDoubleV, ArrowType type2=FilledDoubleV)
	Pixel Constructor.
	RSLine (const RecordInterface &properties)
	Record Constructor.
virtual	~RSLine ()
	Destructor.
Static Public Member Functions
static vector< ArrowType >	allArrowTypes ()
	Returns all possible arrow types.
static vector< String >	allArrowTypesStrings ()
static String	arrowType (ArrowType type)
	Converts to/from the String representation of arrow types.
static ArrowType	arrowType (const String &type)

Detailed Description

Subclass of RegionShape used for drawing lines.

A line has the following properties in addition to those listed for RegionShape:

x1, y1 and x2, y2 coordinates
whether to draw an arrow on either of the endpoints
arrow length

Definition at line 451 of file RegionShapes.h.

Member Enumeration Documentation

enum casa::RSLine::ArrowType

Static Members //.

Different ways to draw the arrow(s) at the end of the line.

Enumerator:

FilledTriangle
Triangle
V
FilledDoubleV

Definition at line 456 of file RegionShapes.h.

Constructor & Destructor Documentation

casa::RSLine::RSLine	(	double	x1,
		double	y1,
		double	x2,
		double	y2,
		MDirection::Types	worldSystem,
		int	arrowLength,
		bool	arrow1 = `false`,
		bool	arrow2 = `false`,
		ArrowType	type1 = `FilledDoubleV`,
		ArrowType	type2 = `FilledDoubleV`
	)

Non-Static Members //.

World Constructor. x1, y1, x2, and y2 must all be 1) using the same world system as defined by worldSystem, and 2) in unit RegionShape::UNIT. arrowLength is in screen pixels. arrow1 defines whether (x1, y1) has an arrow; arrow2 for (x2, y2).

casa::RSLine::RSLine	(	double	x1,
		double	y1,
		double	x2,
		double	y2,
		int	arrowLength,
		bool	arrow1 = `false`,
		bool	arrow2 = `false`,
		ArrowType	type1 = `FilledDoubleV`,
		ArrowType	type2 = `FilledDoubleV`
	)