worklet/WarpVector.h

Go to the documentation of this file.

//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
 
#ifndef vtk_m_worklet_WarpVector_h
#define vtk_m_worklet_WarpVector_h
 
#include <vtkm/worklet/WorkletMapField.h>
 
namespace vtkm
{
namespace worklet
{
// A functor that modify points by moving points along a vector
// then timing a scale factor. It's a VTK-m version of the vtkWarpVector in VTK.
// Useful for showing flow profiles or mechanical deformation.
// This worklet does not modify the input points but generate new point coordinate
// instance that has been warped.
class WarpVector : public vtkm::worklet::WorkletMapField
{
public:
  using ControlSignature = void(FieldIn, FieldIn, FieldOut);
  using ExecutionSignature = _3(_1, _2);
  VTKM_CONT
  explicit WarpVector(vtkm::FloatDefault scale)
    : Scale(scale)
  {
  }
 
  VTKM_EXEC
  vtkm::Vec3f operator()(const vtkm::Vec3f& point, const vtkm::Vec3f& vector) const
  {
    return point + this->Scale * vector;
  }
 
  template <typename T>
  VTKM_EXEC vtkm::Vec<T, 3> operator()(const vtkm::Vec<T, 3>& point,
                                       const vtkm::Vec<T, 3>& vector) const
  {
    return point + static_cast<T>(this->Scale) * vector;
  }
 
 
private:
  vtkm::FloatDefault Scale;
};
}
} // namespace vtkm::worklet
 
#endif // vtk_m_worklet_WarpVector_h