/usr/include/vtk-5.8/vtkClipDataSet.h is in libvtk5-dev 5.8.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 | /*=========================================================================
Program: Visualization Toolkit
Module: vtkClipDataSet.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 vtkClipDataSet - clip any dataset with user-specified implicit function or input scalar data
// .SECTION Description
// vtkClipDataSet is a filter that clips any type of dataset using either
// any subclass of vtkImplicitFunction, or the input scalar
// data. Clipping means that it actually "cuts" through the cells of
// the dataset, returning everything inside of the specified implicit
// function (or greater than the scalar value) including "pieces" of
// a cell. (Compare this with vtkExtractGeometry, which pulls out
// entire, uncut cells.) The output of this filter is an unstructured
// grid.
//
// To use this filter, you must decide if you will be clipping with an
// implicit function, or whether you will be using the input scalar
// data. If you want to clip with an implicit function, you must:
// 1) define an implicit function
// 2) set it with the SetClipFunction method
// 3) apply the GenerateClipScalarsOn method
// If a ClipFunction is not specified, or GenerateClipScalars is off
// (the default), then the input's scalar data will be used to clip
// the polydata.
//
// You can also specify a scalar value, which is used to decide what is
// inside and outside of the implicit function. You can also reverse the
// sense of what inside/outside is by setting the InsideOut instance
// variable. (The clipping algorithm proceeds by computing an implicit
// function value or using the input scalar data for each point in the
// dataset. This is compared to the scalar value to determine
// inside/outside.)
//
// This filter can be configured to compute a second output. The
// second output is the part of the cell that is clipped away. Set the
// GenerateClippedData boolean on if you wish to access this output data.
// .SECTION Caveats
// vtkClipDataSet will triangulate all types of 3D cells (i.e., create
// tetrahedra). This is true even if the cell is not actually cut. This
// is necessary to preserve compatibility across face neighbors. 2D cells
// will only be triangulated if the cutting function passes through them.
// .SECTION See Also
// vtkImplicitFunction vtkCutter vtkClipVolume vtkClipPolyData
#ifndef __vtkClipDataSet_h
#define __vtkClipDataSet_h
#include "vtkUnstructuredGridAlgorithm.h"
class vtkCallbackCommand;
class vtkImplicitFunction;
class vtkIncrementalPointLocator;
class VTK_GRAPHICS_EXPORT vtkClipDataSet : public vtkUnstructuredGridAlgorithm
{
public:
vtkTypeMacro(vtkClipDataSet,vtkUnstructuredGridAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Construct with user-specified implicit function; InsideOut turned off;
// value set to 0.0; and generate clip scalars turned off.
static vtkClipDataSet *New();
// Description:
// Set the clipping value of the implicit function (if clipping with
// implicit function) or scalar value (if clipping with
// scalars). The default value is 0.0. This value is ignored if
// UseValueAsOffset is true and a clip function is defined.
vtkSetMacro(Value,double);
vtkGetMacro(Value,double);
// Description:
// If UseValueAsOffset is true, Value is used as an offset parameter to
// the implicit function. Otherwise, Value is used only when clipping
// using a scalar array. Default is true.
vtkSetMacro(UseValueAsOffset, bool);
vtkGetMacro(UseValueAsOffset, bool);
vtkBooleanMacro(UseValueAsOffset, bool);
// Description:
// Set/Get the InsideOut flag. When off, a vertex is considered
// inside the implicit function if its value is greater than the
// Value ivar. When InsideOutside is turned on, a vertex is
// considered inside the implicit function if its implicit function
// value is less than or equal to the Value ivar. InsideOut is off
// by default.
vtkSetMacro(InsideOut,int);
vtkGetMacro(InsideOut,int);
vtkBooleanMacro(InsideOut,int);
// Description
// Specify the implicit function with which to perform the
// clipping. If you do not define an implicit function,
// then the selected input scalar data will be used for clipping.
virtual void SetClipFunction(vtkImplicitFunction*);
vtkGetObjectMacro(ClipFunction,vtkImplicitFunction);
// Description:
// If this flag is enabled, then the output scalar values will be
// interpolated from the implicit function values, and not the
// input scalar data. If you enable this flag but do not provide an
// implicit function an error will be reported.
vtkSetMacro(GenerateClipScalars,int);
vtkGetMacro(GenerateClipScalars,int);
vtkBooleanMacro(GenerateClipScalars,int);
// Description:
// Control whether a second output is generated. The second output
// contains the polygonal data that's been clipped away.
vtkSetMacro(GenerateClippedOutput,int);
vtkGetMacro(GenerateClippedOutput,int);
vtkBooleanMacro(GenerateClippedOutput,int);
// Description:
// Set the tolerance for merging clip intersection points that are near
// the vertices of cells. This tolerance is used to prevent the generation
// of degenerate primitives. Note that only 3D cells actually use this
// instance variable.
vtkSetClampMacro(MergeTolerance,double,0.0001,0.25);
vtkGetMacro(MergeTolerance,double);
// Description:
// Return the Clipped output.
vtkUnstructuredGrid *GetClippedOutput();
// Description:
// Specify a spatial locator for merging points. By default, an
// instance of vtkMergePoints is used.
void SetLocator(vtkIncrementalPointLocator *locator);
vtkGetObjectMacro(Locator,vtkIncrementalPointLocator);
// Description:
// Create default locator. Used to create one when none is specified. The
// locator is used to merge coincident points.
void CreateDefaultLocator();
// Description:
// Return the mtime also considering the locator and clip function.
unsigned long GetMTime();
protected:
vtkClipDataSet(vtkImplicitFunction *cf=NULL);
~vtkClipDataSet();
// Description:
// Overridden to process REQUEST_UPDATE_EXTENT_INFORMATION.
virtual int ProcessRequest(vtkInformation*,
vtkInformationVector**,
vtkInformationVector*);
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
virtual int FillInputPortInformation(int port, vtkInformation *info);
vtkImplicitFunction *ClipFunction;
vtkIncrementalPointLocator *Locator;
int InsideOut;
double Value;
int GenerateClipScalars;
int GenerateClippedOutput;
double MergeTolerance;
// Callback registered with the InternalProgressObserver.
static void InternalProgressCallbackFunction(vtkObject*, unsigned long,
void* clientdata, void*);
void InternalProgressCallback(vtkAlgorithm *algorithm);
// The observer to report progress from the internal readers.
vtkCallbackCommand* InternalProgressObserver;
//helper functions
void ClipVolume(vtkDataSet *input, vtkUnstructuredGrid *output);
int ClipPoints(vtkDataSet* input, vtkUnstructuredGrid* output,
vtkInformationVector** inputVector);
bool UseValueAsOffset;
private:
vtkClipDataSet(const vtkClipDataSet&); // Not implemented.
void operator=(const vtkClipDataSet&); // Not implemented.
};
#endif
|