BodyCuboid Class Reference

A type of Body representing a cuboid in 3D. More...

#include <BodyCuboid.h>

Inheritance diagram for BodyCuboid:

Collaboration diagram for BodyCuboid:

Public Member Functions
	BodyCuboid ()
	Default constructor.
virtual	~BodyCuboid ()
	Default constructor.
void	setPoints (const Vector3d &point_1, const Vector3d &point_2)
	Configure the geometrical points of the cuboid.
virtual void	setMaterialId (int material_id)
	Configure the material id.
virtual int	getMaterialId () const
	Return the material identification.
virtual void	create (Mesh &mesh, Material *material)
	Create a cuboid in space.
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
Vector3d	pointP1
	lower left point
Vector3d	pointP2
	higher right point
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

A type of Body representing a cuboid in 3D.

Cuboid definition

The cuboid is geometrically defined by the coordinates of the lower-left point (Point 1) and the upper-right point (Point 2). See figure below.

*                              Cuboid
*                           ----------
*                          |\         |\
*                          | \        | \
*    z                     |  \       |  \
*    |                     |     -------- +  <-- Point 2
*    |                     |   |      |   |
*    +---- y   Point 1 --> + --|------    |
*     \                     \  |       \  |
*      \                     \ |        \ |
*       x                     \|         \|
*                               ----------
* 

Constructor & Destructor Documentation

BodyCuboid()

BodyCuboid::BodyCuboid ( )

inline

Default constructor.

~BodyCuboid()

BodyCuboid::~BodyCuboid ( )

inlinevirtual

Default constructor.

Member Function Documentation

create()

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

virtual

Create a cuboid in space.

Parameters

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

Implements Body.

getMaterialId()

virtual int BodyCuboid::getMaterialId ( ) const

inlinevirtual

Return the material identification.

Returns

Material identification

Implements Body.

setMaterialId()

virtual void BodyCuboid::setMaterialId ( int material_id )

inlinevirtual

Configure the material id.

Parameters

[in]

material_id

Material identification

Implements Body.

setPoints()

void BodyCuboid::setPoints ( const Vector3d & point_1, const Vector3d & point_2 )

inline

Configure the geometrical points of the cuboid.

Parameters

[in]	point_1	Lower left geometrical point of the cuboid
[in]	point_2	Higher right geometrical point of the cuboid

Member Data Documentation

materialId

int BodyCuboid::materialId

private

material identification

pointP1

Vector3d BodyCuboid::pointP1

private

lower left point

pointP2

Vector3d BodyCuboid::pointP2

private

higher right point

---

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

• BodyCuboid.h