Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members

mitkSurfaceModel Class Reference

mitkSurfaceModel - an 3D entity in a rendering scene represented in surface More...

#include <mitkSurfaceModel.h>

Inherits mitkDataModel.

Inheritance diagram for mitkSurfaceModel:

Inheritance graph
[legend]
Collaboration diagram for mitkSurfaceModel:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void PrintSelf (ostream &os)
 mitkSurfaceModel ()
virtual int Render (mitkScene *scene)
virtual mitkRenderer * GetBasicRenderer ()
void SetRenderer (mitkSurfaceRenderer *renderer)
mitkSurfaceRenderer * GetRenderer ()
void SetProperty (mitkSurfaceProperty *prop)
mitkSurfaceProperty * GetProperty ()
void SetData (mitkMesh *data)
mitkMesh * GetData ()
virtual bool IsOpaque ()

Detailed Description

mitkSurfaceModel - an 3D entity in a rendering scene represented in surface

mitkSurfaceModel is an 3D entity in a rendering scene represented in surface. It contains an mitkMesh 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.


Constructor & Destructor Documentation

mitkSurfaceModel::mitkSurfaceModel (   ) 
 

Default constructor.


Member Function Documentation

virtual mitkRenderer* mitkSurfaceModel::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 surface model's renderer.

Reimplemented from mitkDataModel.

mitkMesh* mitkSurfaceModel::GetData (  void   )  [inline]
 

Get the surface data.

Returns:
Return pointer to the surface model's mesh data.

mitkSurfaceProperty* mitkSurfaceModel::GetProperty (   ) 
 

Get the surface property.

Returns:
Return pointer to this surface model's property.

mitkSurfaceRenderer* mitkSurfaceModel::GetRenderer (   ) 
 

Get the surface renderer.

Returns:
Return a pointer to this surface model's render.

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

Whether this model is opaque.

Returns:
Return true if this model is opaque.

Implements mitkModel.

virtual void mitkSurfaceModel::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 mitkSurfaceModel::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 mitkSurfaceModel::SetData (  mitkMesh *  data  ) 
 

Set the surface data.

Parameters:
data pointer to an mitkMesh

void mitkSurfaceModel::SetProperty (  mitkSurfaceProperty *  prop  )  [inline]
 

Set the surface property.

Parameters:
prop pointer to an mitkSurfaceProperty

void mitkSurfaceModel::SetRenderer (  mitkSurfaceRenderer *  renderer  )  [inline]
 

Set the surface renderer.

Parameters:
renderer pointer to an mitkSurfaceRenderer


The documentation for this class was generated from the following file:
Generated on Tue Feb 25 15:06:14 2014 for MITK (Medical Imaging ToolKit) by  doxygen 1.4.3