itkArrowSpatialObject.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 itkArrowSpatialObject_h
#define itkArrowSpatialObject_h
 
#include "itkSpatialObject.h"
 
namespace itk
{
 
template <unsigned int TDimension = 3>
class ITK_TEMPLATE_EXPORT ArrowSpatialObject : public SpatialObject<TDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ArrowSpatialObject);
 
  using Self = ArrowSpatialObject;
  using Superclass = SpatialObject<TDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using ScalarType = double;
  using VectorType = Vector<double, TDimension>;
  using PointType = Point<double, TDimension>;
  using typename Superclass::TransformType;
  using MatrixType = typename TransformType::MatrixType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ArrowSpatialObject);

  void
  Clear() override;

  itkSetMacro(PositionInObjectSpace, PointType);

  itkGetConstMacro(PositionInObjectSpace, PointType);

  itkSetMacro(DirectionInObjectSpace, VectorType);

  itkGetConstMacro(DirectionInObjectSpace, VectorType);

  itkSetMacro(LengthInObjectSpace, double);

  itkGetConstReferenceMacro(LengthInObjectSpace, double);

  bool
  IsInsideInObjectSpace(const PointType & point) const override;
 
  /* Avoid hiding the overload that supports depth and name arguments */
  using Superclass::IsInsideInObjectSpace;
 
  PointType
  GetPositionInWorldSpace() const;
  VectorType
  GetDirectionInWorldSpace() const;
  double
  GetLengthInWorldSpace() const;
 
protected:
  void
  ComputeMyBoundingBox() override;
 
  ArrowSpatialObject();
  ~ArrowSpatialObject() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  typename LightObject::Pointer
  InternalClone() const override;
 
private:
  VectorType m_DirectionInObjectSpace{};
  PointType  m_PositionInObjectSpace{};
  double     m_LengthInObjectSpace{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkArrowSpatialObject.hxx"
#endif
 
#endif // itkArrowSpatialObject_h