mitk::VtkVolumeRenderingProperty Class Reference

#include <mitkVtkVolumeRenderingProperty.h>

Inheritance diagram for mitk::VtkVolumeRenderingProperty:

Collaboration diagram for mitk::VtkVolumeRenderingProperty:

List of all members.

Public Types
typedef VtkVolumeRenderingProperty	Self
typedef EnumerationProperty	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
Public Member Functions
virtual const char *	GetClassName () const
virtual int	GetRenderingType ()
virtual void	SetRenderingTypeToMIP ()
virtual void	SetRenderingTypeToComposite ()
Static Public Member Functions
static Pointer	New ()
static Pointer	New (const IdType &_arg)
static Pointer	New (const std::string &_arg)
Protected Member Functions
	VtkVolumeRenderingProperty ()
	VtkVolumeRenderingProperty (const IdType &value)
	VtkVolumeRenderingProperty (const std::string &value)
virtual bool	AddEnum (const std::string &name, const IdType &id)
virtual void	AddRenderingTypes ()

---

Detailed Description

Encapsulates the enumeration for volume rendering. Valid values are (VTK constant/Id/string representation): VTK_VOLUME_RAY_CAST_MIP_FUNCTION VTK_RAY_CAST_COMPOSITE_FUNCTION Default is NULL

Definition at line 35 of file mitkVtkVolumeRenderingProperty.h.

---

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::VtkVolumeRenderingProperty::ConstPointer

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkVtkVolumeRenderingProperty.h.

typedef itk::SmartPointer<Self> mitk::VtkVolumeRenderingProperty::Pointer

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkVtkVolumeRenderingProperty.h.

typedef VtkVolumeRenderingProperty mitk::VtkVolumeRenderingProperty::Self

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkVtkVolumeRenderingProperty.h.

typedef EnumerationProperty mitk::VtkVolumeRenderingProperty::Superclass

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkVtkVolumeRenderingProperty.h.

---

Constructor & Destructor Documentation

mitk::VtkVolumeRenderingProperty::VtkVolumeRenderingProperty

(

)

[protected]

Sets rendering type to default (VTK_RAY_CAST_COMPOSITE_FUNCTION).

Definition at line 23 of file mitkVtkVolumeRenderingProperty.cpp.

References AddRenderingTypes(), mitk::EnumerationProperty::SetValue(), and VTK_RAY_CAST_COMPOSITE_FUNCTION.

{
  this->AddRenderingTypes();
  this->SetValue( static_cast<IdType>( VTK_RAY_CAST_COMPOSITE_FUNCTION ) );
}

mitk::VtkVolumeRenderingProperty::VtkVolumeRenderingProperty

(

const IdType &

value )

[protected]

Constructor. Sets rendering type to the given value.

Definition at line 30 of file mitkVtkVolumeRenderingProperty.cpp.

References MITK_INFO.

{
  this->AddRenderingTypes();
  if ( IsValidEnumerationValue( value ) )
  {
    this->SetValue( value ) ;
  }
  else
    MITK_INFO << "Warning: invalid rendering configuration" << std::endl;
}

mitk::VtkVolumeRenderingProperty::VtkVolumeRenderingProperty

(

const std::string &

value )

[protected]

Constructor. Sets rendering type to the given value.

Definition at line 41 of file mitkVtkVolumeRenderingProperty.cpp.

References MITK_INFO.

{
  this->AddRenderingTypes();
  if ( IsValidEnumerationValue( value ) )
  {
    this->SetValue( value );
  }
  else
    MITK_INFO << "Warning: invalid rendering configuration" << std::endl;
}

---

Member Function Documentation

bool mitk::VtkVolumeRenderingProperty::AddEnum	(	const std::string &	name,
		const IdType &	id
	)		[protected, virtual]

this function is overridden as protected, so that the user may not add additional invalid rendering types.

Reimplemented from mitk::EnumerationProperty.

Definition at line 76 of file mitkVtkVolumeRenderingProperty.cpp.

{
  return Superclass::AddEnum( name, id );  
}

void mitk::VtkVolumeRenderingProperty::AddRenderingTypes

(

)

[protected, virtual]

Adds the enumeration types as defined by vtk to the list of known enumeration values.

Definition at line 69 of file mitkVtkVolumeRenderingProperty.cpp.

References VTK_RAY_CAST_COMPOSITE_FUNCTION, and VTK_VOLUME_RAY_CAST_MIP_FUNCTION.

Referenced by VtkVolumeRenderingProperty().

{
  AddEnum( "MIP", static_cast<IdType>(  VTK_VOLUME_RAY_CAST_MIP_FUNCTION ) );
  AddEnum( "COMPOSITE", static_cast<IdType> (VTK_RAY_CAST_COMPOSITE_FUNCTION));
}

virtual const char* mitk::VtkVolumeRenderingProperty::GetClassName

(

)

const [virtual]

Reimplemented from mitk::EnumerationProperty.

int mitk::VtkVolumeRenderingProperty::GetRenderingType

(

)

[virtual]

Returns the current volume rendering type

Definition at line 53 of file mitkVtkVolumeRenderingProperty.cpp.

{
  return static_cast<int>( this->GetValueAsId() );
}

static Pointer mitk::VtkVolumeRenderingProperty::New

(

const std::string &

_arg )

[inline, static]

Definition at line 45 of file mitkVtkVolumeRenderingProperty.h.

:

static Pointer mitk::VtkVolumeRenderingProperty::New

(

)

[static]

Reimplemented from mitk::EnumerationProperty.

Referenced by mitkPropertySerializationTest(), and mitk::VolumeDataVtkMapper3D::SetDefaultProperties().

static Pointer mitk::VtkVolumeRenderingProperty::New

(

const IdType &

_arg )

[inline, static]

Definition at line 43 of file mitkVtkVolumeRenderingProperty.h.

void mitk::VtkVolumeRenderingProperty::SetRenderingTypeToComposite

(

)

[virtual]

Sets the rendering type to VTK_RAY_CAST_COMPOSITE_FUNCTION

Definition at line 64 of file mitkVtkVolumeRenderingProperty.cpp.

References VTK_RAY_CAST_COMPOSITE_FUNCTION.

{
  this->SetValue( static_cast<IdType>(  VTK_RAY_CAST_COMPOSITE_FUNCTION ) );
}

void mitk::VtkVolumeRenderingProperty::SetRenderingTypeToMIP

(

)

[virtual]

Sets the rendering type to VTK_VOLUME_RAY_CAST_MIP_FUNCTION

Definition at line 59 of file mitkVtkVolumeRenderingProperty.cpp.

References VTK_VOLUME_RAY_CAST_MIP_FUNCTION.

{
  this->SetValue( static_cast<IdType>(  VTK_VOLUME_RAY_CAST_MIP_FUNCTION ) );
}

---

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

• mitkVtkVolumeRenderingProperty.h
• mitkVtkVolumeRenderingProperty.cpp