vtkBoxClipDataSet Class Reference
#include <vtkBoxClipDataSet.h>
Inheritance diagram for vtkBoxClipDataSet:
[legend]Collaboration diagram for vtkBoxClipDataSet:
[legend]List of all members.
Detailed Description
clip an unstructured grid
Clipping means that is actually 'cuts' through the cells of the dataset, returning tetrahedral cells inside of the box. The output of this filter is an unstructured grid.
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.
The vtkBoxClipDataSet will triangulate all types of 3D cells (i.e, create tetrahedra). This is necessary to preserve compatibility across face neighbors.
To use this filter,you can decide if you will be clipping with a box or a hexahedral box. 1) Set orientation if(SetOrientation(0)): box (parallel with coordinate axis) SetBoxClip(xmin,xmax,ymin,ymax,zmin,zmax) if(SetOrientation(1)): hexahedral box (Default) SetBoxClip(n[0],o[0],n[1],o[1],n[2],o[2],n[3],o[3],n[4],o[4],n[5],o[5]) PlaneNormal[] normal of each plane PlanePoint[] point on the plane 2) Apply the GenerateClipScalarsOn() 3) Execute clipping Update();
- Created by:
-
- CVS contributions (if > 5%):
- Law, Charles (75%)
- Malaterre, Mathieu (22%)
- CVS logs (CVSweb):
/Parallel/vtkBoxClipDataSet.h)/Parallel/vtkBoxClipDataSet.cxx)
Definition at line 73 of file vtkBoxClipDataSet.h.
|
Public Types |
| typedef vtkDataSetToUnstructuredGridFilter | Superclass |
Public Member Functions |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | CreateDefaultLocator () |
| unsigned long | GetMTime () |
| virtual unsigned int | GetOrientation () |
| virtual void | SetOrientation (unsigned int) |
| void | MinEdgeF (unsigned int *id_v, vtkIdType *cellIds, unsigned int *edgF) |
| void | PyramidToTetra (vtkIdType *pyramId, vtkIdType *cellIds, vtkCellArray *newCellArray) |
| void | WedgeToTetra (vtkIdType *wedgeId, vtkIdType *cellIds, vtkCellArray *newCellArray) |
| void | CellGrid (vtkIdType typeobj, vtkIdType npts, vtkIdType *cellIds, vtkCellArray *newCellArray) |
| void | CreateTetra (vtkIdType npts, vtkIdType *cellIds, vtkCellArray *newCellArray) |
| void | ClipBox (vtkPoints *newPoints, vtkGenericCell *cell, vtkPointLocator *locator, vtkCellArray *tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD) |
| void | ClipHexahedron (vtkPoints *newPoints, vtkGenericCell *cell, vtkPointLocator *locator, vtkCellArray *tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD) |
| void | ClipBoxInOut (vtkPoints *newPoints, vtkGenericCell *cell, vtkPointLocator *locator, vtkCellArray **tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD) |
| void | ClipHexahedronInOut (vtkPoints *newPoints, vtkGenericCell *cell, vtkPointLocator *locator, vtkCellArray **tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD) |
| void | ClipBox2D (vtkPoints *newPoints, vtkGenericCell *cell, vtkPointLocator *locator, vtkCellArray *tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD) |
| void | ClipBoxInOut2D (vtkPoints *newPoints, vtkGenericCell *cell, vtkPointLocator *locator, vtkCellArray **tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD) |
| void | ClipHexahedron2D (vtkPoints *newPoints, vtkGenericCell *cell, vtkPointLocator *locator, vtkCellArray *tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD) |
| void | ClipHexahedronInOut2D (vtkPoints *newPoints, vtkGenericCell *cell, vtkPointLocator *locator, vtkCellArray **tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD) |
|
| void | SetBoxClip (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) |
| void | SetBoxClip (double *n0, double *o0, double *n1, double *o1, double *n2, double *o2, double *n3, double *o3, double *n4, double *o4, double *n5, double *o5) |
|
| virtual void | SetGenerateClipScalars (int) |
| virtual int | GetGenerateClipScalars () |
| virtual void | GenerateClipScalarsOn () |
| virtual void | GenerateClipScalarsOff () |
|
| virtual void | SetGenerateClippedOutput (int) |
| virtual int | GetGenerateClippedOutput () |
| virtual void | GenerateClippedOutputOn () |
| virtual void | GenerateClippedOutputOff () |
|
| vtkUnstructuredGrid * | GetClippedOutput () |
| virtual int | GetNumberOfOutputs () |
|
| void | SetLocator (vtkPointLocator *locator) |
| virtual vtkPointLocator * | GetLocator () |
|
| virtual char * | GetInputScalarsSelection () |
| void | SelectInputScalars (const char *fieldName) |
Static Public Member Functions |
| int | IsTypeOf (const char *type) |
| vtkBoxClipDataSet * | SafeDownCast (vtkObject *o) |
| vtkBoxClipDataSet * | New () |
Protected Member Functions |
| | vtkBoxClipDataSet () |
| | ~vtkBoxClipDataSet () |
| void | Execute () |
| virtual void | SetInputScalarsSelection (const char *) |
Protected Attributes |
| vtkPointLocator * | Locator |
| int | GenerateClipScalars |
| int | GenerateClippedOutput |
| char * | InputScalarsSelection |
| double | BoundBoxClip [3][2] |
| unsigned int | Orientation |
| double | PlaneNormal [6][3] |
| double | PlanePoint [6][3] |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkBoxClipDataSet::vtkBoxClipDataSet |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkBoxClipDataSet::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkBoxClipDataSet::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataSetToUnstructuredGridFilter. |
| virtual int vtkBoxClipDataSet::IsA |
( |
const char * |
type |
) |
[virtual] |
|
|
|
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataSetToUnstructuredGridFilter. |
| void vtkBoxClipDataSet::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
|
|
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkDataSetToUnstructuredGridFilter. |
|
|
Constructor of the clipping box.
Reimplemented from vtkAlgorithm. |
| void vtkBoxClipDataSet::SetBoxClip |
( |
double |
xmin, |
|
|
double |
xmax, |
|
|
double |
ymin, |
|
|
double |
ymax, |
|
|
double |
zmin, |
|
|
double |
zmax |
|
) |
|
|
|
|
Specify the Box with which to perform the clipping. If the box is not parallel to axis, you need to especify normal vector of each plane and a point on the plane. |
| void vtkBoxClipDataSet::SetBoxClip |
( |
double * |
n0, |
|
|
double * |
o0, |
|
|
double * |
n1, |
|
|
double * |
o1, |
|
|
double * |
n2, |
|
|
double * |
o2, |
|
|
double * |
n3, |
|
|
double * |
o3, |
|
|
double * |
n4, |
|
|
double * |
o4, |
|
|
double * |
n5, |
|
|
double * |
o5 |
|
) |
|
|
|
|
Specify the Box with which to perform the clipping. If the box is not parallel to axis, you need to especify normal vector of each plane and a point on the plane. |
| virtual void vtkBoxClipDataSet::SetGenerateClipScalars |
( |
int |
|
) |
[virtual] |
|
|
|
If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data. |
| virtual int vtkBoxClipDataSet::GetGenerateClipScalars |
( |
|
) |
[virtual] |
|
|
|
If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data. |
| virtual void vtkBoxClipDataSet::GenerateClipScalarsOn |
( |
|
) |
[virtual] |
|
|
|
If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data. |
| virtual void vtkBoxClipDataSet::GenerateClipScalarsOff |
( |
|
) |
[virtual] |
|
|
|
If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data. |
| virtual void vtkBoxClipDataSet::SetGenerateClippedOutput |
( |
int |
|
) |
[virtual] |
|
|
|
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away. |
| virtual int vtkBoxClipDataSet::GetGenerateClippedOutput |
( |
|
) |
[virtual] |
|
|
|
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away. |
| virtual void vtkBoxClipDataSet::GenerateClippedOutputOn |
( |
|
) |
[virtual] |
|
|
|
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away. |
| virtual void vtkBoxClipDataSet::GenerateClippedOutputOff |
( |
|
) |
[virtual] |
|
|
|
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away. |
|
|
Return the Clipped output. |
| virtual int vtkBoxClipDataSet::GetNumberOfOutputs |
( |
|
) |
[virtual] |
|
|
|
Return the Clipped output.
Reimplemented from vtkSource. |
|
|
Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used. |
|
|
Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used. |
| void vtkBoxClipDataSet::CreateDefaultLocator |
( |
|
) |
|
|
|
|
Create default locator. Used to create one when none is specified. The locator is used to merge coincident points. |
| unsigned long vtkBoxClipDataSet::GetMTime |
( |
|
) |
[virtual] |
|
|
|
Return the mtime also considering the locator.
Reimplemented from vtkObject. |
| virtual char* vtkBoxClipDataSet::GetInputScalarsSelection |
( |
|
) |
[virtual] |
|
|
|
If you want to clip by an arbitrary array, then set its name here. By default this in NULL and the filter will use the active scalar array. |
| void vtkBoxClipDataSet::SelectInputScalars |
( |
const char * |
fieldName |
) |
[inline] |
|
|
|
If you want to clip by an arbitrary array, then set its name here. By default this in NULL and the filter will use the active scalar array.
Definition at line 138 of file vtkBoxClipDataSet.h. |
| virtual unsigned int vtkBoxClipDataSet::GetOrientation |
( |
|
) |
[virtual] |
|
| virtual void vtkBoxClipDataSet::SetOrientation |
( |
unsigned |
int |
) |
[virtual] |
|
| void vtkBoxClipDataSet::MinEdgeF |
( |
unsigned int * |
id_v, |
|
|
vtkIdType * |
cellIds, |
|
|
unsigned int * |
edgF |
|
) |
|
|
| void vtkBoxClipDataSet::Execute |
( |
|
) |
[protected, virtual] |
|
|
|
This method is the old style execute method
Reimplemented from vtkSource. |
| virtual void vtkBoxClipDataSet::SetInputScalarsSelection |
( |
const char * |
|
) |
[protected, virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following file: