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

mitk::GridRepresentationProperty Class Reference

#include <mitkGridRepresentationProperty.h>

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

List of all members.

Public Types

enum  RepresentationType { POINTS = 0, WIREFRAME = 1, SURFACE = 2, VOLUME = 3 }
typedef GridRepresentationProperty Self
typedef EnumerationProperty Superclass
typedef itk::SmartPointer< SelfPointer
typedef itk::SmartPointer
< const Self
ConstPointer

Public Member Functions

virtual const char * GetClassName () const
virtual void SetRepresentationToPoints ()
virtual void SetRepresentationToWireframe ()
virtual void SetRepresentationToSurface ()
virtual void SetRepresentationToVolume ()

Static Public Member Functions

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

Protected Member Functions

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

Detailed Description

Extends the enumeration prop mitkEnumerationPropery. Adds the value (constant/Id/string representation): POINTS/0/Points, WIREFRAME/1/Wireframe, SURFACE/2/Surface, VOLUME/3/Volume Default is the Wireframe representation

Definition at line 33 of file mitkGridRepresentationProperty.h.


Member Typedef Documentation

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkGridRepresentationProperty.h.

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkGridRepresentationProperty.h.

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkGridRepresentationProperty.h.

Reimplemented from mitk::EnumerationProperty.

Definition at line 39 of file mitkGridRepresentationProperty.h.


Member Enumeration Documentation

Enumerator:
POINTS 
WIREFRAME 
SURFACE 
VOLUME 

Definition at line 37 of file mitkGridRepresentationProperty.h.

{POINTS = 0, WIREFRAME = 1, SURFACE = 2, VOLUME = 3};

Constructor & Destructor Documentation

mitk::GridRepresentationProperty::GridRepresentationProperty (  ) [protected]

Constructor. Sets the representation to a default value of Wireframe(1)

Definition at line 23 of file mitkGridRepresentationProperty.cpp.

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

mitk::GridRepresentationProperty::GridRepresentationProperty ( const IdType value ) [protected]

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

Parameters:
valuethe integer representation of the representation

Definition at line 30 of file mitkGridRepresentationProperty.cpp.

{
  AddRepresentationTypes();
  if ( IsValidEnumerationValue( value ) )
  {
    SetValue( value );
  }
  else
  {
    SetValue( WIREFRAME );
  }
}
mitk::GridRepresentationProperty::GridRepresentationProperty ( const std::string &  value ) [protected]

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

Parameters:
valuethe string representation of the representation

Definition at line 44 of file mitkGridRepresentationProperty.cpp.

{
  AddRepresentationTypes();
  if ( IsValidEnumerationValue( value ) )
  {
    SetValue( value );
  }
  else
  {
    SetValue( WIREFRAME );
  }
}

Member Function Documentation

bool mitk::GridRepresentationProperty::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 89 of file mitkGridRepresentationProperty.cpp.

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

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

Definition at line 80 of file mitkGridRepresentationProperty.cpp.

Referenced by GridRepresentationProperty().

{
  AddEnum( "Points", POINTS );
  AddEnum( "Wireframe", WIREFRAME );
  AddEnum( "Surface", SURFACE );
  AddEnum( "Volume", VOLUME );
}
virtual const char* mitk::GridRepresentationProperty::GetClassName (  ) const [virtual]

Reimplemented from mitk::EnumerationProperty.

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

Definition at line 45 of file mitkGridRepresentationProperty.h.

:

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

Definition at line 43 of file mitkGridRepresentationProperty.h.

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

Sets the representation type to POINTS.

Definition at line 58 of file mitkGridRepresentationProperty.cpp.

{
  SetValue( POINTS );
}
void mitk::GridRepresentationProperty::SetRepresentationToSurface (  ) [virtual]

Sets the representation type to SURFACE.

Definition at line 70 of file mitkGridRepresentationProperty.cpp.

{
  SetValue( SURFACE );
}
void mitk::GridRepresentationProperty::SetRepresentationToVolume (  ) [virtual]

Sets the representation type to VOLUME.

Definition at line 75 of file mitkGridRepresentationProperty.cpp.

{
  SetValue( VOLUME );
}
void mitk::GridRepresentationProperty::SetRepresentationToWireframe (  ) [virtual]

Sets the representation type to WIREFRAME.

Definition at line 64 of file mitkGridRepresentationProperty.cpp.


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