mitk::ClippingProperty Class Reference

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

#include <mitkClippingProperty.h>

Inheritance diagram for mitk::ClippingProperty:

Collaboration diagram for mitk::ClippingProperty:

Public Types
typedef ClippingProperty	Self
typedef BaseProperty	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef std::string	ValueType
Public Types inherited from mitk::BaseProperty
typedef BaseProperty	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const override
virtual const char *	GetClassName () const
Pointer	Clone () 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)
std::string	GetValueAsString () const override
BaseProperty &	operator= (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...
Public Member Functions inherited from mitk::BaseProperty
Pointer	Clone () const
bool	operator== (const BaseProperty &property) const
	Subclasses must implement IsEqual(const BaseProperty&) to support comparison. More...
BaseProperty &	operator= (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...
bool	AssignProperty (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...

Static Public Member Functions
static const char *	GetStaticNameOfClass ()
static Pointer	New ()
static Pointer	New (const Point3D &_arga, const Vector3D &_argb)
Static Public Member Functions inherited from mitk::BaseProperty
static const char *	GetStaticNameOfClass ()

Protected Member Functions
	ClippingProperty ()
	ClippingProperty (const ClippingProperty &other)
	ClippingProperty (const Point3D &origin, const Vector3D &normal)
Protected Member Functions inherited from mitk::BaseProperty
	BaseProperty ()
	BaseProperty (const BaseProperty &other)
	~BaseProperty () override

Protected Attributes
bool	m_ClippingEnabled
Point3D	m_Origin
Vector3D	m_Normal

Additional Inherited Members
Static Public Attributes inherited from mitk::BaseProperty
static const std::string	VALUE_CANNOT_BE_CONVERTED_TO_STRING
	Default return value if a property which can not be returned as string. More...

Detailed Description

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

Definition at line 36 of file mitkClippingProperty.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 39 of file mitkClippingProperty.h.

Pointer

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

Definition at line 39 of file mitkClippingProperty.h.

Self

typedef ClippingProperty mitk::ClippingProperty::Self

Definition at line 39 of file mitkClippingProperty.h.

Superclass

typedef BaseProperty mitk::ClippingProperty::Superclass

Definition at line 39 of file mitkClippingProperty.h.

ValueType

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

Definition at line 39 of file mitkClippingProperty.h.

Constructor & Destructor Documentation

ClippingProperty() [1/3]

mitk::ClippingProperty::ClippingProperty ( )

protected

ClippingProperty() [2/3]

mitk::ClippingProperty::ClippingProperty ( const ClippingProperty &  other )

protected

ClippingProperty() [3/3]

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

protected

Member Function Documentation

Clone()

Pointer mitk::ClippingProperty::Clone

(

)

const

GetClassHierarchy()

virtual std::vector<std::string> mitk::ClippingProperty::GetClassHierarchy ( ) const

inlineoverridevirtual

Reimplemented from mitk::BaseProperty.

Definition at line 39 of file mitkClippingProperty.h.

GetClassName()

virtual const char* mitk::ClippingProperty::GetClassName ( ) const

virtual

Reimplemented from mitk::BaseProperty.

GetClippingEnabled()

bool mitk::ClippingProperty::GetClippingEnabled

(

)

const

GetNormal()

const Vector3D& mitk::ClippingProperty::GetNormal

(

)

const

GetOrigin()

const Point3D& mitk::ClippingProperty::GetOrigin

(

)

const

GetStaticNameOfClass()

static const char* mitk::ClippingProperty::GetStaticNameOfClass ( )

inlinestatic

Definition at line 39 of file mitkClippingProperty.h.

GetValueAsString()

std::string mitk::ClippingProperty::GetValueAsString ( ) const

overridevirtual

Reimplemented from mitk::BaseProperty.

New() [1/2]

static Pointer mitk::ClippingProperty::New ( )

static

New() [2/2]

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

inlinestatic

Definition at line 46 of file mitkClippingProperty.h.

operator=()

BaseProperty& mitk::BaseProperty::operator=

Assigns property to this BaseProperty instance.

Subclasses must implement Assign(const BaseProperty&) and call the superclass Assign method for proper handling of polymorphic assignments. The assignment operator of the subclass should be disabled and the baseclass operator should be made visible using "using" statements.

SetClippingEnabled()

void mitk::ClippingProperty::SetClippingEnabled

(

bool

enabled

)

SetNormal()

void mitk::ClippingProperty::SetNormal

(

const Vector3D &

normal

)

SetOrigin()

void mitk::ClippingProperty::SetOrigin

(

const Point3D &

origin

)

Member Data Documentation

m_ClippingEnabled

bool mitk::ClippingProperty::m_ClippingEnabled

protected

Definition at line 62 of file mitkClippingProperty.h.

m_Normal

Vector3D mitk::ClippingProperty::m_Normal

protected

Definition at line 65 of file mitkClippingProperty.h.

m_Origin

Point3D mitk::ClippingProperty::m_Origin

protected

Definition at line 64 of file mitkClippingProperty.h.

---

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

• mitkClippingProperty.h