EnvironmentRenderer::WaterReflected Class Reference
The attribute WaterReflected allows for specification of scene parts to be reflected in certain WaterSurfaces. More...
#include <vrs/environment/waterreflected.h>
Public Member Functions | |
| WaterReflected (VRS::SO< WaterSurface > relatedSurface, bool renderOnlyReflection=false) | |
| Each WaterReflected attribute refers to a certain WaterSurface, in which the affected shapes are to be reflected. | |
| VRS::SO< WaterSurface > | getRelatedSurface () const |
| The related surface may be NULL. In this case, the attribute has no effect. | |
| void | setRelatedSurface (VRS::SO< WaterSurface > relatedSurface) |
| bool | getRenderOnlyReflection () const |
| void | setRenderOnlyReflection (bool yesNo) |
| VRS_TYPEINFO (WaterReflected, VRS::PolyAttribute) | |
| VRS_SERIALIZABLE (WaterReflected) | |
Detailed Description
The attribute WaterReflected allows for specification of scene parts to be reflected in certain WaterSurfaces.A clear restriction of scene parts is useful to increase rendering performance.
Note: WaterReflected-attributes require a WaterSurfaceTechniqueGL to be in the scene graph. Without, they are ignored.
Constructor & Destructor Documentation
| EnvironmentRenderer::WaterReflected::WaterReflected | ( | VRS::SO< WaterSurface > | relatedSurface, | |
| bool | renderOnlyReflection = false | |||
| ) |
Each WaterReflected attribute refers to a certain WaterSurface, in which the affected shapes are to be reflected.
It is specified via 'relatedSurface' If 'renderOnlyReflection' is enabled, all affected shapes are considered exclusively for the reflection pass. Otherwise, they are also rendered as part of the scene. This flag is important for complex shapes that should not be rendered completely for the reflection pass, e.g., a large 3D city model. Setting 'renderOnlyReflection' to true allows for using a simpler partial shape representation for those shape parts that are near the water surface.
Member Function Documentation
| VRS::SO<WaterSurface> EnvironmentRenderer::WaterReflected::getRelatedSurface | ( | ) | const |
The related surface may be NULL. In this case, the attribute has no effect.
| void EnvironmentRenderer::WaterReflected::setRelatedSurface | ( | VRS::SO< WaterSurface > | relatedSurface | ) |
| bool EnvironmentRenderer::WaterReflected::getRenderOnlyReflection | ( | ) | const |
| void EnvironmentRenderer::WaterReflected::setRenderOnlyReflection | ( | bool | yesNo | ) |
| EnvironmentRenderer::WaterReflected::VRS_TYPEINFO | ( | WaterReflected | , | |
| VRS::PolyAttribute | ||||
| ) |
| EnvironmentRenderer::WaterReflected::VRS_SERIALIZABLE | ( | WaterReflected | ) |
The documentation for this class was generated from the following file: