vtkPolyData Class Reference
#include <vtkPolyData.h>
Inheritance diagram for vtkPolyData:
[legend]Collaboration diagram for vtkPolyData:
[legend]List of all members.
Detailed Description
concrete dataset represents vertices, lines, polygons, and triangle strips
vtkPolyData is a data object that is a concrete implementation of vtkDataSet. vtkPolyData represents a geometric structure consisting of vertices, lines, polygons, and triangle strips. Point attribute values (e.g., scalars, vectors, etc.) also are represented.
The actual cell types (CellType.h) supported by vtkPolyData are: vtkVertex, vtkPolyVertex, vtkLine, vtkPolyLine, vtkTriangle, vtkTriangleStrip, vtkPolygon, vtkPixel, and vtkQuad.
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) and then use vtkCellArray's InitTraversal() and GetNextCell() methods.
- Examples:
- vtkPolyData (Examples)
- Tests:
- vtkPolyData (Tests)
Definition at line 60 of file vtkPolyData.h.
|
Public Types |
| typedef vtkPointSet | Superclass |
Public Member Functions |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| int | GetDataObjectType () |
| void | CopyStructure (vtkDataSet *ds) |
| vtkIdType | GetNumberOfCells () |
| vtkCell * | GetCell (vtkIdType cellId) |
| void | GetCell (vtkIdType cellId, vtkGenericCell *cell) |
| int | GetCellType (vtkIdType cellId) |
| void | GetCellBounds (vtkIdType cellId, double bounds[6]) |
| void | GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds) |
| void | CopyCells (vtkPolyData *pd, vtkIdList *idList, vtkPointLocator *locator=NULL) |
| void | GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) |
| void | GetPointCells (vtkIdType ptId, vtkIdList *cellIds) |
| void | ComputeBounds () |
| void | Squeeze () |
| int | GetMaxCellSize () |
| void | SetVerts (vtkCellArray *v) |
| vtkCellArray * | GetVerts () |
| void | SetLines (vtkCellArray *l) |
| vtkCellArray * | GetLines () |
| void | SetPolys (vtkCellArray *p) |
| vtkCellArray * | GetPolys () |
| void | SetStrips (vtkCellArray *s) |
| vtkCellArray * | GetStrips () |
| vtkIdType | GetNumberOfVerts () |
| vtkIdType | GetNumberOfLines () |
| vtkIdType | GetNumberOfPolys () |
| vtkIdType | GetNumberOfStrips () |
| void | Allocate (vtkIdType numCells=1000, int extSize=1000) |
| void | Allocate (vtkPolyData *inPolyData, vtkIdType numCells=1000, int extSize=1000) |
| int | InsertNextCell (int type, int npts, vtkIdType *pts) |
| int | InsertNextCell (int type, vtkIdList *pts) |
| void | Reset () |
| void | BuildCells () |
| void | BuildLinks (int initialSize=0) |
| void | DeleteCells () |
| void | DeleteLinks () |
| void | GetPointCells (vtkIdType ptId, unsigned short &ncells, vtkIdType *&cells) |
| void | GetCellEdgeNeighbors (vtkIdType cellId, vtkIdType p1, vtkIdType p2, vtkIdList *cellIds) |
| void | GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType *&pts) |
| int | IsTriangle (int v1, int v2, int v3) |
| int | IsEdge (vtkIdType p1, vtkIdType p2) |
| int | IsPointUsedByCell (vtkIdType ptId, vtkIdType cellId) |
| void | ReplaceCell (vtkIdType cellId, int npts, vtkIdType *pts) |
| void | ReplaceCellPoint (vtkIdType cellId, vtkIdType oldPtId, vtkIdType newPtId) |
| void | ReverseCell (vtkIdType cellId) |
| void | DeletePoint (vtkIdType ptId) |
| void | DeleteCell (vtkIdType cellId) |
| int | InsertNextLinkedPoint (int numLinks) |
| int | InsertNextLinkedPoint (double x[3], int numLinks) |
| int | InsertNextLinkedCell (int type, int npts, vtkIdType *pts) |
| void | ReplaceLinkedCell (vtkIdType cellId, int npts, vtkIdType *pts) |
| void | RemoveCellReference (vtkIdType cellId) |
| void | AddCellReference (vtkIdType cellId) |
| void | RemoveReferenceToCell (vtkIdType ptId, vtkIdType cellId) |
| void | AddReferenceToCell (vtkIdType ptId, vtkIdType cellId) |
| void | ResizeCellList (vtkIdType ptId, int size) |
| virtual void | Initialize () |
| void | SetUpdateExtent (int piece, int numPieces, int ghostLevel) |
| void | SetUpdateExtent (int piece, int numPieces) |
| void | GetUpdateExtent (int &piece, int &numPieces, int &ghostLevel) |
| virtual int * | GetUpdateExtent () |
| virtual void | GetUpdateExtent (int &, int &, int &, int &, int &, int &) |
| virtual void | GetUpdateExtent (int[6]) |
| void | SetUpdateExtent (int x1, int x2, int y1, int y2, int z1, int z2) |
| void | SetUpdateExtent (int ext[6]) |
| virtual int | GetPiece () |
| virtual int | GetNumberOfPieces () |
| virtual int | GetGhostLevel () |
| unsigned long | GetActualMemorySize () |
| void | ShallowCopy (vtkDataObject *src) |
| void | DeepCopy (vtkDataObject *src) |
| void | RemoveGhostCells (int level) |
Static Public Member Functions |
| static vtkPolyData * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkPolyData * | SafeDownCast (vtkObject *o) |
Protected Member Functions |
| | vtkPolyData () |
| | ~vtkPolyData () |
| virtual void | Crop () |
Protected Attributes |
| vtkVertex * | Vertex |
| vtkPolyVertex * | PolyVertex |
| vtkLine * | Line |
| vtkPolyLine * | PolyLine |
| vtkTriangle * | Triangle |
| vtkQuad * | Quad |
| vtkPolygon * | Polygon |
| vtkTriangleStrip * | TriangleStrip |
| vtkEmptyCell * | EmptyCell |
| vtkCellArray * | Verts |
| vtkCellArray * | Lines |
| vtkCellArray * | Polys |
| vtkCellArray * | Strips |
| vtkCellTypes * | Cells |
| vtkCellLinks * | Links |
Static Protected Attributes |
| static vtkCellArray * | Dummy |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkPolyData::vtkPolyData |
( |
|
) |
[protected] |
|
| vtkPolyData::~vtkPolyData |
( |
|
) |
[protected] |
|
Member Function Documentation
|
|
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] |
|
| static int vtkPolyData::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 vtkPointSet. |
| virtual int vtkPolyData::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 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] |
|
| 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] |
|
|
|
Get cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS NOT THREAD SAFE.
Implements vtkDataSet. |
|
|
Get cell with cellId such that: 0 <= cellId < NumberOfCells. This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
Implements vtkDataSet. |
| int vtkPolyData::GetCellType |
( |
vtkIdType |
cellId |
) |
[virtual] |
|
|
|
Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
Implements vtkDataSet. |
| void vtkPolyData::GetCellBounds |
( |
vtkIdType |
cellId, |
|
|
double |
bounds[6] |
|
) |
[virtual] |
|
|
|
Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. A subclass may be able to determine the bounds of cell without using an expensive GetCell() method. A default implementation is provided that actually uses a GetCell() call. This is to ensure the method is available to all datasets. Subclasses should override this method to provide an efficient implementation. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
Reimplemented from vtkDataSet. |
|
|
Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). Note that the list consists of only cells that use ALL the points provided. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
Reimplemented from vtkDataSet. |
|
|
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. |
| 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. |
|
|
Set the cell array defining vertices. |
|
|
Get the cell array defining vertices. If there are no vertices, an empty array will be returned (convenience to simplify traversal). |
|
|
Set the cell array defining lines. |
|
|
Get the cell array defining lines. If there are no lines, an empty array will be returned (convenience to simplify traversal). |
|
|
Set the cell array defining polygons. |
|
|
Get the cell array defining polygons. If there are no polygons, an empty array will be returned (convenience to simplify traversal). |
|
|
Set the cell array defining triangle strips. |
|
|
Get the cell array defining triangle strips. If there are no triangle strips, an empty array will be returned (convenience to simplify traversal). |
|
|
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 vtkVERTEX, vtkPOLY_VERTEX, vtkLINE, vtkPOLY_LINE, vtkTRIANGLE, vtkQUAD, vtkPOLYGON, or vtkTRIANGLE_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 vtkPIXEL, but converts it to vtkQUAD. |
| 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] |
|
|
|
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] |
|
|
|
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. |
|
|
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::ReverseCell |
( |
vtkIdType |
cellId |
) |
|
|
|
|
Reverse the order of point ids defining the cell. |
| void vtkPolyData::DeletePoint |
( |
vtkIdType |
ptId |
) |
[inline] |
|
| void vtkPolyData::DeleteCell |
( |
vtkIdType |
cellId |
) |
[inline] |
|
| 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 |
|
) |
|
|
| 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] |
|
| void vtkPolyData::AddCellReference |
( |
vtkIdType |
cellId |
) |
[inline] |
|
|
|
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] |
|
| virtual void vtkPolyData::Initialize |
( |
|
) |
[virtual] |
|
|
|
Restore object to initial state. Release memory back to system.
Reimplemented from vtkPointSet. |
| void vtkPolyData::SetUpdateExtent |
( |
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. |
| void vtkPolyData::SetUpdateExtent |
( |
int |
piece, |
|
|
int |
numPieces |
|
) |
[inline] |
|
| void vtkPolyData::GetUpdateExtent |
( |
int & |
piece, |
|
|
int & |
numPieces, |
|
|
int & |
ghostLevel |
|
) |
|
|
| virtual int* vtkPolyData::GetUpdateExtent |
( |
|
) |
[virtual] |
|
|
|
We need this here to avoid hiding superclass method
Reimplemented from vtkDataObject. |
| virtual void vtkPolyData::GetUpdateExtent |
( |
int & |
, |
|
|
int & |
, |
|
|
int & |
, |
|
|
int & |
, |
|
|
int & |
, |
|
|
int & |
|
|
) |
[virtual] |
|
| virtual void vtkPolyData::GetUpdateExtent |
( |
int |
[6] |
) |
[virtual] |
|
| void vtkPolyData::SetUpdateExtent |
( |
int |
x1, |
|
|
int |
x2, |
|
|
int |
y1, |
|
|
int |
y2, |
|
|
int |
z1, |
|
|
int |
z2 |
|
) |
[inline, virtual] |
|
| void vtkPolyData::SetUpdateExtent |
( |
int |
ext[6] |
) |
[inline, virtual] |
|
| virtual int vtkPolyData::GetPiece |
( |
|
) |
[virtual] |
|
|
|
Set / Get the piece and the number of pieces. Similar to extent in 3D. |
| virtual int vtkPolyData::GetNumberOfPieces |
( |
|
) |
[virtual] |
|
| virtual int vtkPolyData::GetGhostLevel |
( |
|
) |
[virtual] |
|
| 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::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). |
| virtual void vtkPolyData::Crop |
( |
|
) |
[protected, virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following file: