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

Class used to set the properties of the box used in POV-Ray output. More...

Inheritance diagram for povray.Box:

Public Member Functions

 Box ()
 Constructor to set the coordinates and colour of this box. More...
 
void setColor (float r, float g, float b)
 Set the colour that will be used to represent this box. More...
 
void setCorner1 (double x, double y, double z)
 Set the coordinates of the first corner of this box. More...
 
void setCorner2 (double x, double y, double z)
 Set the coordinates of the second corner of this box. More...
 
String toString ()
 Summarise the characteristics of this box as a string. More...
 

Detailed Description

Class used to set the properties of the box used in POV-Ray output.

Class used to set the properties of the box used in POV-Ray output

Constructor & Destructor Documentation

povray.Box.Box ( )

Constructor to set the coordinates and colour of this box.

Constructor to set the coordinates and colour of this box

Member Function Documentation

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

Set the colour that will be used to represent this box.

Set the colour that will be used to represent this box

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.Box.setCorner1 ( double  x,
double  y,
double  z 
)

Set the coordinates of the first corner of this box.

Set the coordinates of the first corner this box

Parameters
xDouble value X coordinate
yDouble value Y coordinate
zDouble value Z coordinate
void povray.Box.setCorner2 ( double  x,
double  y,
double  z 
)

Set the coordinates of the second corner of this box.

Set the coordinates of the second corner this box

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

Summarise the characteristics of this box as a string.

Summarise the characteristics of this box as a string

Returns
String value containing all the attributes of this box

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