plist::Angle Class Reference

Handles angle measurements by adding a 'unit' attribute to numeric values, or a character suffix in a string value. */. More...

#include <plistSpecialty.h>

Inheritance diagram for plist::Angle:

[legend]

Detailed Description

Handles angle measurements by adding a 'unit' attribute to numeric values, or a character suffix in a string value. */.

Values are always stored in radians, but may be converted from/to degrees when loading/saving.

Valid values for a 'unit' attribute are: rad, radian, radians, °, deg, degree, degrees, π, pi, %, percent.

Valid values for a suffix are: °, π, π/, %. The 'π/' should be followed by another number to form a fraction, e.g. '3π/2' or 'π/3'.

To conform completely to Apple's plist specification, the 'unit' attribute should be avoided, and unit suffixes should only be used in 'string' elements. This code can handle both, but other editors might not. Use of the setPedantic() function can give a warning when such values are loaded, and rely on solely on strings for non-radian values.

Definition at line 114 of file plistSpecialty.h.

List of all members.

Public Types
enum	Format { FORMAT_NONE, FORMAT_RADIAN, FORMAT_DEGREE, FORMAT_PI, FORMAT_PERCENT, FORMAT_SAME, FORMAT_AUTO }
enum	Pedantic { PEDANTIC_FULL, PEDANTIC_VALID, PEDANTIC_CUTE }
Public Member Functions
	Angle ()
	constructor
	Angle (PLISTREAL v)
	casting constructor
Angle &	operator= (const std::string &v)
	assignment from std::string, wraps it in a plist::Primitive and passes on to operator=(PrimitiveBase)
void	loadXML (xmlNode *node)
	interprets node as holding the specialization type
void	saveXML (xmlNode *node) const
	saves val into node
void	set (const std::string &str)
	assign a new value
void	setDegree (PLISTREAL v)
PLISTREAL	getDegree () const
std::string	get () const
	return current value as a string
void	setFormat (Format fmt)
	sets saveFormat
Format	getFormat () const
	returns saveFormat
Format	getLoadedFormat () const
virtual Angle *	clone () const __attribute__((warn_unused_result))
	clone definition for Angle
Static Public Member Functions
static void	setDefaultFormat (Format fmt)
	sets defaultFormat
static Format	getDefaultFormat ()
	returns defaultFormat
static void	setPedantic (Pedantic p)
	sets pedantic
static Pedantic	getPedantic ()
	returns pedantic
Protected Member Functions
void	parseRadian (const std::string &str)
Protected Attributes
Format	saveFormat
	Specifies what format we should save in.
Format	loadedFormat
	Specifies the format last loaded (to be reused if saveFormat is FORMAT_SAME).
Static Protected Attributes
static Format	defaultFormat = Angle::FORMAT_DEGREE
	The format to use if loadedFormat is FORMAT_AUTO;.
static Pedantic	pedantic = Angle::PEDANTIC_FULL
	If true, saved elements will use 'string' instead of 'real' with an element, and warnings will be issued.

Member Enumeration Documentation

enum plist::Angle::Format

Enumerator:

FORMAT_NONE	value will be in radians, but no unit will be specified
FORMAT_RADIAN	value will be in radians
FORMAT_DEGREE	value will be in degrees
FORMAT_PI	value will be multiple of pi
FORMAT_PERCENT	value will be a percentage of a circle
FORMAT_SAME	use same units that was loaded, or 'auto' if not loaded
FORMAT_AUTO	uses degrees if value works out to be a integer, or raw radian otherwise

Definition at line 116 of file plistSpecialty.h.

enum plist::Angle::Pedantic

Enumerator:

PEDANTIC_FULL	uses 'string' elements for plist compliance, though less intuitive since these are really numeric values
PEDANTIC_VALID	uses a 'unit' attribute on the value element to specify the units... may be stripped by editor, but validates
PEDANTIC_CUTE	uses a 'real' element, regardless of presence of suffix... editor may refuse to open due to non-numeric characters