mrpt::opengl::CGridPlaneXY Class Reference

A grid of lines over the XY plane. More...

#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
void	render () const
	Render.
Static Public Member Functions
static CGridPlaneXYPtr	Create (float xMin=-10, float xMax=10, float yMin=-10, float yMax=10, 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.

---

Detailed Description

A grid of lines over the XY plane.

See also:

opengl::COpenGLScene

Definition at line 46 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 101 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 118 of file CGridPlaneXY.h.

---

Member Function Documentation

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

Class factory.

Definition at line 80 of file CGridPlaneXY.h.

References mrpt::opengl::CGridPlaneXY.

float mrpt::opengl::CGridPlaneXY::getGridFrequency

(

)

const [inline]

Definition at line 73 of file CGridPlaneXY.h.

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

Definition at line 63 of file CGridPlaneXY.h.

float mrpt::opengl::CGridPlaneXY::getPlaneZcoord

(

)

const [inline]

Definition at line 70 of file CGridPlaneXY.h.

void mrpt::opengl::CGridPlaneXY::render

(

)

const [virtual]

Render.

Implements mrpt::opengl::CRenderizable.

void mrpt::opengl::CGridPlaneXY::setGridFrequency

(

float

freq

)

[inline]

Definition at line 72 of file CGridPlaneXY.h.

References ASSERT_.

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

Definition at line 57 of file CGridPlaneXY.h.

void mrpt::opengl::CGridPlaneXY::setPlaneZcoord

(

float

z

)

[inline]

Definition at line 69 of file CGridPlaneXY.h.

---

Member Data Documentation

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

Definition at line 54 of file CGridPlaneXY.h.

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

Definition at line 53 of file CGridPlaneXY.h.

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

Definition at line 51 of file CGridPlaneXY.h.

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

Definition at line 51 of file CGridPlaneXY.h.

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

Definition at line 52 of file CGridPlaneXY.h.

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

Definition at line 52 of file CGridPlaneXY.h.