vtkPolyData Class Reference
#include <vtkPolyData.h>
Detailed Description
concrete dataset represents vertices, lines, polygons, and triangle stripsvtkPolyData is a data object that is a concrete implementation of vtkDataSet. vtkPolyData represents a geometric structure consisting of vertices, lines, polygons, and/or triangle strips. Point and cell attribute values (e.g., scalars, vectors, etc.) also are represented.
The actual cell types (vtkCellType.h) supported by vtkPolyData are: vtkVertex, vtkPolyVertex, vtkLine, vtkPolyLine, vtkTriangle, vtkQuad, vtkPolygon, and vtkTriangleStrip.
One important feature of vtkPolyData objects is that special traversal and data manipulation methods are available to process data. These methods are generally more efficient than vtkDataSet methods and should be used whenever possible. For example, traversing the cells in a dataset we would use GetCell(). To traverse cells with vtkPolyData we would retrieve the cell array object representing polygons (for example using GetPolys()) and then use vtkCellArray's InitTraversal() and GetNextCell() methods.
- Warning:
- Because vtkPolyData is implemented with four separate instances of vtkCellArray to represent 0D vertices, 1D lines, 2D polygons, and 2D triangle strips, it is possible to create vtkPolyData instances that consist of a mixture of cell types. Because of the design of the class, there are certain limitations on how mixed cell types are inserted into the vtkPolyData, and in turn the order in which they are processed and rendered. To preserve the consistency of cell ids, and to insure that cells with cell data are rendered properly, users must insert mixed cells in the order of vertices (vtkVertex and vtkPolyVertex), lines (vtkLine and vtkPolyLine), polygons (vtkTriangle, vtkQuad, vtkPolygon), and triangle strips (vtkTriangleStrip).
Some filters when processing vtkPolyData with mixed cell types may process the cells in differing ways. Some will convert one type into another (e.g., vtkTriangleStrip into vtkTriangles) or expect a certain type (vtkDecimatePro expects triangles or triangle strips; vtkTubeFilter expects lines). Read the documentation for each filter carefully to understand how each part of vtkPolyData is processed.
- Tests:
- vtkPolyData (Tests)
Definition at line 78 of file vtkPolyData.h.
Member Typedef Documentation
| typedef vtkPointSet vtkPolyData::Superclass |
Constructor & Destructor Documentation
| vtkPolyData::vtkPolyData | ( | ) | [protected] |
| vtkPolyData::~vtkPolyData | ( | ) | [protected] |
Member Function Documentation
| static vtkPolyData* vtkPolyData::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkDataObject.
| virtual const char* vtkPolyData::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkPointSet.
| static int vtkPolyData::IsTypeOf | ( | const char * | name | ) | [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 vtkPointSet.
| virtual int vtkPolyData::IsA | ( | const char * | name | ) | [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 vtkPointSet.
| static vtkPolyData* vtkPolyData::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkPointSet.
| void vtkPolyData::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 vtkPointSet.
| int vtkPolyData::GetDataObjectType | ( | ) | [inline, virtual] |
Return what type of dataset this is.
Reimplemented from vtkDataSet.
Definition at line 87 of file vtkPolyData.h.
| void vtkPolyData::CopyStructure | ( | vtkDataSet * | ds | ) | [virtual] |
Copy the geometric and topological structure of an input poly data object.
Reimplemented from vtkPointSet.
| vtkIdType vtkPolyData::GetNumberOfCells | ( | ) | [virtual] |
Standard vtkDataSet interface.
Implements vtkDataSet.
Standard vtkDataSet interface.
Implements vtkDataSet.
| void vtkPolyData::GetCell | ( | vtkIdType | cellId, | |
| vtkGenericCell * | cell | |||
| ) | [virtual] |
Standard vtkDataSet interface.
Implements vtkDataSet.
| int vtkPolyData::GetCellType | ( | vtkIdType | cellId | ) | [virtual] |
Standard vtkDataSet interface.
Implements vtkDataSet.
| void vtkPolyData::GetCellBounds | ( | vtkIdType | cellId, | |
| double | bounds[6] | |||
| ) | [virtual] |
Standard vtkDataSet interface.
Reimplemented from vtkDataSet.
| void vtkPolyData::GetCellNeighbors | ( | vtkIdType | cellId, | |
| vtkIdList * | ptIds, | |||
| vtkIdList * | cellIds | |||
| ) | [virtual] |
Standard vtkDataSet interface.
Reimplemented from vtkDataSet.
| void vtkPolyData::CopyCells | ( | vtkPolyData * | pd, | |
| vtkIdList * | idList, | |||
| vtkPointLocator * | locator = NULL | |||
| ) |
Copy cells listed in idList from pd, including points, point data, and cell data. This method assumes that point and cell data have been allocated. If you pass in a point locator, then the points won't be duplicated in the output.
Copy a cells point ids into list provided. (Less efficient.)
Implements vtkDataSet.
Efficient method to obtain cells using a particular point. Make sure that routine BuildLinks() has been called.
Implements vtkDataSet.
| void vtkPolyData::ComputeBounds | ( | ) | [virtual] |
Compute the (X, Y, Z) bounds of the data.
Reimplemented from vtkPointSet.
| void vtkPolyData::Squeeze | ( | ) | [virtual] |
Recover extra allocated memory when creating data whose initial size is unknown. Examples include using the InsertNextCell() method, or when using the CellArray::EstimateSize() method to create vertices, lines, polygons, or triangle strips.
Reimplemented from vtkPointSet.
| int vtkPolyData::GetMaxCellSize | ( | ) | [virtual] |
Return the maximum cell size in this poly data.
Implements vtkDataSet.
| void vtkPolyData::SetVerts | ( | vtkCellArray * | v | ) |
Set the cell array defining vertices.
| vtkCellArray* vtkPolyData::GetVerts | ( | ) |
Get the cell array defining vertices. If there are no vertices, an empty array will be returned (convenience to simplify traversal).
| void vtkPolyData::SetLines | ( | vtkCellArray * | l | ) |
Set the cell array defining lines.
| vtkCellArray* vtkPolyData::GetLines | ( | ) |
Get the cell array defining lines. If there are no lines, an empty array will be returned (convenience to simplify traversal).
| void vtkPolyData::SetPolys | ( | vtkCellArray * | p | ) |
Set the cell array defining polygons.
| vtkCellArray* vtkPolyData::GetPolys | ( | ) |
Get the cell array defining polygons. If there are no polygons, an empty array will be returned (convenience to simplify traversal).
| void vtkPolyData::SetStrips | ( | vtkCellArray * | s | ) |
Set the cell array defining triangle strips.
| vtkCellArray* vtkPolyData::GetStrips | ( | ) |
Get the cell array defining triangle strips. If there are no triangle strips, an empty array will be returned (convenience to simplify traversal).
| vtkIdType vtkPolyData::GetNumberOfVerts | ( | ) |
Return the number of primitives of a particular type held..
| vtkIdType vtkPolyData::GetNumberOfLines | ( | ) |
Return the number of primitives of a particular type held..
| vtkIdType vtkPolyData::GetNumberOfPolys | ( | ) |
Return the number of primitives of a particular type held..
| vtkIdType vtkPolyData::GetNumberOfStrips | ( | ) |
Return the number of primitives of a particular type held..
| void vtkPolyData::Allocate | ( | vtkIdType | numCells = 1000, |
|
| int | extSize = 1000 | |||
| ) |
Method allocates initial storage for vertex, line, polygon, and triangle strip arrays. Use this method before the method PolyData::InsertNextCell(). (Or, provide vertex, line, polygon, and triangle strip cell arrays.)
| void vtkPolyData::Allocate | ( | vtkPolyData * | inPolyData, | |
| vtkIdType | numCells = 1000, |
|||
| int | extSize = 1000 | |||
| ) |
Similar to the method above, this method allocates initial storage for vertex, line, polygon, and triangle strip arrays. It does this more intelligently, examining the supplied inPolyData to determine whether to allocate the verts, lines, polys, and strips arrays. (These arrays are allocated only if there is data in the corresponding arrays in the inPolyData.) Caution: if the inPolyData has no verts, and after allocating with this method an PolyData::InsertNextCell() is invoked where a vertex is inserted, bad things will happen.
| int vtkPolyData::InsertNextCell | ( | int | type, | |
| int | npts, | |||
| vtkIdType * | pts | |||
| ) |
Insert a cell of type VTK_VERTEX, VTK_POLY_VERTEX, VTK_LINE, VTK_POLY_LINE, VTK_TRIANGLE, VTK_QUAD, VTK_POLYGON, or VTK_TRIANGLE_STRIP. Make sure that the PolyData::Allocate() function has been called first or that vertex, line, polygon, and triangle strip arrays have been supplied. Note: will also insert VTK_PIXEL, but converts it to VTK_QUAD.
| int vtkPolyData::InsertNextCell | ( | int | type, | |
| vtkIdList * | pts | |||
| ) |
Insert a cell of type VTK_VERTEX, VTK_POLY_VERTEX, VTK_LINE, VTK_POLY_LINE, VTK_TRIANGLE, VTK_QUAD, VTK_POLYGON, or VTK_TRIANGLE_STRIP. Make sure that the PolyData::Allocate() function has been called first or that vertex, line, polygon, and triangle strip arrays have been supplied. Note: will also insert VTK_PIXEL, but converts it to VTK_QUAD.
| void vtkPolyData::Reset | ( | ) |
Begin inserting data all over again. Memory is not freed but otherwise objects are returned to their initial state.
| void vtkPolyData::BuildCells | ( | ) |
Create data structure that allows random access of cells.
| void vtkPolyData::BuildLinks | ( | int | initialSize = 0 |
) |
Create upward links from points to cells that use each point. Enables topologically complex queries. Normally the links array is allocated based on the number of points in the vtkPolyData. The optional initialSize parameter can be used to allocate a larger size initially.
| void vtkPolyData::DeleteCells | ( | ) |
Release data structure that allows random access of the cells. This must be done before a 2nd call to BuildLinks(). DeleteCells implicitly deletes the links as well since they are no longer valid.
| void vtkPolyData::DeleteLinks | ( | ) |
Release the upward links from point to cells that use each point.
| void vtkPolyData::GetPointCells | ( | vtkIdType | ptId, | |
| unsigned short & | ncells, | |||
| vtkIdType *& | cells | |||
| ) | [inline] |
Special (efficient) operations on poly data. Use carefully.
Definition at line 446 of file vtkPolyData.h.
| void vtkPolyData::GetCellEdgeNeighbors | ( | vtkIdType | cellId, | |
| vtkIdType | p1, | |||
| vtkIdType | p2, | |||
| vtkIdList * | cellIds | |||
| ) |
Get the neighbors at an edge. More efficient than the general GetCellNeighbors(). Assumes links have been built (with BuildLinks()), and looks specifically for edge neighbors.
Return a pointer to a list of point ids defining cell. (More efficient.) Assumes that cells have been built (with BuildCells()).
| int vtkPolyData::IsTriangle | ( | int | v1, | |
| int | v2, | |||
| int | v3 | |||
| ) | [inline] |
Given three vertices, determine whether it's a triangle. Make sure BuildLinks() has been called first.
Definition at line 453 of file vtkPolyData.h.
Determine whether two points form an edge. If they do, return non-zero. By definition PolyVertex and PolyLine have no edges since 1-dimensional edges are only found on cells 2D and higher. Edges are defined as 1-D boundary entities to cells. Make sure BuildLinks() has been called first.
Determine whether a point is used by a particular cell. If it is, return non-zero. Make sure BuildCells() has been called first.
Definition at line 483 of file vtkPolyData.h.
Replace the points defining cell "cellId" with a new set of points. This operator is (typically) used when links from points to cells have not been built (i.e., BuildLinks() has not been executed). Use the operator ReplaceLinkedCell() to replace a cell when cell structure has been built.
| void vtkPolyData::ReplaceCellPoint | ( | vtkIdType | cellId, | |
| vtkIdType | oldPtId, | |||
| vtkIdType | newPtId | |||
| ) | [inline] |
Replace a point in the cell connectivity list with a different point.
Definition at line 536 of file vtkPolyData.h.
| void vtkPolyData::ReverseCell | ( | vtkIdType | cellId | ) |
Reverse the order of point ids defining the cell.
| void vtkPolyData::DeletePoint | ( | vtkIdType | ptId | ) | [inline] |
Mark a point/cell as deleted from this vtkPolyData.
Definition at line 499 of file vtkPolyData.h.
| void vtkPolyData::DeleteCell | ( | vtkIdType | cellId | ) | [inline] |
Mark a point/cell as deleted from this vtkPolyData.
Definition at line 504 of file vtkPolyData.h.
| void vtkPolyData::RemoveDeletedCells | ( | ) |
The cells marked by calls to DeleteCell are stored in the Cell Array VTK_EMPTY_CELL, but they still exist in the polys array. Calling RemoveDeletedCells will travers the poly array and remove/compact the cell array as well as any cell data thus truly removing the cells from the polydata object. WARNING. This only handles the polys at the moment
| int vtkPolyData::InsertNextLinkedPoint | ( | int | numLinks | ) |
Add a point to the cell data structure (after cell pointers have been built). This method adds the point and then allocates memory for the links to the cells. (To use this method, make sure points are available and BuildLinks() has been invoked.) Of the two methods below, one inserts a point coordinate and the other just makes room for cell links.
| int vtkPolyData::InsertNextLinkedPoint | ( | double | x[3], | |
| int | numLinks | |||
| ) |
Add a point to the cell data structure (after cell pointers have been built). This method adds the point and then allocates memory for the links to the cells. (To use this method, make sure points are available and BuildLinks() has been invoked.) Of the two methods below, one inserts a point coordinate and the other just makes room for cell links.
| int vtkPolyData::InsertNextLinkedCell | ( | int | type, | |
| int | npts, | |||
| vtkIdType * | pts | |||
| ) |
Add a new cell to the cell data structure (after cell pointers have been built). This method adds the cell and then updates the links from the points to the cells. (Memory is allocated as necessary.)
Replace one cell with another in cell structure. This operator updates the connectivity list and the point's link list. It does not delete references to the old cell in the point's link list. Use the operator RemoveCellReference() to delete all references from points to (old) cell. You may also want to consider using the operator ResizeCellList() if the link list is changing size.
| void vtkPolyData::RemoveCellReference | ( | vtkIdType | cellId | ) | [inline] |
Remove all references to cell in cell structure. This means the links from the cell's points to the cell are deleted. Memory is not reclaimed. Use the method ResizeCellList() to resize the link list from a point to its using cells. (This operator assumes BuildLinks() has been called.)
Definition at line 509 of file vtkPolyData.h.
| void vtkPolyData::AddCellReference | ( | vtkIdType | cellId | ) | [inline] |
Add references to cell in cell structure. This means the links from the cell's points to the cell are modified. Memory is not extended. Use the method ResizeCellList() to resize the link list from a point to its using cells. (This operator assumes BuildLinks() has been called.)
Definition at line 520 of file vtkPolyData.h.
Remove a reference to a cell in a particular point's link list. You may also consider using RemoveCellReference() to remove the references from all the cell's points to the cell. This operator does not reallocate memory; use the operator ResizeCellList() to do this if necessary.
Add a reference to a cell in a particular point's link list. (You may also consider using AddCellReference() to add the references from all the cell's points to the cell.) This operator does not realloc memory; use the operator ResizeCellList() to do this if necessary.
| void vtkPolyData::ResizeCellList | ( | vtkIdType | ptId, | |
| int | size | |||
| ) | [inline] |
Resize the list of cells using a particular point. (This operator assumes that BuildLinks() has been called.)
Definition at line 531 of file vtkPolyData.h.
| virtual void vtkPolyData::Initialize | ( | ) | [virtual] |
Restore object to initial state. Release memory back to system.
Reimplemented from vtkPointSet.
| void vtkPolyData::GetUpdateExtent | ( | int & | piece, | |
| int & | numPieces, | |||
| int & | ghostLevel | |||
| ) |
For streaming. User/next filter specifies which piece they want updated. The source of this poly data has to return exactly this piece.
| virtual int* vtkPolyData::GetUpdateExtent | ( | ) | [virtual] |
We need this here to avoid hiding superclass method
Reimplemented from vtkDataObject.
| virtual void vtkPolyData::GetUpdateExtent | ( | int & | x0, | |
| int & | x1, | |||
| int & | y0, | |||
| int & | y1, | |||
| int & | z0, | |||
| int & | z1 | |||
| ) | [virtual] |
We need this here to avoid hiding superclass method
Reimplemented from vtkDataObject.
| virtual void vtkPolyData::GetUpdateExtent | ( | int | extent[6] | ) | [virtual] |
We need this here to avoid hiding superclass method
Reimplemented from vtkDataObject.
| virtual int vtkPolyData::GetPiece | ( | ) | [virtual] |
Get the piece and the number of pieces. Similar to extent in 3D.
| virtual int vtkPolyData::GetNumberOfPieces | ( | ) | [virtual] |
Get the piece and the number of pieces. Similar to extent in 3D.
| virtual int vtkPolyData::GetGhostLevel | ( | ) | [virtual] |
Get the ghost level.
| unsigned long vtkPolyData::GetActualMemorySize | ( | ) | [virtual] |
Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE.
Reimplemented from vtkPointSet.
| void vtkPolyData::ShallowCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow and Deep copy.
Reimplemented from vtkPointSet.
| void vtkPolyData::DeepCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow and Deep copy.
Reimplemented from vtkPointSet.
| void vtkPolyData::RemoveGhostCells | ( | int | level | ) |
This method will remove any cell that has a ghost level array value greater or equal to level. It does not remove unused points (yet).
| static vtkPolyData* vtkPolyData::GetData | ( | vtkInformation * | info | ) | [static] |
Retrieve an instance of this class from an information object.
Reimplemented from vtkPointSet.
| static vtkPolyData* vtkPolyData::GetData | ( | vtkInformationVector * | v, | |
| int | i = 0 | |||
| ) | [static] |
Retrieve an instance of this class from an information object.
Reimplemented from vtkPointSet.
| virtual void vtkPolyData::Crop | ( | ) | [protected, virtual] |
This method crops the data object (if necesary) so that the extent matches the update extent.
Reimplemented from vtkDataObject.
Member Data Documentation
vtkVertex* vtkPolyData::Vertex [protected] |
Definition at line 400 of file vtkPolyData.h.
vtkPolyVertex* vtkPolyData::PolyVertex [protected] |
Definition at line 401 of file vtkPolyData.h.
vtkLine* vtkPolyData::Line [protected] |
Definition at line 402 of file vtkPolyData.h.
vtkPolyLine* vtkPolyData::PolyLine [protected] |
Definition at line 403 of file vtkPolyData.h.
vtkTriangle* vtkPolyData::Triangle [protected] |
Definition at line 404 of file vtkPolyData.h.
vtkQuad* vtkPolyData::Quad [protected] |
Definition at line 405 of file vtkPolyData.h.
vtkPolygon* vtkPolyData::Polygon [protected] |
Definition at line 406 of file vtkPolyData.h.
vtkTriangleStrip* vtkPolyData::TriangleStrip [protected] |
Definition at line 407 of file vtkPolyData.h.
vtkEmptyCell* vtkPolyData::EmptyCell [protected] |
Definition at line 408 of file vtkPolyData.h.
vtkCellArray* vtkPolyData::Verts [protected] |
Definition at line 412 of file vtkPolyData.h.
vtkCellArray* vtkPolyData::Lines [protected] |
Definition at line 413 of file vtkPolyData.h.
vtkCellArray* vtkPolyData::Polys [protected] |
Definition at line 414 of file vtkPolyData.h.
vtkCellArray* vtkPolyData::Strips [protected] |
Definition at line 415 of file vtkPolyData.h.
vtkCellArray* vtkPolyData::Dummy [static, protected] |
Definition at line 418 of file vtkPolyData.h.
vtkCellTypes* vtkPolyData::Cells [protected] |
Definition at line 422 of file vtkPolyData.h.
vtkCellLinks* vtkPolyData::Links [protected] |
Definition at line 423 of file vtkPolyData.h.
The documentation for this class was generated from the following file:
- dox/Filtering/vtkPolyData.h
