mrpt::opengl::CTexturedPlane Class Reference

---

Detailed Description

A 2D plane in the XY plane with a texture image.

See also:

opengl::COpenGLScene

Definition at line 45 of file CTexturedPlane.h.

#include <mrpt/opengl/CTexturedPlane.h>

Inheritance diagram for mrpt::opengl::CTexturedPlane:

List of all members.

Public Member Functions
void	setTextureCornerCoords (float tex_x_min, float tex_x_max, float tex_y_min, float tex_y_max)
	Set the texture coordinates of the four corners (in the range 0-1).
void	setPlaneCorners (float xMin, float xMax, float yMin, float yMax)
	Set the coordinates of the four corners that define the plane on the XY plane.
void	getPlaneCorners (float &xMin, float &xMax, float &yMin, float &yMax) const
	Get the coordinates of the four corners that define the plane on the XY plane.
virtual bool	traceRay (const mrpt::poses::CPose3D &o, double &dist) const
	Ray trace.
Static Public Member Functions
static CTexturedPlanePtr	Create (float x_min, float x_max, float y_min, float y_max)
	Class factory.
Protected Member Functions
void	updatePoly () const
void	unloadTexture ()
void	render_texturedobj () const
	Must be implemented by derived classes.
Protected Attributes
float	m_tex_x_min
float	m_tex_x_max
float	m_tex_y_min
float	m_tex_y_max
float	m_xMin
float	m_xMax
float	m_yMin
float	m_yMax
bool	polygonUpToDate
std::vector < mrpt::math::TPolygonWithPlane >	tmpPoly
	Used for ray-tracing.
Private Member Functions
	CTexturedPlane (float x_min=-1, float x_max=1, float y_min=-1, float y_max=1)
	Constructor.
virtual	~CTexturedPlane ()
	Private, virtual destructor: only can be deleted from smart pointers.
RTTI stuff
typedef CTexturedPlanePtr	SmartPtr
static mrpt::utils::CLASSINIT	_init_CTexturedPlane
static mrpt::utils::TRuntimeClassId	classCTexturedPlane
static const mrpt::utils::TRuntimeClassId *	classinfo
static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()
virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime.
virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class.
static mrpt::utils::CObject *	CreateObject ()
static CTexturedPlanePtr	Create ()

---

Member Typedef Documentation

typedef CTexturedPlanePtr mrpt::opengl::CTexturedPlane::SmartPtr

A typedef for the associated smart pointer

Definition at line 47 of file CTexturedPlane.h.

---

Constructor & Destructor Documentation

mrpt::opengl::CTexturedPlane::CTexturedPlane	(	float	x_min = -1,
		float	x_max = 1,
		float	y_min = -1,
		float	y_max = 1
	)		[private]

Constructor.

virtual mrpt::opengl::CTexturedPlane::~CTexturedPlane

(

)

[private, virtual]

Private, virtual destructor: only can be deleted from smart pointers.

---

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::opengl::CTexturedPlane::_GetBaseClass

(

)

[static, protected]

Reimplemented from mrpt::opengl::CTexturedObject.

static CTexturedPlanePtr mrpt::opengl::CTexturedPlane::Create

(

)

[static]

static CTexturedPlanePtr mrpt::opengl::CTexturedPlane::Create	(	float	x_min,
		float	x_max,
		float	y_min,
		float	y_max
	)		[inline, static]

Class factory.

Definition at line 90 of file CTexturedPlane.h.

References mrpt::opengl::CTexturedPlane.

static mrpt::utils::CObject* mrpt::opengl::CTexturedPlane::CreateObject

(

)

[static]

virtual mrpt::utils::CObject* mrpt::opengl::CTexturedPlane::duplicate

(

)

const [virtual]

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

void mrpt::opengl::CTexturedPlane::getPlaneCorners	(	float &	xMin,
		float &	xMax,
		float &	yMin,
		float &	yMax
	)		const [inline]

Get the coordinates of the four corners that define the plane on the XY plane.

Definition at line 83 of file CTexturedPlane.h.

virtual const mrpt::utils::TRuntimeClassId* mrpt::opengl::CTexturedPlane::GetRuntimeClass

(

)

const [virtual]

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CTexturedObject.

void mrpt::opengl::CTexturedPlane::render_texturedobj

(

)

const [protected, virtual]

Must be implemented by derived classes.

Implements mrpt::opengl::CTexturedObject.

void mrpt::opengl::CTexturedPlane::setPlaneCorners	(	float	xMin,
		float	xMax,
		float	yMin,
		float	yMax
	)		[inline]

Set the coordinates of the four corners that define the plane on the XY plane.

Definition at line 74 of file CTexturedPlane.h.

References mrpt::opengl::CRenderizableDisplayList::notifyChange().

void mrpt::opengl::CTexturedPlane::setTextureCornerCoords	(	float	tex_x_min,
		float	tex_x_max,
		float	tex_y_min,
		float	tex_y_max
	)		[inline]

Set the texture coordinates of the four corners (in the range 0-1).

Definition at line 64 of file CTexturedPlane.h.

References mrpt::opengl::CRenderizableDisplayList::notifyChange().

virtual bool mrpt::opengl::CTexturedPlane::traceRay	(	const mrpt::poses::CPose3D &	o,
		double &	dist
	)		const [virtual]

Ray trace.

Reimplemented from mrpt::opengl::CRenderizable.

void mrpt::opengl::CTexturedPlane::unloadTexture

(

)

[protected]

Reimplemented from mrpt::opengl::CTexturedObject.

void mrpt::opengl::CTexturedPlane::updatePoly

(

)

const [protected]

---

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::opengl::CTexturedPlane::_init_CTexturedPlane [static, protected]

Definition at line 47 of file CTexturedPlane.h.

mrpt::utils::TRuntimeClassId mrpt::opengl::CTexturedPlane::classCTexturedPlane [static]

Definition at line 47 of file CTexturedPlane.h.

const mrpt::utils::TRuntimeClassId* mrpt::opengl::CTexturedPlane::classinfo [static]

Definition at line 47 of file CTexturedPlane.h.

float mrpt::opengl::CTexturedPlane::m_tex_x_max [mutable, protected]

Definition at line 49 of file CTexturedPlane.h.

float mrpt::opengl::CTexturedPlane::m_tex_x_min [mutable, protected]

Definition at line 49 of file CTexturedPlane.h.

float mrpt::opengl::CTexturedPlane::m_tex_y_max [mutable, protected]

Definition at line 50 of file CTexturedPlane.h.

float mrpt::opengl::CTexturedPlane::m_tex_y_min [mutable, protected]

Definition at line 50 of file CTexturedPlane.h.

float mrpt::opengl::CTexturedPlane::m_xMax [protected]

Definition at line 52 of file CTexturedPlane.h.

float mrpt::opengl::CTexturedPlane::m_xMin [protected]

Definition at line 52 of file CTexturedPlane.h.

float mrpt::opengl::CTexturedPlane::m_yMax [protected]

Definition at line 53 of file CTexturedPlane.h.

float mrpt::opengl::CTexturedPlane::m_yMin [protected]

Definition at line 53 of file CTexturedPlane.h.

bool mrpt::opengl::CTexturedPlane::polygonUpToDate [mutable, protected]

Definition at line 55 of file CTexturedPlane.h.

std::vector<mrpt::math::TPolygonWithPlane> mrpt::opengl::CTexturedPlane::tmpPoly [mutable, protected]

Used for ray-tracing.

Definition at line 56 of file CTexturedPlane.h.