The interface of a Visualization3DSite. More...

#include <visualization/Visualization3D.h>

Inheritance diagram for IVisualization3DSite:

[legend]

Classes
class	Camera

Public Member Functions
virtual	~IVisualization3DSite ()

virtual Ogre::SceneManager *	getSceneManager ()=0

virtual void	registerInteractionListener (InteractionListener3D *listener)=0

virtual void	removeInteractionListener (InteractionListener3D *listener)=0

virtual std::set< InteractionListener3D * >	getInteractionListeners ()=0

virtual const Camera &	getCamera () const =0
	Obtains the current camera settings (position, orientation, etc.) of the views own camera. More...

virtual void	setCamera (const Camera &camera)=0
	Sets the current camera settings (position, orientation, etc.) of the views own camera. More...

virtual Ogre::Camera *	acquireCamera (boost::function< void()> lostCameraCallback=boost::function< void()>())=0
	Requests the camera of the visualization site. More...

virtual void	releaseCamera ()=0
	Releases a camera that previously was acquired. More...

virtual const std::string &	getFixedFrame () const =0

virtual const std::string &	getCameraFrame () const =0

Detailed Description

The interface of a Visualization3DSite.

A Visualization3DSite is the host or rather the container for visualizations. The IVisualization3DSite interface is e.g. implemented by the Visualization3DView. The Visualization3DSite usually has an internal camera that can be moved freely by the user. The position of that internal camera can be obtained and set via getCamera() and setCamera(). Additionally, the camera can be acquired by a visualization or a tool. The visualization/tool is then responsible for updating the cameras position.

Examples:: tutorials/Point3Visualization.C.

Constructor & Destructor Documentation

◆ ~IVisualization3DSite()

virtual ~IVisualization3DSite ( )

inlinevirtual

Member Function Documentation

◆ getSceneManager()

virtual Ogre::SceneManager* getSceneManager ( )

pure virtual

Implemented in Visualization3DView, and Visualization3DContainer.

Examples:: tutorials/Point3Visualization.C.

◆ registerInteractionListener()

virtual void registerInteractionListener ( InteractionListener3D * listener )

pure virtual

Implemented in Visualization3DView, and Visualization3DContainer.

◆ removeInteractionListener()

virtual void removeInteractionListener ( InteractionListener3D * listener )

pure virtual

Implemented in Visualization3DView, and Visualization3DContainer.

◆ getInteractionListeners()

virtual std::set<InteractionListener3D*> getInteractionListeners ( )

pure virtual

Implemented in Visualization3DView, and Visualization3DContainer.

◆ getCamera()

virtual const Camera& getCamera ( ) const

pure virtual

Obtains the current camera settings (position, orientation, etc.) of the views own camera.

Implemented in Visualization3DView, and Visualization3DContainer.

◆ setCamera()

virtual void setCamera ( const Camera & camera )

pure virtual

Sets the current camera settings (position, orientation, etc.) of the views own camera.

Implemented in Visualization3DContainer.

◆ acquireCamera()

virtual Ogre::Camera* acquireCamera ( boost::function< void()> lostCameraCallback = boost::function< void()>() )

pure virtual

Requests the camera of the visualization site.

This method can be called by visualizations or tools to get direct access to the camera. The visualization/tool is then responsible for updating the cameras position (e.g. in its update() method). Optionally, a callback can be specified, that is called if another visualization/tool has requested the camera. The visualization finally should release the camera by calling releaseCamera().

Implemented in Visualization3DView, and Visualization3DContainer.