mrpt::opengl::C3DSScene Class Reference

This element keeps a set of objects imported from a 3DStudio file (.3ds). More...

#include <mrpt/opengl/C3DSScene.h>

Inheritance diagram for mrpt::opengl::C3DSScene:

[legend]

Collaboration diagram for mrpt::opengl::C3DSScene:

[legend]

List of all members.

Classes
struct	TImpl3DS
	A container for automatic deletion of lib3ds's scene when the last reference of the smart_ptr's is destroyed. More...
Public Member Functions
void	render () const
	Render child objects.
void	loadFrom3DSFile (const std::string &file_name)
	Loads a scene from a 3DS file (3D Studio format) into this object, from either plain .3ds format, or in gzip compressed .3ds.gz format.
void	initializeAllTextures ()
	Initializes all textures in the scene (See opengl::CTexturedPlane::loadTextureInOpenGL).
void	clear ()
	Empty the object.
void	evaluateAnimation (double time_anim)
	Evaluates the scene at a given animation time.
void	enableExtraAmbientLight (bool enable=true)
	Enables an extra ambient light.
virtual bool	traceRay (const mrpt::poses::CPose3D &o, double &dist) const
	Simulation of ray-trace, given a pose.
Private Member Functions
	C3DSScene ()
	Default constructor.
virtual	~C3DSScene ()
	Private, virtual destructor: only can be deleted from smart pointers.
Private Attributes
stlplus::smart_ptr< TImpl3DS >	m_3dsfile
	An internal pointer to the lib3ds library's object of type "Lib3dsFile".
bool	m_enable_extra_lighting
	Scale of the object.

---

Detailed Description

This element keeps a set of objects imported from a 3DStudio file (.3ds).

This class uses the opensource library lib3ds internally.

See also:

opengl::COpenGLScene

Definition at line 48 of file C3DSScene.h.

---

Constructor & Destructor Documentation

mrpt::opengl::C3DSScene::C3DSScene

(

)

[private]

Default constructor.

virtual mrpt::opengl::C3DSScene::~C3DSScene

(

)

[private, virtual]

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

---

Member Function Documentation

void mrpt::opengl::C3DSScene::clear

(

)

Empty the object.

void mrpt::opengl::C3DSScene::enableExtraAmbientLight

(

bool

enable = true

)

[inline]

Enables an extra ambient light.

Definition at line 77 of file C3DSScene.h.

void mrpt::opengl::C3DSScene::evaluateAnimation

(

double

time_anim

)

Evaluates the scene at a given animation time.

void mrpt::opengl::C3DSScene::initializeAllTextures

(

)

Initializes all textures in the scene (See opengl::CTexturedPlane::loadTextureInOpenGL).

void mrpt::opengl::C3DSScene::loadFrom3DSFile

(

const std::string &

file_name

)

Loads a scene from a 3DS file (3D Studio format) into this object, from either plain .3ds format, or in gzip compressed .3ds.gz format.

Previous contents are lost. If the file ends in ".gz", it'll be automatically decompressed using gzip (see mrpt::compress::zip).

void mrpt::opengl::C3DSScene::render

(

)

const [virtual]

Render child objects.

Implements mrpt::opengl::CRenderizable.

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

Simulation of ray-trace, given a pose.

Returns true if the ray effectively collisions with the object (returning the distance to the origin of the ray in "dist"), or false in other case. "dist" variable yields undefined behaviour when false is returned

Reimplemented from mrpt::opengl::CRenderizable.

---

Member Data Documentation

stlplus::smart_ptr<TImpl3DS> mrpt::opengl::C3DSScene::m_3dsfile [private]

An internal pointer to the lib3ds library's object of type "Lib3dsFile".

Definition at line 101 of file C3DSScene.h.

bool mrpt::opengl::C3DSScene::m_enable_extra_lighting [private]

Scale of the object.

Definition at line 106 of file C3DSScene.h.