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

#include <BALL/VIEW/KERNEL/stage.h>

List of all members.


Classes

class  RaytracingMaterial

Public Member Functions

virtual void dump (std::ostream &s=std::cout, Size depth=0) const
RaytracingMaterialgetRTMaterial ()
 

Gives access to the default material parameters.


const RaytracingMaterialgetRTMaterial () const
 

Gives access to the default material parameters, const version.


Constructors and Destructors
 Stage ()
 Stage (const Stage &stage)
 

Copy constructor.


virtual ~Stage ()
 

Destructor.


virtual void clear ()
 

Explicit default initialization.


Accessors
virtual const std::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 CameragetCamera ()
 

Get the camera.


virtual const CameragetCamera () const
 

Get the camera (const).


virtual void setCamera (const Camera &camera)
virtual const ColorRGBAgetBackgroundColor () const
 

Get the background color.


virtual void setBackgroundColor (const ColorRGBA &color)
 

Set the background color.


virtual const ColorRGBAgetInfoColor () 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
Vector3 calculateAbsoluteCoordinates (Vector3 pos) const

Protected Attributes

ColorRGBA background_color_
ColorRGBA info_color_
std::list< LightSourcelight_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.

Definition at line 399 of file stage.h.


Constructor & Destructor Documentation

BALL::VIEW::Stage::Stage (  ) 

Default Constructor

BALL::VIEW::Stage::Stage ( const Stage stage  ) 

Copy constructor.

virtual BALL::VIEW::Stage::~Stage (  )  [inline, virtual]

Destructor.

Definition at line 433 of file stage.h.


Member Function Documentation

virtual void BALL::VIEW::Stage::addLightSource ( const LightSource light_source  )  [virtual]

Add a light source.

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::clear (  )  [virtual]

Explicit default initialization.

void BALL::VIEW::Stage::clearLightSources (  ) 
bool BALL::VIEW::Stage::coordinateSystemEnabled (  )  const [inline]

Shows coordinate system.

Definition at line 490 of file stage.h.

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
float BALL::VIEW::Stage::getAmbientIntensity (  )  const [inline]

Definition at line 542 of file stage.h.

virtual const ColorRGBA& BALL::VIEW::Stage::getBackgroundColor (  )  const [inline, virtual]

Get the background color.

Definition at line 470 of file stage.h.

virtual const Camera& BALL::VIEW::Stage::getCamera (  )  const [inline, virtual]

Get the camera (const).

Definition at line 461 of file stage.h.

virtual Camera& BALL::VIEW::Stage::getCamera (  )  [inline, virtual]

Get the camera.

Definition at line 457 of file stage.h.

float BALL::VIEW::Stage::getDiffuseIntensity (  )  const [inline]

Definition at line 534 of file stage.h.

float BALL::VIEW::Stage::getEyeDistance (  )  const [inline]

Get the eye distance for the stereo view.

Definition at line 498 of file stage.h.

float BALL::VIEW::Stage::getFocalDistance (  )  const [inline]

Get the focal distance for the stereo view.

Definition at line 506 of file stage.h.

float BALL::VIEW::Stage::getFogIntensity (  )  const [inline]

Definition at line 518 of file stage.h.

virtual const ColorRGBA& BALL::VIEW::Stage::getInfoColor (  )  const [inline, virtual]

Get the background color.

Definition at line 478 of file stage.h.

virtual const std::list<LightSource>& BALL::VIEW::Stage::getLightSources (  )  const [inline, virtual]

Get the light sources (const).

Definition at line 444 of file stage.h.

const RaytracingMaterial& BALL::VIEW::Stage::getRTMaterial (  )  const [inline]

Gives access to the default material parameters, const version.

Definition at line 593 of file stage.h.

RaytracingMaterial& BALL::VIEW::Stage::getRTMaterial (  )  [inline]

Gives access to the default material parameters.

Definition at line 590 of file stage.h.

float BALL::VIEW::Stage::getShininess (  )  const [inline]

Definition at line 550 of file stage.h.

float BALL::VIEW::Stage::getSpecularIntensity (  )  const [inline]

Definition at line 526 of file stage.h.

bool BALL::VIEW::Stage::operator== ( const Stage stage  )  const
virtual void BALL::VIEW::Stage::removeLightSource ( const LightSource light_source  )  [virtual]

Remove a light source.

void BALL::VIEW::Stage::setAmbientIntensity ( float  value  )  [inline]

Definition at line 546 of file stage.h.

virtual void BALL::VIEW::Stage::setBackgroundColor ( const ColorRGBA color  )  [inline, virtual]

Set the background color.

Definition at line 474 of file stage.h.

virtual void BALL::VIEW::Stage::setCamera ( const Camera camera  )  [inline, virtual]

Set the camera of the stage

Definition at line 466 of file stage.h.

void BALL::VIEW::Stage::setDiffuseIntensity ( float  value  )  [inline]

Definition at line 538 of file stage.h.

void BALL::VIEW::Stage::setEyeDistance ( float  value  )  [inline]

Set the eye distance for the stereo view.

Definition at line 494 of file stage.h.

void BALL::VIEW::Stage::setFocalDistance ( float  value  )  [inline]

Set the focal distance for the stereo view.

Definition at line 502 of file stage.h.

void BALL::VIEW::Stage::setFogIntensity ( float  value  )  [inline]

Definition at line 522 of file stage.h.

virtual void BALL::VIEW::Stage::setInfoColor ( const ColorRGBA color  )  [inline, virtual]

Set the background color.

Definition at line 482 of file stage.h.

void BALL::VIEW::Stage::setShininess ( float  value  )  [inline]

Definition at line 554 of file stage.h.

void BALL::VIEW::Stage::setSpecularIntensity ( float  value  )  [inline]

Definition at line 530 of file stage.h.

void BALL::VIEW::Stage::setSwapSideBySideStereo ( bool  state  )  [inline]

Settings for side by side stereo side swapping.

Definition at line 510 of file stage.h.

void BALL::VIEW::Stage::showCoordinateSystem ( bool  state  )  [inline]

Show coordinate system.

Definition at line 486 of file stage.h.

bool BALL::VIEW::Stage::swapSideBySideStereo (  )  const [inline]

Get settings for side by side stereo side swapping.

Definition at line 514 of file stage.h.


Member Data Documentation

Definition at line 626 of file stage.h.

Definition at line 598 of file stage.h.

Definition at line 607 of file stage.h.

Definition at line 625 of file stage.h.

Definition at line 616 of file stage.h.

Definition at line 619 of file stage.h.

Definition at line 613 of file stage.h.

Definition at line 601 of file stage.h.

Definition at line 604 of file stage.h.

Definition at line 630 of file stage.h.

Definition at line 627 of file stage.h.

Definition at line 610 of file stage.h.

Definition at line 624 of file stage.h.

Definition at line 622 of file stage.h.


Generated on Tue Dec 7 19:13:11 2010 for BALL by  doxygen 1.5.9