VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkClipClosedSurface Class Reference

Clip a closed surface with a plane collection. More...

#include <vtkClipClosedSurface.h>

Inherits vtkPolyDataAlgorithm.

Public Types

typedef vtkPolyDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkClipClosedSurfaceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetClippingPlanes (vtkPlaneCollection *planes)
 
virtual vtkPlaneCollection * GetClippingPlanes ()
 
virtual void SetTolerance (double)
 
virtual double GetTolerance ()
 
virtual void SetPassPointData (int)
 
virtual void PassPointDataOn ()
 
virtual void PassPointDataOff ()
 
virtual int GetPassPointData ()
 
virtual void SetGenerateOutline (int)
 
virtual void GenerateOutlineOn ()
 
virtual void GenerateOutlineOff ()
 
virtual int GetGenerateOutline ()
 
virtual void SetGenerateFaces (int)
 
virtual void GenerateFacesOn ()
 
virtual void GenerateFacesOff ()
 
virtual int GetGenerateFaces ()
 
virtual void SetScalarMode (int)
 
void SetScalarModeToNone ()
 
void SetScalarModeToColors ()
 
void SetScalarModeToLabels ()
 
virtual int GetScalarMode ()
 
const char * GetScalarModeAsString ()
 
virtual void SetBaseColor (double, double, double)
 
virtual void SetBaseColor (double[3])
 
virtual double * GetBaseColor ()
 
virtual void GetBaseColor (double &, double &, double &)
 
virtual void GetBaseColor (double[3])
 
virtual void SetClipColor (double, double, double)
 
virtual void SetClipColor (double[3])
 
virtual double * GetClipColor ()
 
virtual void GetClipColor (double &, double &, double &)
 
virtual void GetClipColor (double[3])
 
virtual void SetActivePlaneId (int)
 
virtual int GetActivePlaneId ()
 
virtual void SetActivePlaneColor (double, double, double)
 
virtual void SetActivePlaneColor (double[3])
 
virtual double * GetActivePlaneColor ()
 
virtual void GetActivePlaneColor (double &, double &, double &)
 
virtual void GetActivePlaneColor (double[3])
 
virtual void SetTriangulationErrorDisplay (int)
 
virtual void TriangulationErrorDisplayOn ()
 
virtual void TriangulationErrorDisplayOff ()
 
virtual int GetTriangulationErrorDisplay ()
 

Static Public Member Functions

static vtkClipClosedSurfaceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkClipClosedSurfaceSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkClipClosedSurface ()
 
 ~vtkClipClosedSurface ()
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, int requestFromOutputPort, unsigned long *mtime)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
void ClipLines (vtkPoints *points, vtkDoubleArray *pointScalars, vtkPointData *pointData, vtkCCSEdgeLocator *edgeLocator, vtkCellArray *inputCells, vtkCellArray *outputLines, vtkCellData *inCellData, vtkCellData *outLineData)
 
void ClipAndContourPolys (vtkPoints *points, vtkDoubleArray *pointScalars, vtkPointData *pointData, vtkCCSEdgeLocator *edgeLocator, int triangulate, vtkCellArray *inputCells, vtkCellArray *outputPolys, vtkCellArray *outputLines, vtkCellData *inPolyData, vtkCellData *outPolyData, vtkCellData *outLineData)
 
int TriangulatePolygon (vtkIdList *polygon, vtkPoints *points, vtkCellArray *triangles)
 
void TriangulateContours (vtkPolyData *data, vtkIdType firstLine, vtkIdType numLines, vtkCellArray *outputPolys, const double normal[3])
 

Static Protected Member Functions

static int InterpolateEdge (vtkPoints *points, vtkPointData *pointData, vtkCCSEdgeLocator *edgeLocator, double tol, vtkIdType i0, vtkIdType i1, double v0, double v1, vtkIdType &i)
 
static void BreakPolylines (vtkCellArray *inputLines, vtkCellArray *outputLines, vtkUnsignedCharArray *inputScalars, vtkIdType firstLineScalar, vtkUnsignedCharArray *outputScalars, const unsigned char color[3])
 
static void CopyPolygons (vtkCellArray *inputPolys, vtkCellArray *outputPolys, vtkUnsignedCharArray *inputScalars, vtkIdType firstPolyScalar, vtkUnsignedCharArray *outputScalars, const unsigned char color[3])
 
static void BreakTriangleStrips (vtkCellArray *inputStrips, vtkCellArray *outputPolys, vtkUnsignedCharArray *inputScalars, vtkIdType firstStripScalar, vtkUnsignedCharArray *outputScalars, const unsigned char color[3])
 
static void SqueezeOutputPoints (vtkPolyData *output, vtkPoints *points, vtkPointData *pointData, int outputPointDataType)
 
static void CreateColorValues (const double color1[3], const double color2[3], const double color3[3], unsigned char colors[3][3])
 

Protected Attributes

vtkPlaneCollection * ClippingPlanes
 
double Tolerance
 
int PassPointData
 
int GenerateOutline
 
int GenerateFaces
 
int ActivePlaneId
 
int ScalarMode
 
double BaseColor [3]
 
double ClipColor [3]
 
double ActivePlaneColor [3]
 
int TriangulationErrorDisplay
 
vtkIdList * IdList
 

Detailed Description

Clip a closed surface with a plane collection.

vtkClipClosedSurface will clip a closed polydata surface with a collection of clipping planes. It will produce a new closed surface by creating new polygonal faces where the input data was clipped. If GenerateOutline is on, it will also generate an outline wherever the clipping planes intersect the data. The ScalarMode option will add cell scalars to the output, so that the generated faces can be visualized in a different color from the original surface.

Warning
The triangulation of new faces is done in O(n) time for simple convex inputs, but for non-convex inputs the worst-case time is O(n^2*m^2) where n is the number of points and m is the number of 3D cavities. The best triangulation algorithms, in contrast, are O(n log n). There are also rare cases where the triangulation will fail to produce a watertight output. Turn on TriangulationErrorDisplay to be notified of these failures.
See Also
vtkOutlineFilter vtkOutlineSource vtkVolumeOutlineSource
Thanks:
Thanks to David Gobbi for contributing this class to VTK.
Tests:
vtkClipClosedSurface (Tests)

Definition at line 65 of file vtkClipClosedSurface.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkClipClosedSurface::Superclass

Definition at line 69 of file vtkClipClosedSurface.h.

Constructor & Destructor Documentation

vtkClipClosedSurface::vtkClipClosedSurface ( )
protected
vtkClipClosedSurface::~vtkClipClosedSurface ( )
protected

Member Function Documentation

static vtkClipClosedSurface* vtkClipClosedSurface::New ( )
static
static int vtkClipClosedSurface::IsTypeOf ( const char *  type)
static
virtual int vtkClipClosedSurface::IsA ( const char *  type)
virtual
static vtkClipClosedSurface* vtkClipClosedSurface::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkClipClosedSurface::NewInstanceInternal ( ) const
protectedvirtual
vtkClipClosedSurface* vtkClipClosedSurface::NewInstance ( ) const
void vtkClipClosedSurface::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkClipClosedSurface::SetClippingPlanes ( vtkPlaneCollection *  planes)
virtual

Set the vtkPlaneCollection that holds the clipping planes.

virtual vtkPlaneCollection* vtkClipClosedSurface::GetClippingPlanes ( )
virtual

Set the vtkPlaneCollection that holds the clipping planes.

virtual void vtkClipClosedSurface::SetTolerance ( double  )
virtual

Set the tolerance for creating new points while clipping. If the tolerance is too small, then degenerate triangles might be produced. The default tolerance is 1e-6.

virtual double vtkClipClosedSurface::GetTolerance ( )
virtual

Set the tolerance for creating new points while clipping. If the tolerance is too small, then degenerate triangles might be produced. The default tolerance is 1e-6.

virtual void vtkClipClosedSurface::SetPassPointData ( int  )
virtual

Pass the point data to the output. Point data will be interpolated when new points are generated. This is off by default.

virtual void vtkClipClosedSurface::PassPointDataOn ( )
virtual

Pass the point data to the output. Point data will be interpolated when new points are generated. This is off by default.

virtual void vtkClipClosedSurface::PassPointDataOff ( )
virtual

Pass the point data to the output. Point data will be interpolated when new points are generated. This is off by default.

virtual int vtkClipClosedSurface::GetPassPointData ( )
virtual

Pass the point data to the output. Point data will be interpolated when new points are generated. This is off by default.

virtual void vtkClipClosedSurface::SetGenerateOutline ( int  )
virtual

Set whether to generate an outline wherever an input face was cut by a plane. This is off by default.

virtual void vtkClipClosedSurface::GenerateOutlineOn ( )
virtual

Set whether to generate an outline wherever an input face was cut by a plane. This is off by default.

virtual void vtkClipClosedSurface::GenerateOutlineOff ( )
virtual

Set whether to generate an outline wherever an input face was cut by a plane. This is off by default.

virtual int vtkClipClosedSurface::GetGenerateOutline ( )
virtual

Set whether to generate an outline wherever an input face was cut by a plane. This is off by default.

virtual void vtkClipClosedSurface::SetGenerateFaces ( int  )
virtual

Set whether to generate polygonal faces for the output. This is on by default. If it is off, then the output will have no polys.

virtual void vtkClipClosedSurface::GenerateFacesOn ( )
virtual

Set whether to generate polygonal faces for the output. This is on by default. If it is off, then the output will have no polys.

virtual void vtkClipClosedSurface::GenerateFacesOff ( )
virtual

Set whether to generate polygonal faces for the output. This is on by default. If it is off, then the output will have no polys.

virtual int vtkClipClosedSurface::GetGenerateFaces ( )
virtual

Set whether to generate polygonal faces for the output. This is on by default. If it is off, then the output will have no polys.

virtual void vtkClipClosedSurface::SetScalarMode ( int  )
virtual

Set whether to add cell scalars, so that new faces and outlines can be distinguished from original faces and lines. The options are "None", "Colors", and "Labels". For the "Labels" option, a scalar value of "0" indicates an original cell, "1" indicates a new cell on a cut face, and "2" indicates a new cell on the ActivePlane as set by the SetActivePlane() method. The default scalar mode is "None".

void vtkClipClosedSurface::SetScalarModeToNone ( )
inline

Set whether to add cell scalars, so that new faces and outlines can be distinguished from original faces and lines. The options are "None", "Colors", and "Labels". For the "Labels" option, a scalar value of "0" indicates an original cell, "1" indicates a new cell on a cut face, and "2" indicates a new cell on the ActivePlane as set by the SetActivePlane() method. The default scalar mode is "None".

Definition at line 119 of file vtkClipClosedSurface.h.

void vtkClipClosedSurface::SetScalarModeToColors ( )
inline

Set whether to add cell scalars, so that new faces and outlines can be distinguished from original faces and lines. The options are "None", "Colors", and "Labels". For the "Labels" option, a scalar value of "0" indicates an original cell, "1" indicates a new cell on a cut face, and "2" indicates a new cell on the ActivePlane as set by the SetActivePlane() method. The default scalar mode is "None".

Definition at line 121 of file vtkClipClosedSurface.h.

void vtkClipClosedSurface::SetScalarModeToLabels ( )
inline

Set whether to add cell scalars, so that new faces and outlines can be distinguished from original faces and lines. The options are "None", "Colors", and "Labels". For the "Labels" option, a scalar value of "0" indicates an original cell, "1" indicates a new cell on a cut face, and "2" indicates a new cell on the ActivePlane as set by the SetActivePlane() method. The default scalar mode is "None".

Definition at line 123 of file vtkClipClosedSurface.h.

virtual int vtkClipClosedSurface::GetScalarMode ( )
virtual

Set whether to add cell scalars, so that new faces and outlines can be distinguished from original faces and lines. The options are "None", "Colors", and "Labels". For the "Labels" option, a scalar value of "0" indicates an original cell, "1" indicates a new cell on a cut face, and "2" indicates a new cell on the ActivePlane as set by the SetActivePlane() method. The default scalar mode is "None".

const char* vtkClipClosedSurface::GetScalarModeAsString ( )

Set whether to add cell scalars, so that new faces and outlines can be distinguished from original faces and lines. The options are "None", "Colors", and "Labels". For the "Labels" option, a scalar value of "0" indicates an original cell, "1" indicates a new cell on a cut face, and "2" indicates a new cell on the ActivePlane as set by the SetActivePlane() method. The default scalar mode is "None".

virtual void vtkClipClosedSurface::SetBaseColor ( double  ,
double  ,
double   
)
virtual

Set the color for all cells were part of the original geometry. If the the input data already has color cell scalars, then those values will be used and parameter will be ignored. The default color is red. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::SetBaseColor ( double  [3])
virtual

Set the color for all cells were part of the original geometry. If the the input data already has color cell scalars, then those values will be used and parameter will be ignored. The default color is red. Requires SetScalarModeToColors.

virtual double* vtkClipClosedSurface::GetBaseColor ( )
virtual

Set the color for all cells were part of the original geometry. If the the input data already has color cell scalars, then those values will be used and parameter will be ignored. The default color is red. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::GetBaseColor ( double &  ,
double &  ,
double &   
)
virtual

Set the color for all cells were part of the original geometry. If the the input data already has color cell scalars, then those values will be used and parameter will be ignored. The default color is red. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::GetBaseColor ( double  [3])
virtual

Set the color for all cells were part of the original geometry. If the the input data already has color cell scalars, then those values will be used and parameter will be ignored. The default color is red. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::SetClipColor ( double  ,
double  ,
double   
)
virtual

Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping. The default color is orange. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::SetClipColor ( double  [3])
virtual

Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping. The default color is orange. Requires SetScalarModeToColors.

virtual double* vtkClipClosedSurface::GetClipColor ( )
virtual

Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping. The default color is orange. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::GetClipColor ( double &  ,
double &  ,
double &   
)
virtual

Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping. The default color is orange. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::GetClipColor ( double  [3])
virtual

Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping. The default color is orange. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::SetActivePlaneId ( int  )
virtual

Set the active plane, so that the clipping from that plane can be displayed in a different color. Set this to -1 if there is no active plane. The default value is -1.

virtual int vtkClipClosedSurface::GetActivePlaneId ( )
virtual

Set the active plane, so that the clipping from that plane can be displayed in a different color. Set this to -1 if there is no active plane. The default value is -1.

virtual void vtkClipClosedSurface::SetActivePlaneColor ( double  ,
double  ,
double   
)
virtual

Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set. Default is yellow. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::SetActivePlaneColor ( double  [3])
virtual

Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set. Default is yellow. Requires SetScalarModeToColors.

virtual double* vtkClipClosedSurface::GetActivePlaneColor ( )
virtual

Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set. Default is yellow. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::GetActivePlaneColor ( double &  ,
double &  ,
double &   
)
virtual

Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set. Default is yellow. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::GetActivePlaneColor ( double  [3])
virtual

Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set. Default is yellow. Requires SetScalarModeToColors.

virtual void vtkClipClosedSurface::SetTriangulationErrorDisplay ( int  )
virtual

Generate errors when the triangulation fails. Usually the triangulation errors are too small to see, but they result in a surface that is not watertight. This option has no impact on performance.

virtual void vtkClipClosedSurface::TriangulationErrorDisplayOn ( )
virtual

Generate errors when the triangulation fails. Usually the triangulation errors are too small to see, but they result in a surface that is not watertight. This option has no impact on performance.

virtual void vtkClipClosedSurface::TriangulationErrorDisplayOff ( )
virtual

Generate errors when the triangulation fails. Usually the triangulation errors are too small to see, but they result in a surface that is not watertight. This option has no impact on performance.

virtual int vtkClipClosedSurface::GetTriangulationErrorDisplay ( )
virtual

Generate errors when the triangulation fails. Usually the triangulation errors are too small to see, but they result in a surface that is not watertight. This option has no impact on performance.

virtual int vtkClipClosedSurface::ComputePipelineMTime ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector,
int  requestFromOutputPort,
unsigned long *  mtime 
)
protectedvirtual
virtual int vtkClipClosedSurface::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual
void vtkClipClosedSurface::ClipLines ( vtkPoints *  points,
vtkDoubleArray *  pointScalars,
vtkPointData *  pointData,
vtkCCSEdgeLocator *  edgeLocator,
vtkCellArray *  inputCells,
vtkCellArray *  outputLines,
vtkCellData *  inCellData,
vtkCellData *  outLineData 
)
protected

Method for clipping lines and copying the scalar data.

void vtkClipClosedSurface::ClipAndContourPolys ( vtkPoints *  points,
vtkDoubleArray *  pointScalars,
vtkPointData *  pointData,
vtkCCSEdgeLocator *  edgeLocator,
int  triangulate,
vtkCellArray *  inputCells,
vtkCellArray *  outputPolys,
vtkCellArray *  outputLines,
vtkCellData *  inPolyData,
vtkCellData *  outPolyData,
vtkCellData *  outLineData 
)
protected

Clip and contour polys in one step, in order to guarantee that the contour lines exactly match the new free edges of the clipped polygons. This exact correspondence is necessary in order to guarantee that the surface remains closed.

static int vtkClipClosedSurface::InterpolateEdge ( vtkPoints *  points,
vtkPointData *  pointData,
vtkCCSEdgeLocator *  edgeLocator,
double  tol,
vtkIdType  i0,
vtkIdType  i1,
double  v0,
double  v1,
vtkIdType &  i 
)
staticprotected

A helper function for interpolating a new point along an edge. It stores the index of the interpolated point in "i", and returns 1 if a new point was added to the points. The values i0, i1, v0, v1 are the edge enpoints and scalar values, respectively.

int vtkClipClosedSurface::TriangulatePolygon ( vtkIdList *  polygon,
vtkPoints *  points,
vtkCellArray *  triangles 
)
protected

A robust method for triangulating a polygon. It cleans up the polygon and then applies the ear-cut method that is implemented in vtkPolygon. A zero return value indicates that triangulation failed.

void vtkClipClosedSurface::TriangulateContours ( vtkPolyData *  data,
vtkIdType  firstLine,
vtkIdType  numLines,
vtkCellArray *  outputPolys,
const double  normal[3] 
)
protected

Given some closed contour lines, create a triangle mesh that fills those lines. The input lines must be single-segment lines, not polylines. The input lines do not have to be in order. Only lines from firstLine to will be used. Specify the normal of the clip plane, which will be opposite the the normals of the polys that will be produced. If outCD has scalars, then color scalars will be added for each poly that is created.

static void vtkClipClosedSurface::BreakPolylines ( vtkCellArray *  inputLines,
vtkCellArray *  outputLines,
vtkUnsignedCharArray *  inputScalars,
vtkIdType  firstLineScalar,
vtkUnsignedCharArray *  outputScalars,
const unsigned char  color[3] 
)
staticprotected

Break polylines into individual lines, copying scalar values from inputScalars starting at firstLineScalar. If inputScalars is zero, then scalars will be set to color. If scalars is zero, then no scalars will be generated.

static void vtkClipClosedSurface::CopyPolygons ( vtkCellArray *  inputPolys,
vtkCellArray *  outputPolys,
vtkUnsignedCharArray *  inputScalars,
vtkIdType  firstPolyScalar,
vtkUnsignedCharArray *  outputScalars,
const unsigned char  color[3] 
)
staticprotected

Copy polygons and their associated scalars to a new array. If inputScalars is set to zero, set polyScalars to color instead. If polyScalars is set to zero, don't generate scalars.

static void vtkClipClosedSurface::BreakTriangleStrips ( vtkCellArray *  inputStrips,
vtkCellArray *  outputPolys,
vtkUnsignedCharArray *  inputScalars,
vtkIdType  firstStripScalar,
vtkUnsignedCharArray *  outputScalars,
const unsigned char  color[3] 
)
staticprotected

Break triangle strips and add the triangles to the output. See CopyPolygons for more information.

static void vtkClipClosedSurface::SqueezeOutputPoints ( vtkPolyData *  output,
vtkPoints *  points,
vtkPointData *  pointData,
int  outputPointDataType 
)
staticprotected

Squeeze the points and store them in the output. Only the points that are used by the cells will be saved, and the pointIds of the cells will be modified.

static void vtkClipClosedSurface::CreateColorValues ( const double  color1[3],
const double  color2[3],
const double  color3[3],
unsigned char  colors[3][3] 
)
staticprotected

Take three colors as doubles, and convert to unsigned char.

Member Data Documentation

vtkPlaneCollection* vtkClipClosedSurface::ClippingPlanes
protected

Definition at line 176 of file vtkClipClosedSurface.h.

double vtkClipClosedSurface::Tolerance
protected

Definition at line 178 of file vtkClipClosedSurface.h.

int vtkClipClosedSurface::PassPointData
protected

Definition at line 180 of file vtkClipClosedSurface.h.

int vtkClipClosedSurface::GenerateOutline
protected

Definition at line 181 of file vtkClipClosedSurface.h.

int vtkClipClosedSurface::GenerateFaces
protected

Definition at line 182 of file vtkClipClosedSurface.h.

int vtkClipClosedSurface::ActivePlaneId
protected

Definition at line 183 of file vtkClipClosedSurface.h.

int vtkClipClosedSurface::ScalarMode
protected

Definition at line 184 of file vtkClipClosedSurface.h.

double vtkClipClosedSurface::BaseColor[3]
protected

Definition at line 185 of file vtkClipClosedSurface.h.

double vtkClipClosedSurface::ClipColor[3]
protected

Definition at line 186 of file vtkClipClosedSurface.h.

double vtkClipClosedSurface::ActivePlaneColor[3]
protected

Definition at line 187 of file vtkClipClosedSurface.h.

int vtkClipClosedSurface::TriangulationErrorDisplay
protected

Definition at line 189 of file vtkClipClosedSurface.h.

vtkIdList* vtkClipClosedSurface::IdList
protected

Definition at line 191 of file vtkClipClosedSurface.h.


The documentation for this class was generated from the following file: