File: vtkImplicitHalo.h

package info (click to toggle)
vtk6 6.3.0%2Bdfsg2-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 118,880 kB
  • sloc: cpp: 1,442,792; ansic: 113,395; python: 72,383; tcl: 46,998; xml: 8,119; yacc: 4,525; java: 4,239; perl: 3,108; lex: 1,694; sh: 1,093; asm: 154; makefile: 103; objc: 17
file content (85 lines) | stat: -rw-r--r-- 2,658 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkImplicitHalo.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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.

=========================================================================*/
// .NAME vtkImplicitHalo - implicit function for an halo
// .SECTION Description
// vtkImplicitHalo evaluates to 1.0 for each position in the sphere of a
// given center and radius Radius*(1-FadeOut). It evaluates to 0.0 for each
// position out the sphere of a given Center and radius Radius. It fades out
// linearly from 1.0 to 0.0 for points in a radius from Radius*(1-FadeOut) to
// Radius.
// vtkImplicitHalo is a concrete implementation of vtkImplicitFunction.
// It is useful as an input to
// vtkSampleFunction to generate an 2D image of an halo. It is used this way by
// vtkShadowMapPass.
// .SECTION Caveats
// It does not implement the gradient.

#ifndef vtkImplicitHalo_h
#define vtkImplicitHalo_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkImplicitFunction.h"

class VTKCOMMONDATAMODEL_EXPORT vtkImplicitHalo : public vtkImplicitFunction
{
public:
  // Description
  // Center=(0.0,0.0,0.0), Radius=1.0, FadeOut=0.01
  static vtkImplicitHalo *New();

  vtkTypeMacro(vtkImplicitHalo,vtkImplicitFunction);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description
  // Evaluate the equation.
  virtual double EvaluateFunction(double x[3]);
  virtual double EvaluateFunction(double x, double y, double z)
    {
      return this->vtkImplicitFunction::EvaluateFunction(x, y, z);
    }

  // Description
  // Evaluate normal. Not implemented.
  void EvaluateGradient(double x[3], double g[3]);

  // Description:
  // Radius of the sphere.
  vtkSetMacro(Radius,double);
  vtkGetMacro(Radius,double);

  // Description:
  // Center of the sphere.
  vtkSetVector3Macro(Center,double);
  vtkGetVector3Macro(Center,double);

  // Description:
  // FadeOut ratio. Valid values are between 0.0 and 1.0.
  vtkSetMacro(FadeOut,double);
  vtkGetMacro(FadeOut,double);

protected:
  vtkImplicitHalo();
  virtual ~vtkImplicitHalo();

  double Radius;
  double Center[3];
  double FadeOut;

private:
  vtkImplicitHalo(const vtkImplicitHalo&); // Not implemented.
  void operator=(const vtkImplicitHalo&); // Not implemented.
};

#endif