mitk::ClippingProperty Class Reference [Data Management Classes]

Property for clipping datasets; currently only clipping planes are possible. More...

#include <mitkClippingProperty.h>

Inheritance diagram for mitk::ClippingProperty:

Collaboration diagram for mitk::ClippingProperty:

List of all members.

Public Types
typedef ClippingProperty	Self
typedef BaseProperty	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef std::string	ValueType
Public Member Functions
virtual const char *	GetClassName () const
bool	GetClippingEnabled () const
void	SetClippingEnabled (bool enabled)
const Point3D &	GetOrigin () const
void	SetOrigin (const Point3D &origin)
const Vector3D &	GetNormal () const
void	SetNormal (const Vector3D &normal)
virtual bool	operator== (const BaseProperty &property) const
	Subclasses must implement this operator==. Operator== which is used by PropertyList to check whether a property has been changed.
virtual std::string	GetValueAsString () const
Static Public Member Functions
static Pointer	New ()
static Pointer	New (const Point3D &_arga, const Vector3D &_argb)
Protected Member Functions
	ClippingProperty ()
	ClippingProperty (const Point3D &origin, const Vector3D &normal)
Protected Attributes
bool	m_ClippingEnabled
Point3D	m_Origin
Vector3D	m_Normal

---

Detailed Description

Property for clipping datasets; currently only clipping planes are possible.

Definition at line 38 of file mitkClippingProperty.h.

---

Member Typedef Documentation

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

Reimplemented from mitk::BaseProperty.

Definition at line 41 of file mitkClippingProperty.h.

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

Reimplemented from mitk::BaseProperty.

Definition at line 41 of file mitkClippingProperty.h.

typedef ClippingProperty mitk::ClippingProperty::Self

Reimplemented from mitk::BaseProperty.

Definition at line 41 of file mitkClippingProperty.h.

typedef BaseProperty mitk::ClippingProperty::Superclass

Reimplemented from mitk::BaseProperty.

Definition at line 41 of file mitkClippingProperty.h.

typedef std::string mitk::ClippingProperty::ValueType

Definition at line 41 of file mitkClippingProperty.h.

---

Constructor & Destructor Documentation

mitk::ClippingProperty::ClippingProperty

(

)

[protected]

Definition at line 22 of file mitkClippingProperty.cpp.

{

ClippingProperty::ClippingProperty()

mitk::ClippingProperty::ClippingProperty	(	const Point3D &	origin,
		const Vector3D &	normal
	)		[protected]

Definition at line 28 of file mitkClippingProperty.cpp.

: m_ClippingEnabled( true ),
  m_Origin( origin ),

---

Member Function Documentation

virtual const char* mitk::ClippingProperty::GetClassName

(

)

const [virtual]

Reimplemented from mitk::BaseProperty.

bool mitk::ClippingProperty::GetClippingEnabled

(

)

const

Definition at line 37 of file mitkClippingProperty.cpp.

Referenced by mitk::SurfaceVtkMapper3D::CheckForClippingProperty().

{

const Vector3D & mitk::ClippingProperty::GetNormal

(

)

const

Definition at line 61 of file mitkClippingProperty.cpp.

Referenced by mitk::SurfaceVtkMapper3D::CheckForClippingProperty().

{

const Point3D & mitk::ClippingProperty::GetOrigin

(

)

const

Definition at line 49 of file mitkClippingProperty.cpp.

Referenced by mitk::SurfaceVtkMapper3D::CheckForClippingProperty().

{

std::string mitk::ClippingProperty::GetValueAsString

(

)

const [virtual]

Reimplemented from mitk::BaseProperty.

Definition at line 84 of file mitkClippingProperty.cpp.

{
  std::stringstream myStr;

static Pointer mitk::ClippingProperty::New

(

)

[static]

Referenced by mitk::ClippingPropertyDeserializer::Deserialize(), and mitkPropertySerializationTest().

static Pointer mitk::ClippingProperty::New	(	const Point3D &	_arga,
		const Vector3D &	_argb
	)		[inline, static]

Definition at line 46 of file mitkClippingProperty.h.

bool mitk::ClippingProperty::operator==

(

const BaseProperty &

property )

const [virtual]

Subclasses must implement this operator==. Operator== which is used by PropertyList to check whether a property has been changed.

Implements mitk::BaseProperty.

Definition at line 73 of file mitkClippingProperty.cpp.

{  
  const Self *other = dynamic_cast< const Self * >( &property );

  if ( other == NULL ) return false;

void mitk::ClippingProperty::SetClippingEnabled

(

bool

enabled )

Definition at line 43 of file mitkClippingProperty.cpp.

{

void mitk::ClippingProperty::SetNormal

(

const Vector3D &

normal )

Definition at line 67 of file mitkClippingProperty.cpp.

{

void mitk::ClippingProperty::SetOrigin

(

const Point3D &

origin )

Definition at line 55 of file mitkClippingProperty.cpp.

{

---

Member Data Documentation

bool mitk::ClippingProperty::m_ClippingEnabled [protected]

Definition at line 63 of file mitkClippingProperty.h.

Vector3D mitk::ClippingProperty::m_Normal [protected]

Definition at line 66 of file mitkClippingProperty.h.

Point3D mitk::ClippingProperty::m_Origin [protected]

Definition at line 65 of file mitkClippingProperty.h.

---

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

• mitkClippingProperty.h
• mitkClippingProperty.cpp