mitkSceneBase Class Reference

#include <mitkSceneBase.h>

Inherits mitkObject.

Inherited by mitkCUDAEndoscopySliceScene, mitkEndoscopySliceScene, mitkScene, and mitkVis2Scene3D.

Inheritance diagram for mitkSceneBase:

[legend]Collaboration diagram for mitkSceneBase:

[legend]List of all members.

Public Member Functions
void *	GetWindowId ()
const int *	GetSize ()
int	GetWidth ()
int	GetHeight ()
void	Update ()
void	MakeCurrent ()
void	SwapBuffers ()
bool	HasUnprocessedMouseMessage ()
virtual void	InitGL ()
virtual void	DestroyGL ()
virtual void	ResizeGL (int newX, int newY)
virtual void	RenderGL ()
virtual void	OnMouseDown (int mouseButton, bool ctrlDown, bool shiftDown, int xPos, int yPos)
virtual void	OnMouseUp (int mouseButton, bool ctrlDown, bool shiftDown, int xPos, int yPos)
virtual void	OnMouseMove (bool ctrlDown, bool shiftDown, int xPos, int yPos)
virtual void	OnMouseWheel (bool ctrlDown, bool shiftDown, int xPos, int yPos, int delta)

---

Detailed Description

mitkSceneBase - an abstract class defining the interface of a scene, which need to be referenced by the container window

mitkSceneBase is an abstract class defining the interface of a scene, which need to be referenced by the container window You can use this interface to define your own subclass of scenes. A concrete scene should reponse to the events passed by the container and do the rendering.

---

Member Function Documentation

virtual void mitkSceneBase::DestroyGL (   )  [inline, virtual]

The Interface to free OpenGL resources Reimplemented in mitkScene.

int mitkSceneBase::GetHeight (   )  [inline]

Get the height of the container window. Provided for convinience.

const int* mitkSceneBase::GetSize (   )  [inline]

Get the size of the container window. Provided for convinience.

int mitkSceneBase::GetWidth (   )  [inline]

Get the width of the container window. Provided for convinience.

void* mitkSceneBase::GetWindowId (  void   )  [inline]

Get the system dependent id of the container window. Provided for convinience.

bool mitkSceneBase::HasUnprocessedMouseMessage (   )  [inline]

Test if there is any unprocessed mouse message (button down/up) in the message queue of rendering thread. Calls the container. Provided for convinience.

virtual void mitkSceneBase::InitGL (   )  [inline, virtual]

The Interface to initialize OpenGL variables and resources. Reimplemented in mitkImageScene, and mitkScene.

void mitkSceneBase::MakeCurrent (   )  [inline]

Make the OpenGL context of the container window current. Provided for convinience.

virtual void mitkSceneBase::OnMouseDown (  int  mouseButton, bool  ctrlDown, bool  shiftDown, int  xPos, int  yPos )  [inline, virtual]

The Interface for handling the mouse pressed event pass by the container Reimplemented in mitkScene, mitkEndoscopySliceScene, mitkFullVRScene, mitkGLSLFullVRScene, mitkGLSLIsosurfaceVRScene, mitkIsosurfaceVRScene, mitkVis2Scene3D, mitkCUDAAugmentedSurfaceVRScene, mitkCUDADecomposedIsosurfaceVRScene, mitkCUDADeltaAccStateVRScene, mitkCUDAEndoscopySliceScene, mitkCUDAFullVRScene, mitkCUDAIsosurfaceVRScene, mitkCUDAROIDistanceVRScene, mitkCUDASegmentedVRScene, mitkCUDAStructureFunctionVRScene, mitkCUDAValueBasedStateVRScene, and mitkCUDAVersatileVRScene.

virtual void mitkSceneBase::OnMouseMove (  bool  ctrlDown, bool  shiftDown, int  xPos, int  yPos )  [inline, virtual]

The Interface for handling the mouse moved event pass by the container Reimplemented in mitkScene, mitkEndoscopySliceScene, mitkFullVRScene, mitkGLSLFullVRScene, mitkGLSLIsosurfaceVRScene, mitkIsosurfaceVRScene, mitkVis2Scene3D, mitkCUDAAugmentedSurfaceVRScene, mitkCUDADecomposedIsosurfaceVRScene, mitkCUDADeltaAccStateVRScene, mitkCUDAEndoscopySliceScene, mitkCUDAFullVRScene, mitkCUDAIsosurfaceVRScene, mitkCUDAROIDistanceVRScene, mitkCUDASegmentedVRScene, mitkCUDAStructureFunctionVRScene, mitkCUDAValueBasedStateVRScene, and mitkCUDAVersatileVRScene.

virtual void mitkSceneBase::OnMouseUp (  int  mouseButton, bool  ctrlDown, bool  shiftDown, int  xPos, int  yPos )  [inline, virtual]

The Interface for handling the mouse released event pass by the container Reimplemented in mitkScene, mitkEndoscopySliceScene, mitkFullVRScene, mitkGLSLFullVRScene, mitkGLSLIsosurfaceVRScene, mitkIsosurfaceVRScene, mitkVis2Scene3D, mitkCUDAAugmentedSurfaceVRScene, mitkCUDADecomposedIsosurfaceVRScene, mitkCUDADeltaAccStateVRScene, mitkCUDAEndoscopySliceScene, mitkCUDAFullVRScene, mitkCUDAIsosurfaceVRScene, mitkCUDAROIDistanceVRScene, mitkCUDASegmentedVRScene, mitkCUDAStructureFunctionVRScene, mitkCUDAValueBasedStateVRScene, and mitkCUDAVersatileVRScene.

virtual void mitkSceneBase::OnMouseWheel (  bool  ctrlDown, bool  shiftDown, int  xPos, int  yPos, int  delta )  [inline, virtual]

The Interface for handling the mouse wheel event pass by the container Reimplemented in mitkScene, mitkEndoscopySliceScene, and mitkCUDAEndoscopySliceScene.

virtual void mitkSceneBase::RenderGL (   )  [inline, virtual]

The Interface for handling the render event pass by the container Reimplemented in mitkImageScene, mitkScene, mitkEndoscopySliceScene, mitkFullVRScene, mitkGLSLFullVRScene, mitkGLSLIsosurfaceVRScene, mitkGLSLMIPVRScene, mitkIsosurfaceVRScene, mitkMIPVRScene, mitkTargetMeasurementScene, mitkVis2Scene3D, mitkCUDAAugmentedSurfaceVRScene, mitkCUDADecomposedIsosurfaceVRScene, mitkCUDADeltaAccStateVRScene, mitkCUDAEndoscopySliceScene, mitkCUDAFullVRScene, mitkCUDAIsosurfaceVRScene, mitkCUDAMIPVRScene, mitkCUDAROIDistanceVRScene, mitkCUDASegmentedVRScene, mitkCUDAStructureFunctionVRScene, mitkCUDAValueBasedStateVRScene, and mitkCUDAVersatileVRScene.

virtual void mitkSceneBase::ResizeGL (  int  newX, int  newY )  [inline, virtual]

The Interface for handling the resize event pass by the container Reimplemented in mitkImageScene, mitkScene, and mitkVis2Scene3D.

void mitkSceneBase::SwapBuffers (   )  [inline]

Swap the buffers of the container window. Provided for convinience.

void mitkSceneBase::Update (   )  [inline]

Update the scene. Actually calls the container->Update(). Provided for convinience.

---

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

• mitkSceneBase.h

---