#include <mitkVtkScalarModeProperty.h>

Inheritance diagram for mitk::VtkScalarModeProperty:

Collaboration diagram for mitk::VtkScalarModeProperty:

Public Types
typedef VtkScalarModeProperty	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	GetVtkScalarMode ()
virtual void	SetScalarModeToDefault ()
virtual void	SetScalarModeToPointData ()
virtual void	SetScalarModeToCellData ()
virtual void	SetScalarModeToPointFieldData ()
virtual void	SetScalarModeToCellFieldData ()
Static Public Member Functions
static Pointer	New ()
static Pointer	New (const IdType &_arg)
static Pointer	New (const std::string &_arg)
Protected Member Functions
	VtkScalarModeProperty ()
	VtkScalarModeProperty (const IdType &value)
	Sets the scalar mode to the given value. If it is not valid, the scalar mode is set to default (0).
	VtkScalarModeProperty (const std::string &value)
	Sets the scalar mode to the given value. If it is not valid, the representation is set to default (0).
virtual bool	AddEnum (const std::string &name, const IdType &id)
virtual void	AddInterpolationTypes ()

Detailed Description

Encapsulates the enumeration vtkInterpolation. Valid values are (VTK constant/Id/string representation):

VTK_SCALAR_MODE_DEFAULT/0/Default,
VTK_SCALAR_MODE_USE_POINT_DATA/1/PointData,
VTK_SCALAR_MODE_USE_CELL_DATA/2/CellData
VTK_SCALAR_MODE_USE_POINT_FIELD_DATA/3/PointFieldData
VTK_SCALAR_MODE_USE_CELL_FIELD_DATA/4/CellFieldData

Definition at line 35 of file mitkVtkScalarModeProperty.h.

Member Typedef Documentation

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkVtkScalarModeProperty.h.

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkVtkScalarModeProperty.h.

typedef VtkScalarModeProperty mitk::VtkScalarModeProperty::Self

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkVtkScalarModeProperty.h.

typedef EnumerationProperty mitk::VtkScalarModeProperty::Superclass

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkVtkScalarModeProperty.h.

Constructor & Destructor Documentation

mitk::VtkScalarModeProperty::VtkScalarModeProperty ( ) [protected]

Constructor. Sets the representation to a default value of surface(2)

Definition at line 21 of file mitkVtkScalarModeProperty.cpp.

References AddInterpolationTypes(), and SetScalarModeToDefault().

{
  AddInterpolationTypes();
  SetScalarModeToDefault();
}

mitk::VtkScalarModeProperty::VtkScalarModeProperty ( const IdType & value ) [protected]

Sets the scalar mode to the given value. If it is not valid, the scalar mode is set to default (0).

Parameters:

value the integer representation of the scalar mode

Definition at line 27 of file mitkVtkScalarModeProperty.cpp.

{
  AddInterpolationTypes();
  if ( IsValidEnumerationValue( value ) )
  {
    SetValue( value ) ;
  }
  else
  {
    SetScalarModeToDefault();
  }
}

mitk::VtkScalarModeProperty::VtkScalarModeProperty ( const std::string & value ) [protected]

Sets the scalar mode to the given value. If it is not valid, the representation is set to default (0).

Parameters:

value the string representation of the scalar mode

Definition at line 40 of file mitkVtkScalarModeProperty.cpp.

{
  AddInterpolationTypes();
  if ( IsValidEnumerationValue( value ) )
  {
    SetValue( value );
  }
  else
  {
    SetScalarModeToDefault();
  }
}

Member Function Documentation

bool mitk::VtkScalarModeProperty::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 scalar mode types.

Reimplemented from mitk::EnumerationProperty.

Definition at line 92 of file mitkVtkScalarModeProperty.cpp.

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

void mitk::VtkScalarModeProperty::AddInterpolationTypes ( ) [protected, virtual]

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

Definition at line 83 of file mitkVtkScalarModeProperty.cpp.

Referenced by VtkScalarModeProperty().

{
  AddEnum( "Default", static_cast<IdType>( VTK_SCALAR_MODE_DEFAULT ) );
  AddEnum( "PointData", static_cast<IdType>( VTK_SCALAR_MODE_USE_POINT_DATA ) );
  AddEnum( "CellData", static_cast<IdType>( VTK_SCALAR_MODE_USE_CELL_DATA ) );
  AddEnum( "PointFieldData", static_cast<IdType>( VTK_SCALAR_MODE_USE_POINT_FIELD_DATA ) );
  AddEnum( "CellFieldData", static_cast<IdType>( VTK_SCALAR_MODE_USE_CELL_FIELD_DATA ) );
}

virtual const char* mitk::VtkScalarModeProperty::GetClassName ( ) const [virtual]

Reimplemented from mitk::EnumerationProperty.

int mitk::VtkScalarModeProperty::GetVtkScalarMode ( ) [virtual]

Returns the current scalar mode value as defined by VTK constants.

Returns:: the current scalar mode as VTK constant.

Definition at line 53 of file mitkVtkScalarModeProperty.cpp.

Referenced by mitk::SurfaceVtkMapper3D::ApplyProperties(), and mitk::SurfaceGLMapper2D::PaintCells().

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

static Pointer mitk::VtkScalarModeProperty::New ( const std::string & _arg ) [inline, static]

Definition at line 45 of file mitkVtkScalarModeProperty.h.

static Pointer mitk::VtkScalarModeProperty::New ( ) [static]

Reimplemented from mitk::EnumerationProperty.

Referenced by mitkPropertySerializationTest(), mitk::UnstructuredGridVtkMapper3D::SetDefaultProperties(), mitk::SurfaceVtkMapper3D::SetDefaultProperties(), and mitk::SurfaceGLMapper2D::SetDefaultProperties().

static Pointer mitk::VtkScalarModeProperty::New ( const IdType & _arg ) [inline, static]

Definition at line 43 of file mitkVtkScalarModeProperty.h.

void mitk::VtkScalarModeProperty::SetScalarModeToCellData ( ) [virtual]

Definition at line 68 of file mitkVtkScalarModeProperty.cpp.

{
  SetValue( static_cast<IdType>( VTK_SCALAR_MODE_USE_CELL_DATA ) );
}

void mitk::VtkScalarModeProperty::SetScalarModeToCellFieldData ( ) [virtual]

Definition at line 78 of file mitkVtkScalarModeProperty.cpp.

{
  SetValue( static_cast<IdType>( VTK_SCALAR_MODE_USE_CELL_FIELD_DATA ) );
}

void mitk::VtkScalarModeProperty::SetScalarModeToDefault ( ) [virtual]

Definition at line 58 of file mitkVtkScalarModeProperty.cpp.

Referenced by VtkScalarModeProperty().

{
  SetValue( static_cast<IdType>( VTK_SCALAR_MODE_DEFAULT ) );
}

void mitk::VtkScalarModeProperty::SetScalarModeToPointData ( ) [virtual]

Definition at line 63 of file mitkVtkScalarModeProperty.cpp.

{
  SetValue( static_cast<IdType>( VTK_SCALAR_MODE_USE_POINT_DATA ) );
}

void mitk::VtkScalarModeProperty::SetScalarModeToPointFieldData ( ) [virtual]

Definition at line 73 of file mitkVtkScalarModeProperty.cpp.

{
  SetValue( static_cast<IdType>( VTK_SCALAR_MODE_USE_POINT_FIELD_DATA ) );
}

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

mitk::VtkScalarModeProperty Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation