QgsOverlayObject Class Reference

An object that holds information about the position and bounding box size of an overlay object. More...

#include <qgsoverlayobject.h>

Collaboration diagram for QgsOverlayObject:

List of all members.

Public Member Functions
	QgsOverlayObject (int width=0, int height=0, double rotation=0, QgsGeometry *geometry=0)
	QgsOverlayObject (const QgsOverlayObject &other)
virtual	~QgsOverlayObject ()
void	addPosition (const QgsPoint &position)
	Adds a position in map coordinates.
QgsGeometry *	geometry ()
const QgsGeometry *	geometry () const
int	height () const
QgsOverlayObject &	operator= (const QgsOverlayObject &other)
QgsPoint	position () const
QList< QgsPoint >	positions () const
double	rotation () const
void	setGeometry (QgsGeometry *g)
	Set geometry.
void	setHeight (int height)
void	setRotation (double rotation)
void	setWidth (int width)
int	width () const
Private Attributes
QgsGeometry *	mGeometry
	Copy of the feature geometry.
int	mHeight
	Height of the bounding box in pixels.
QList< QgsPoint >	mPositions
	Position of the object in map coordinates.
double	mRotation
	Rotation of the object.
int	mWidth
	Width of the bounding box in pixels.

---

Detailed Description

An object that holds information about the position and bounding box size of an overlay object.

It stores a copy of the feature geometry as this information is commonly used to calculate object placement

Note:

This class has been added in version 1.1

Definition at line 32 of file qgsoverlayobject.h.

---

Constructor & Destructor Documentation

QgsOverlayObject::QgsOverlayObject	(	int	width = 0,
		int	height = 0,
		double	rotation = 0,
		QgsGeometry *	geometry = 0
	)

Definition at line 21 of file qgsoverlayobject.cpp.

QgsOverlayObject::~QgsOverlayObject

(

)

[virtual]

Definition at line 26 of file qgsoverlayobject.cpp.

References mGeometry.

QgsOverlayObject::QgsOverlayObject

(

const QgsOverlayObject &

other

)

Definition at line 31 of file qgsoverlayobject.cpp.

References geometry(), and mGeometry.

---

Member Function Documentation

void QgsOverlayObject::addPosition

(

const QgsPoint &

position

)

Adds a position in map coordinates.

Definition at line 46 of file qgsoverlayobject.cpp.

References mPositions.

Referenced by QgsPALObjectPositionManager::findObjectPositions().

QgsGeometry* QgsOverlayObject::geometry

(

)

[inline]

Definition at line 46 of file qgsoverlayobject.h.

Referenced by QgsPALGeometry::getGeosGeometry(), operator=(), and QgsOverlayObject().

const QgsGeometry* QgsOverlayObject::geometry

(

)

const [inline]

Definition at line 47 of file qgsoverlayobject.h.

int QgsOverlayObject::height

(

)

const [inline]

Definition at line 44 of file qgsoverlayobject.h.

Referenced by operator=().

QgsOverlayObject & QgsOverlayObject::operator=

(

const QgsOverlayObject &

other

)

Definition at line 36 of file qgsoverlayobject.cpp.

References geometry(), height(), mGeometry, mHeight, mPositions, mRotation, mWidth, positions(), rotation(), and width().

QgsPoint QgsOverlayObject::position

(

)

const

Definition at line 57 of file qgsoverlayobject.cpp.

References mPositions.

QList<QgsPoint> QgsOverlayObject::positions

(

)

const [inline]

Definition at line 49 of file qgsoverlayobject.h.

Referenced by operator=().

double QgsOverlayObject::rotation

(

)

const [inline]

Definition at line 45 of file qgsoverlayobject.h.

Referenced by operator=().

void QgsOverlayObject::setGeometry

(

QgsGeometry *

g

)

Set geometry.

This class takes ownership of the object

Definition at line 51 of file qgsoverlayobject.cpp.

References mGeometry.

void QgsOverlayObject::setHeight

(

int

height

)

[inline]

Definition at line 52 of file qgsoverlayobject.h.

void QgsOverlayObject::setRotation

(

double

rotation

)

[inline]

Definition at line 54 of file qgsoverlayobject.h.

void QgsOverlayObject::setWidth

(

int

width

)

[inline]

Definition at line 53 of file qgsoverlayobject.h.

int QgsOverlayObject::width

(

)

const [inline]

Definition at line 43 of file qgsoverlayobject.h.

Referenced by operator=().

---

Member Data Documentation

QgsGeometry* QgsOverlayObject::mGeometry [private]

Copy of the feature geometry.

A copy is necessary because in QGIS geometries are deleted after drawing. The geometry is in map coordinates

Definition at line 76 of file qgsoverlayobject.h.

Referenced by operator=(), QgsOverlayObject(), setGeometry(), and ~QgsOverlayObject().

int QgsOverlayObject::mHeight [private]

Height of the bounding box in pixels.

Definition at line 66 of file qgsoverlayobject.h.

Referenced by operator=().

QList<QgsPoint> QgsOverlayObject::mPositions [private]

Position of the object in map coordinates.

Note that it is possible that an object has several positions, e.g. a multiobject or an object that is split into multiple parts by the edge of the view extent. It is also possible that there is no position (e.g. geometry too small). In that case

Definition at line 71 of file qgsoverlayobject.h.

Referenced by addPosition(), operator=(), and position().

double QgsOverlayObject::mRotation [private]

Rotation of the object.

Definition at line 73 of file qgsoverlayobject.h.

Referenced by operator=().

int QgsOverlayObject::mWidth [private]

Width of the bounding box in pixels.

Definition at line 64 of file qgsoverlayobject.h.

Referenced by operator=().

---

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

• src/core/qgsoverlayobject.h
• src/core/qgsoverlayobject.cpp