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

mitkVolumeProperty Class Reference

mitkVolumeProperty - properties of an mitkVolumeModel More...

#include <mitkVolumeProperty.h>

Inherits mitkObject.

Inheritance diagram for mitkVolumeProperty:

Inheritance graph
[legend]
Collaboration diagram for mitkVolumeProperty:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void PrintSelf (ostream &os)
void SetInterpolationType (int intpType)
int GetInterpolationType ()
void SetInterpolationTypeToNearest ()
void SetInterpolationTypeToLinear ()
const char * GetInterpolationTypeAsString ()
void SetScalarColor (mitkColorTransferFunction *scFunction)
void SetScalarOpacity (mitkTransferFunction1D *soFunction)
void SetGradientOpacity (mitkTransferFunction1D *goFunction)
void SetTF2DRGBA (mitkTransferFunction2DRGBA *tf2drgba)
mitkColorTransferFunction * GetScalarColor ()
mitkTransferFunction1D * GetScalarOpacity ()
mitkTransferFunction1D * GetGradientOpacity ()
mitkTransferFunction2DRGBA * GetTF2DRGBA ()
void CorrectScalarOpacity (float sampleDistance)
void SetOpacityTransferFunction (mitkTransferFunction *moFunction)
mitkTransferFunction * GetOpacityTransferFunction ()
void SetTransferFunctionStyle (TransferFunctionStyle tfStyle)
TransferFunctionStyle GetTransferFunctionStyle ()
void SetShade (bool shade)
int GetShade ()
void ShadeOn ()
void ShadeOff ()
void SetGradientOpacityCalculation (bool goEnable)
int GetGradientOpacityCalculation ()
void GradientOpacityCalculationOn ()
void GradientOpacityCalculationOff ()
void SetTF2DRGBACalculation (bool TF2DRGBAEnable)
int GetTF2DRGBACalculation ()
void TF2DRGBACalculationOn ()
void TF2DRGBACalculationOff ()
void SetAmbient (float value)
float GetAmbient ()
void SetDiffuse (float value)
float GetDiffuse ()
void SetSpecular (float value)
float GetSpecular ()
void SetSpecularPower (float value)
float GetSpecularPower ()
bool IsModified () const
void SetUnmodified ()

Detailed Description

mitkVolumeProperty - properties of an mitkVolumeModel

mitkVolumeProperty is a class contains properties of an mitkVolumeModel including shading parameters and transfer functions.

Member Function Documentation

void mitkVolumeProperty::CorrectScalarOpacity (  float  sampleDistance  ) 
 

Correct the scalar-opacity transfer function when the sample distance changed.

Parameters:
sampleDistance Specify the new sample distance

float mitkVolumeProperty::GetAmbient (   )  [inline]
 

Get the ambient lighting coefficient.

Returns:
Return the ambient lighting coefficient.

float mitkVolumeProperty::GetDiffuse (   )  [inline]
 

Get the diffuse lighting coefficient.

Returns:
Return the diffuse lighting coefficient.

mitkTransferFunction1D* mitkVolumeProperty::GetGradientOpacity (   ) 
 

Get the gradient value to opacity transfer function.

Returns:
Return the gradient-opacity transfer function

int mitkVolumeProperty::GetGradientOpacityCalculation (   )  [inline]
 

Get the enableness of Gradient-Opacity transfer function.

Returns:
Return non-zero value, the calculation of Gradient-Opacity transfer function is enabled Return zero, the calculation of Gradient-Opacity transfer function is disabled

int mitkVolumeProperty::GetInterpolationType (   )  [inline]
 

Get the interpolation type for sampling a volume.

Returns:
Return the interpolation type. Return MITK_NEAREST_INTERPOLATION, the interpolation type is nearest interpolation Return MITK_LINEAR_INTERPOLATION, the interpolation type is linear interpolation

const char * mitkVolumeProperty::GetInterpolationTypeAsString (   )  [inline]
 

Get the interpolation type as a C string.

Returns:
Return "Nearest Neighbor" if the interpolation type is nearest interpolation Return "Linear" if the interpolation type is linear interpolation Otherwise return "Unknown"

mitkTransferFunction* mitkVolumeProperty::GetOpacityTransferFunction (   ) 
 

Get the general transfer function (may be multi-dimensional).

Returns:
Return the general transfer function

mitkColorTransferFunction* mitkVolumeProperty::GetScalarColor (   ) 
 

Get the scalar value to color transfer function.

Returns:
Return the scalar-color transfer function

mitkTransferFunction1D* mitkVolumeProperty::GetScalarOpacity (   ) 
 

Get the scalar value to opacity transfer function.

Returns:
Return the scalar-opacity transfer function

int mitkVolumeProperty::GetShade (   )  [inline]
 

Get the status of shading.

Returns:
Return true, the shading is on Return false, the shading is off

float mitkVolumeProperty::GetSpecular (   )  [inline]
 

Get the specular lighting coefficient.

Returns:
Return the specular lighting coefficient.

float mitkVolumeProperty::GetSpecularPower (   )  [inline]
 

Get the specular power.

Returns:
Return the specular power.

mitkTransferFunction2DRGBA* mitkVolumeProperty::GetTF2DRGBA (   ) 
 

Get the scalar value and gradient Magnitudes value to opacity transfer function.

Returns:
Return the Scalar-GradientMagnitudes-opacity transfer function

int mitkVolumeProperty::GetTF2DRGBACalculation (   )  [inline]
 

Get the enableness of 2-D RGB and Opacity transfer function.

Returns:
Return non-zero value, the calculation of 2-D RGB and Opacity transfer function is enabled Return zero, the calculation of 2-D RGB and Opacity transfer function is disabled

TransferFunctionStyle mitkVolumeProperty::GetTransferFunctionStyle (   )  [inline]
 

Get the style of transfer function.

Returns:
Return the style of transfer function.
See also:
TransferFunctionStyle

void mitkVolumeProperty::GradientOpacityCalculationOff (   )  [inline]
 

Disable the calculation of Gradient-Opacity transfer function.

void mitkVolumeProperty::GradientOpacityCalculationOn (   )  [inline]
 

Enable the calculation of Gradient-Opacity transfer function.

bool mitkVolumeProperty::IsModified (   )  const
 

Test if some of the properties are modified.

Returns:
Return true if some of the properties are modified. Otherwise return false.

virtual void mitkVolumeProperty::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 mitkObject.

void mitkVolumeProperty::SetAmbient (  float  value  )  [inline]
 

Set the ambient lighting coefficient.

Parameters:
value Specify the ambient lighting coefficient.

void mitkVolumeProperty::SetDiffuse (  float  value  )  [inline]
 

Set the diffuse lighting coefficient.

Parameters:
value Specify the diffuse lighting coefficient.

void mitkVolumeProperty::SetGradientOpacity (  mitkTransferFunction1D *  goFunction  ) 
 

Set the gradient value to opacity transfer function.

Parameters:
goFunction Specify the gradient-opacity transfer function

void mitkVolumeProperty::SetGradientOpacityCalculation (  bool  goEnable  )  [inline]
 

Set the enableness of Gradient-Opacity transfer function.

Parameters:
goEnable goEnable = true, enable the calculation of Gradient-Opacity transfer function goEnable = false, disable the calculation of Gradient-Opacity transfer function

void mitkVolumeProperty::SetInterpolationType (  int  intpType  )  [inline]
 

Set the interpolation type for sampling a volume.

Parameters:
intpType Specify the interpolation type. intpType = MITK_NEAREST_INTERPOLATION, set the interpolation type to nearest interpolation intpType = MITK_LINEAR_INTERPOLATION, set the interpolation type to linear interpolation

void mitkVolumeProperty::SetInterpolationTypeToLinear (   )  [inline]
 

Set the interpolation type to linear interpolation.

void mitkVolumeProperty::SetInterpolationTypeToNearest (   )  [inline]
 

Set the interpolation type to nearest interpolation.

void mitkVolumeProperty::SetOpacityTransferFunction (  mitkTransferFunction *  moFunction  ) 
 

Set the general transfer function (may be multi-dimensional).

Parameters:
moFunction Specify the general transfer function

void mitkVolumeProperty::SetScalarColor (  mitkColorTransferFunction *  scFunction  ) 
 

Set the scalar value to color transfer function.

Parameters:
scFunction Specify the scalar-color transfer function

void mitkVolumeProperty::SetScalarOpacity (  mitkTransferFunction1D *  soFunction  ) 
 

Set the scalar value to opacity transfer function.

Parameters:
soFunction Specify the scalar-opacity transfer function

void mitkVolumeProperty::SetShade (  bool  shade  )  [inline]
 

Set the status of shading.

Parameters:
shade shade = true, turn the shading on shade = false, turn the shading off

void mitkVolumeProperty::SetSpecular (  float  value  )  [inline]
 

Set the specular lighting coefficient.

Parameters:
value Specify the specular lighting coefficient.

void mitkVolumeProperty::SetSpecularPower (  float  value  )  [inline]
 

Set the specular power.

Parameters:
value Specify the specular power.

void mitkVolumeProperty::SetTF2DRGBA (  mitkTransferFunction2DRGBA *  tf2drgba  ) 
 

Set the scalar value and gradient Magnitudes value to 2D R, G, B and opacity transfer function.

Parameters:
sgmoFunction Specify the 2D RGBOpacity transfer function

void mitkVolumeProperty::SetTF2DRGBACalculation (  bool  TF2DRGBAEnable  )  [inline]
 

Set the enableness of 2 dimensional RGB and Opacity transfer function.

Parameters:
goEnable TF2DRGBAEnable = true, enable the calculation of 2-D RGB and Opacity transfer function TF2DRGBAEnable = false, disable the calculation of 2-D RGB and Opacity transfer function

void mitkVolumeProperty::SetTransferFunctionStyle (  TransferFunctionStyle  tfStyle  )  [inline]
 

Set the style of transfer function.

Parameters:
tfStyle Specify the style of transfer function.
See also:
TransferFunctionStyle

void mitkVolumeProperty::SetUnmodified (   ) 
 

Reset to unmodified after changes have been done according to the new properties.

void mitkVolumeProperty::ShadeOff (   )  [inline]
 

Turn the shading off.

void mitkVolumeProperty::ShadeOn (   )  [inline]
 

Turn the shading on.

void mitkVolumeProperty::TF2DRGBACalculationOff (   )  [inline]
 

Disable the calculation of 2-D RGB and Opacity transfer function.

void mitkVolumeProperty::TF2DRGBACalculationOn (   )  [inline]
 

Enable the calculation of 2-D RGB and Opacity transfer function.

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