Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions

mitk::VtkRepresentationProperty Class Reference

#include <mitkVtkRepresentationProperty.h>

Inheritance diagram for mitk::VtkRepresentationProperty:
Inheritance graph
[legend]
Collaboration diagram for mitk::VtkRepresentationProperty:
Collaboration graph
[legend]

List of all members.

Public Types

typedef VtkRepresentationProperty Self
typedef EnumerationProperty Superclass
typedef itk::SmartPointer< SelfPointer
typedef itk::SmartPointer
< const Self
ConstPointer

Public Member Functions

virtual const char * GetClassName () const
virtual int GetVtkRepresentation ()
virtual void SetRepresentationToPoints ()
virtual void SetRepresentationToWireframe ()
virtual void SetRepresentationToSurface ()

Static Public Member Functions

static Pointer New ()
static Pointer New (const IdType &_arg)
static Pointer New (const std::string &_arg)

Protected Member Functions

 VtkRepresentationProperty ()
 VtkRepresentationProperty (const IdType &value)
 VtkRepresentationProperty (const std::string &value)
virtual bool AddEnum (const std::string &name, const IdType &id)
virtual void AddRepresentationTypes ()

Detailed Description

Encapsulates the enumeration vtkRepresentation. Valid values are (VTK constant/Id/string representation): VTK_POINTS/0/Points, VTK_WIREFRAME/1/Wireframe, VTK_SURFACE/2/Surface Default is the Surface representation

Definition at line 32 of file mitkVtkRepresentationProperty.h.


Member Typedef Documentation

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 36 of file mitkVtkRepresentationProperty.h.

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 36 of file mitkVtkRepresentationProperty.h.

Reimplemented from mitk::EnumerationProperty.

Definition at line 36 of file mitkVtkRepresentationProperty.h.

Reimplemented from mitk::EnumerationProperty.

Definition at line 36 of file mitkVtkRepresentationProperty.h.


Constructor & Destructor Documentation

mitk::VtkRepresentationProperty::VtkRepresentationProperty (  ) [protected]

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

Definition at line 22 of file mitkVtkRepresentationProperty.cpp.

References AddRepresentationTypes(), and mitk::EnumerationProperty::SetValue().

{
  AddRepresentationTypes();
  SetValue( static_cast<IdType>( VTK_SURFACE ) );
}
mitk::VtkRepresentationProperty::VtkRepresentationProperty ( const IdType value ) [protected]

Constructor. Sets the representation to the given value. If it is not valid, the representation is set to Surface(2)

Parameters:
valuethe integer representation of the representation

Definition at line 29 of file mitkVtkRepresentationProperty.cpp.

{
  AddRepresentationTypes();
  if ( IsValidEnumerationValue( value ) )
  {
    SetValue( value );
  }
  else
  {
    SetValue( static_cast<IdType>( VTK_SURFACE ) );
  }
}
mitk::VtkRepresentationProperty::VtkRepresentationProperty ( const std::string &  value ) [protected]

Constructor. Sets the representation to the given value. If it is not valid, the representation is set to Surface(2)

Parameters:
valuethe string representation of the representation

Definition at line 43 of file mitkVtkRepresentationProperty.cpp.

{
  AddRepresentationTypes();
  if ( IsValidEnumerationValue( value ) )
  {
    SetValue( value );
  }
  else
  {
    SetValue( static_cast<IdType>( VTK_SURFACE ) );
  }
}

Member Function Documentation

bool mitk::VtkRepresentationProperty::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 representation types.

Reimplemented from mitk::EnumerationProperty.

Definition at line 88 of file mitkVtkRepresentationProperty.cpp.

{
  return Superclass::AddEnum( name, id );  
}
void mitk::VtkRepresentationProperty::AddRepresentationTypes (  ) [protected, virtual]

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

Definition at line 80 of file mitkVtkRepresentationProperty.cpp.

Referenced by VtkRepresentationProperty().

{
  AddEnum( "Points", static_cast<IdType>( VTK_POINTS ) );
  AddEnum( "Wireframe", static_cast<IdType>( VTK_WIREFRAME ) );
  AddEnum( "Surface", static_cast<IdType>( VTK_SURFACE ) );
}
virtual const char* mitk::VtkRepresentationProperty::GetClassName (  ) const [virtual]

Reimplemented from mitk::EnumerationProperty.

int mitk::VtkRepresentationProperty::GetVtkRepresentation (  ) [virtual]

Returns the current representation value as defined by VTK constants.

Returns:
the current representation as VTK constant.

Definition at line 57 of file mitkVtkRepresentationProperty.cpp.

{
  return static_cast<int>( GetValueAsId() );
}
static Pointer mitk::VtkRepresentationProperty::New ( const std::string &  _arg ) [inline, static]

Definition at line 42 of file mitkVtkRepresentationProperty.h.

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

Definition at line 40 of file mitkVtkRepresentationProperty.h.

void mitk::VtkRepresentationProperty::SetRepresentationToPoints (  ) [virtual]

Sets the representation type to VTK_POINTS.

Definition at line 63 of file mitkVtkRepresentationProperty.cpp.

{
  SetValue( static_cast<IdType>( VTK_POINTS ) );
}
void mitk::VtkRepresentationProperty::SetRepresentationToSurface (  ) [virtual]

Sets the representation type to VTK_SURFACE.

Definition at line 75 of file mitkVtkRepresentationProperty.cpp.

{
  SetValue( static_cast<IdType>( VTK_SURFACE ) );
}
void mitk::VtkRepresentationProperty::SetRepresentationToWireframe (  ) [virtual]

Sets the representation type to VTK_WIREFRAME.

Definition at line 69 of file mitkVtkRepresentationProperty.cpp.

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

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines