osgSim::OverlayNode Class Reference
List of all members.
Detailed Description
OverlayNode is for creating texture overlays on scenes, with the overlay texture being generated by pre rendering an Overlay Subgraph to a texture, then projecting this resulting texture on the scene.
Member Typedef Documentation
Member Enumeration Documentation
- Enumerator:
OBJECT_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY |
|
VIEW_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY |
|
VIEW_DEPENDENT_WITH_PERSPECTIVE_OVERLAY |
|
Constructor & Destructor Documentation
osgSim::OverlayNode::OverlayNode |
( |
OverlayTechnique |
technique = OBJECT_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY |
) |
|
osgSim::OverlayNode::OverlayNode |
( |
const OverlayNode & |
es, |
|
|
const osg::CopyOp & |
copyop = osg::CopyOp::SHALLOW_COPY | |
|
) |
| | |
virtual osgSim::OverlayNode::~OverlayNode |
( |
|
) |
[inline, protected, virtual] |
Member Function Documentation
void osgSim::OverlayNode::dirtyOverlayTexture |
( |
|
) |
|
Inform the OverlayNode that the overlay texture needs to be updated.
bool osgSim::OverlayNode::getContinuousUpdate |
( |
|
) |
const [inline] |
Get whether the OverlayNode should update the overlay texture on every frame.
double osgSim::OverlayNode::getOverlayBaseHeight |
( |
|
) |
const [inline] |
Get the base height that the overlay subgraph will be projected down to.
const osg::Vec4& osgSim::OverlayNode::getOverlayClearColor |
( |
|
) |
const [inline] |
Get the clear color to use when rendering the overlay subgraph.
const osg::Node* osgSim::OverlayNode::getOverlaySubgraph |
( |
|
) |
const [inline] |
Get the const overlay subgraph which will be render to texture.
osg::Node* osgSim::OverlayNode::getOverlaySubgraph |
( |
|
) |
[inline] |
Get the overlay subgraph which will be rendered to texture.
unsigned int osgSim::OverlayNode::getOverlayTextureSizeHint |
( |
|
) |
const [inline] |
Get the texture size hint.
unsigned int osgSim::OverlayNode::getOverlayTextureUnit |
( |
|
) |
const [inline] |
Get the texture unit that the texture should be assigned to.
GLenum osgSim::OverlayNode::getTexEnvMode |
( |
|
) |
const [inline] |
Get the TexEnv mode used to combine the overlay texture with the base color/texture of the OverlayNode's decorate subgraph.
void osgSim::OverlayNode::init |
( |
|
) |
[protected] |
void osgSim::OverlayNode::init_OBJECT_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY |
( |
|
) |
[protected] |
void osgSim::OverlayNode::init_VIEW_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY |
( |
|
) |
[protected] |
void osgSim::OverlayNode::init_VIEW_DEPENDENT_WITH_PERSPECTIVE_OVERLAY |
( |
|
) |
[protected] |
osgSim::OverlayNode::META_Node |
( |
osgSim |
, |
|
|
OverlayNode |
| |
|
) |
| | |
virtual void osgSim::OverlayNode::releaseGLObjects |
( |
osg::State * |
= 0 |
) |
const [virtual] |
If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. Otherwise, releases OpenGL objexts for all graphics contexts.
Reimplemented from osg::Group.
virtual void osgSim::OverlayNode::resizeGLObjectBuffers |
( |
unsigned |
int |
) |
[virtual] |
Resize any per context GLObject buffers to specified size.
Reimplemented from osg::Group.
void osgSim::OverlayNode::setContinuousUpdate |
( |
bool |
update |
) |
[inline] |
Set whether the OverlayNode should update the overlay texture on every frame.
void osgSim::OverlayNode::setOverlayBaseHeight |
( |
double |
baseHeight |
) |
[inline] |
Set the base height that the overlay subgraph will be projected down to. Normally you'll set this to just below ground level, if you set it too high then the overlay texture can end up being clipped in certain viewing directions, while if its too low then there will be a limit to how close you can get to the terrain before pixaltion becomes an issue.
void osgSim::OverlayNode::setOverlayClearColor |
( |
const osg::Vec4 & |
color |
) |
[inline] |
Set the clear color to use when rendering the overlay subgraph.
void osgSim::OverlayNode::setOverlaySubgraph |
( |
osg::Node * |
node |
) |
|
Set the overlay subgraph which will be rendered to texture.
void osgSim::OverlayNode::setOverlayTextureSizeHint |
( |
unsigned int |
size |
) |
|
Set the texture size hint. The size hint is used to request a texture of specified size.
void osgSim::OverlayNode::setOverlayTextureUnit |
( |
unsigned int |
unit |
) |
|
Set the texture unit that the texture should be assigned to.
Set the implementation to be used when creating the overlay texture.
void osgSim::OverlayNode::setTexEnvMode |
( |
GLenum |
mode |
) |
|
Set the TexEnv mode used to combine the overlay texture with the base color/texture of the OverlayNode's decorate subgraph.
virtual void osgSim::OverlayNode::setThreadSafeRefUnref |
( |
bool |
threadSafe |
) |
[virtual] |
Traverse downwards : calls children's accept method with NodeVisitor.
Reimplemented from osg::Group.
void osgSim::OverlayNode::traverse_OBJECT_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY |
( |
osg::NodeVisitor & |
nv |
) |
[protected] |
void osgSim::OverlayNode::traverse_VIEW_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY |
( |
osg::NodeVisitor & |
nv |
) |
[protected] |
void osgSim::OverlayNode::traverse_VIEW_DEPENDENT_WITH_PERSPECTIVE_OVERLAY |
( |
osg::NodeVisitor & |
nv |
) |
[protected] |
void osgSim::OverlayNode::updateMainSubgraphStateSet |
( |
|
) |
[protected] |
Member Data Documentation
The documentation for this class was generated from the following file: