Celartem::DjVu::MapLine Class Reference

#include <djv_mapareas.h>

Inheritance diagram for Celartem::DjVu::MapLine:

List of all members.

Public Member Functions
virtual MapAreaType	getType () const
virtual Rect	getRect () const
virtual bool	isPointInsideArea (const Point &inPoint) const
virtual size_t	isPointOnLine (const Point &inPoint, size_t inRadius=1) const
virtual String	getANTString (const PageInfo &inPageInfo, Rotation inCurrentRotation) const
virtual AutoPtr< MapArea >	duplicate () const
Static Public Member Functions
static AutoPtr< MapLine >	create ()
Public Attributes
Point	p0
Point	p1
bool	isArrow

---

Detailed Description

Represents a line (matLine) maparea instance.

---

Member Function Documentation

static AutoPtr<MapLine> Celartem::DjVu::MapLine::create

(

)

[inline, static]

Initialize new MapLine instance.

virtual AutoPtr<MapArea> Celartem::DjVu::MapLine::duplicate

(

)

const [virtual]

Clone this instance.

Returns:

Pointer to the newly created instance.

Implements Celartem::DjVu::MapArea.

virtual String Celartem::DjVu::MapLine::getANTString	(	const PageInfo &	inPageInfo,
		Rotation	inCurrentRotation
	)			const [virtual]

Get the string for ANT* encoding.
This is for advanced purpose and should not be used for normal use.

Parameters:

	inPageInfo	The dimensions and rotation status of the page is used during encoding the ANT* string.
	inCurrentRotation	The current rotation.

Returns:

ANT* encoded representation of this maparea.

Implements Celartem::DjVu::MapArea.

virtual Rect Celartem::DjVu::MapLine::getRect

(

)

const [inline, virtual]

Gets the minimum rectangle which can contain all the points of the maparea.
For rect and text areas, it is identical to the area of the maparea.

Returns:

A Rect instance.

Implements Celartem::DjVu::MapArea.

virtual MapAreaType Celartem::DjVu::MapLine::getType

(

)

const [inline, virtual]

Gets the type of the shape.

Returns:

One of MapAreaType enumeration values.

Implements Celartem::DjVu::MapArea.

virtual bool Celartem::DjVu::MapLine::isPointInsideArea

(

const Point &

inPoint

)

const [inline, virtual]

Determines whether the specified point is inside the maparea or not.
For MapLine, this method is identical to the result of isPointOnLine method.

Parameters:

inPoint

A point to verify.

Returns:

true if the point is inside the maparea.

Implements Celartem::DjVu::MapArea.

virtual size_t Celartem::DjVu::MapLine::isPointOnLine	(	const Point &	inPoint,
		size_t	inRadius = 1
	)			const [virtual]

Determines whether the specified point is on the border (line) or not.

Parameters:

	inPoint	A point to verify.
	inRadius	The points within the area defined by inRadius is determined as on-line.

Returns:

0 if the point is not on-line. 1 if the point is on-line.

Implements Celartem::DjVu::MapArea.

Referenced by isPointInsideArea().

---

Member Data Documentation

bool Celartem::DjVu::MapLine::isArrow

Whether the line is an arrow or not.

Point Celartem::DjVu::MapLine::p0

The beginning point of the line.

Referenced by getRect().

Point Celartem::DjVu::MapLine::p1

The ending point of the line.

Referenced by getRect().

---

The documentation for this class was generated from the following file:

• djv_mapareas.h