mrpt::opengl::CTexturedObject Class Reference

A base class for all OpenGL objects with loadable textures. More...

#include <mrpt/opengl/CTexturedObject.h>

Inheritance diagram for mrpt::opengl::CTexturedObject:

[legend]

Collaboration diagram for mrpt::opengl::CTexturedObject:

[legend]

List of all members.

Public Member Functions
void	assignImage (const mrpt::utils::CImage &img, const mrpt::utils::CImage &imgAlpha)
	Assigns a texture and a transparency image, and enables transparency (If the images are not 2^N x 2^M, they will be internally filled to its dimensions to be powers of two).
void	assignImage (const mrpt::utils::CImage &img)
	Assigns a texture image, and disable transparency.
void	assignImage_fast (mrpt::utils::CImage &img, mrpt::utils::CImage &imgAlpha)
	Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer.
void	assignImage_fast (mrpt::utils::CImage &img)
	Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer.
void	loadTextureInOpenGL () const
	VERY IMPORTANT: If you use a multi-thread application, you MUST call this from the same thread that will later destruct the object in order to the OpenGL texture memory to be correctly deleted.
Protected Member Functions
	CTexturedObject ()
virtual	~CTexturedObject ()
void	unloadTexture ()
void	render_texture_pre () const
void	render_texture_post () const
void	writeToStreamTexturedObject (mrpt::utils::CStream &out) const
void	readFromStreamTexturedObject (mrpt::utils::CStream &in)
Protected Attributes
unsigned int	m_glTextureName
bool	m_texture_is_loaded
mrpt::utils::CImage	m_textureImage
mrpt::utils::CImage	m_textureImageAlpha
bool	m_enableTransparency
	Of the texture using "m_textureImageAlpha".
int	r_width
int	r_height
	Size of the texture image, rounded up to next power of 2.
int	m_fill_x_left
int	m_fill_y_top
int	m_fill_x_right
int	m_fill_y_bottom
	The size of the fill in pixels in the textured image, w.r.t the image passed by the user.

Detailed Description

A base class for all OpenGL objects with loadable textures.

See also:: opengl::COpenGLScene, opengl::CTexturedPlane, opengl::CSetOfTexturedTriangles

Definition at line 47 of file CTexturedObject.h.

Constructor & Destructor Documentation

mrpt::opengl::CTexturedObject::CTexturedObject ( ) [protected]

virtual mrpt::opengl::CTexturedObject::~CTexturedObject ( ) [protected, virtual]

Member Function Documentation

void mrpt::opengl::CTexturedObject::assignImage ( const mrpt::utils::CImage & img )

Assigns a texture image, and disable transparency.

Note:: Images are copied, the original ones can be deleted.

void mrpt::opengl::CTexturedObject::assignImage	(	const mrpt::utils::CImage &	img,
		const mrpt::utils::CImage &	imgAlpha
	)

Assigns a texture and a transparency image, and enables transparency (If the images are not 2^N x 2^M, they will be internally filled to its dimensions to be powers of two).

Note:: Images are copied, the original ones can be deleted.

void mrpt::opengl::CTexturedObject::assignImage_fast ( mrpt::utils::CImage & img )

Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer.

void mrpt::opengl::CTexturedObject::assignImage_fast	(	mrpt::utils::CImage &	img,
		mrpt::utils::CImage &	imgAlpha
	)

Similar to assignImage, but the passed images will be returned as empty: it avoids making a copy of the whole image, just copies a pointer.

void mrpt::opengl::CTexturedObject::loadTextureInOpenGL ( ) const

VERY IMPORTANT: If you use a multi-thread application, you MUST call this from the same thread that will later destruct the object in order to the OpenGL texture memory to be correctly deleted.

Calling this method more than once has no effects. If you use one thread, this method will be automatically called when rendering, so there is no need to explicitly call it.

void mrpt::opengl::CTexturedObject::readFromStreamTexturedObject ( mrpt::utils::CStream & in ) [protected]