version 3.3

VRS::Mirror Class Reference

#include <vrs/mirror.h>

Inheritance diagram for VRS::Mirror:

VRS::MonoAttribute VRS::Attribute VRS::RenderObj VRS::SharedObj VRS::Visitable VRS::CubeEnvMirror VRS::PlanarMirror

List of all members.

Public Member Functions

virtual ID category () const
void setQuality (double)
double getQuality () const
 Gets the quality of the mirrored image.
void setBackground (const Color &)
const ColorgetBackground () const
 Gets the background color of the reflected background.
 VRS_TYPEINFO (Mirror, MonoAttribute)
 VRS_SERIALIZABLE (Mirror)

Protected Member Functions

 Mirror (double quality=0.5, const Color &background=Color::black)


Detailed Description

Mirror attribute indicating mirroring property of shapes (abstract) A Mirror attribute is an abstract attribute that indicates the ability of a shape to reflect other shapes tagged by the Mirrored Attribute constructed with the Mirror.

Concrete implementations of a Mirror class (with a public constructor) are PlanarMirror (for planar reflections) and CubeEnvMirror (for environment reflections).


Constructor & Destructor Documentation

VRS::Mirror::Mirror ( double  quality = 0.5,
const Color background = Color::black 
) [protected]


Member Function Documentation

virtual ID VRS::Mirror::category (  )  const [virtual]

All mirror objects of derived light classes are managed uniformly as Mirror objects by the engine.

Reimplemented from VRS::Attribute.

void VRS::Mirror::setQuality ( double   ) 

Quality sets the brightness of the mirrored image and must be between 0 and 1.

double VRS::Mirror::getQuality (  )  const

Gets the quality of the mirrored image.

void VRS::Mirror::setBackground ( const Color  ) 

Sets the brightness of the reflected background (where no mirrored geometry is visible). This is modulated by the quality, also.

const Color& VRS::Mirror::getBackground (  )  const

Gets the background color of the reflected background.

VRS::Mirror::VRS_TYPEINFO ( Mirror  ,
MonoAttribute   
)

VRS::Mirror::VRS_SERIALIZABLE ( Mirror   ) 


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

Generated on Tue May 22 06:00:22 2012 by Doxygen 1.5.6
© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact