vtkParametricMobius.h 3.27 KB
Newer Older
1 2 3 4 5
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkParametricMobius.h

6
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 8 9
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

10 11
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 13 14
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/**
 * @class   vtkParametricMobius
 * @brief   Generate a Mobius strip.
 *
 * vtkParametricMobius generates a Mobius strip.
 *
 * For further information about this surface, please consult the
 * technical description "Parametric surfaces" in http://www.vtk.org/publications
 * in the "VTK Technical Documents" section in the VTk.org web pages.
 *
 * @par Thanks:
 * Andrew Maclean andrew.amaclean@gmail.com for creating and contributing the
 * class.
 *
*/

31 32
#ifndef vtkParametricMobius_h
#define vtkParametricMobius_h
33

34
#include "vtkCommonComputationalGeometryModule.h" // For export macro
35 36
#include "vtkParametricFunction.h"

37 38
class VTKCOMMONCOMPUTATIONALGEOMETRY_EXPORT vtkParametricMobius : public
  vtkParametricFunction
39
{
40 41
  public:
    vtkTypeMacro(vtkParametricMobius, vtkParametricFunction);
42
    void PrintSelf(ostream& os, vtkIndent indent) override;
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66

    /**
     * Construct a Mobius strip with the following parameters:
     * MinimumU = 0, MaximumU = 2*Pi,
     * MinimumV = -1, MaximumV = 1,
     * JoinU = 1, JoinV = 0,
     * TwistU = 0, TwistV = 0,
     * ClockwiseOrdering = 0,
     * DerivativesAvailable = 1,
     * Radius = 1.
     */
    static vtkParametricMobius *New();

    //@{
    /**
     * Set/Get the radius of the Mobius strip. Default is 1.
     */
    vtkSetMacro(Radius, double);
    vtkGetMacro(Radius, double);
    //@}

    /**
     * Return the parametric dimension of the class.
     */
67
    int GetDimension() override {return 2;}
68 69 70 71 72 73 74 75 76

    /**
     * The Mobius strip.

     * This function performs the mapping \f$f(u,v) \rightarrow (x,y,x)\f$, returning it
     * as Pt. It also returns the partial derivatives Du and Dv.
     * \f$Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv)\f$ .
     * Then the normal is \f$N = Du X Dv\f$ .
     */
77
    void Evaluate(double uvw[3], double Pt[3], double Duvw[9]) override;
78 79 80 81

    /**
     * Calculate a user defined scalar using one or all of uvw, Pt, Duvw.

luz.paz's avatar
luz.paz committed
82
     * uvw are the parameters with Pt being the cartesian point,
83 84 85 86 87 88 89 90 91 92
     * Duvw are the derivatives of this point with respect to u, v and w.
     * Pt, Du, Dv are obtained from Evaluate().

     * This function is only called if the ScalarMode has the value
     * vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED

     * If the user does not need to calculate a scalar, then the
     * instantiated function should return zero.
     */
    double EvaluateScalar(double uvw[3], double Pt[3],
93
                          double Duvw[9]) override;
94 95 96

  protected:
    vtkParametricMobius();
97
    ~vtkParametricMobius() override;
98 99 100 101 102

    // Variables
    double Radius;

  private:
103 104
    vtkParametricMobius(const vtkParametricMobius&) = delete;
    void operator=(const vtkParametricMobius&) = delete;
105 106 107
};

#endif