mitkClippingProperty.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkClippingProperty_h
#define mitkClippingProperty_h
 
#include <mitkBaseProperty.h>
#include <mitkNumericTypes.h>
#include <MitkCoreExports.h>
 
#include <itkConfigure.h>
 
#include <string>
 
namespace mitk
{
  class MITKCORE_EXPORT ClippingProperty : public BaseProperty
  {
  public:
    mitkClassMacro(ClippingProperty, BaseProperty);
 
    typedef std::string ValueType;
 
    itkFactorylessNewMacro(Self);
 
    itkCloneMacro(Self)
      mitkNewMacro2Param(ClippingProperty, const Point3D &, const Vector3D &);
 
    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;
 
    bool ToJSON(nlohmann::json& j) const override;
 
    bool FromJSON(const nlohmann::json& j) override;
 
    using BaseProperty::operator=;
 
  protected:
    bool m_ClippingEnabled;
 
    Point3D m_Origin;
    Vector3D m_Normal;
 
    ClippingProperty();
    ClippingProperty(const ClippingProperty &other);
    ClippingProperty(const Point3D &origin, const Vector3D &normal);
 
    mitkCloneMacro(ClippingProperty);
 
  private:
    // purposely not implemented
    ClippingProperty &operator=(const ClippingProperty &);
 
    bool IsEqual(const BaseProperty &property) const override;
    bool Assign(const BaseProperty &property) override;
  };
 
 
} // namespace mitk
 
#endif