SoGradientBackground Class Reference
[Backgrounds]
Gradient background node. More...
#include <Inventor/nodes/SoGradientBackground.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoGradientBackground () | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Public Attributes | |
| SoSFColor | color0 |
| SoSFColor | color1 |
| SoSFBool | swapColors |
Detailed Description
Gradient background node.
Draws a color gradient background.
This node provides a convenient way of drawing a color gradient background for a scene. The first color (color0) appears at the bottom of the window and the second color (color1) appears at the top of the window. Rendering of the gradient is automatically recalculated if the window size changes.
Generally background nodes should be placed at the beginning of the scene graph so that geometry is drawn on top of the background. Background nodes have no size, are not pickable, and do not modify the OpenGL depth buffer.
Another convenient feature is that this node renders correctly on a tiled display that represents a single large virtual window, for example using the MultiPipe extension (see SoXtMPExaminerViewer). The gradient will be interpolated smoothly across the entire virtual window.
FILE FORMAT/DEFAULT
- GradientBackground {
| color0 | 0.7 0.7 0.8 |
| color1 | 0.0 0.1 0.3 |
| swapColors | FALSE |
ACTION BEHAVIOR
- SoGLRenderAction
Renders background, does not affect state.
SEE ALSO
SoBackground, SoImageBackground
- See related examples:
Constructor & Destructor Documentation
| SoGradientBackground::SoGradientBackground | ( | ) |
Creates a background gradient node with default settings.
Member Function Documentation
| static SoType SoGradientBackground::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoBackground.
| virtual SoType SoGradientBackground::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoBackground.
Member Data Documentation
First color in gradient (0.7 0.7 0.8 by default).
This color appears at the bottom of the window (unless the swapColors field is TRUE).
Second color in gradient (0.0 0.1 0.3 by default).
This color appears at the top of the window (unless the swapColors field is TRUE).
Reverse colors (default is FALSE).
The documentation for this class was generated from the following file:
- Inventor/nodes/SoGradientBackground.h