EnvironmentRenderer::PolygonSetWaterSurface Class Reference
This class takes a list of PolygonSets and calculates an average plane for each entry. More...
#include <vrs/environment/polygonsetwatersurface.h>
Inheritance diagram for EnvironmentRenderer::PolygonSetWaterSurface:
Public Member Functions | |
| PolygonSetWaterSurface (VRS::SO< VRS::Iterator< VRS::SO< VRS::PolygonSet > > > surface, const VRS::Vector &flowDirection, const VRS::Color &waterColor=VRS::Color::slate_blue, float fresnelBias=0.0f, const VertexData2f &reflectionScale=VertexData2f(0.2f, 0.2f), const VertexData2f &refractionScale=VertexData2f(0.2f, 0.2f), double junctionSize=0.0, bool refracting=false, const VRS::Matrix &waveTf=VRS::Matrix::identity) | |
| virtual VRS::Bounds | boundingBox () const |
| see shape.h | |
| double | getAverageDeviation () const |
| returns the surface's average deviation from the calculated plane. | |
| void | setPolygonSetSurface (VRS::SO< VRS::Iterator< VRS::SO< VRS::PolygonSet > > > surface) |
| VRS::SO< VRS::Iterator < VRS::SO< VRS::PolygonSet > > > | getPolygonSetSurface () const |
| VRS_TYPEINFO (PolygonSetWaterSurface, EnvironmentRenderer::WaterSurface) | |
| VRS_SERIALIZABLE (PolygonSetWaterSurface) | |
Detailed Description
This class takes a list of PolygonSets and calculates an average plane for each entry.The individual PolygonSets are assumed to be planar, as non-planar surfaces cannot be displayed by the implemented technique. However, if the PolygonSets are not planar they are still rendered, but artifacts may occur. for a description of the parameters see watersurface.h
Constructor & Destructor Documentation
| EnvironmentRenderer::PolygonSetWaterSurface::PolygonSetWaterSurface | ( | VRS::SO< VRS::Iterator< VRS::SO< VRS::PolygonSet > > > | surface, | |
| const VRS::Vector & | flowDirection, | |||
| const VRS::Color & | waterColor = VRS::Color::slate_blue, |
|||
| float | fresnelBias = 0.0f, |
|||
| const VertexData2f & | reflectionScale = VertexData2f(0.2f, 0.2f), |
|||
| const VertexData2f & | refractionScale = VertexData2f(0.2f, 0.2f), |
|||
| double | junctionSize = 0.0, |
|||
| bool | refracting = false, |
|||
| const VRS::Matrix & | waveTf = VRS::Matrix::identity | |||
| ) |
Member Function Documentation
| virtual VRS::Bounds EnvironmentRenderer::PolygonSetWaterSurface::boundingBox | ( | ) | const [inline, virtual] |
| double EnvironmentRenderer::PolygonSetWaterSurface::getAverageDeviation | ( | ) | const [inline] |
returns the surface's average deviation from the calculated plane.
This can be used to estimate the degree of artifacts. the greater the deviation, the stronger the artifacts.
| void EnvironmentRenderer::PolygonSetWaterSurface::setPolygonSetSurface | ( | VRS::SO< VRS::Iterator< VRS::SO< VRS::PolygonSet > > > | surface | ) |
| VRS::SO<VRS::Iterator<VRS::SO<VRS::PolygonSet> > > EnvironmentRenderer::PolygonSetWaterSurface::getPolygonSetSurface | ( | ) | const [inline] |
| EnvironmentRenderer::PolygonSetWaterSurface::VRS_TYPEINFO | ( | PolygonSetWaterSurface | , | |
| EnvironmentRenderer::WaterSurface | ||||
| ) |
| EnvironmentRenderer::PolygonSetWaterSurface::VRS_SERIALIZABLE | ( | PolygonSetWaterSurface | ) |
The documentation for this class was generated from the following file: