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

Used by Povray3DScene to create a capsule object in a format that can be displayed graphically in POV-Ray output. More...

Inheritance diagram for povray.ParticleWithCapsule:

Public Member Functions

 ParticleWithCapsule ()
 Constructor that initialises this storage object, creating the required center and colour vector properties. More...
 
 ParticleWithCapsule (LocatedAgent p)
 Constructor that initialises this storage object with a specific LocatedAgent, creating the required center and colour vector properties. More...
 
void setColorCore (Color c)
 Set the colour to be used for the core of this agent from the colour specified. More...
 
void setColorCapsule (Color c)
 Set the colour to be used for the capsule of this agent from the colour specified. More...
 
void setNameCore (String theName)
 Set the name of the core being represented to that specified. More...
 
void setNameCapsule (String theName)
 Set the name of the capsule being represented to that specified. More...
 
void setActiveFrac (double activeFrac)
 Set the fraction of this agent that is active biomass. More...
 
void setCenter (ContinuousVector c)
 Set the centre of the output agent to a transformation of the current agent location. More...
 
void setCoreRadius (double fs)
 Set the radius of the output agent to a transformation of the current agent radius. More...
 
String toString ()
 Represents the information about this particle with capsule as a string. More...
 

Detailed Description

Used by Povray3DScene to create a capsule object in a format that can be displayed graphically in POV-Ray output.

Used by Povray3DScene to create a capsule object in a format that can be displayed graphically in POV-Ray output

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.ParticleWithCapsule.ParticleWithCapsule ( )

Constructor that initialises this storage object, creating the required center and colour vector properties.

Constructor that initialises this storage object, creating the required center and colour vector properties

povray.ParticleWithCapsule.ParticleWithCapsule ( LocatedAgent  p)

Constructor that initialises this storage object with a specific LocatedAgent, creating the required center and colour vector properties.

Constructor that initialises this storage object with a specific LocatedAgent, creating the required center and colour vector properties

Member Function Documentation

void povray.ParticleWithCapsule.setActiveFrac ( double  activeFrac)

Set the fraction of this agent that is active biomass.

Set the fraction of this agent that is active biomass

Parameters
activeFracThe percentage of this agent that is active biomass
void povray.ParticleWithCapsule.setCenter ( ContinuousVector  c)

Set the centre of the output agent to a transformation of the current agent location.

Set the centre of the output agent to a transformation of the current agent location

Parameters
cThe current location of the located agent, expressed as a vector
void povray.ParticleWithCapsule.setColorCapsule ( Color  c)

Set the colour to be used for the capsule of this agent from the colour specified.

Set the colour to be used for the capsule of this agent from the colour specified

Parameters
cColour to be used to represent the capsule of this agent
void povray.ParticleWithCapsule.setColorCore ( Color  c)

Set the colour to be used for the core of this agent from the colour specified.

Set the colour to be used for the core of this agent from the colour specified

Parameters
cColour to be used to represent the core of this agent
void povray.ParticleWithCapsule.setCoreRadius ( double  fs)

Set the radius of the output agent to a transformation of the current agent radius.

Set the radius of the output agent to a transformation of the current agent radius

Parameters
fsThe current radius of the located agent
void povray.ParticleWithCapsule.setNameCapsule ( String  theName)

Set the name of the capsule being represented to that specified.

Set the name of the capsule being represented to that specified

Parameters
theNameString that should be set as the name of the capsule
void povray.ParticleWithCapsule.setNameCore ( String  theName)

Set the name of the core being represented to that specified.

Set the name of the core being represented to that specified

Parameters
theNameString that should be set as the name of the core
String povray.ParticleWithCapsule.toString ( )

Represents the information about this particle with capsule as a string.

Represents the information about particle with capsule as a string

Returns
String value summarising the information stored about this particle with capsule

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