InteractiveImage is an event handler that computes the mouse coordinates in an images coordinate frame and then passes keyboard and mouse events to it. More...

Inheritance diagram for osgViewer::InteractiveImageHandler:

[legend]

Public Member Functions
	InteractiveImageHandler (osg::Image *image)
	Constructor to use when the InteractiveImage is in the 3D scene (i.e. not in a fullscreen HUD overlay). More...

	InteractiveImageHandler (osg::Image image, osg::Texture2D texture, osg::Camera *camera)
	Constructor to use when the InteractiveImage is in a fullscreen HUD overlay. More...

	META_Object (osgViewer, InteractiveImageHandler)

virtual bool	run (osg::Object object, osg::Object data)
	Invoke the callback, first parameter is the Object that the callback is attached to, the second parameter, the data, is typically the NodeVisitor that is invoking the callback. More...

virtual bool	handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa, osg::Object , osg::NodeVisitor nv)
	Handle events, return true if handled, false otherwise. More...

virtual bool	cull (osg::NodeVisitor nv, osg::Drawable drawable, osg::RenderInfo *renderInfo) const
	do customized cull code, return true if drawable should be culled. More...

Public Member Functions inherited from osgGA::GUIEventHandler
	GUIEventHandler ()

	GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

	META_Object (osgGA, GUIEventHandler)

virtual bool	handle (osgGA::Event event, osg::Object object, osg::NodeVisitor *nv)
	Handle event. More...

virtual bool	handle (const GUIEventAdapter &, GUIActionAdapter &)
	Deprecated, Handle events, return true if handled, false otherwise. More...

Public Member Functions inherited from osgGA::EventHandler
	EventHandler ()

	EventHandler (const EventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

	META_Object (osgGA, EventHandler)

virtual void	operator() (osg::Node node, osg::NodeVisitor nv)
	Event traversal node callback method. More...

virtual void	event (osg::NodeVisitor nv, osg::Drawable drawable)
	Event traversal drawable callback method. More...

virtual void	getUsage (osg::ApplicationUsage &) const
	Get the user interface usage of this event handler, i.e. More...

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

	NodeCallback (const NodeCallback &nc, const CopyOp &copyop)

	META_Object (osg, NodeCallback)

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

	Callback (const Callback &cb, const CopyOp &copyop)

	META_Object (osg, Callback)

bool	traverse (osg::Object object, osg::Object data)
	traverse the nested callbacks or call NodeVisitor::traverse() if the object is Node, and data is NodeVisitor. More...

void	setNestedCallback (osg::Callback *cb)

osg::Callback *	getNestedCallback ()

const osg::Callback *	getNestedCallback () const

void	addNestedCallback (osg::Callback *nc)

void	removeNestedCallback (osg::Callback *nc)

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

virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...

virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...

virtual bool	isSameKindAs (const Object *) const

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

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

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. 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 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	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. 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...

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

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

Public Member Functions inherited from osg::Drawable::EventCallback
	EventCallback ()

	EventCallback (const EventCallback &, const CopyOp &)

	META_Object (osg, EventCallback)

Public Member Functions inherited from osg::Drawable::CullCallback
	CullCallback ()

	CullCallback (const CullCallback &, const CopyOp &)

	META_Object (osg, CullCallback)

virtual bool	cull (osg::NodeVisitor , osg::Drawable , osg::State *) const
	deprecated. More...

Protected Member Functions
virtual	~InteractiveImageHandler ()

	InteractiveImageHandler ()

	InteractiveImageHandler (const InteractiveImageHandler &, const osg::CopyOp &=osg::CopyOp::SHALLOW_COPY)

bool	mousePosition (osgViewer::View view, osg::NodeVisitor nv, const osgGA::GUIEventAdapter &ea, int &x, int &y) const

void	resize (int width, int height)

Protected Member Functions inherited from osgGA::GUIEventHandler
virtual	~GUIEventHandler ()

Protected Member Functions inherited from osg::NodeCallback
virtual	~NodeCallback ()

Protected Member Functions inherited from osg::Callback
virtual	~Callback ()

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
osg::observer_ptr< osg::Image >	_image

osg::observer_ptr< osg::Texture2D >	_texture

bool	_fullscreen

osg::observer_ptr< osg::Camera >	_camera

Protected Attributes inherited from osg::Callback
ref_ptr< Callback >	_nestedCallback

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
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

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

InteractiveImage is an event handler that computes the mouse coordinates in an images coordinate frame and then passes keyboard and mouse events to it.

This event handler is useful for vnc or browser surfaces in the 3D scene.

Constructor & Destructor Documentation

osgViewer::InteractiveImageHandler::InteractiveImageHandler ( osg::Image * image )

Constructor to use when the InteractiveImage is in the 3D scene (i.e. not in a fullscreen HUD overlay).

osgViewer::InteractiveImageHandler::InteractiveImageHandler	(	osg::Image *	image,
		osg::Texture2D *	texture,
		osg::Camera *	camera
	)

Constructor to use when the InteractiveImage is in a fullscreen HUD overlay.

virtual osgViewer::InteractiveImageHandler::~InteractiveImageHandler ( )

inlineprotectedvirtual

osgViewer::InteractiveImageHandler::InteractiveImageHandler ( )

inlineprotected

osgViewer::InteractiveImageHandler::InteractiveImageHandler	(	const InteractiveImageHandler &	,
		const osg::CopyOp &	= `osg::CopyOp::SHALLOW_COPY`
	)

inlineprotected

Member Function Documentation

virtual bool osgViewer::InteractiveImageHandler::cull	(	osg::NodeVisitor *	nv,
		osg::Drawable *	drawable,
		osg::RenderInfo *	renderInfo
	)		const

virtual

do customized cull code, return true if drawable should be culled.

Reimplemented from osg::Drawable::CullCallback.

virtual bool osgViewer::InteractiveImageHandler::handle	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	aa,
		osg::Object *	,
		osg::NodeVisitor *
	)

virtual

Handle events, return true if handled, false otherwise.

Reimplemented from osgGA::GUIEventHandler.

osgViewer::InteractiveImageHandler::META_Object	(	osgViewer	,
		InteractiveImageHandler
	)

bool osgViewer::InteractiveImageHandler::mousePosition	(	osgViewer::View *	view,
		osg::NodeVisitor *	nv,
		const osgGA::GUIEventAdapter &	ea,
		int &	x,
		int &	y
	)		const

protected

void osgViewer::InteractiveImageHandler::resize	(	int	width,
		int	height
	)

protected

virtual bool osgViewer::InteractiveImageHandler::run	(	osg::Object *	object,
		osg::Object *	data
	)

inlinevirtual

Invoke the callback, first parameter is the Object that the callback is attached to, the second parameter, the data, is typically the NodeVisitor that is invoking the callback.

The run(..) method may be overriden by users directly, or if the user is using one of the old style callbacks such as NodeCallback or Drawable::UpdateCallback then you can just override the appropriate callback method on those callback subclasses. If you are implementing your own callback then one should call traverse() to make sure nested callbacks and visitor traversal() is completed.

Reimplemented from osg::Callback.

Member Data Documentation

osg::observer_ptr<osg::Camera> osgViewer::InteractiveImageHandler::_camera

protected

bool osgViewer::InteractiveImageHandler::_fullscreen

protected

osg::observer_ptr<osg::Image> osgViewer::InteractiveImageHandler::_image

protected

osg::observer_ptr<osg::Texture2D> osgViewer::InteractiveImageHandler::_texture

protected

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

osgViewer/ViewerEventHandlers

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation