version 3.3

VRS::CubeEnvMirror Class Reference

#include <vrs/cubeenvmirror.h>

Inheritance diagram for VRS::CubeEnvMirror:

VRS::Mirror VRS::MonoAttribute VRS::Attribute VRS::RenderObj VRS::SharedObj VRS::Visitable

List of all members.

Public Types

enum  ReflectionType { Normal, Reflection }
enum  CalculationMode { CM_Dynamic, CM_CheckModified, CM_Static }

Public Member Functions

 VRS_SERIALIZABLE_CLASS_ENUM (ReflectionType)
 VRS_SERIALIZABLE_CLASS_ENUM (CalculationMode)
 CubeEnvMirror (double quality=0.5, const Color &background=Color::black, ReflectionType=CubeEnvMirror::Normal, Bumpmap *=0, CalculationMode=CubeEnvMirror::CM_Dynamic)
ReflectionType getReflection () const
 Returns the reflection type.
void setReflection (ReflectionType)
 Sets the reflection type, see getReflection.
BumpmapgetBumpmap () const
 Returns the Bumpmap (can return NULL!).
void setBumpmap (Bumpmap *)
void setCalculationMode (CalculationMode)
CalculationMode getCalculationMode () const
void modifiedCallback (SharedObj *)
 VRS_TYPEINFO (CubeEnvMirror, Mirror)
 VRS_SERIALIZABLE (CubeEnvMirror)


Detailed Description

A CubeEnvMirror attribute enables that shapes mirror other shapes that are tagged with a Mirrored Attribute. It is also possible to disturb the direction of reflection using a bumpmap.

Member Enumeration Documentation

Enumerator:
Normal 
Reflection 

Enumerator:
CM_Dynamic 
CM_CheckModified 
CM_Static 


Constructor & Destructor Documentation

VRS::CubeEnvMirror::CubeEnvMirror ( double  quality = 0.5,
const Color background = Color::black,
ReflectionType  = CubeEnvMirror::Normal,
Bumpmap = 0,
CalculationMode  = CubeEnvMirror::CM_Dynamic 
)

Quality indicates the brightness of the mirrored image and must be between 0 and 1. background indicates the color of the reflected background area. It is allowed to specify NULL as Bumpmap, in case the direction of reflection is not disturbed.


Member Function Documentation

VRS::CubeEnvMirror::VRS_SERIALIZABLE_CLASS_ENUM ( ReflectionType   ) 

VRS::CubeEnvMirror::VRS_SERIALIZABLE_CLASS_ENUM ( CalculationMode   ) 

ReflectionType VRS::CubeEnvMirror::getReflection (  )  const

Returns the reflection type.

The ReflectionType switches whether the normal vector or the view vector reflected on the normal are chosen as reflection direction.

void VRS::CubeEnvMirror::setReflection ( ReflectionType   ) 

Sets the reflection type, see getReflection.

Bumpmap* VRS::CubeEnvMirror::getBumpmap (  )  const

Returns the Bumpmap (can return NULL!).

void VRS::CubeEnvMirror::setBumpmap ( Bumpmap  ) 

Sets the Bumpmap to specify how the direction of reflection is disturbed. May be zero, in this case no disturbation occurs.

void VRS::CubeEnvMirror::setCalculationMode ( CalculationMode   ) 

Sets the setting for recalculation of the cube map.

CalculationMode VRS::CubeEnvMirror::getCalculationMode (  )  const

Returns the setting for recalculation of the cube map.

void VRS::CubeEnvMirror::modifiedCallback ( SharedObj  ) 

For easy binding of a modified-callback to a CubeEnvMirror object.

VRS::CubeEnvMirror::VRS_TYPEINFO ( CubeEnvMirror  ,
Mirror   
)

VRS::CubeEnvMirror::VRS_SERIALIZABLE ( CubeEnvMirror   ) 


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

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