BodyParticle Class Reference

Is a Body created by a list of particles. More...

#include <BodyParticle.h>

Inheritance diagram for BodyParticle:

Collaboration diagram for BodyParticle:

Public Member Functions
	BodyParticle ()
	Default constructor.
	~BodyParticle ()
	Default destruction.
virtual void	setMaterialId (int material_id)
	Configure the material id.
virtual int	getMaterialId () const
	Return the material identification.
void	setParticles (const vector< Particle * > &particle_list)
	Configure the particles in the body.
void	insertParticles (const vector< Particle * > &particle_list)
	Add particles to the current particle list.
vector< Particle * > *	getParticles ()
	Return the particles forming the body.
virtual void	create (Mesh &mesh, Material *material)
	Create a body in space using particles.
Public Member Functions inherited from Body
	Body ()
	Default constructor.
virtual	~Body ()
	Default destructor.
int	getId () const
	Return the body identification.
Vector3d	getInitialVelocity () const
	Return the initial velocity of the body.
vector< Particle * > *	getParticles ()
	Return the particles forming the body.
void	setId (int body_id)
	Configure the id of the body.
void	setInitialVelocity (Vector3d initial_velocity)
	Configure the initial velocity of the body.
void	setParticles (const vector< Particle * > &particle_list)
	Configure the particles in the body.
void	insertParticles (const vector< Particle * > &particle_list)
	Add particles to the current particle list.

Private Attributes
int	materialId
	material identification

Additional Inherited Members
Protected Attributes inherited from Body
int	id
	body identification
Vector3d	initial_velocity
	initial velocity of the body
vector< Particle * >	particles
	material points forming the body

Detailed Description

Is a Body created by a list of particles.

Introduction

This class allows to create a 3D body in the space by a list of particles.

Constructor & Destructor Documentation

BodyParticle()

BodyParticle::BodyParticle

(

)

Default constructor.

~BodyParticle()

BodyParticle::~BodyParticle

(

)

Default destruction.

Member Function Documentation

create()

virtual void BodyParticle::create ( Mesh & mesh, Material * material )

virtual

Create a body in space using particles.

Parameters

[in]	&mesh	Mesh reference
[in]	*material	Material pointer

Implements Body.

getMaterialId()

virtual int BodyParticle::getMaterialId ( ) const

inlinevirtual

Return the material identification.

Returns

Material identification

Implements Body.

getParticles()

vector< Particle * > * BodyParticle::getParticles ( )

inline

Return the particles forming the body.

Returns

A reference to a vector containing Particle pointers

insertParticles()

void BodyParticle::insertParticles ( const vector< Particle * > & particle_list )

inline

Add particles to the current particle list.

Parameters

[in]

particle_list

A vector containing pointers to particles

setMaterialId()

virtual void BodyParticle::setMaterialId ( int material_id )

inlinevirtual

Configure the material id.

Parameters

[in]

material_id

Material identification

Implements Body.

setParticles()

void BodyParticle::setParticles ( const vector< Particle * > & particle_list )

inline

Configure the particles in the body.

Parameters

[in]

particle_list

A vector containing pointers to the particle

Member Data Documentation

materialId

int BodyParticle::materialId

private

material identification

---

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

• BodyParticle.h