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

mitkFullVRScene Class Reference

mitkFullVRScene - a 3D scene for shaded semi-transparent rendering from volume datasets. Optimized for multicore CPU. More...

#include <mitkFullVRScene.h>

Inherits mitkVis2Scene3D.

Inheritance diagram for mitkFullVRScene:

Inheritance graph
[legend]
Collaboration diagram for mitkFullVRScene:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void RenderGL ()
void SetData (mitkICVolume *data)
void SetDataModified ()
void SetCoherentData (mitkCoherentVolume *CVolume)
void SetCoherentDataModified ()
void SetBackGroundColor (float r, float g, float b)
void GetBackGroundColor (float &r, float &g, float &b)
mitkRGBATransferFunction1DGetTransferFunction ()
void SetTransferFunction (mitkRGBATransferFunction1D *tf)
void SetStdSampleDistance (float stdSampleDistance)
float GetStdSampleDistance ()
void SetShade (bool shade)
bool GetShade ()
void ShadeOn ()
void ShadeOff ()
void SetLightDirection (float x, float y, float z)
void GetLightDirection (float &x, float &y, float &z)
void SetLightIntensity (float intensity)
void SetLightColor (float r, float g, float b)
void SetAmbient (float value)
float GetAmbient ()
void SetDiffuse (float value)
float GetDiffuse ()
void SetSpecular (float value)
float GetSpecular ()
void SetSpecularPower (float value)
float GetSpecularPower ()
void RotateLightDirection (bool turnOn)
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)
void SetIllustrativeShading (int illustrative)
bool GetIllustrativeShading ()
void SetCroppingBounds (const float CroppingBounds[6])
void GetCroppingBounds (float CroppingBounds[6])

Detailed Description

mitkFullVRScene - a 3D scene for shaded semi-transparent rendering from volume datasets. Optimized for multicore CPU.

mitkFullVRScene is a 3D scene for shaded semi-transparent rendering from volume datasets. Optimized for multicore CPU. mitkFullVRScene needs a container subclasses from mitkSceneContainer. You can use mitkGLWindow for the container, or implement your own container. Two kinds of data source are supported, ICVolume and CohrerentVolume.


Member Function Documentation

float mitkFullVRScene::GetAmbient  ) 
 

Get the ambient factor of the material of the isosurface

Returns:
Return The ambient factor of the material of the isosurface

void mitkFullVRScene::GetBackGroundColor float &  r,
float &  g,
float &  b
 

Return the background color of the scene

Parameters:
r Return the red component of the background color.
g Return the green component of the background color.
b Return the blue component of the background color.

void mitkFullVRScene::GetCroppingBounds float  CroppingBounds[6]  ) 
 

Get the cropping boundary

Parameters:
CroppingBounds,: the cropping boundary

float mitkFullVRScene::GetDiffuse  ) 
 

Get the diffuse factor of the material of the isosurface

Returns:
Return The diffuse factor of the material of the isosurface

bool mitkFullVRScene::GetIllustrativeShading  ) 
 

Get the illustrative shading status

Returns:
: Return the illustrative shading status.

void mitkFullVRScene::GetLightDirection float &  x,
float &  y,
float &  z
 

Return the light direction

Parameters:
x Return the x component of the light direction.
y Return the y component of the light direction.
z Return the z component of the light direction.

bool mitkFullVRScene::GetShade  ) 
 

Get the shading status

Returns:
Return the shading status.

float mitkFullVRScene::GetSpecular  ) 
 

Get the specular factor of the material of the isosurface

Returns:
Return The specular factor of the material of the isosurface

float mitkFullVRScene::GetSpecularPower  ) 
 

Get the specular power of the material of the isosurface

Returns:
Return The specular power of the material of the isosurface

float mitkFullVRScene::GetStdSampleDistance  ) 
 

Get the standard sample distance where the opacity of each step equals to the alpha channel of the transfered value.

Returns:
Return the standard sample distance

mitkRGBATransferFunction1D* mitkFullVRScene::GetTransferFunction  ) 
 

Get the transfer function

Returns:
Return the transfer function.

virtual void mitkFullVRScene::OnMouseDown int  mouseButton,
bool  ctrlDown,
bool  shiftDown,
int  xPos,
int  yPos
[virtual]
 

The Interface for handling the mouse pressed event pass by the container

Reimplemented from mitkVis2Scene3D.

virtual void mitkFullVRScene::OnMouseMove bool  ctrlDown,
bool  shiftDown,
int  xPos,
int  yPos
[virtual]
 

The Interface for handling the mouse moved event pass by the container

Reimplemented from mitkVis2Scene3D.

virtual void mitkFullVRScene::OnMouseUp int  mouseButton,
bool  ctrlDown,
bool  shiftDown,
int  xPos,
int  yPos
[virtual]
 

The Interface for handling the mouse released event pass by the container

Reimplemented from mitkVis2Scene3D.

virtual void mitkFullVRScene::RenderGL  )  [virtual]
 

The Interface for handling the render event pass by the container

Reimplemented from mitkVis2Scene3D.

void mitkFullVRScene::RotateLightDirection bool  turnOn  ) 
 

Turn this on to enter the light rotation interaction mode.

Parameters:
Whether turn the light rotation mode on.

void mitkFullVRScene::SetAmbient float  value  ) 
 

Set the ambient factor of the material of the isosurface

Parameters:
value The ambient factor of the material of the isosurface

void mitkFullVRScene::SetBackGroundColor float  r,
float  g,
float  b
 

Set the background color of the scene

Parameters:
r Specify the red component of the background color.
g Specify the green component of the background color.
b Specify the blue component of the background color.

void mitkFullVRScene::SetCoherentData mitkCoherentVolume CVolume  ) 
 

Set the data object(CoherentVolume) to be rendered.

Parameters:
data The data object to be rendered.

void mitkFullVRScene::SetCoherentDataModified  ) 
 

Tell the scene the data is modified when any modification is done to the data object

void mitkFullVRScene::SetCroppingBounds const float  CroppingBounds[6]  ) 
 

Set the cropping boundary

Parameters:
CroppingBounds,: the cropping boundary

void mitkFullVRScene::SetData mitkICVolume data  ) 
 

Set the data object(ICVolume) to be rendered.

Parameters:
data The data object to be rendered.

void mitkFullVRScene::SetDataModified  ) 
 

Tell the scene the data is modified when any modification is done to the data object

void mitkFullVRScene::SetDiffuse float  value  ) 
 

Set the diffuse factor of the material of the isosurface

Parameters:
value The diffuse factor of the material of the isosurface

void mitkFullVRScene::SetIllustrativeShading int  illustrative  ) 
 

Turn on or turn off illustrative shading.

Parameters:
shade,: The illustrative shading status.

void mitkFullVRScene::SetLightColor float  r,
float  g,
float  b
 

Set the color of the light source

Parameters:
r Specify the red component of the light source color.
g Specify the green component of the light source color.
b Specify the blue component of the light source color.

void mitkFullVRScene::SetLightDirection float  x,
float  y,
float  z
 

Set the light direction

Parameters:
x Specify the x component of the light direction.
y Specify the y component of the light direction.
z Specify the z component of the light direction.

void mitkFullVRScene::SetLightIntensity float  intensity  ) 
 

Set the light's intensity

Parameters:
intensity Light's intensity

void mitkFullVRScene::SetShade bool  shade  ) 
 

Turn on or turn off shading.

Parameters:
shade The shading status.

void mitkFullVRScene::SetSpecular float  value  ) 
 

Set the specular factor of the material of the isosurface

Parameters:
value The specular factor of the material of the isosurface

void mitkFullVRScene::SetSpecularPower float  value  ) 
 

Set the specular power of the material of the isosurface

Parameters:
value The specular power of the material of the isosurface

void mitkFullVRScene::SetStdSampleDistance float  stdSampleDistance  ) 
 

Set the standard sample distance where the opacity of each step equals to the alpha channel of the transfered value.

Parameters:
stdSampleDistance The standard sample distance

void mitkFullVRScene::SetTransferFunction mitkRGBATransferFunction1D tf  ) 
 

Set the transfer function

Parameters:
tf The transfer function.

void mitkFullVRScene::ShadeOff  ) 
 

Turn off shading.

void mitkFullVRScene::ShadeOn  ) 
 

Turn on shading.


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