gpu_coverage::Light Class Reference

Represents a light source, corresponds to Assimp's aiLight structure. More...

#include <Light.h>

Public Member Functions
	Light (const aiLight *const light, const size_t id, Node *node)
	Constructor. More...
virtual	~Light ()
	Destructor.
void	toDot (FILE *dot)
	Write Graphviz Dot node representing this light source to file for debugging. More...
size_t	getId () const
	Returns the unique ID of this light source. More...
const std::string &	getName () const
	Returns the name of this light source for logging. More...
Node *	getNode () const
	Returns the scene graph node that this bone is attached to. More...
const glm::vec3 &	getDiffuse () const
	Returns the diffuse light color. More...
const glm::vec3 &	getAmbient () const
	Returns the ambient light color. More...
const glm::vec3 &	getSpecular () const
	Returns the specular light color. More...
aiLightSourceType	getType () const
	Returns the type of the light source. More...

Protected Attributes
const size_t	id
	Unique ID, see getId().
const std::string	name
	Name of this light source, see getName().
Node *const	node
	Scene graph node where this light source is attached, see getNode().
const aiLightSourceType	type
	Type of this light source, see getType()
const glm::vec3	diffuse
	Diffuse light color, see getDiffuse().
const glm::vec3	ambient
	Ambient light color, see getAmbient().
const glm::vec3	specular
	Specular light color, see getSpecular().

Detailed Description

Represents a light source, corresponds to Assimp's aiLight structure.

Constructor & Destructor Documentation

gpu_coverage::Light::Light	(	const aiLight *const	light,
		const size_t	id,
		Node *	node
	)

Constructor.

Parameters

[in]	light	Assimp light structure.
[in]	id	Unique ID of the light source-
[in]	node	Scene graph node where the light is attached.

Member Function Documentation

const glm::vec3& gpu_coverage::Light::getAmbient ( ) const

inline

Returns the ambient light color.

Returns

Ambient light color.

const glm::vec3& gpu_coverage::Light::getDiffuse ( ) const

inline

Returns the diffuse light color.

Returns

Diffuse light color.

size_t gpu_coverage::Light::getId ( ) const

inline

Returns the unique ID of this light source.

Returns

ID.

const std::string& gpu_coverage::Light::getName ( ) const

inline

Returns the name of this light source for logging.

Returns

Name of this light source.

If available, the name included in the input file read by Assimp is used.

Node* gpu_coverage::Light::getNode ( ) const

inline

Returns the scene graph node that this bone is attached to.

Returns

The scene graph node.

const glm::vec3& gpu_coverage::Light::getSpecular ( ) const

inline

Returns the specular light color.

Returns

Specular light color.

aiLightSourceType gpu_coverage::Light::getType ( ) const

inline

Returns the type of the light source.

Returns

Type of the light source.

void gpu_coverage::Light::toDot

(

FILE *

dot

)

Write Graphviz Dot node representing this light source to file for debugging.

Parameters

[in]

dot

Output Dot file.

---

The documentation for this class was generated from the following file:

• include/gpu_coverage/Light.h