VTK
vtkClipPolyData.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkClipPolyData.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
65 #ifndef vtkClipPolyData_h
66 #define vtkClipPolyData_h
67 
68 #include "vtkFiltersCoreModule.h" // For export macro
69 #include "vtkPolyDataAlgorithm.h"
70 
73 
74 class VTKFILTERSCORE_EXPORT vtkClipPolyData : public vtkPolyDataAlgorithm
75 {
76 public:
78  void PrintSelf(ostream& os, vtkIndent indent) override;
79 
85  static vtkClipPolyData *New();
86 
88 
93  vtkSetMacro(Value,double);
94  vtkGetMacro(Value,double);
96 
98 
106  vtkSetMacro(InsideOut,vtkTypeBool);
107  vtkGetMacro(InsideOut,vtkTypeBool);
108  vtkBooleanMacro(InsideOut,vtkTypeBool);
110 
112 
118  vtkGetObjectMacro(ClipFunction,vtkImplicitFunction);
120 
122 
129  vtkSetMacro(GenerateClipScalars,vtkTypeBool);
130  vtkGetMacro(GenerateClipScalars,vtkTypeBool);
131  vtkBooleanMacro(GenerateClipScalars,vtkTypeBool);
133 
135 
140  vtkSetMacro(GenerateClippedOutput,vtkTypeBool);
141  vtkGetMacro(GenerateClippedOutput,vtkTypeBool);
142  vtkBooleanMacro(GenerateClippedOutput,vtkTypeBool);
144 
149 
154  {
155  return this->GetOutputPort(1);
156  }
157 
159 
164  vtkGetObjectMacro(Locator,vtkIncrementalPointLocator);
166 
172 
176  vtkMTimeType GetMTime() override;
177 
179 
185  vtkSetMacro(OutputPointsPrecision,int);
186  vtkGetMacro(OutputPointsPrecision,int);
188 
189 protected:
191  ~vtkClipPolyData() override;
192 
195 
198  double Value;
202 
203 private:
204  vtkClipPolyData(const vtkClipPolyData&) = delete;
205  void operator=(const vtkClipPolyData&) = delete;
206 };
207 
208 #endif
vtkClipPolyData::GetClippedOutputPort
vtkAlgorithmOutput * GetClippedOutputPort()
Return the output port (a vtkAlgorithmOutput) of the clipped output.
Definition: vtkClipPolyData.h:153
vtkClipPolyData::~vtkClipPolyData
~vtkClipPolyData() override
vtkClipPolyData::Locator
vtkIncrementalPointLocator * Locator
Definition: vtkClipPolyData.h:196
vtkClipPolyData::GenerateClippedOutput
vtkTypeBool GenerateClippedOutput
Definition: vtkClipPolyData.h:200
vtkAlgorithm::GetOutputPort
vtkAlgorithmOutput * GetOutputPort()
Definition: vtkAlgorithm.h:460
vtkClipPolyData::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkClipPolyData::CreateDefaultLocator
void CreateDefaultLocator()
Create default locator.
vtkClipPolyData::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkClipPolyData::SetClipFunction
virtual void SetClipFunction(vtkImplicitFunction *)
Specify the implicit function with which to perform the clipping.
vtkPolyDataAlgorithm.h
vtkClipPolyData::GetMTime
vtkMTimeType GetMTime() override
Return the mtime also considering the locator and clip function.
vtkImplicitFunction
abstract interface for implicit functions
Definition: vtkImplicitFunction.h:61
vtkClipPolyData::New
static vtkClipPolyData * New()
Construct with user-specified implicit function; InsideOut turned off; value set to 0....
vtkClipPolyData::ClipFunction
vtkImplicitFunction * ClipFunction
Definition: vtkClipPolyData.h:194
vtkClipPolyData::SetLocator
void SetLocator(vtkIncrementalPointLocator *locator)
Specify a spatial locator for merging points.
vtkClipPolyData::vtkClipPolyData
vtkClipPolyData(vtkImplicitFunction *cf=nullptr)
vtkClipPolyData::GetClippedOutput
vtkPolyData * GetClippedOutput()
Return the Clipped output.
vtkClipPolyData::GenerateClipScalars
vtkTypeBool GenerateClipScalars
Definition: vtkClipPolyData.h:199
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkClipPolyData::InsideOut
vtkTypeBool InsideOut
Definition: vtkClipPolyData.h:197
vtkIncrementalPointLocator
Abstract class in support of both point location and point insertion.
Definition: vtkIncrementalPointLocator.h:52
vtkClipPolyData::Value
double Value
Definition: vtkClipPolyData.h:198
vtkClipPolyData::OutputPointsPrecision
int OutputPointsPrecision
Definition: vtkClipPolyData.h:201
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkClipPolyData
clip polygonal data with user-specified implicit function or input scalar data
Definition: vtkClipPolyData.h:75
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:40
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:45