itkTubeSpatialObject.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkTubeSpatialObject_h
#define itkTubeSpatialObject_h
 
#include <list>
 
#include "itkPointBasedSpatialObject.h"
#include "itkTubeSpatialObjectPoint.h"
 
namespace itk
{
 
template <unsigned int TDimension = 3, class TSpatialObjectPointType = TubeSpatialObjectPoint<TDimension>>
class ITK_TEMPLATE_EXPORT TubeSpatialObject : public PointBasedSpatialObject<TDimension, TSpatialObjectPointType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(TubeSpatialObject);
 
  using Self = TubeSpatialObject;
  using Superclass = PointBasedSpatialObject<TDimension, TSpatialObjectPointType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using ScalarType = double;
 
  using TubePointType = TSpatialObjectPointType;
  using TubePointListType = std::vector<TubePointType>;
 
  using typename Superclass::PointType;
  using typename Superclass::TransformType;
  using typename Superclass::SpatialObjectPointType;
  using PointContainerType = VectorContainer<PointType>;
  using PointContainerPointer = SmartPointer<PointContainerType>;
  using typename Superclass::VectorType;
  using typename Superclass::CovariantVectorType;
  using typename Superclass::BoundingBoxType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(TubeSpatialObject);

  void
  Clear() override;

  itkSetMacro(EndRounded, bool);
  itkGetConstMacro(EndRounded, bool);
  itkBooleanMacro(EndRounded);

  bool
  ComputeTangentsAndNormals();
 
#if !defined(ITK_LEGACY_REMOVE)
  itkLegacyMacro(bool ComputeTangentAndNormals())
  {
    return ComputeTangentsAndNormals();
  }
#endif

  unsigned int
  RemoveDuplicatePointsInObjectSpace(double minSpacingInObjectSpace = 0);

  itkSetMacro(ParentPoint, int);

  itkGetConstMacro(ParentPoint, int);

  itkSetMacro(Root, bool);

  itkGetConstMacro(Root, bool);
 
  itkBooleanMacro(Root);

  bool
  IsInsideInObjectSpace(const PointType & point) const override;
 
  /* Avoid hiding the overload that supports depth and name arguments */
  using Superclass::IsInsideInObjectSpace;

  void
  CopyInformation(const DataObject * data) override;
 
protected:
  void
  ComputeMyBoundingBox() override;
 
  TubeSpatialObject();
  ~TubeSpatialObject() override = default;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  typename LightObject::Pointer
  InternalClone() const override;
 
private:
  int  m_ParentPoint{};
  bool m_EndRounded{};
  bool m_Root{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkTubeSpatialObject.hxx"
#endif
 
#endif // itkTubeSpatialObject_h