openscenegraph
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osgSim::OverlayNode Class Reference
Inheritance diagram for osgSim::OverlayNode:
osg::Group osg::Node osg::Object osg::Referenced

Classes

struct  OverlayData

Public Types

enum  OverlayTechnique { OBJECT_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY, VIEW_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY, VIEW_DEPENDENT_WITH_PERSPECTIVE_OVERLAY }

Public Member Functions

 OverlayNode (OverlayTechnique technique=OBJECT_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY)
 OverlayNode (const OverlayNode &es, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Node (osgSim, OverlayNode)
virtual void traverse (osg::NodeVisitor &nv)
void setOverlayTechnique (OverlayTechnique technique)
OverlayTechnique getOverlayTechnique () const
void setRenderTargetImplementation (osg::Camera::RenderTargetImplementation impl)
void setOverlaySubgraph (osg::Node *node)
osg::NodegetOverlaySubgraph ()
const osg::NodegetOverlaySubgraph () const
void dirtyOverlayTexture ()
void setContinuousUpdate (bool update)
bool getContinuousUpdate () const
void setOverlayBaseHeight (double baseHeight)
double getOverlayBaseHeight () const
void setOverlayClearColor (const osg::Vec4 &color)
const osg::Vec4getOverlayClearColor () const
void setTexEnvMode (GLenum mode)
GLenum getTexEnvMode () const
void setOverlayTextureUnit (unsigned int unit)
unsigned int getOverlayTextureUnit () const
void setOverlayTextureSizeHint (unsigned int size)
unsigned int getOverlayTextureSizeHint () const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int)
virtual void releaseGLObjects (osg::State *=0) const
- Public Member Functions inherited from osg::Group
 Group ()
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Group)
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual bool addChild (Node *child)
virtual bool insertChild (unsigned int index, Node *child)
bool removeChild (Node *child)
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
virtual bool replaceChild (Node *origChild, Node *newChild)
unsigned int getNumChildren () const
virtual bool setChild (unsigned int i, Node *node)
NodegetChild (unsigned int i)
const NodegetChild (unsigned int i) const
bool containsNode (const Node *node) const
unsigned int getChildIndex (const Node *node) const
virtual BoundingSphere computeBound () const
- Public Member Functions inherited from osg::Node
 Node ()
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual GeodeasGeode ()
virtual const GeodeasGeode () const
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
virtual void accept (NodeVisitor &nv)
virtual void ascend (NodeVisitor &nv)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
unsigned int getNumParents () const
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setUpdateCallback (NodeCallback *nc)
NodeCallbackgetUpdateCallback ()
const NodeCallbackgetUpdateCallback () const
void addUpdateCallback (NodeCallback *nc)
void removeUpdateCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (NodeCallback *nc)
NodeCallbackgetEventCallback ()
const NodeCallbackgetEventCallback () const
void addEventCallback (NodeCallback *nc)
void removeEventCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (NodeCallback *nc)
NodeCallbackgetCullCallback ()
const NodeCallbackgetCullCallback () const
void addCullCallback (NodeCallback *nc)
void removeCullCallback (NodeCallback *nc)
void setCullingActive (bool active)
bool getCullingActive () const
unsigned int getNumChildrenWithCullingDisabled () const
bool isCullingActive () const
unsigned int getNumChildrenWithOccluderNodes () const
bool containsOccluderNodes () const
void setNodeMask (NodeMask nm)
NodeMask getNodeMask () const
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () const
const std::string & getDescription (unsigned int i) const
std::string & getDescription (unsigned int i)
unsigned int getNumDescriptions () const
void addDescription (const std::string &desc)
void setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Protected Types

typedef osg::buffered_value< int > TextureObjectValidList
typedef std::map
< osgUtil::CullVisitor
*, osg::ref_ptr< OverlayData > > 
OverlayDataMap

Protected Member Functions

virtual ~OverlayNode ()
void init ()
void init_OBJECT_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY ()
void init_VIEW_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY ()
void init_VIEW_DEPENDENT_WITH_PERSPECTIVE_OVERLAY ()
void traverse_OBJECT_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY (osg::NodeVisitor &nv)
void traverse_VIEW_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY (osg::NodeVisitor &nv)
void traverse_VIEW_DEPENDENT_WITH_PERSPECTIVE_OVERLAY (osg::NodeVisitor &nv)
void updateMainSubgraphStateSet ()
OverlayNode::OverlayDatagetOverlayData (osgUtil::CullVisitor *cv)
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
virtual void childRemoved (unsigned int, unsigned int)
virtual void childInserted (unsigned int)
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
void addParent (osg::Group *node)
void removeParent (osg::Group *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
void setNumChildrenRequiringEventTraversal (unsigned int num)
void setNumChildrenWithCullingDisabled (unsigned int num)
void setNumChildrenWithOccluderNodes (unsigned int num)
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

TextureObjectValidList _textureObjectValidList
OverlayTechnique _overlayTechnique
osg::ref_ptr< osg::Node_overlaySubgraph
osg::ref_ptr< osg::StateSet_overlayStateSet
osg::ref_ptr< osg::StateSet_mainStateSet
GLenum _texEnvMode
unsigned int _textureUnit
unsigned int _textureSizeHint
osg::Vec4 _overlayClearColor
bool _continuousUpdate
double _overlayBaseHeight
bool _updateCamera
osg::Camera::RenderTargetImplementation _renderTargetImpl
OpenThreads::Mutex _overlayDataMapMutex
OverlayDataMap _overlayDataMap
- Protected Attributes inherited from osg::Group
NodeList _children
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
ref_ptr
< ComputeBoundingSphereCallback
_computeBoundCallback
BoundingSphere _boundingSphere
bool _boundingSphereComputed
ParentList _parents
ref_ptr< NodeCallback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< NodeCallback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< NodeCallback_cullCallback
bool _cullingActive
unsigned int _numChildrenWithCullingDisabled
unsigned int _numChildrenWithOccluderNodes
NodeMask _nodeMask
ref_ptr< StateSet_stateset
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()

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 ( )
inlineprotectedvirtual

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.

OverlayNode::OverlayData* osgSim::OverlayNode::getOverlayData ( osgUtil::CullVisitor cv)
protected
osg::Node* osgSim::OverlayNode::getOverlaySubgraph ( )
inline

Get the overlay subgraph which will be rendered to texture.

const osg::Node* osgSim::OverlayNode::getOverlaySubgraph ( ) const
inline

Get the const overlay subgraph which will be render to texture.

OverlayTechnique osgSim::OverlayNode::getOverlayTechnique ( ) const
inline
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::setOverlayTechnique ( OverlayTechnique  technique)
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.

void osgSim::OverlayNode::setRenderTargetImplementation ( osg::Camera::RenderTargetImplementation  impl)

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

Set whether to use a mutex to ensure ref() and unref() are thread safe.

Reimplemented from osg::Group.

virtual void osgSim::OverlayNode::traverse ( osg::NodeVisitor )
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

bool osgSim::OverlayNode::_continuousUpdate
protected
osg::ref_ptr<osg::StateSet> osgSim::OverlayNode::_mainStateSet
protected
double osgSim::OverlayNode::_overlayBaseHeight
protected
osg::Vec4 osgSim::OverlayNode::_overlayClearColor
protected
OverlayDataMap osgSim::OverlayNode::_overlayDataMap
protected
OpenThreads::Mutex osgSim::OverlayNode::_overlayDataMapMutex
protected
osg::ref_ptr<osg::StateSet> osgSim::OverlayNode::_overlayStateSet
protected
osg::ref_ptr<osg::Node> osgSim::OverlayNode::_overlaySubgraph
protected
OverlayTechnique osgSim::OverlayNode::_overlayTechnique
protected
osg::Camera::RenderTargetImplementation osgSim::OverlayNode::_renderTargetImpl
protected
GLenum osgSim::OverlayNode::_texEnvMode
protected
TextureObjectValidList osgSim::OverlayNode::_textureObjectValidList
mutableprotected
unsigned int osgSim::OverlayNode::_textureSizeHint
protected
unsigned int osgSim::OverlayNode::_textureUnit
protected
bool osgSim::OverlayNode::_updateCamera
protected

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