mrpt::opengl::CGridPlaneXZ Class Reference

---

Detailed Description

A grid of lines over the XZ plane.

See also:

opengl::COpenGLScene

mrpt::opengl::CGridPlaneXZ

Definition at line 53 of file CGridPlaneXZ.h.

#include <mrpt/opengl/CGridPlaneXZ.h>

Inheritance diagram for mrpt::opengl::CGridPlaneXZ:

List of all members.

Public Member Functions
void	setPlaneLimits (float xmin, float xmax, float zmin, float zmax)
void	getPlaneLimits (float &xmin, float &xmax, float &zmin, float &zmax) const
void	setPlaneYcoord (float y)
float	getPlaneYcoord () const
void	setGridFrequency (float freq)
float	getGridFrequency () const
void	render_dl () const
	Render.
Static Public Member Functions
static CGridPlaneXZPtr	Create (float xMin=-10, float xMax=10, float zMin=-10, float zMax=10, float y=0, float frequency=1)
	Class factory.
Protected Attributes
float	m_xMin
float	m_xMax
float	m_zMin
float	m_zMax
float	m_plane_y
float	m_frequency
Private Member Functions
	CGridPlaneXZ (float xMin=-10, float xMax=10, float zMin=-10, float zMax=10, float y=0, float frequency=1)
	Constructor.
virtual	~CGridPlaneXZ ()
	Private, virtual destructor: only can be deleted from smart pointers.
RTTI stuff
typedef CGridPlaneXZPtr	SmartPtr
static mrpt::utils::CLASSINIT	_init_CGridPlaneXZ
static mrpt::utils::TRuntimeClassId	classCGridPlaneXZ
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 CGridPlaneXZPtr	Create ()

---

Member Typedef Documentation

typedef CGridPlaneXZPtr mrpt::opengl::CGridPlaneXZ::SmartPtr

A typedef for the associated smart pointer

Definition at line 55 of file CGridPlaneXZ.h.

---

Constructor & Destructor Documentation

mrpt::opengl::CGridPlaneXZ::CGridPlaneXZ	(	float	xMin = -10,
		float	xMax = 10,
		float	zMin = -10,
		float	zMax = 10,
		float	y = 0,
		float	frequency = 1
	)		[inline, private]

Constructor.

Definition at line 106 of file CGridPlaneXZ.h.

virtual mrpt::opengl::CGridPlaneXZ::~CGridPlaneXZ

(

)

[inline, private, virtual]

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

Definition at line 121 of file CGridPlaneXZ.h.

---

Member Function Documentation

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

(

)

[static, protected]

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

static CGridPlaneXZPtr mrpt::opengl::CGridPlaneXZ::Create

(

)

[static]

static CGridPlaneXZPtr mrpt::opengl::CGridPlaneXZ::Create	(	float	xMin = -10,
		float	xMax = 10,
		float	zMin = -10,
		float	zMax = 10,
		float	y = 0,
		float	frequency = 1
	)		[inline, static]

Class factory.

Definition at line 87 of file CGridPlaneXZ.h.

References mrpt::opengl::CGridPlaneXZ, and internal::y.

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

(

)

[static]

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

(

)

const [virtual]

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

Implements mrpt::utils::CObject.

float mrpt::opengl::CGridPlaneXZ::getGridFrequency

(

)

const [inline]

Definition at line 82 of file CGridPlaneXZ.h.

void mrpt::opengl::CGridPlaneXZ::getPlaneLimits	(	float &	xmin,
		float &	xmax,
		float &	zmin,
		float &	zmax
	)		const [inline]

Definition at line 72 of file CGridPlaneXZ.h.

float mrpt::opengl::CGridPlaneXZ::getPlaneYcoord

(

)

const [inline]

Definition at line 79 of file CGridPlaneXZ.h.

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

(

)

const [virtual]

Returns information about the class of an object in runtime.

Reimplemented from mrpt::opengl::CRenderizableDisplayList.

void mrpt::opengl::CGridPlaneXZ::render_dl

(

)

const [virtual]

Render.

Implements mrpt::opengl::CRenderizableDisplayList.

void mrpt::opengl::CGridPlaneXZ::setGridFrequency

(

float

freq )

[inline]

Definition at line 81 of file CGridPlaneXZ.h.

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

void mrpt::opengl::CGridPlaneXZ::setPlaneLimits	(	float	xmin,
		float	xmax,
		float	zmin,
		float	zmax
	)		[inline]

Definition at line 65 of file CGridPlaneXZ.h.

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

void mrpt::opengl::CGridPlaneXZ::setPlaneYcoord

(

float

y )

[inline]

Definition at line 78 of file CGridPlaneXZ.h.

References mrpt::opengl::CRenderizableDisplayList::notifyChange(), and internal::y.

---

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::opengl::CGridPlaneXZ::_init_CGridPlaneXZ [static, protected]

Definition at line 55 of file CGridPlaneXZ.h.

mrpt::utils::TRuntimeClassId mrpt::opengl::CGridPlaneXZ::classCGridPlaneXZ [static]

Definition at line 55 of file CGridPlaneXZ.h.

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

Definition at line 55 of file CGridPlaneXZ.h.

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

Definition at line 61 of file CGridPlaneXZ.h.

float mrpt::opengl::CGridPlaneXZ::m_plane_y [protected]

Definition at line 60 of file CGridPlaneXZ.h.

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

Definition at line 58 of file CGridPlaneXZ.h.

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

Definition at line 58 of file CGridPlaneXZ.h.

float mrpt::opengl::CGridPlaneXZ::m_zMax [protected]

Definition at line 59 of file CGridPlaneXZ.h.

float mrpt::opengl::CGridPlaneXZ::m_zMin [protected]

Definition at line 59 of file CGridPlaneXZ.h.