#include <OverlayNode.h>

Inheritance diagram for osgSim::OverlayNode:

Collaboration diagram for osgSim::OverlayNode:

Classes
struct	OverlayData

Public Types
enum	OverlayTechnique { OBJECT_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY, VIEW_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY, VIEW_DEPENDENT_WITH_PERSPECTIVE_OVERLAY }

Public Types inherited from osg::Node
typedef std::vector< Group * >	ParentList

typedef unsigned int	NodeMask

typedef std::vector< std::string >	DescriptionList

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

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::Node *	getOverlaySubgraph ()

const osg::Node *	getOverlaySubgraph () 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::Vec4 &	getOverlayClearColor () 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 Group *	asGroup ()

virtual const Group *	asGroup () const

virtual bool	addChild (Node *child)

virtual bool	insertChild (unsigned int index, Node *child)

virtual 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)

virtual unsigned int	getNumChildren () const

virtual bool	setChild (unsigned int i, Node *node)

Node *	getChild (unsigned int i)

const Node *	getChild (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 Object *	cloneType () const

virtual Object *	clone (const CopyOp &copyop) const

virtual bool	isSameKindAs (const Object *obj) const

virtual const char *	libraryName () const

virtual const char *	className () const

virtual Node *	asNode ()

virtual const Node *	asNode () const

virtual Drawable *	asDrawable ()

virtual const Drawable *	asDrawable () const

virtual Geometry *	asGeometry ()

virtual const Geometry *	asGeometry () const

virtual Transform *	asTransform ()

virtual const Transform *	asTransform () const

virtual Camera *	asCamera ()

virtual const Camera *	asCamera () const

virtual Switch *	asSwitch ()

virtual const Switch *	asSwitch () const

virtual Geode *	asGeode ()

virtual const Geode *	asGeode () const

virtual osgTerrain::Terrain *	asTerrain ()

virtual const osgTerrain::Terrain *	asTerrain () const

virtual void	accept (NodeVisitor &nv)

virtual void	ascend (NodeVisitor &nv)

const ParentList &	getParents () const

ParentList	getParents ()

Group *	getParent (unsigned int i)

const Group *	getParent (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 (Callback *nc)

Callback *	getUpdateCallback ()

const Callback *	getUpdateCallback () const

void	addUpdateCallback (Callback *nc)

void	removeUpdateCallback (Callback *nc)

unsigned int	getNumChildrenRequiringUpdateTraversal () const

void	setEventCallback (Callback *nc)

Callback *	getEventCallback ()

const Callback *	getEventCallback () const

void	addEventCallback (Callback *nc)

void	removeEventCallback (Callback *nc)

unsigned int	getNumChildrenRequiringEventTraversal () const

void	setCullCallback (Callback *nc)

Callback *	getCullCallback ()

const Callback *	getCullCallback () const

void	addCullCallback (Callback *nc)

void	removeCullCallback (Callback *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::StateSet *	getOrCreateStateSet ()

osg::StateSet *	getStateSet ()

const osg::StateSet *	getStateSet () const

void	setDescriptions (const DescriptionList &descriptions)

DescriptionList &	getDescriptions ()

const DescriptionList &	getDescriptions () 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 BoundingSphere &	getInitialBound () const

void	dirtyBound ()

const BoundingSphere &	getBound () const

void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)

ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()

const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const

Public Member Functions inherited from osg::Object
	Object ()

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

std::string	getCompoundClassName () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () const

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::UserDataContainer *	getUserDataContainer ()

const osg::UserDataContainer *	getUserDataContainer () const

osg::UserDataContainer *	getOrCreateUserDataContainer ()

virtual void	setUserData (Referenced *obj)

virtual Referenced *	getUserData ()

virtual const Referenced *	getUserData () 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)

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const

int	ref () const

int	unref () const

int	unref_nodelete () const

int	referenceCount () const

ObserverSet *	getObserverSet () const

ObserverSet *	getOrCreateObserverSet () 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::OverlayData *	getOverlayData (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 *parent)

void	removeParent (osg::Group *parent)

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< Callback >	_updateCallback

unsigned int	_numChildrenRequiringUpdateTraversal

ref_ptr< Callback >	_eventCallback

unsigned int	_numChildrenRequiringEventTraversal

ref_ptr< Callback >	_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::Mutex *	getGlobalReferencedMutex ()

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

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.

Definition at line 31 of file OverlayNode.h.

Member Typedef Documentation

typedef std::map<osgUtil::CullVisitor*, osg::ref_ptr<OverlayData> > osgSim::OverlayNode::OverlayDataMap

protected

Definition at line 184 of file OverlayNode.h.

typedef osg::buffered_value< int > osgSim::OverlayNode::TextureObjectValidList

protected

Definition at line 138 of file OverlayNode.h.

Member Enumeration Documentation

enum osgSim::OverlayNode::OverlayTechnique

Enumerator
OBJECT_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY
VIEW_DEPENDENT_WITH_ORTHOGRAPHIC_OVERLAY
VIEW_DEPENDENT_WITH_PERSPECTIVE_OVERLAY

Definition at line 35 of file OverlayNode.h.

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

Definition at line 124 of file OverlayNode.h.

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.

Definition at line 74 of file OverlayNode.h.

double osgSim::OverlayNode::getOverlayBaseHeight ( ) const

inline

Get the base height that the overlay subgraph will be projected down to.

Definition at line 84 of file OverlayNode.h.

const osg::Vec4& osgSim::OverlayNode::getOverlayClearColor ( ) const

inline

Get the clear color to use when rendering the overlay subgraph.

Definition at line 90 of file OverlayNode.h.

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.

Definition at line 61 of file OverlayNode.h.

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

inline

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

Definition at line 64 of file OverlayNode.h.

OverlayTechnique osgSim::OverlayNode::getOverlayTechnique ( ) const

inline

Definition at line 52 of file OverlayNode.h.

unsigned int osgSim::OverlayNode::getOverlayTextureSizeHint ( ) const

inline

Get the texture size hint.

Definition at line 108 of file OverlayNode.h.

unsigned int osgSim::OverlayNode::getOverlayTextureUnit ( ) const

inline

Get the texture unit that the texture should be assigned to.

Definition at line 102 of file OverlayNode.h.

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.

Definition at line 96 of file OverlayNode.h.

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.

Definition at line 71 of file OverlayNode.h.

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.

Definition at line 81 of file OverlayNode.h.

void osgSim::OverlayNode::setOverlayClearColor ( const osg::Vec4 & color )

inline

Set the clear color to use when rendering the overlay subgraph.

Definition at line 87 of file OverlayNode.h.

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

Definition at line 157 of file OverlayNode.h.

osg::ref_ptr<osg::StateSet> osgSim::OverlayNode::_mainStateSet

protected

Definition at line 149 of file OverlayNode.h.

double osgSim::OverlayNode::_overlayBaseHeight

protected

Definition at line 158 of file OverlayNode.h.

osg::Vec4 osgSim::OverlayNode::_overlayClearColor

protected

Definition at line 155 of file OverlayNode.h.

OverlayDataMap osgSim::OverlayNode::_overlayDataMap

protected

Definition at line 187 of file OverlayNode.h.

OpenThreads::Mutex osgSim::OverlayNode::_overlayDataMapMutex

protected

Definition at line 186 of file OverlayNode.h.

osg::ref_ptr<osg::StateSet> osgSim::OverlayNode::_overlayStateSet

protected

Definition at line 148 of file OverlayNode.h.

osg::ref_ptr<osg::Node> osgSim::OverlayNode::_overlaySubgraph

protected

Definition at line 146 of file OverlayNode.h.

OverlayTechnique osgSim::OverlayNode::_overlayTechnique

protected

Definition at line 142 of file OverlayNode.h.

osg::Camera::RenderTargetImplementation osgSim::OverlayNode::_renderTargetImpl

protected

Definition at line 161 of file OverlayNode.h.

GLenum osgSim::OverlayNode::_texEnvMode

protected

Definition at line 152 of file OverlayNode.h.

TextureObjectValidList osgSim::OverlayNode::_textureObjectValidList

mutableprotected

Definition at line 140 of file OverlayNode.h.

unsigned int osgSim::OverlayNode::_textureSizeHint

protected

Definition at line 154 of file OverlayNode.h.

unsigned int osgSim::OverlayNode::_textureUnit

protected

Definition at line 153 of file OverlayNode.h.

bool osgSim::OverlayNode::_updateCamera

protected

Definition at line 159 of file OverlayNode.h.

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

osg_head/include/osgSim/OverlayNode.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation