mitkVolumeModel Class Reference

mitkVolumeModel - an 3D entity in a rendering scene represented in volume More...

#include <mitkVolumeModel.h>

Inherits mitkDataModel.

Inheritance diagram for mitkVolumeModel:

[legend]Collaboration diagram for mitkVolumeModel:

[legend]List of all members.

Public Member Functions
virtual void	PrintSelf (ostream &os)
virtual mitkRenderer *	GetBasicRenderer ()
void	SetRenderer (mitkVolumeRenderer *renderer)
mitkVolumeRenderer *	GetRenderer (void)
void	SetProperty (mitkVolumeProperty *prop)
mitkVolumeProperty *	GetProperty (void)
void	SetData (mitkVolume *data)
mitkVolume *	GetData (void)
virtual int	Render (mitkScene *scene)
virtual bool	IsOpaque ()

---

Detailed Description

mitkVolumeModel - an 3D entity in a rendering scene represented in volume

mitkVolumeModel is an 3D entity in a rendering scene represented in volume. It contains an mitkVolume object which should be shown in the rendering scene. Not like widget model, it is a kind of mitkDataModel and can not be manipulated by itself.

---

Member Function Documentation

virtual mitkRenderer* mitkVolumeModel::GetBasicRenderer (   )  [inline, virtual]

Get the renderer for widget. Returns: Return pointer to an mitkRenderer which renders this model actually. Note: This function is written for the widget who needs to know the information about the volume model's renderer. Reimplemented from mitkDataModel.

mitkVolume* mitkVolumeModel::GetData (  void   )

Get the volume data. Returns: Return pointer to the volume data.

mitkVolumeProperty* mitkVolumeModel::GetProperty (  void   )

Get the volume property. Returns: Return pointer to this volume model's property.

mitkVolumeRenderer* mitkVolumeModel::GetRenderer (  void   )

Get the volume renderer. Returns: Return a pointer to this volume model's renderer.

virtual bool mitkVolumeModel::IsOpaque (   )  [inline, virtual]

Whether this model is opaque. Returns: Return true if this model is opaque. Implements mitkModel.

virtual void mitkVolumeModel::PrintSelf (  ostream &  os  )  [virtual]

Print the necessary information about this object for the debugging purpose. Parameters: os  The specified ostream to output information. Reimplemented from mitkDataModel.

virtual int mitkVolumeModel::Render (  mitkScene *  scene  )  [virtual]

Render this model. Parameters: scene  the pointer of an mitkScene in which this model will be shown Returns: Return 1 if this model is rendered successfully. Otherwise return 0. Warning: Don't call this function directly. Reimplemented from mitkModel.

void mitkVolumeModel::SetData (  mitkVolume *  data  )

Set the volume data. Parameters: data  pointer to an mitkVolume

void mitkVolumeModel::SetProperty (  mitkVolumeProperty *  prop  )

Set the volume property. Parameters: prop  pointer to an mitkVolumeProperty

void mitkVolumeModel::SetRenderer (  mitkVolumeRenderer *  renderer  )

Set the volume renderer. Parameters: renderer  pointer to an mitkVolumeRenderer

---

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

• mitkVolumeModel.h

---