version 3.3

VRS::PlanarMirror Class Reference

#include <vrs/planarmirror.h>

Inheritance diagram for VRS::PlanarMirror:

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

List of all members.

Public Member Functions

 PlanarMirror (Facet *facet, double quality=0.5, const Color &background=Color::black, bool clip=true)
FacetgetFacet () const
 Gets the mirroring Facet.
void setFacet (Facet *facet)
 Sets the mirroring Facet.
bool getClip () const
 Gets the current clip setting.
void setClip (bool)
 Sets the clip setting.
 VRS_TYPEINFO (PlanarMirror, Mirror)
 VRS_SERIALIZABLE (PlanarMirror)

Protected Member Functions

 PlanarMirror ()


Detailed Description

Mirror attribute indicating mirroring property of Facet. A PlanarMirror attribute indicates that the given Facet mirrors other shapes which are tagged by the Mirrored Attribute constructed with this Mirror. Be careful that the Facet is oriented correctly (in VRS this means counterclockwise for the outer loop) for correct rendering by the MirrorTechniqueGL.

Constructor & Destructor Documentation

VRS::PlanarMirror::PlanarMirror ( Facet facet,
double  quality = 0.5,
const Color background = Color::black,
bool  clip = true 
)

Facet sets the facet which mirrors. The facet must be contained as a separate shape in the scene graph with the PlanarMirror attribute active to be mirroring.

Quality indicates the brightness of the mirrored image and must be between 0 and 1. background inducates the color of the reflected background area. clip indicates whether objects behind the mirror should be clipped away. The default value true always yields correct images, but with the setting false, the mirror might be rendered faster

VRS::PlanarMirror::PlanarMirror (  )  [protected]


Member Function Documentation

Facet* VRS::PlanarMirror::getFacet (  )  const

Gets the mirroring Facet.

void VRS::PlanarMirror::setFacet ( Facet facet  ) 

Sets the mirroring Facet.

bool VRS::PlanarMirror::getClip (  )  const

Gets the current clip setting.

void VRS::PlanarMirror::setClip ( bool   ) 

Sets the clip setting.

VRS::PlanarMirror::VRS_TYPEINFO ( PlanarMirror  ,
Mirror   
)

VRS::PlanarMirror::VRS_SERIALIZABLE ( PlanarMirror   ) 


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

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