BALL  1.4.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Classes | Public Member Functions | Protected Attributes
BALL::VIEW::Stage Class Reference

#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 398 of file stage.h.


Constructor & Destructor Documentation

Default Constructor

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

Copy constructor.

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

Destructor.

Definition at line 432 of file stage.h.


Member Function Documentation

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

Add a light source.

Calculate absolute room coordinates from relative coordinates.

See also:
calculateRelativeCoordinates

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.

Shows coordinate system.

Definition at line 489 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:
soutput stream
depththe dumping depth

Definition at line 541 of file stage.h.

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

Get the background color.

Definition at line 469 of file stage.h.

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

Get the camera.

Definition at line 456 of file stage.h.

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

Get the camera (const)

Definition at line 460 of file stage.h.

Definition at line 533 of file stage.h.

Get the eye distance for the stereo view.

Definition at line 497 of file stage.h.

Get the focal distance for the stereo view.

Definition at line 505 of file stage.h.

Definition at line 517 of file stage.h.

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

Get the background color.

Definition at line 477 of file stage.h.

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

Get the light sources (const)

Definition at line 443 of file stage.h.

Gives access to the default material parameters.

Definition at line 589 of file stage.h.

Gives access to the default material parameters, const version.

Definition at line 592 of file stage.h.

Definition at line 549 of file stage.h.

Definition at line 525 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.

Definition at line 545 of file stage.h.

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

Set the background color.

Definition at line 473 of file stage.h.

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

Set the camera of the stage

Definition at line 465 of file stage.h.

Definition at line 537 of file stage.h.

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

Set the eye distance for the stereo view.

Definition at line 493 of file stage.h.

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

Set the focal distance for the stereo view.

Definition at line 501 of file stage.h.

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

Definition at line 521 of file stage.h.

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

Set the background color.

Definition at line 481 of file stage.h.

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

Definition at line 553 of file stage.h.

Definition at line 529 of file stage.h.

Settings for side by side stereo side swapping.

Definition at line 509 of file stage.h.

Show coordinate system.

Definition at line 485 of file stage.h.

Get settings for side by side stereo side swapping.

Definition at line 513 of file stage.h.


Member Data Documentation

Definition at line 625 of file stage.h.

Definition at line 597 of file stage.h.

Definition at line 606 of file stage.h.

Definition at line 624 of file stage.h.

Definition at line 615 of file stage.h.

Definition at line 618 of file stage.h.

Definition at line 612 of file stage.h.

Definition at line 600 of file stage.h.

Definition at line 603 of file stage.h.

Definition at line 629 of file stage.h.

Definition at line 626 of file stage.h.

Definition at line 609 of file stage.h.

Definition at line 623 of file stage.h.

Definition at line 621 of file stage.h.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines