Create a POV-Ray 3D scene object for use in visualising 3D Biofilms (with class Biofilm3D) More...

Inheritance diagram for povray.Povray3DScene:

Public Member Functions
	Povray3DScene (Simulator aSim, String domainName)
	Constructor that initialises the POV-Ray scene, setting the domain to be represented and the rendering scale that will be used. More...

void	writeModelStateFull (String fileName) throws IOException
	Write the complete model state to a file (including camera, lights and boxes) More...

File[]	writePovrayIncFiles (String dir) throws IOException
	Write the include files. For use with writeModelState. More...

File	writeModelState (String fileName) throws IOException
	Write the present state using include files for camera, background lights and solid surface. More...

void	setTopPerspective ()
	Make top perspective. More...

void	setSidePerspective ()
	Make side perspective. More...

void	setAnglePerspective ()
	Make angle perspective. More...

void	addCell (float x, float y, float z, float rad, int r, int g, int b)
	Add a cell to the biofilm, to be used with scenes constructed using the Povray3DScene(float x, float y, float z, int n) constructor. More...

Static Public Member Functions
static double	getScaling ()
	Return the scaling factor applied to points in this output. More...

Public Attributes
Simulator	mySim

Protected Member Functions
double	getX ()
	Get the scaled X value used to scale other X coordinates. More...

double	getY ()
	Get the scaled Y value used to scale other Y coordinates. More...

double	getZ ()
	Get the scaled Z value used to scale other Z coordinates. More...

Detailed Description

Create a POV-Ray 3D scene object for use in visualising 3D Biofilms (with class Biofilm3D)

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.Povray3DScene.Povray3DScene	(	Simulator	aSim,
		String	domainName
	)

Constructor that initialises the POV-Ray scene, setting the domain to be represented and the rendering scale that will be used.

Constructor that initialises the POV-Ray scene, setting the domain to be represented and the rendering scale that will be used

Parameters

aSim	The simulation object used to simulate the conditions specified in the protocol file
domainName	The name of the computation domain to be rendered

Member Function Documentation

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

Add a cell to the biofilm, to be used with scenes constructed using the Povray3DScene(float x, float y, float z, int n) constructor.

Add a cell to the biofilm, to be used with scenes constructed using the Povray3DScene(float x, float y, float z, int n) constructor

Parameters

x	X coordinate of the cell to add
y	Y coordinate of the cell to add
z	Z coordinate of the cell to add
rad	Radius of the cell to add
r	Amount of red colour to use in creating the colour of this cell
g	Amount of green colour to use in creating the colour of this cell
b	Amount of blue colour to use in creating the colour of this cell

static double povray.Povray3DScene.getScaling ( )

static

Return the scaling factor applied to points in this output.

Return the scaling factor applied to points in this output

Returns: Calculated scaling value

double povray.Povray3DScene.getX ( )

protected

Get the scaled X value used to scale other X coordinates.

Get the scaled X value used to scale other X coordinates

Returns: Scaled X value

double povray.Povray3DScene.getY ( )

protected

Get the scaled Y value used to scale other Y coordinates.

Get the scaled Y value used to scale other Y coordinates

Returns: Scaled Y value

double povray.Povray3DScene.getZ ( )

protected

Get the scaled Z value used to scale other Z coordinates.

Get the scaled Z value used to scale other Z coordinates

Returns: Scaled Z value

void povray.Povray3DScene.setAnglePerspective ( )

Make angle perspective.

Make angle perspective

void povray.Povray3DScene.setSidePerspective ( )

Make side perspective.

Make side perspective

void povray.Povray3DScene.setTopPerspective ( )

Make top perspective.

Make top perspective

File povray.Povray3DScene.writeModelState ( String fileName ) throws IOException

Write the present state using include files for camera, background lights and solid surface.

Write the present state using include files for camera, background lights and solid surface. Using this method instead of writeModelStateFull, which includes the full scene information in each .pov file created at an iteration, allows changing scene properties after the simulation

Parameters

fileName Filename of the POV-Ray file to be written

Returns: the POV-Ray file containing the model state

Exceptions

IOException Exception thrown should this file not be able to be accessed

void povray.Povray3DScene.writeModelStateFull ( String fileName ) throws IOException

Write the complete model state to a file (including camera, lights and boxes)

Parameters

fileName File name of the POV-Ray file being written

Exceptions

IOException Exception thrown if the file output stream cannot be opened

File [] povray.Povray3DScene.writePovrayIncFiles ( String dir ) throws IOException

Write the include files. For use with writeModelState.

Write the include files. For use with writeModelState

Parameters

dir	Results directory to write the include file to

Exceptions

IOException Exception thrown if the file output stream cannot be opened

Member Data Documentation

Simulator povray.Povray3DScene.mySim

Current simulator object through which the result has been formed

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

/home/kieran/Dropbox/workspace/iDynoMiCS/src/povray/Povray3DScene.java

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation