This class mainly define a mesh (list of Shape) used by the Simulation object. More...

#include <Scene.h>

Inheritance diagram for Scene:

Collaboration diagram for Scene:

[legend]

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

	Scene (const Scene &other)
	Copy constructor. More...

virtual	~Scene ()
	Destructor. More...

void	clean ()
	Clear all arrays. More...

void	addShape (Shape *shape)
	Add a shape to the list. More...

BBox	getGlobalBox ()
	Return global bounding box. More...

Accelerator *	getAccelerator () const
	Get the accelerator. More...

std::vector< Shape * > *	getShapes ()
	Return all the shapes. More...

const std::vector< Shape * > *	getShapes () const

std::vector< vec3 > *	getVertices ()
	Return all the vertices. More...

const std::vector< vec3 > *	getVertices () const

std::vector< Shape * >	getShapes (int shape_type)
	Return all the shapes of a specific type. More...

bool	finish (int accelerator_id=1, leafTreatment::treatment _intersectionChoice=leafTreatment::FIRST)
	Build the selected accelerator on the scene. More...

bool	getIndex (vec3 &search, unsigned int &result)
	Get the index of a vertex in the vertices array. More...

bool	getVertex (unsigned int &search, vec3 &result)
	Get a vertex from the vertices array with its index. More...

bool	addVertex (const vec3 &newVertex, unsigned int &index)
	Add a vertex to the vertices array. More...

Shape *	addTriangle (unsigned int i1, unsigned int i2, unsigned int i3, Material *m, const bool &isSol=false)
	Add a triangle to the scene built with the vertices array. More...

void	addBuilding (vec3 origine, vec3 dimension, Material *m)
	Add a building to the scene. More...

void	export_to_ply (std::string fileName)
	Export the Scene to a PLY format file named fileName. More...

void	import_from_ply (std::string fileName)
	Import a Scene from a PLY format file named fileName. More...

Public Member Functions inherited from Base
	Base ()
	Default constructor. More...

	Base (const Base &other)
	Copy constructor. More...

virtual	~Base ()
	Destructor. More...

std::string	getName ()
	Get the name of the object. More...

void	setName (const std::string &_name)
	Set the name of the object. More...

Protected Attributes
std::vector< Shape * >	shapes
	Array of pointers to the shapes. More...

BBox	globalBox
	Bounding box of the Scene. More...

Accelerator *	accelerator
	Pointer to the accelerator. More...

std::vector< vec3 >	vertices
	All the vertices used by the different shapes. More...

std::map< vec3, unsigned int, compVec >	registeredVertices
	Association between a vertex and his index in vertices. More...

unsigned int	compteurPrimitive
	Primitives counter. More...

unsigned int	compteurFace
	Faces counter. More...

Protected Attributes inherited from Base
std::string	name
	Each instantiated object may be named. More...

Detailed Description

This class mainly define a mesh (list of Shape) used by the Simulation object.

Definition at line 50 of file Scene.h.

Constructor & Destructor Documentation

◆ Scene() [1/2]

Scene::Scene ( )

inline

Constructor.

Definition at line 55 of file Scene.h.

◆ Scene() [2/2]

Scene::Scene ( const Scene & other )

inline

Copy constructor.

Definition at line 62 of file Scene.h.

◆ ~Scene()

virtual Scene::~Scene ( )

inlinevirtual

Destructor.

Definition at line 64 of file Scene.h.

Member Function Documentation

◆ addBuilding()

void Scene::addBuilding	(	vec3	origine,
		vec3	dimension,
		Material *	m
	)

Add a building to the scene.

Parameters

origine	Position
dimension	Dimensions
m	Material

Definition at line 135 of file Scene.cpp.

Here is the call graph for this function:

◆ addShape()

void Scene::addShape ( Shape * shape )

inline

Add a shape to the list.

Definition at line 68 of file Scene.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addTriangle()

Shape * Scene::addTriangle	(	unsigned int	i1,
		unsigned int	i2,
		unsigned int	i3,
		Material *	m,
		const bool &	isSol = `false`
	)

Add a triangle to the scene built with the vertices array.

Parameters

i1	Index of first vertex in vertices
i2	Index of second vertex in vertices
i3	Index of third vertex in vertices
m	Material
isSol	True is ground triangle

Returns: The triangle

Definition at line 127 of file Scene.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addVertex()

bool Scene::addVertex	(	const vec3 &	newVertex,
		unsigned int &	index
	)

Add a vertex to the vertices array.

Parameters

newVertex	[in] New vertex
index	[out] Index in the array vertices

Returns: True if succeeds, else false

Definition at line 110 of file Scene.cpp.

Here is the caller graph for this function:

◆ clean()

void Scene::clean ( )

Clear all arrays.

Definition at line 33 of file Scene.cpp.

Here is the caller graph for this function:

◆ export_to_ply()

void Scene::export_to_ply ( std::string fileName )

Export the Scene to a PLY format file named fileName.

Definition at line 178 of file Scene.cpp.

◆ finish()

bool Scene::finish	(	int	accelerator_id = `1`,
		leafTreatment::treatment	_intersectionChoice = `leafTreatment::FIRST`
	)

Build the selected accelerator on the scene.

Parameters

accelerator_id	Accelerator id
_intersectionChoice	Intersection choice

Returns: True if succeeds, false if not

Definition at line 51 of file Scene.cpp.

Here is the call graph for this function:

◆ getAccelerator()

Accelerator* Scene::getAccelerator ( ) const

inline

Get the accelerator.

Definition at line 82 of file Scene.h.

Here is the caller graph for this function:

◆ getGlobalBox()

BBox Scene::getGlobalBox ( )

inline

Return global bounding box.

Definition at line 77 of file Scene.h.

Here is the caller graph for this function:

◆ getIndex()

bool Scene::getIndex	(	vec3 &	search,
		unsigned int &	result
	)

Get the index of a vertex in the vertices array.

Parameters

search	[in] Vertex
result	[out] Index found

Returns: True if succeeds, false if not

Definition at line 87 of file Scene.cpp.

◆ getShapes() [1/3]

std::vector<Shape*>* Scene::getShapes ( )

inline

Return all the shapes.

Definition at line 88 of file Scene.h.

Here is the caller graph for this function:

◆ getShapes() [2/3]

const std::vector<Shape*>* Scene::getShapes ( ) const

inline

Definition at line 92 of file Scene.h.

◆ getShapes() [3/3]

std::vector< Shape * > Scene::getShapes ( int shape_type )

Return all the shapes of a specific type.

Definition at line 165 of file Scene.cpp.

◆ getVertex()

bool Scene::getVertex	(	unsigned int &	search,
		vec3 &	result
	)

Get a vertex from the vertices array with its index.

Parameters

search	[in] Index
result	[out] Vertex found

Returns: True if vertex is found else false

Definition at line 99 of file Scene.cpp.

◆ getVertices() [1/2]

std::vector<vec3>* Scene::getVertices ( )

inline

Return all the vertices.

Definition at line 97 of file Scene.h.

Here is the caller graph for this function:

◆ getVertices() [2/2]

const std::vector<vec3>* Scene::getVertices ( ) const

inline

Definition at line 101 of file Scene.h.

◆ import_from_ply()

void Scene::import_from_ply ( std::string fileName )

Import a Scene from a PLY format file named fileName.

Definition at line 237 of file Scene.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ accelerator

Accelerator* Scene::accelerator

protected

Pointer to the accelerator.

Definition at line 165 of file Scene.h.

◆ compteurFace

unsigned int Scene::compteurFace

protected

Faces counter.

Definition at line 172 of file Scene.h.

◆ compteurPrimitive

unsigned int Scene::compteurPrimitive

protected

Primitives counter.

Definition at line 171 of file Scene.h.

◆ globalBox

BBox Scene::globalBox

protected

Bounding box of the Scene.

Definition at line 164 of file Scene.h.

◆ registeredVertices

std::map<vec3, unsigned int, compVec> Scene::registeredVertices

protected

Association between a vertex and his index in vertices.

Definition at line 169 of file Scene.h.

◆ shapes

std::vector<Shape*> Scene::shapes

protected

Array of pointers to the shapes.

Definition at line 163 of file Scene.h.

◆ vertices

std::vector<vec3> Scene::vertices

protected

All the vertices used by the different shapes.

Definition at line 167 of file Scene.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Geometry/Scene.h
/home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Geometry/Scene.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Scene() [1/2]

◆ Scene() [2/2]

◆ ~Scene()

Member Function Documentation

◆ addBuilding()

◆ addShape()

◆ addTriangle()

◆ addVertex()

◆ clean()

◆ export_to_ply()

◆ finish()

◆ getAccelerator()

◆ getGlobalBox()

◆ getIndex()

◆ getShapes() [1/3]

◆ getShapes() [2/3]

◆ getShapes() [3/3]

◆ getVertex()

◆ getVertices() [1/2]

◆ getVertices() [2/2]

◆ import_from_ply()

Member Data Documentation

◆ accelerator

◆ compteurFace

◆ compteurPrimitive

◆ globalBox

◆ registeredVertices

◆ shapes

◆ vertices