mrpt::opengl::CGridPlaneXY Class Reference

---

Detailed Description

A grid of lines over the XY plane.

See also:

opengl::COpenGLScene

mrpt::opengl::CGridPlaneXY

Definition at line 53 of file CGridPlaneXY.h.

#include <mrpt/opengl/CGridPlaneXY.h>

Inheritance diagram for mrpt::opengl::CGridPlaneXY:

List of all members.

Public Member Functions
void	setPlaneLimits (float xmin, float xmax, float ymin, float ymax)
void	getPlaneLimits (float &xmin, float &xmax, float &ymin, float &ymax) const
void	setPlaneZcoord (float z)
float	getPlaneZcoord () const
void	setGridFrequency (float freq)
float	getGridFrequency () const
virtual void	render_dl () const
	Render.
Static Public Member Functions
static CGridPlaneXYPtr	Create (float xMin, float xMax, float yMin, float yMax, float z=0, float frequency=1)
	Class factory.
Protected Attributes
float	m_xMin
float	m_xMax
float	m_yMin
float	m_yMax
float	m_plane_z
float	m_frequency
Private Member Functions
	CGridPlaneXY (float xMin=-10, float xMax=10, float yMin=-10, float yMax=10, float z=0, float frequency=1)
	Constructor.
virtual	~CGridPlaneXY ()
	Private, virtual destructor: only can be deleted from smart pointers.
RTTI stuff
typedef CGridPlaneXYPtr	SmartPtr
static mrpt::utils::CLASSINIT	_init_CGridPlaneXY
static mrpt::utils::TRuntimeClassId	classCGridPlaneXY
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 CGridPlaneXYPtr	Create ()

---

Member Typedef Documentation

typedef CGridPlaneXYPtr mrpt::opengl::CGridPlaneXY::SmartPtr

A typedef for the associated smart pointer

Definition at line 55 of file CGridPlaneXY.h.

---

Constructor & Destructor Documentation

mrpt::opengl::CGridPlaneXY::CGridPlaneXY	(	float	xMin = -10,
		float	xMax = 10,
		float	yMin = -10,
		float	yMax = 10,
		float	z = 0,
		float	frequency = 1
	)		[inline, private]

Constructor.

Definition at line 110 of file CGridPlaneXY.h.

virtual mrpt::opengl::CGridPlaneXY::~CGridPlaneXY

(

)

[inline, private, virtual]

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

Definition at line 127 of file CGridPlaneXY.h.

---

Member Function Documentation

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

(

)

[static, protected]

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

static CGridPlaneXYPtr mrpt::opengl::CGridPlaneXY::Create

(

)

[static]

static CGridPlaneXYPtr mrpt::opengl::CGridPlaneXY::Create	(	float	xMin,
		float	xMax,
		float	yMin,
		float	yMax,
		float	z = 0,
		float	frequency = 1
	)		[inline, static]

Class factory.

Definition at line 89 of file CGridPlaneXY.h.

References mrpt::opengl::CGridPlaneXY.

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

(

)

[static]

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

(

)

const [virtual]

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

Implements mrpt::utils::CObject.

float mrpt::opengl::CGridPlaneXY::getGridFrequency

(

)

const [inline]

Definition at line 82 of file CGridPlaneXY.h.

void mrpt::opengl::CGridPlaneXY::getPlaneLimits	(	float &	xmin,
		float &	xmax,
		float &	ymin,
		float &	ymax
	)		const [inline]

Definition at line 72 of file CGridPlaneXY.h.

float mrpt::opengl::CGridPlaneXY::getPlaneZcoord

(

)

const [inline]

Definition at line 79 of file CGridPlaneXY.h.

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

(

)

const [virtual]

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

virtual void mrpt::opengl::CGridPlaneXY::render_dl

(

)

const [virtual]

Render.

Implements mrpt::opengl::CRenderizableDisplayList.

void mrpt::opengl::CGridPlaneXY::setGridFrequency

(

float

freq )

[inline]

Definition at line 81 of file CGridPlaneXY.h.

References ASSERT_, and mrpt::opengl::CRenderizableDisplayList::notifyChange().

void mrpt::opengl::CGridPlaneXY::setPlaneLimits	(	float	xmin,
		float	xmax,
		float	ymin,
		float	ymax
	)		[inline]

Definition at line 65 of file CGridPlaneXY.h.

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

void mrpt::opengl::CGridPlaneXY::setPlaneZcoord

(

float

z )

[inline]

Definition at line 78 of file CGridPlaneXY.h.

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

---

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::opengl::CGridPlaneXY::_init_CGridPlaneXY [static, protected]

Definition at line 55 of file CGridPlaneXY.h.

mrpt::utils::TRuntimeClassId mrpt::opengl::CGridPlaneXY::classCGridPlaneXY [static]

Definition at line 55 of file CGridPlaneXY.h.

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

Definition at line 55 of file CGridPlaneXY.h.

float mrpt::opengl::CGridPlaneXY::m_frequency [protected]

Definition at line 61 of file CGridPlaneXY.h.

float mrpt::opengl::CGridPlaneXY::m_plane_z [protected]

Definition at line 60 of file CGridPlaneXY.h.

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

Definition at line 58 of file CGridPlaneXY.h.

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

Definition at line 58 of file CGridPlaneXY.h.

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

Definition at line 59 of file CGridPlaneXY.h.

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

Definition at line 59 of file CGridPlaneXY.h.