Celartem::DjVu::MapRect Class Reference

#include <djv_mapareas.h>

Inheritance diagram for Celartem::DjVu::MapRect:

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< MapRect >	create ()
Public Attributes
Rect	rect
Color	bgColor
size_t	opacity

---

Detailed Description

Represents a rect (matRect) maparea instance.

---

Member Function Documentation

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

(

)

[inline, static]

Initializes MapRect instance.

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

(

)

const [virtual]

Clone this instance.

Returns:

Pointer to the newly created instance.

Implements Celartem::DjVu::MapArea.

virtual String Celartem::DjVu::MapRect::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::MapRect::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::MapRect::getType

(

)

const [inline, virtual]

Gets the type of the shape.

Returns:

One of MapAreaType enumeration values.

Implements Celartem::DjVu::MapArea.

virtual bool Celartem::DjVu::MapRect::isPointInsideArea

(

const Point &

inPoint

)

const [inline, virtual]

Determines whether the specified point is inside the maparea or not.

Parameters:

inPoint

A point to verify.

Returns:

true if the point is inside the maparea.

Implements Celartem::DjVu::MapArea.

virtual size_t Celartem::DjVu::MapRect::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 indicates the point is on left-top to left-bottom line. 2 indicates the point is on left-top to right-top line. 3 indicates the point is on right-top to right-bottom line. 4 indicates the point is on left-bottom to right-bottom line.

Implements Celartem::DjVu::MapArea.

---

Member Data Documentation

Color Celartem::DjVu::MapRect::bgColor

The background color (a.k.a. hilight) of this MapRect instance.
If this color is invalid (see Color::isValid, Color::InvalidColor), the background is not filled.
The default is invalid color and the background is not filled.

size_t Celartem::DjVu::MapRect::opacity

The opacity of the background in 0-100. 0 means completely transparent and 100 means completely opaque.
The default is 50.

Rect Celartem::DjVu::MapRect::rect

The area of this MapRect instance.

Referenced by getRect(), and isPointInsideArea().

---

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

• djv_mapareas.h