Version 1.2 (June 2013)
 All Classes Namespaces Files Functions Variables Pages
Protected Member Functions | List of all members
povray.Biofilm3D Class Reference

Creates a union with a box (the biofilm carrier) and spheres (the bacteria), creating a 3D scene for the PovRay rendering engine. More...

Inheritance diagram for povray.Biofilm3D:

Protected Member Functions

 Biofilm3D (Povray3DScene pov)
 Create a Biofilm3D scene from a specified POV-Ray 3D scene and initialise the output. More...
 
 Biofilm3D (Povray3DScene pov, int n)
 Create a Biofilm3D scene from a specified POV-Ray 3D scene and initialise the output and the array of cells to include. More...
 
void addCell (float x, float y, float z, float rad, int r, int g, int b)
 Add a new cell to the POV-Ray 3D output. More...
 
void toFile (FileWriter f) throws IOException
 Writes the cell positions to the POV-Ray file output stream. More...
 
void modelStateToFile (FileWriter f) throws IOException
 Writes the current cells position in model to the POV-Ray file output stream by not using the _cells array, which is too memory consuming. More...
 
void biofilmHeaderToFile (FileWriter f) throws IOException
 Writes the union open and the carrier to file. More...
 
void biofilmFooterToFile (FileWriter f) throws IOException
 Writes the union translations and rotations to the POV-Ray file stream and closes the file. More...
 
void particlesToFile (FileWriter f) throws IOException
 Write the particles only to the POV-Ray file output stream. More...
 

Detailed Description

Creates a union with a box (the biofilm carrier) and spheres (the bacteria), creating a 3D scene for the PovRay rendering engine.

Creates a union with a box (the biofilm carrier) and spheres (the bacteria), creating a 3D scene for the PovRay rendering engine

Author
João Xavier (xavie.nosp@m.rj@m.nosp@m.skcc..nosp@m.org), Memorial Sloan-Kettering Cancer Center (NY, USA)
Laurent Lardon (lardo.nosp@m.nl@s.nosp@m.upagr.nosp@m.o.in.nosp@m.ra.fr), INRA, France

Constructor & Destructor Documentation

povray.Biofilm3D.Biofilm3D ( Povray3DScene  pov)
protected

Create a Biofilm3D scene from a specified POV-Ray 3D scene and initialise the output.

Create a Biofilm3D scene from a specified POV-Ray 3D scene and initialise the output

Parameters
povA specific POV-Ray 3D scene to generate
povray.Biofilm3D.Biofilm3D ( Povray3DScene  pov,
int  n 
)
protected

Create a Biofilm3D scene from a specified POV-Ray 3D scene and initialise the output and the array of cells to include.

Create a Biofilm3D scene from a specified POV-Ray 3D scene and initialise the output and the array of cells to include

Parameters
povA specific POV-Ray 3D scene to generate
nThe number of cells that will be included in this scene

Member Function Documentation

void povray.Biofilm3D.addCell ( float  x,
float  y,
float  z,
float  rad,
int  r,
int  g,
int  b 
)
protected

Add a new cell to the POV-Ray 3D output.

Add a new cell to the POV-Ray 3D output

Parameters
xX coordinate of the cell to add
yY coordinate of the cell to add
zZ coordinate of the cell to add
radRadius of the cell to add
rAmount of red colour to use in creating the colour of this cell
gAmount of green colour to use in creating the colour of this cell
bAmount of blue colour to use in creating the colour of this cell
void povray.Biofilm3D.biofilmFooterToFile ( FileWriter  f) throws IOException
protected

Writes the union translations and rotations to the POV-Ray file stream and closes the file.

Writes the union translations and rotations to the POV-Ray file stream and closes the file

Parameters
fPOV-Ray output file stream to be written to
Exceptions
IOExceptionException that is thrown if there are problems with this output stream
void povray.Biofilm3D.biofilmHeaderToFile ( FileWriter  f) throws IOException
protected

Writes the union open and the carrier to file.

Writes the union open and the carrier to file

Parameters
fPOV-Ray output file stream to be written to
Exceptions
IOExceptionException that is thrown if there are problems with this output stream
void povray.Biofilm3D.modelStateToFile ( FileWriter  f) throws IOException
protected

Writes the current cells position in model to the POV-Ray file output stream by not using the _cells array, which is too memory consuming.

Writes the current cells position in model to the POV-Ray file output stream by not using the _cells array, which is too memory consuming

Parameters
fPOV-Ray output file stream to be written to
Exceptions
IOExceptionException that is thrown if there are problems with this output stream
void povray.Biofilm3D.particlesToFile ( FileWriter  f) throws IOException
protected

Write the particles only to the POV-Ray file output stream.

Write the particles only to the POV-Ray file output stream

Parameters
fPOV-Ray output file stream to be written to
Exceptions
IOExceptionException that is thrown if there are problems with this output stream
void povray.Biofilm3D.toFile ( FileWriter  f) throws IOException
protected

Writes the cell positions to the POV-Ray file output stream.

Writes the cell positions to the POV-Ray file output stream

Parameters
fPOV-Ray output file stream to be written to
Exceptions
IOExceptionException that is thrown if there are problems with this output stream

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