BALL::VIEW::Stage Class Reference
[Setup of the Stage, Camera and LightSources]

A Stage has a Camera, LightSources and a background color. More...

#include <stage.h>

List of all members.


Classes

class RaytracingMaterial
This class holds all material parameters passed on to a raytracer. More...

Public Member Functions

virtual void dump (std::ostream &s=std::cout, Size depth=0) const
Internal value dump.
RaytracingMaterial & getRTMaterial ()
Gives access to the default material parameters.
const RaytracingMaterial & getRTMaterial () const
Gives access to the default material parameters, const version.
Constructors and Destructors
Stage ()
Default Constructor.
Stage (const Stage &stage)
Copy constructor.
virtual ~Stage ()
Destructor.
virtual void clear ()
Explicit default initialization.
Accessors
virtual const List< LightSource > & getLightSources () const
Get the light sources (const).
virtual void addLightSource (const LightSource &light_source)
Add a light source.
virtual void removeLightSource (const LightSource &light_source)
Remove a light source.
void clearLightSources ()
virtual Camera & getCamera ()
Get the camera.
virtual const Camera & getCamera () const
Get the camera (const).
virtual void setCamera (const Camera &camera)
Set the camera of the stage.
virtual const ColorRGBA & getBackgroundColor () const
Get the background color.
virtual void setBackgroundColor (const ColorRGBA &color)
Set the background color.
virtual const ColorRGBA & getInfoColor () const
Get the background color.
virtual void setInfoColor (const ColorRGBA &color)
Set the background color.
void showCoordinateSystem (bool state)
Show coordinate system.
bool coordinateSystemEnabled () const
Shows coordinate system.
void setEyeDistance (float value)
Set the eye distance for the stereo view.
float getEyeDistance () const
Get the eye distance for the stereo view.
void setFocalDistance (float value)
Set the focal distance for the stereo view.
float getFocalDistance () const
Get the focal distance for the stereo view.
void setSwapSideBySideStereo (bool state)
Settings for side by side stereo side swapping.
bool swapSideBySideStereo () const
Get settings for side by side stereo side swapping.
float getFogIntensity () const
void setFogIntensity (float value)
float getSpecularIntensity () const
void setSpecularIntensity (float value)
float getDiffuseIntensity () const
void setDiffuseIntensity (float value)
float getAmbientIntensity () const
void setAmbientIntensity (float value)
float getShininess () const
void setShininess (float value)
Predicates
bool operator== (const Stage &stage) const
Vector3 calculateRelativeCoordinates (Vector3 pos) const
Calculate coordiantes relative to the position of the camera in units of right_vector, look_up_vector and view_vector.
Vector3 calculateAbsoluteCoordinates (Vector3 pos) const
Calculate absolute room coordinates from relative coordinates.

Protected Attributes

ColorRGBA background_color_
ColorRGBA info_color_
List< LightSource > light_sources_
Camera camera_
bool show_coordinate_system_
float fog_intensity_
float eye_distance_
float focal_distance_
bool swap_side_by_side_stereo_
float specular_
float diffuse_
float ambient_
float shininess_
RaytracingMaterial rt_material_

Detailed Description

A Stage has a Camera, LightSources and a background color.

It stores also the eye distance for the stereo view. Finally a flag can be set, so that a coordinate system will be shown.


Member Function Documentation

Vector3 BALL::VIEW::Stage::calculateAbsoluteCoordinates ( Vector3 pos ) const

Calculate absolute room coordinates from relative coordinates.

See also:
calculateRelativeCoordinates

Vector3 BALL::VIEW::Stage::calculateRelativeCoordinates ( Vector3 pos ) const

Calculate coordiantes relative to the position of the camera in units of right_vector, look_up_vector and view_vector.

This is done by calculating the normals to three planes, spaned by these three vectors. This method is e.g. used to store the coordinates of the relative light sources in the INIFile, or in the LightSettings dialog.

Returns:
Vector3(times right_vector, times look_up_vector, times view_vector)

virtual void BALL::VIEW::Stage::dump ( std::ostream & s = std::cout,
Size depth = 0
) const [virtual]

Internal value dump.

Dump the current state of this instance to the output ostream s with dumping depth depth.

Parameters:
s output stream
depth the dumping depth

Generated on Thu Aug 6 18:30:56 2009 for BALL by doxygen 1.5.8