VTK  9.3.20240422
vtkmClip.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright (c) Kitware, Inc.
3// SPDX-FileCopyrightText: Copyright 2012 Sandia Corporation.
4// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
14#ifndef vtkmClip_h
15#define vtkmClip_h
16
17#include "vtkAcceleratorsVTKmFiltersModule.h" // For export macro
18#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_3_0
20
21#include "vtkmlib/vtkmInitializer.h" // Need for initializing vtk-m
22
23#include <memory> // For std::unique_ptr
24
25VTK_ABI_NAMESPACE_BEGIN
27
28class VTKACCELERATORSVTKMFILTERS_EXPORT vtkmClip : public vtkTableBasedClipDataSet
29{
30public:
31 static vtkmClip* New();
33 void PrintSelf(ostream& os, vtkIndent indent) override;
34
39 VTK_DEPRECATED_IN_9_3_0("Please use GetValue instead.")
40 double GetClipValue() { return this->GetValue(); }
41
42 VTK_DEPRECATED_IN_9_3_0("Please use SetValue instead.")
43 void SetClipValue(double v) { this->SetValue(v); }
44
49 vtkGetMacro(ComputeScalars, bool);
50 vtkSetMacro(ComputeScalars, bool);
51 vtkBooleanMacro(ComputeScalars, bool);
52
54
60 vtkGetMacro(ForceVTKm, vtkTypeBool);
61 vtkSetMacro(ForceVTKm, vtkTypeBool);
62 vtkBooleanMacro(ForceVTKm, vtkTypeBool);
64
65protected:
67 ~vtkmClip() override;
68
70
71 vtkTypeBool ForceVTKm = false;
72 bool ComputeScalars = true;
73
74 struct internals;
75
76private:
77 vtkmClip(const vtkmClip&) = delete;
78 void operator=(const vtkmClip&) = delete;
79 vtkmInitializer Initializer;
80};
81
82VTK_ABI_NAMESPACE_END
83#endif // vtkmClip_h
abstract interface for implicit functions
a simple class to control print indentation
Definition vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Clip any dataset with a user-specified implicit function or an input scalar point data array.
virtual void SetValue(double)
Set/Get the clipping value of the implicit function (if an implicit function is applied) or scalar da...
virtual double GetValue()
Set/Get the clipping value of the implicit function (if an implicit function is applied) or scalar da...
Clip a dataset using the accelerated vtk-m Clip filter.
Definition vtkmClip.h:29
static vtkmClip * New()
~vtkmClip() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_DEPRECATED_IN_9_3_0(reason)