vpRectOriented Class Reference

#include <visp3/core/vpRectOriented.h>

Public Member Functions
	vpRectOriented ()
	vpRectOriented (const vpRectOriented &rect)=default
	vpRectOriented (const vpImagePoint &center, double width, double height, double theta=0)
	vpRectOriented (const vpRect &rect)
vpRectOriented &	operator= (const vpRectOriented &rect)=default
vpRectOriented &	operator= (const vpRect &rect)
	operator vpRect ()
void	setCenter (const vpImagePoint &center)
void	setPoints (const vpImagePoint &topLeft, const vpImagePoint &topRight, const vpImagePoint &bottomLeft, const vpImagePoint &bottomRight)
vpImagePoint	getCenter () const
vpImagePoint	getTopLeft () const
vpImagePoint	getTopRight () const
vpImagePoint	getBottomLeft () const
vpImagePoint	getBottomRight () const
void	setSize (double width, double height)
double	getWidth () const
double	getHeight () const
void	setOrientation (double theta)
double	getOrientation () const
bool	isInside (const vpImagePoint &point) const

Detailed Description

Defines an oriented rectangle in the plane.

Definition at line 52 of file vpRectOriented.h.

Constructor & Destructor Documentation

vpRectOriented() [1/4]

vpRectOriented::vpRectOriented

(

)

Default constructor.

Definition at line 44 of file vpRectOriented.cpp.

vpRectOriented() [2/4]

vpRectOriented::vpRectOriented ( const vpRectOriented &  rect )

default

vpRectOriented() [3/4]

vpRectOriented::vpRectOriented	(	const vpImagePoint &	center,
		double	width,
		double	height,
		double	theta = 0
	)

Constructor.

Parameters

center	The rectangle center.
width	The rectangle width.
height	The rectangle height.
theta	The rectangle orientation (rad).

Definition at line 55 of file vpRectOriented.cpp.

References vpImagePoint::get_i(), vpImagePoint::get_j(), vpImagePoint::set_i(), and vpImagePoint::set_j().

vpRectOriented() [4/4]

vpRectOriented::vpRectOriented

(

const vpRect &

rect

)

Copy constructor.

Parameters

rect	Rectangle to copy.

Definition at line 74 of file vpRectOriented.cpp.

References vpImagePoint::get_i(), vpImagePoint::get_j(), vpRect::getCenter(), vpRect::getHeight(), vpRect::getWidth(), vpImagePoint::set_i(), and vpImagePoint::set_j().

Member Function Documentation

getBottomLeft()

vpImagePoint vpRectOriented::getBottomLeft

(

)

const

Get the bottom-left corner.

Definition at line 183 of file vpRectOriented.cpp.

getBottomRight()

vpImagePoint vpRectOriented::getBottomRight

(

)

const

Get the bottom-right corner.

Definition at line 186 of file vpRectOriented.cpp.

getCenter()

vpImagePoint vpRectOriented::getCenter

(

)

const

Get the rectangle center point.

Definition at line 174 of file vpRectOriented.cpp.

getHeight()

double vpRectOriented::getHeight

(

)

const

Get the rectangle height.

Definition at line 207 of file vpRectOriented.cpp.

Referenced by vpImageTools::extract().

getOrientation()

double vpRectOriented::getOrientation

(

)

const

Get the rectangle orientation (rad).

Definition at line 224 of file vpRectOriented.cpp.

Referenced by vpImageTools::extract().

getTopLeft()

vpImagePoint vpRectOriented::getTopLeft

(

)

const

Get the top-left corner.

Definition at line 177 of file vpRectOriented.cpp.

Referenced by vpImageTools::extract().

getTopRight()

vpImagePoint vpRectOriented::getTopRight

(

)

const

Get the top-right corner.

Definition at line 180 of file vpRectOriented.cpp.

getWidth()

double vpRectOriented::getWidth

(

)

const

Get the rectangle width.

Definition at line 204 of file vpRectOriented.cpp.

Referenced by vpImageTools::extract().

isInside()

bool vpRectOriented::isInside

(

const vpImagePoint &

point

)

const

Check whether the point is inside the rectangle.

Definition at line 227 of file vpRectOriented.cpp.

operator vpRect()

vpRectOriented::operator vpRect

(

)

Conversion to vpRect operator.

Definition at line 135 of file vpRectOriented.cpp.

References vpException::badValue.

operator=() [1/2]

vpRectOriented & vpRectOriented::operator=

(

const vpRect &

rect

)

Assignement operator from vpRect.

Parameters

rect	Rectangle to copy.

Definition at line 116 of file vpRectOriented.cpp.

References vpImagePoint::get_i(), vpImagePoint::get_j(), vpRect::getCenter(), vpRect::getHeight(), vpRect::getWidth(), vpImagePoint::set_i(), and vpImagePoint::set_j().

operator=() [2/2]

vpRectOriented& vpRectOriented::operator= ( const vpRectOriented &  rect )

default

setCenter()

void vpRectOriented::setCenter

(

const vpImagePoint &

center

)

Set the center of the rectangle.

Definition at line 164 of file vpRectOriented.cpp.

setOrientation()

void vpRectOriented::setOrientation

(

double

theta

)

Set the rectangle orientation (rad).

Definition at line 210 of file vpRectOriented.cpp.

References vpImagePoint::get_i(), vpImagePoint::get_j(), vpImagePoint::set_i(), and vpImagePoint::set_j().

setPoints()

void vpRectOriented::setPoints	(	const vpImagePoint &	topLeft,
		const vpImagePoint &	topRight,
		const vpImagePoint &	bottomLeft,
		const vpImagePoint &	bottomRight
	)

Set the corners of the rectangle.

Warning

This method doesn't check whether the 4 points actually form a rectangle! The behaviour is undefined if it is not the case.

Definition at line 147 of file vpRectOriented.cpp.

References vpImagePoint::get_i(), vpImagePoint::get_j(), vpImagePoint::set_i(), and vpImagePoint::set_j().

setSize()

void vpRectOriented::setSize	(	double	width,
		double	height
	)

Set the size of the rectangle : performs a homothety relatively to the rectangle center.

Definition at line 189 of file vpRectOriented.cpp.

References vpImagePoint::get_i(), vpImagePoint::get_j(), vpImagePoint::set_i(), and vpImagePoint::set_j().