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. More...

Inheritance diagram for osgSim::OverlayNode:

[legend]

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
	A vector of osg::Group pointers which is used to store the parent(s) of node. More...

typedef unsigned int	NodeMask
	This is a set of bits (flags) that represent the Node. More...

typedef std::vector< std::string >	DescriptionList
	A vector of std::string's which are used to describe the object. More...

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)
	Traverse downwards : calls children's accept method with NodeVisitor. More...

void	setOverlayTechnique (OverlayTechnique technique)

OverlayTechnique	getOverlayTechnique () const

void	setRenderTargetImplementation (osg::Camera::RenderTargetImplementation impl)
	Set the implementation to be used when creating the overlay texture. More...

void	setOverlaySubgraph (osg::Node *node)
	Set the overlay subgraph which will be rendered to texture. More...

template<class T >
void	setOverlaySubgraph (const osg::ref_ptr< T > &node)

osg::Node *	getOverlaySubgraph ()
	Get the overlay subgraph which will be rendered to texture. More...

const osg::Node *	getOverlaySubgraph () const
	Get the const overlay subgraph which will be render to texture. More...

void	dirtyOverlayTexture ()
	Inform the OverlayNode that the overlay texture needs to be updated. More...

void	setContinuousUpdate (bool update)
	Set whether the OverlayNode should update the overlay texture on every frame. More...

bool	getContinuousUpdate () const
	Get whether the OverlayNode should update the overlay texture on every frame. More...

void	setOverlayBaseHeight (double baseHeight)
	Set the base height that the overlay subgraph will be projected down to. More...

double	getOverlayBaseHeight () const
	Get the base height that the overlay subgraph will be projected down to. More...

void	setOverlayClearColor (const osg::Vec4 &color)
	Set the clear color to use when rendering the overlay subgraph. More...

const osg::Vec4 &	getOverlayClearColor () const
	Get the clear color to use when rendering the overlay subgraph. More...

void	setTexEnvMode (GLenum mode)
	Set the TexEnv mode used to combine the overlay texture with the base color/texture of the OverlayNode's decorate subgraph. More...

GLenum	getTexEnvMode () const
	Get the TexEnv mode used to combine the overlay texture with the base color/texture of the OverlayNode's decorate subgraph. More...

void	setOverlayTextureUnit (unsigned int unit)
	Set the texture unit that the texture should be assigned to. More...

unsigned int	getOverlayTextureUnit () const
	Get the texture unit that the texture should be assigned to. More...

void	setOverlayTextureSizeHint (unsigned int size)
	Set the texture size hint. More...

unsigned int	getOverlayTextureSizeHint () const
	Get the texture size hint. More...

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...

virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...

virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...

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

	Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

	META_Node (osg, Group)

virtual Group *	asGroup ()
	convert 'this' into a Group pointer if Node is a Group, otherwise return 0. More...

virtual const Group *	asGroup () const
	convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. More...

virtual bool	addChild (Node *child)
	Add Node to Group. More...

template<class T >
bool	addChild (const ref_ptr< T > &child)

virtual bool	insertChild (unsigned int index, Node *child)
	Insert Node to Group at specific location. More...

template<class T >
bool	insertChild (unsigned int index, const ref_ptr< T > &child)

virtual bool	removeChild (Node *child)
	Remove Node from Group. More...

template<class T >
bool	removeChild (const ref_ptr< T > &child)

bool	removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
	Remove Node from Group. More...

virtual bool	removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
	Remove children from Group. More...

virtual bool	replaceChild (Node origChild, Node newChild)
	Replace specified child Node with another Node. More...

template<class T , class R >
bool	replaceChild (const ref_ptr< T > &origChild, const ref_ptr< R > &newChild)

virtual unsigned int	getNumChildren () const
	Return the number of children nodes. More...

virtual bool	setChild (unsigned int i, Node *node)
	Set child node at position i. More...

Node *	getChild (unsigned int i)
	Return child node at position i. More...

const Node *	getChild (unsigned int i) const
	Return child node at position i. More...

bool	containsNode (const Node *node) const
	Return true if node is contained within Group. More...

template<class T >
bool	conatainsNode (const ref_ptr< T > &node) const

unsigned int	getChildIndex (const Node *node) const
	Get the index number of child, return a value between 0 and _children.size()-1 if found, if not found then return _children.size(). More...

virtual BoundingSphere	computeBound () const
	Compute the bounding sphere around Node's geometry or children. More...

Public Member Functions inherited from osg::Node
	Node ()
	Construct a node. More...

	Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

virtual Object *	cloneType () const
	clone an object of the same type as the node. More...

virtual Object *	clone (const CopyOp &copyop) const
	return a clone of a node, with Object* return type. More...

virtual bool	isSameKindAs (const Object *obj) const
	return true if this and obj are of the same kind of object. More...

virtual const char *	libraryName () const
	return the name of the node's library. More...

virtual const char *	className () const
	return the name of the node's class type. More...

virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual Drawable *	asDrawable ()
	convert 'this' into a Drawable pointer if Node is a Drawable, otherwise return 0. More...

virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Node is a Drawable, otherwise return 0. More...

virtual Geometry *	asGeometry ()
	convert 'this' into a Geometry pointer if Node is a Geometry, otherwise return 0. More...

virtual const Geometry *	asGeometry () const
	convert 'const this' into a const Geometry pointer if Node is a Geometry, otherwise return 0. More...

virtual Transform *	asTransform ()
	Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. More...

virtual const Transform *	asTransform () const
	convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0. More...

virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...

virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...

virtual Switch *	asSwitch ()
	Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0. More...

virtual const Switch *	asSwitch () const
	convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0. More...

virtual Geode *	asGeode ()
	Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0. More...

virtual const Geode *	asGeode () const
	convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0. More...

virtual osgTerrain::Terrain *	asTerrain ()
	Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0. More...

virtual const osgTerrain::Terrain *	asTerrain () const
	convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0. More...

virtual void	accept (NodeVisitor &nv)
	Visitor Pattern : calls the apply method of a NodeVisitor with this node's type. More...

virtual void	ascend (NodeVisitor &nv)
	Traverse upwards : calls parents' accept method with NodeVisitor. More...

const ParentList &	getParents () const
	Get the parent list of node. More...

ParentList	getParents ()
	Get the a copy of parent list of node. More...

Group *	getParent (unsigned int i)

const Group *	getParent (unsigned int i) const
	Get a single const parent of node. More...

unsigned int	getNumParents () const
	Get the number of parents of node. More...

NodePathList	getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
	Get the list of node paths parent paths. More...

MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
	Get the list of matrices that transform this node from local coordinates to world coordinates. More...

void	setUpdateCallback (Callback *nc)
	Set update node callback, called during update traversal. More...

template<class T >
void	setUpdateCallback (const ref_ptr< T > &nc)

Callback *	getUpdateCallback ()
	Get update node callback, called during update traversal. More...

const Callback *	getUpdateCallback () const
	Get const update node callback, called during update traversal. More...

void	addUpdateCallback (Callback *nc)
	Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one. More...

template<class T >
void	addUpdateCallback (const ref_ptr< T > &nc)

void	removeUpdateCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

template<class T >
void	removeUpdateCallback (const ref_ptr< T > &nc)

unsigned int	getNumChildrenRequiringUpdateTraversal () const
	Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children. More...

void	setEventCallback (Callback *nc)
	Set event node callback, called during event traversal. More...

template<class T >
void	setEventCallback (const ref_ptr< T > &nc)

Callback *	getEventCallback ()
	Get event node callback, called during event traversal. More...

const Callback *	getEventCallback () const
	Get const event node callback, called during event traversal. More...

void	addEventCallback (Callback *nc)
	Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one. More...

template<class T >
void	addEventCallback (const ref_ptr< T > &nc)

void	removeEventCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

template<class T >
void	removeEventCallback (const ref_ptr< T > &nc)

unsigned int	getNumChildrenRequiringEventTraversal () const
	Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children. More...

void	setCullCallback (Callback *nc)
	Set cull node callback, called during cull traversal. More...

template<class T >
void	setCullCallback (const ref_ptr< T > &nc)

Callback *	getCullCallback ()
	Get cull node callback, called during cull traversal. More...

const Callback *	getCullCallback () const
	Get const cull node callback, called during cull traversal. More...

void	addCullCallback (Callback *nc)
	Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one. More...

template<class T >
void	addCullCallback (const ref_ptr< T > &nc)

void	removeCullCallback (Callback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

template<class T >
void	removeCullCallback (const ref_ptr< T > &nc)

void	setCullingActive (bool active)
	Set the view frustum/small feature culling of this node to be active or inactive. More...

bool	getCullingActive () const
	Get the view frustum/small feature _cullingActive flag for this node. More...

unsigned int	getNumChildrenWithCullingDisabled () const
	Get the number of Children of this node which have culling disabled. More...

bool	isCullingActive () const
	Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal. More...

unsigned int	getNumChildrenWithOccluderNodes () const
	Get the number of Children of this node which are or have OccluderNode's. More...

bool	containsOccluderNodes () const
	return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes. More...

void	setNodeMask (NodeMask nm)
	Set the node mask. More...

NodeMask	getNodeMask () const
	Get the node Mask. More...

void	setStateSet (osg::StateSet *stateset)
	Set the node's StateSet. More...

template<class T >
void	setStateSet (const osg::ref_ptr< T > &stateset)

osg::StateSet *	getOrCreateStateSet ()
	return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet. More...

osg::StateSet *	getStateSet ()
	Return the node's StateSet. More...

const osg::StateSet *	getStateSet () const
	Return the node's const StateSet. More...

void	setDescriptions (const DescriptionList &descriptions)
	Set the list of string descriptions. More...

DescriptionList &	getDescriptions ()
	Get the description list of the node. More...

const DescriptionList &	getDescriptions () const
	Get the const description list of the const node. More...

const std::string &	getDescription (unsigned int i) const
	Get a single const description of the const node. More...

std::string &	getDescription (unsigned int i)
	Get a single description of the node. More...

unsigned int	getNumDescriptions () const
	Get the number of descriptions of the node. More...

void	addDescription (const std::string &desc)
	Add a description string to the node. More...

void	setInitialBound (const osg::BoundingSphere &bsphere)
	Set the initial bounding volume to use when computing the overall bounding volume. More...

const BoundingSphere &	getInitialBound () const
	Set the initial bounding volume to use when computing the overall bounding volume. More...

void	dirtyBound ()
	Mark this node's bounding sphere dirty. More...

const BoundingSphere &	getBound () const

void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
	Set the compute bound callback to override the default computeBound. More...

template<class T >
void	setComputeBoundingSphereCallback (const ref_ptr< T > &callback)

ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()
	Get the compute bound callback. More...

const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const
	Get the const compute bound callback. More...

Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...

void	setName (const char *name)
	Set the name of object using a C style string. More...

const std::string &	getName () const
	Get the name of object. More...

void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...

DataVariance	getDataVariance () const
	Get the data variance of this object. More...

virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...

void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...

template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)

osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...

virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...

template<class T >
void	setUserData (const ref_ptr< T > &ud)

virtual Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () const
	Get const user data. More...

template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...

template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...

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

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

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...

int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	referenceCount () const
	Return the number of pointers currently referencing this object. More...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...

void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...

void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

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 ()
	Node destructor. More...

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 ()
	Object destructor. More...

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 ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

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

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

protected

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

protected

Member Enumeration Documentation

enum osgSim::OverlayNode::OverlayTechnique

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.

template<class T >

void osgSim::OverlayNode::setOverlaySubgraph ( const osg::ref_ptr< T > & node )

inline

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:

osgSim/OverlayNode

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