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

Class used to specify the light source information for POV-Ray images. More...

Inheritance diagram for povray.LightSource:

Public Member Functions

 LightSource ()
 Constructor to create a light source and initialise the location and colour vector properties. More...
 
void setLocation (double x, double y, double z)
 Set the location of this light source in the image. More...
 
void setColor (float r, float g, float b)
 Sets the value of this vector property to reflect a colour, specified in red, green, and blue values. More...
 
String toString ()
 Represents the information about the lightsource as a string. More...
 

Detailed Description

Class used to specify the light source information for POV-Ray images.

Class used to specify the light source information for POV-Ray images

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

Constructor to create a light source and initialise the location and colour vector properties.

Constructor to create a light source and initialise the location and colour vector properties

Member Function Documentation

void povray.LightSource.setColor ( float  r,
float  g,
float  b 
)

Sets the value of this vector property to reflect a colour, specified in red, green, and blue values.

Sets the value of this vector property to reflect a colour, specified in red, green, and blue values

Parameters
rThe amount of red in the colour required
gThe amount of green in the colour required
bThe amount of blue in the colour required
void povray.LightSource.setLocation ( double  x,
double  y,
double  z 
)

Set the location of this light source in the image.

Set the location of this light source in the image

Parameters
xDouble value X coordinate
yDouble value Y coordinate
zDouble value Z coordinate
String povray.LightSource.toString ( )

Represents the information about the lightsource as a string.

Represents the information about the lightsource as a string

Returns
String value summarising the information stored about this lightsource

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