vtkCapsuleSource.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause AND Apache-2.0
 
#ifndef vtkCapsuleSource_h
#define vtkCapsuleSource_h
 
#include "vtkDeprecation.h"          // For deprecation macros
#include "vtkFiltersSourcesModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
 
#include "vtkSphereSource.h" // For VTK_MAX_SPHERE_RESOLUTION
 
VTK_ABI_NAMESPACE_BEGIN
class VTK_DEPRECATED_IN_9_3_0(
  "Use vtkCylinderSource with SetCapping(true) and SetCapsuleCap(true) instead of "
  "vtkCapsuleSource.") VTKFILTERSSOURCES_EXPORT vtkCapsuleSource : public vtkPolyDataAlgorithm
{
public:
  vtkTypeMacro(vtkCapsuleSource, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkCapsuleSource* New();


  vtkSetClampMacro(Radius, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(Radius, double);


  vtkSetVector3Macro(Center, double);
  vtkGetVectorMacro(Center, double, 3);


  vtkSetClampMacro(CylinderLength, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(CylinderLength, double);


  vtkSetClampMacro(ThetaResolution, int, 8, VTK_INT_MAX);
  vtkGetMacro(ThetaResolution, int);


  vtkSetClampMacro(PhiResolution, int, 8, VTK_INT_MAX);
  vtkGetMacro(PhiResolution, int);


  vtkSetMacro(LatLongTessellation, int);
  vtkGetMacro(LatLongTessellation, int);
  vtkBooleanMacro(LatLongTessellation, int);


  vtkSetMacro(OutputPointsPrecision, int);
  vtkGetMacro(OutputPointsPrecision, int);
 
protected:
  vtkCapsuleSource(int res = 8);
  ~vtkCapsuleSource() override = default;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  double Radius;
  double Center[3];
  int ThetaResolution;
  int PhiResolution;
  int LatLongTessellation;
  int FillPoles;
  double CylinderLength;
  int OutputPointsPrecision;
 
private:
  vtkCapsuleSource(const vtkCapsuleSource&) = delete;
  void operator=(const vtkCapsuleSource&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif