casa::DSText Class Reference

Implementation of text. More...

#include <DSText.h>

Inheritance diagram for casa::DSText:

Public Member Functions
	DSText ()
	Constructors and destructors.
	DSText (const DSText &other)
	DSText (const Float &xPos, const Float &yPos, const String &text="Label", const Bool &hasHandles=True, const Bool &drawHandles=True)
virtual	~DSText ()
virtual void	draw (PixelCanvas *pix)
	Functions to ensure consistancy with the "DisplayShape" interface.
virtual void	move (const Float &dX, const Float &dY)
virtual void	rotate (const Float &angle)
	Rotate the shape about its center by a set angle (angle in degrees).
virtual Bool	inObject (const Float &xPos, const Float &yPos)
	Is the supplied point within the DisplayShape?
virtual void	changePoint (const Vector< Float > &newPos)
	Changes the closest point to the supplied location to that location.
virtual void	changePoint (const Vector< Float > &newPos, const Int nPoint)
	Changes the nth point making up the DisplayShape ot the specified location.
virtual void	scale (const Float &scaleFactor)
	Scale the shape about its center by the scaleFactor.
virtual void	setCenter (const Float &xPos, const Float &yPos)
	Sets the center of the DisplayShape.
virtual Vector< Float >	getCenter ()
	Returns the center of the DisplayShape (x,y).
virtual Record	getOptions ()
	Get and set options.
virtual Bool	setOptions (const Record &settings)
Private Member Functions
void	makeAlignmentChoice ()
	This is a bit messy, so seperate it out.
virtual void	calculateHandlePositions ()
	Update handle positions.
Display::TextAlign	toEnum (const Int fromInt)
	Cast from int to enum.
virtual void	setDefaultOptions ()
	Set default options.
Private Attributes
DParameterString *	itsString
	Text Parameter.
DParameterRange< Float > *	itsAngle
	Angle Param.
DParameterMapKeyChoice *	itsAlignment
DParameterFontChoice *	itsFont
DParameterRange< Int > *	itsFontSize
Vector< Float >	itsCenter
	Rotate about a point.
Int	itsPixHeight
Int	itsPixWidth
Bool	itsValid
Bool	itsHandlesMade
Bool	itsValidPositions
Float	itsStringLength
Float	itsStringHeight
Matrix< Float >	itsHandleLocation
Display::TextAlign	itsAlign

Detailed Description

Implementation of text.

Prerequisite

DisplayShape

Etymology

DSText is a method of managing the drawing of text onto a PixelCanvas.

Synopsis

DSText is designed to have the same interface as any other 'shape' extending DisplayShape. Much of the functionality is exactly the same, and hence provides a usefull wrapper for text in an 'annotations' context.

There are generally two ways to make DisplayShape(s); To create them in "one hit" by providing arguments to the constructor, or by using the default constructor and then the "setOptions" method. A simple interface for all classes inheriting from the DisplayShape class is provided by DisplayShapeInterface .

Motivation

To create a text wrapper which behaved in the same was as any other DisplayShape

Example

Definition at line 82 of file DSText.h.

Constructor & Destructor Documentation

casa::DSText::DSText ( )

Constructors and destructors.

casa::DSText::DSText ( const DSText & other )

casa::DSText::DSText	(	const Float &	xPos,
		const Float &	yPos,
		const String &	text = `"Label"`,
		const Bool &	hasHandles = `True`,
		const Bool &	drawHandles = `True`
	)