A 3d model that can be rendered to the screen. More...

#include <Model.h>

Inherited by Sprite.

Public Types
typedef std::unordered_map< std::string, GeometryPtr >	GroupMap

typedef std::shared_ptr< std::unordered_map< ShaderPtr, PropertiesPtr > >	InstanceMapPtr

typedef std::unordered_map< std::string, InstanceMapPtr >	InstancesMap

Public Member Functions
	Model ()
	Constructor. More...

	Model (ObjectManager *o, const ModelData &modelData, GLuint shaderMaxLights, bool variableNumberOfLights, bool shaderFromFile, bool ambientLighting, PropertiesPtr properties=nullptr)
	Constructor. More...

	Model (ObjectManager *o, const ModelData &modelData, ShaderPtr shader, PropertiesPtr properties=nullptr)
	Constructor. More...

	Model (const ModelData &modelData, MaterialPtr material, PropertiesPtr properties=nullptr)
	Constructor. More...

virtual	~Model ()
	Virtual destructor. More...

virtual void	draw (GLenum mode=GL_TRIANGLES) override
	Draws the model to the screen. More...

virtual void	draw (const std::string &geometryName, GLenum mode=GL_TRIANGLES)
	Draws the specified group of geometry to the screen. More...

virtual void	drawInstance (const std::string &instanceName, GLenum mode=GL_TRIANGLES) override
	Draws an instance of the model to the screen. More...

virtual InstanceMapPtr	addInstance (const std::string &instanceName)
	Creates an instance of this model and associated geometry. More...

virtual PropertiesPtr	getInstanceProperties (const std::string &instanceName, const std::string &geometryName)
	Get the properties of a geometry instance. More...

virtual InstanceMapPtr	getInstanceProperties (const std::string &instanceName)
	Get the instance properties for every shader used in the model. More...

virtual void	removeInstance (const std::string &instanceName)
	Removes an instance of the model and associated geometry. More...

virtual void	clearInstances ()
	Removes all instances of the model and associated geometry. More...

MaterialPtr	getMaterial ()
	Returns the material of the model. More...

void	setMaterial (MaterialPtr arg)
	Sets the material of the model. More...

PropertiesPtr	getProperties ()
	Returns the properties of the model. More...

void	setProperties (PropertiesPtr arg)
	Sets the properties of the model. More...

GroupMap &	getGroups ()
	Returns the groups of geometry of the model. More...

vmml::AABBf &	getBoundingBoxObjectSpace ()
	Returns the bounding box of the geometry in object space. More...

void	setBoundingBoxObjectSpace (vmml::AABBf arg)
	Sets the bounding box of the geometry in object space. More...

virtual void	addGeometry (const std::string &name, GeometryPtr geometry)
	Adds geometry to the model. More...

virtual void	removeGeometry (const std::string &name)
	Removes geometry from the model. More...

virtual void	deleteModelGeometry ()
	Deletes all geometry of the model. More...

Public Member Functions inherited from IDrawable
virtual	~IDrawable ()
	Virtual destructor. More...

Detailed Description

A 3d model that can be rendered to the screen.

Author: Rahul Mukhi, David Steiner

Member Typedef Documentation

typedef std::unordered_map< std::string, GeometryPtr > Model::GroupMap

typedef std::shared_ptr< std::unordered_map< ShaderPtr, PropertiesPtr > > Model::InstanceMapPtr

typedef std::unordered_map< std::string, InstanceMapPtr > Model::InstancesMap

Constructor & Destructor Documentation

Model::Model ( )

inline

Constructor.

Model::Model	(	ObjectManager *	o,
		const ModelData &	modelData,
		GLuint	shaderMaxLights,
		bool	variableNumberOfLights,
		bool	shaderFromFile,
		bool	ambientLighting,
		PropertiesPtr	properties = `nullptr`
	)

Constructor.

Parameters

[in]	o	Object management
[in]	modelData
[in]	shaderMaxLights	The maximum light sources to be used
[in]	variableNumberOfLights	True if the number of lights may vary, otherwise the number of lights has to be the same as specified as maximum number of lights
[in]	shaderFromFile	Set true if for every material a shader file with the same name should be loaded
[in]	ambientLighting	Set true if the shader supports ambient lighting
[in]	properties	Properties that will be passed to the shader of the model (optional)

Model::Model	(	ObjectManager *	o,
		const ModelData &	modelData,
		ShaderPtr	shader,
		PropertiesPtr	properties = `nullptr`
	)

Constructor.

Parameters

[in]	o	Object management
[in]	modelData
[in]	shader
[in]	properties	Properties that will be passed to the shader of the model (optional)

Model::Model	(	const ModelData &	modelData,
		MaterialPtr	material,
		PropertiesPtr	properties = `nullptr`
	)

Constructor.

Parameters

[in]	modelData
[in]	material
[in]	properties	Properties that will be passed to the shader of the model (optional)

virtual Model::~Model ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

void Model::addGeometry	(	const std::string &	name,
		GeometryPtr	geometry
	)

virtual

Adds geometry to the model.

Parameters

[in]	name	Name of the geometry
[in]	geometry	A pointer to the geometry

Model::InstanceMapPtr Model::addInstance ( const std::string & instanceName )

virtual

Creates an instance of this model and associated geometry.

All geometry that belong to this model get additional properties

Parameters

[in] instanceName Name of the instance

void Model::clearInstances ( )

virtual

Removes all instances of the model and associated geometry.

virtual void Model::deleteModelGeometry ( )

inlinevirtual

Deletes all geometry of the model.

void Model::draw ( GLenum mode = GL_TRIANGLES )

overridevirtual

Draws the model to the screen.

Parameters

[in] mode

Implements IDrawable.

void Model::draw	(	const std::string &	geometryName,
		GLenum	mode = `GL_TRIANGLES`
	)

virtual

Draws the specified group of geometry to the screen.

Parameters

[in]	geometryName	Name of the group to draw
[in]	mode

void Model::drawInstance	(	const std::string &	instanceName,
		GLenum	mode = `GL_TRIANGLES`
	)

overridevirtual

Draws an instance of the model to the screen.

Parameters

[in]	instanceName
[in]	mode

Implements IDrawable.

vmml::AABBf& Model::getBoundingBoxObjectSpace ( )

inline

Returns the bounding box of the geometry in object space.

GroupMap& Model::getGroups ( )

inline

Returns the groups of geometry of the model.

PropertiesPtr Model::getInstanceProperties	(	const std::string &	instanceName,
		const std::string &	geometryName
	)

virtual

Get the properties of a geometry instance.

Parameters

[in]	instanceName	Name of the instance
[in]	geometryName	Name of the geometry

Model::InstanceMapPtr Model::getInstanceProperties ( const std::string & instanceName )

virtual

Get the instance properties for every shader used in the model.

Parameters

[in] instanceName Name of the instance

MaterialPtr Model::getMaterial ( )

inline

Returns the material of the model.

PropertiesPtr Model::getProperties ( )

inline

Returns the properties of the model.

virtual void Model::removeGeometry ( const std::string & name )

inlinevirtual

Removes geometry from the model.

Parameters

[in] name Name of the geometry

void Model::removeInstance ( const std::string & instanceName )

virtual

Removes an instance of the model and associated geometry.

Parameters

[in] instanceName Name of the instance

void Model::setBoundingBoxObjectSpace ( vmml::AABBf arg )

inline

Sets the bounding box of the geometry in object space.

Parameters

[in] arg The bounding box for the geometry in object space

void Model::setMaterial ( MaterialPtr arg )

inline

Sets the material of the model.

Parameters

[in] arg The material for the model

void Model::setProperties ( PropertiesPtr arg )

inline

Sets the properties of the model.

Parameters

[in] arg The properties for the model

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation