#include <Arc.hpp>

Public Member Functions
	Arc ()
	Returns a new Arc object.
	Arc (Tag from_tag, double from_twist, double distance, Tag to_tag, double to_twist, double goodness)
	Create and return a new Arc object.
void	svg_write (SVG *svg)
	Draws arc into svg.
void	update (double distance, double angle, double twist, double goodness)
	Updates the contents of arc.
void	write (File out_file)
	Write arc out to out_file in XML format.
Static Public Member Functions
static bool	distance_less (Arc arc1, Arc arc2)
	Return the distance sort order of arc1 vs. arc2.
static bool	equal (Arc arc1, Arc arc2)
	Return the sort order of arc1 vs. arc2.
static bool	less (Arc arc1, Arc arc2)
static Arc *	read (File out_file, Map map)
	Read in an XML <Arc.../> tag from in_file.
Public Attributes
double	angle
	The angle in radians from the origin center parallel to the bottom edge to the line that connects the origin and target centers.
double	distance
	The distance between the from and to.
Tag *	from_tag
	The from Tag.
double	from_twist
	The amount from_tag is twisted from distance line segment.
double	goodness
	Distance between camera center and line connecting both tags.
bool	in_tree
	Set to true if this Arc is part of the map tree.
Tag *	to_tag
	The to Tag (has larger id than from).
double	to_twist
	The amount to_tag is twisted from distance line segment.
unsigned int	visit
	The visit number for the arc.

Detailed Description

Definition at line 52 of file Arc.hpp.

Constructor & Destructor Documentation

Arc::Arc ( )

Returns a new *Arc* object.

Returns:: new *Arc* object.

Arc__new*() will return a new *Arc*.

Definition at line 108 of file Arc.cpp.

Arc::Arc	(	Tag *	from_tag,
		double	from_twist,
		double	distance,
		Tag *	to_tag,
		double	to_twist,
		double	goodness
	)

Create and return a new *Arc* object.

Parameters:

from_tag	is the tag with the lower id.
from_twist	is the amount the from_tag is twisted in radians.
distance	between the tags.
to_tag	is the tag with the higher id.
to_twist	is the amount to_tag is twisted in radians.
goodness	is the distance from camera center to tag point center.

Returns:: new *Arc* object

Arc__create*() will create and return arc a new *Arc* object that contains *from_tag*, *from_twist*, *distance*, *to_tag*, *to_twist*, and *goodness*.

Definition at line 49 of file Arc.cpp.

Member Function Documentation

bool Arc::distance_less	(	Arc *	arc1,
		Arc *	arc2
	)		`[static]`

Return the distance sort order of *arc1* vs. *arc2*.

Parameters:

arc1	is the first Arc object.
arc2	is the second Arc object.

Returns:: true or false depending upon distance sort order.

Arc__distance_compare*() will return true if the *arc1* distance is larger than the *arc2* distance, otherwise false

Definition at line 85 of file Arc.cpp.

bool Arc::equal	(	Arc *	arc1,
		Arc *	arc2
	)		`[static]`

Return the sort order of *arc1* vs. *arc2*.

Parameters:

arc1	is the first Arc object.
arc2	is the first Arc object.

Returns:: -1, 0, or 1 depending upon sort order.

Arc__compare*() will return -1 if *arc1* sorts before *arc2*, 0 if they are equal, and 1 if *arc1* sorts after *arc2*.

Definition at line 21 of file Arc.cpp.

bool Arc::less	(	Arc *	arc1,
		Arc *	arc2
	)		`[static]`

Definition at line 27 of file Arc.cpp.

Arc * Arc::read	(	File	in_file,
		Map	map
	)		`[static]`

Read in an XML <Arc.../> tag from *in_file*.

Parameters:

in_file	is the file to read from.
map	is contains the Tag associations.

Returns:: new *Arc* object.

Arc__read*() will read in a <Arc.../> tag from *in_file* and return the resulting *Arc* object. *Tag* objects all looked up using *map*.

Definition at line 128 of file Arc.cpp.

void Arc::svg_write ( SVG * svg )

Draws *arc* into *svg*.

Parameters:

arc	is the Arc to draw.
svg	is the SVG object to draw it into.

Arc__svg_write*() will draw *arc* into *svg*.

Definition at line 170 of file Arc.cpp.

void Arc::update	(	double	from_twist,
		double	distance,
		double	to_twist,
		double	goodness
	)

Updates the contents of *arc*.

Parameters:

arc	to update.
from_twist	is the amount the from tag is twisted in radians.
distance	between the two tag centers.
to_twist	is the amount the to tag is twisted in radians.
goodness	the distence between the camera center and center point between the two tag centers.