VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
vtkPolyData Class Reference

concrete dataset represents vertices, lines, polygons, and triangle strips More...

#include <vtkPolyData.h>

Inheritance diagram for vtkPolyData:
[legend]
Collaboration diagram for vtkPolyData:
[legend]

Public Types

enum  {
  ERR_NO_SUCH_FIELD = -4, ERR_INCORRECT_FIELD = -3, ERR_NON_MANIFOLD_STAR = -2, REGULAR_POINT = -1,
  MINIMUM = 0, SADDLE = 1, MAXIMUM = 2
}
 Scalar field critical point classification (for manifold 2D meshes). More...
 
typedef vtkPointSet Superclass
 
- Public Types inherited from vtkPointSet
typedef vtkDataSet Superclass
 Standard methdos for type information and printing. More...
 
- Public Types inherited from vtkDataSet
enum  FieldDataType { DATA_OBJECT_FIELD = 0, POINT_DATA_FIELD = 1, CELL_DATA_FIELD = 2 }
 
typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS,
  FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS
}
 Possible values for the FIELD_ASSOCIATION information entry. More...
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 Possible attribute types. More...
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 Possible values for the FIELD_OPERATION information entry. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPolyDataNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetDataObjectType () override
 Return what type of dataset this is. More...
 
void CopyStructure (vtkDataSet *ds) override
 Copy the geometric and topological structure of an input poly data object. More...
 
vtkIdType GetNumberOfCells () override
 Standard vtkDataSet interface. More...
 
vtkCellGetCell (vtkIdType cellId) override
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
void GetCell (vtkIdType cellId, vtkGenericCell *cell) override
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
int GetCellType (vtkIdType cellId) override
 Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
void GetCellBounds (vtkIdType cellId, double bounds[6]) override
 Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds) override
 Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). More...
 
void CopyCells (vtkPolyData *pd, vtkIdList *idList, vtkIncrementalPointLocator *locator=nullptr)
 Copy cells listed in idList from pd, including points, point data, and cell data. More...
 
void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override
 Copy a cells point ids into list provided. More...
 
void GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
 Efficient method to obtain cells using a particular point. More...
 
void ComputeBounds () override
 Compute the (X, Y, Z) bounds of the data. More...
 
void Squeeze () override
 Recover extra allocated memory when creating data whose initial size is unknown. More...
 
int GetMaxCellSize () override
 Return the maximum cell size in this poly data. More...
 
void SetVerts (vtkCellArray *v)
 Set the cell array defining vertices. More...
 
vtkCellArrayGetVerts ()
 Get the cell array defining vertices. More...
 
void SetLines (vtkCellArray *l)
 Set the cell array defining lines. More...
 
vtkCellArrayGetLines ()
 Get the cell array defining lines. More...
 
void SetPolys (vtkCellArray *p)
 Set the cell array defining polygons. More...
 
vtkCellArrayGetPolys ()
 Get the cell array defining polygons. More...
 
void SetStrips (vtkCellArray *s)
 Set the cell array defining triangle strips. More...
 
vtkCellArrayGetStrips ()
 Get the cell array defining triangle strips. More...
 
vtkIdType GetNumberOfVerts ()
 Return the number of primitives of a particular type held. More...
 
vtkIdType GetNumberOfLines ()
 
vtkIdType GetNumberOfPolys ()
 
vtkIdType GetNumberOfStrips ()
 
bool AllocateEstimate (vtkIdType numCells, vtkIdType maxCellSize)
 Preallocate memory for the internal cell arrays. More...
 
bool AllocateEstimate (vtkIdType numVerts, vtkIdType maxVertSize, vtkIdType numLines, vtkIdType maxLineSize, vtkIdType numPolys, vtkIdType maxPolySize, vtkIdType numStrips, vtkIdType maxStripSize)
 Preallocate memory for the internal cell arrays. More...
 
bool AllocateExact (vtkIdType numCells, vtkIdType connectivitySize)
 Preallocate memory for the internal cell arrays. More...
 
bool AllocateExact (vtkIdType numVerts, vtkIdType vertConnSize, vtkIdType numLines, vtkIdType lineConnSize, vtkIdType numPolys, vtkIdType polyConnSize, vtkIdType numStrips, vtkIdType stripConnSize)
 Preallocate memory for the internal cell arrays. More...
 
bool AllocateCopy (vtkPolyData *pd)
 Preallocate memory for the internal cell arrays such that they are the same size as those in pd. More...
 
bool AllocateProportional (vtkPolyData *pd, double ratio)
 Preallocate memory for the internal cell arrays such that they are proportional to those in pd by a factor of ratio (for instance, ratio = 2 allocates twice as many cells). More...
 
void Allocate (vtkIdType numCells=1000, int vtkNotUsed(extSize)=1000)
 Method allocates initial storage for vertex, line, polygon, and triangle strip arrays. More...
 
void Allocate (vtkPolyData *inPolyData, vtkIdType numCells=1000, int vtkNotUsed(extSize)=1000)
 Similar to the method above, this method allocates initial storage for vertex, line, polygon, and triangle strip arrays. More...
 
vtkIdType InsertNextCell (int type, int npts, const 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. More...
 
vtkIdType 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. More...
 
void Reset ()
 Begin inserting data all over again. More...
 
void BuildCells ()
 Create data structure that allows random access of cells. More...
 
bool NeedToBuildCells ()
 Check if BuildCells is needed. More...
 
void BuildLinks (int initialSize=0)
 Create upward links from points to cells that use each point. More...
 
void DeleteCells ()
 Release data structure that allows random access of the cells. More...
 
void DeleteLinks ()
 Release the upward links from point to cells that use each point. More...
 
void GetPointCells (vtkIdType ptId, vtkIdType &ncells, vtkIdType *&cells)
 Special (efficient) operations on poly data. More...
 
void GetPointCells (vtkIdType ptId, unsigned short &ncells, vtkIdType *&cells)
 
void GetCellEdgeNeighbors (vtkIdType cellId, vtkIdType p1, vtkIdType p2, vtkIdList *cellIds)
 Get the neighbors at an edge. More...
 
unsigned char GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const *&pts)
 Get a list of point ids that define a cell. More...
 
int IsTriangle (int v1, int v2, int v3)
 Given three vertices, determine whether it's a triangle. More...
 
int IsEdge (vtkIdType p1, vtkIdType p2)
 Determine whether two points form an edge. More...
 
int IsPointUsedByCell (vtkIdType ptId, vtkIdType cellId)
 Determine whether a point is used by a particular cell. More...
 
void ReplaceCellPoint (vtkIdType cellId, vtkIdType oldPtId, vtkIdType newPtId)
 Replace a point in the cell connectivity list with a different point. More...
 
void ReverseCell (vtkIdType cellId)
 Reverse the order of point ids defining the cell. More...
 
void DeletePoint (vtkIdType ptId)
 Mark a point/cell as deleted from this vtkPolyData. More...
 
void DeleteCell (vtkIdType cellId)
 
void RemoveDeletedCells ()
 The cells marked by calls to DeleteCell are stored in the Cell Array VTK_EMPTY_CELL, but they still exist in the cell arrays. More...
 
vtkIdType InsertNextLinkedPoint (int numLinks)
 Add a point to the cell data structure (after cell pointers have been built). More...
 
vtkIdType InsertNextLinkedPoint (double x[3], int numLinks)
 
vtkIdType InsertNextLinkedCell (int type, int npts, const vtkIdType pts[])
 Add a new cell to the cell data structure (after cell pointers have been built). More...
 
void ReplaceLinkedCell (vtkIdType cellId, int npts, const vtkIdType pts[])
 Replace one cell with another in cell structure. More...
 
void RemoveCellReference (vtkIdType cellId)
 Remove all references to cell in cell structure. More...
 
void AddCellReference (vtkIdType cellId)
 Add references to cell in cell structure. More...
 
void RemoveReferenceToCell (vtkIdType ptId, vtkIdType cellId)
 Remove a reference to a cell in a particular point's link list. More...
 
void AddReferenceToCell (vtkIdType ptId, vtkIdType cellId)
 Add a reference to a cell in a particular point's link list. More...
 
void ResizeCellList (vtkIdType ptId, int size)
 Resize the list of cells using a particular point. More...
 
void Initialize () override
 Restore object to initial state. More...
 
virtual int GetPiece ()
 Get the piece and the number of pieces. More...
 
virtual int GetNumberOfPieces ()
 
virtual int GetGhostLevel ()
 Get the ghost level. More...
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes). More...
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy. More...
 
void DeepCopy (vtkDataObject *src) override
 
void RemoveGhostCells ()
 This method will remove any cell that is marked as ghost (has the vtkDataSetAttributes::DUPLICATECELL bit set). More...
 
int GetScalarFieldCriticalIndex (vtkIdType pointId, vtkDataArray *scalarField)
 
int GetScalarFieldCriticalIndex (vtkIdType pointId, int fieldId)
 
int GetScalarFieldCriticalIndex (vtkIdType pointId, const char *fieldName)
 
virtual vtkMTimeType GetMeshMTime ()
 Return the mesh (geometry/topology) modification time. More...
 
vtkMTimeType GetMTime () override
 Get MTime which also considers its cell array MTime. More...
 
unsigned char GetCell (vtkIdType cellId, const vtkIdType *&pts)
 Get a pointer to the cell, ie [npts pid1 . More...
 
virtual vtkCellGetCell (vtkIdType cellId)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
virtual void GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
void ReplaceCell (vtkIdType cellId, vtkIdList *ids)
 Replace the points defining cell "cellId" with a new set of points. More...
 
void ReplaceCell (vtkIdType cellId, int npts, const vtkIdType pts[])
 Replace the points defining cell "cellId" with a new set of points. More...
 
- Public Member Functions inherited from vtkPointSet
vtkPointSetNewInstance () const
 
virtual void SetEditable (bool)
 Specify whether this dataset is editable after creation. More...
 
virtual bool GetEditable ()
 
virtual void EditableOn ()
 
virtual void EditableOff ()
 
vtkIdType GetNumberOfPoints () override
 See vtkDataSet for additional information. More...
 
void GetPoint (vtkIdType ptId, double x[3]) override
 Copy point coordinates into user provided array x[3] for specified point id. More...
 
vtkIdType FindPoint (double x[3]) override
 
vtkIdType FindPoint (double x, double y, double z)
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Locate cell based on global coordinate x and tolerance squared. More...
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 This is a version of the above method that can be used with multithreaded applications. More...
 
double * GetPoint (vtkIdType ptId) override
 See vtkDataSet for additional information. More...
 
vtkCellIteratorNewCellIterator () override
 Return an iterator that traverses the cells in this data set. More...
 
void BuildPointLocator ()
 Build the internal point locator . More...
 
void BuildLocator ()
 
void BuildCellLocator ()
 Build the cell locator. More...
 
virtual void SetPointLocator (vtkAbstractPointLocator *)
 Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods. More...
 
virtual vtkAbstractPointLocatorGetPointLocator ()
 
virtual void SetCellLocator (vtkAbstractCellLocator *)
 Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCelloperation. More...
 
virtual vtkAbstractCellLocatorGetCellLocator ()
 
virtual void SetPoints (vtkPoints *)
 Specify point array to define point coordinates. More...
 
virtual vtkPointsGetPoints ()
 
void Register (vtkObjectBase *o) override
 Overwritten to handle the data/locator loop. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
- Public Member Functions inherited from vtkDataSet
vtkDataSetNewInstance () const
 
virtual void CopyAttributes (vtkDataSet *ds)
 Copy the attributes associated with the specified dataset to this instance of vtkDataSet. More...
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
virtual void GetCellTypes (vtkCellTypes *types)
 Get a list of types of cells in a dataset. More...
 
vtkIdType FindPoint (double x, double y, double z)
 Locate the closest point to the global coordinate x. More...
 
virtual vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 Locate the cell that contains a point and return the cell. More...
 
vtkCellDataGetCellData ()
 Return a pointer to this dataset's cell data. More...
 
vtkPointDataGetPointData ()
 Return a pointer to this dataset's point data. More...
 
double * GetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6])
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
double * GetCenter ()
 Get the center of the bounding box. More...
 
void GetCenter (double center[3])
 Get the center of the bounding box. More...
 
double GetLength ()
 Return the length of the diagonal of the bounding box. More...
 
virtual void GetScalarRange (double range[2])
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
double * GetScalarRange ()
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
int CheckAttributes ()
 This method checks to see if the cell and point attributes match the geometry. More...
 
virtual void GenerateGhostArray (int zeroExt[6])
 Normally called by pipeline executives or algorithms only. More...
 
virtual void GenerateGhostArray (int zeroExt[6], bool cellOnly)
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the attributes of the data object as a vtkFieldData. More...
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...
 
bool HasAnyGhostCells ()
 Returns 1 if there are any ghost cells 0 otherwise. More...
 
bool HasAnyGhostPoints ()
 Returns 1 if there are any ghost points 0 otherwise. More...
 
virtual bool HasAnyBlankCells ()
 Returns 1 if there are any blanking cells 0 otherwise. More...
 
virtual bool HasAnyBlankPoints ()
 Returns 1 if there are any blanking points 0 otherwise. More...
 
vtkUnsignedCharArrayGetPointGhostArray ()
 Gets the array that defines the ghost type of each point. More...
 
void UpdatePointGhostArrayCache ()
 Updates the pointer to the point ghost array. More...
 
vtkUnsignedCharArrayAllocatePointGhostArray ()
 Allocate ghost array for points. More...
 
vtkUnsignedCharArrayGetCellGhostArray ()
 Get the array that defines the ghost type of each cell. More...
 
void UpdateCellGhostArrayCache ()
 Updates the pointer to the cell ghost array. More...
 
vtkUnsignedCharArrayAllocateCellGhostArray ()
 Allocate ghost array for cells. More...
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object. More...
 
virtual void SetInformation (vtkInformation *)
 
void ReleaseData ()
 Release data back to system to conserve memory resource. More...
 
virtual int GetDataReleased ()
 Get the flag indicating the data has been released. More...
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object. More...
 
virtual vtkFieldDataGetFieldData ()
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information. More...
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information. More...
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data. More...
 
virtual void PrepareForNewData ()
 make the output data ready for new data to be inserted. More...
 
virtual int GetExtentType ()
 The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. More...
 
virtual void Crop (const int *updateExtent)
 This method crops the data object (if necessary) so that the extent matches the update extent. More...
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. More...
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkPolyDataNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataSafeDownCast (vtkObjectBase *o)
 
static vtkPolyDataGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkPolyDataGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkPointSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPointSetSafeDownCast (vtkObjectBase *o)
 
static vtkPointSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkPointSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static void SetGlobalReleaseDataFlag (int val)
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
static int GetGlobalReleaseDataFlag ()
 
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) More...
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. More...
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array. More...
 
static vtkInformationSetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters. More...
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static int GetAssociationTypeFromString (const char *associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Types

using TaggedCellId = vtkPolyData_detail::TaggedCellId
 
using CellMap = vtkPolyData_detail::CellMap
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPolyData ()
 
 ~vtkPolyData () override
 
vtkCellArrayGetCellArrayInternal (TaggedCellId tag)
 
- Protected Member Functions inherited from vtkPointSet
 vtkPointSet ()
 
 ~vtkPointSet () override
 
void ReportReferences (vtkGarbageCollector *) override
 
- Protected Member Functions inherited from vtkDataSet
 vtkDataSet ()
 
 ~vtkDataSet () override
 
virtual void ComputeScalarRange ()
 Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime). More...
 
bool IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
 Helper function that tests if any of the values in 'a' have bitFlag set. More...
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkVertexVertex
 
vtkSmartPointer< vtkPolyVertexPolyVertex
 
vtkSmartPointer< vtkLineLine
 
vtkSmartPointer< vtkPolyLinePolyLine
 
vtkSmartPointer< vtkTriangleTriangle
 
vtkSmartPointer< vtkQuadQuad
 
vtkSmartPointer< vtkPolygonPolygon
 
vtkSmartPointer< vtkTriangleStripTriangleStrip
 
vtkSmartPointer< vtkEmptyCellEmptyCell
 
vtkSmartPointer< vtkCellArrayVerts
 
vtkSmartPointer< vtkCellArrayLines
 
vtkSmartPointer< vtkCellArrayPolys
 
vtkSmartPointer< vtkCellArrayStrips
 
vtkSmartPointer< CellMapCells
 
vtkSmartPointer< vtkCellLinksLinks
 
vtkNew< vtkIdListLegacyBuffer
 
- Protected Attributes inherited from vtkPointSet
bool Editable
 
vtkPointsPoints
 
vtkAbstractPointLocatorPointLocator
 
vtkAbstractCellLocatorCellLocator
 
- Protected Attributes inherited from vtkDataSet
vtkCellDataCellData
 
vtkPointDataPointData
 
vtkCallbackCommandDataObserver
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
vtkUnsignedCharArrayPointGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
vtkUnsignedCharArrayCellGhostArray
 
bool PointGhostArrayCached
 
bool CellGhostArrayCached
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Static Protected Attributes

static vtkPolyDataDummyContainter DummyContainer
 

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/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.
Some of the methods specified here function properly only when the dataset has been specified as "Editable". They are documented as such.

Definition at line 84 of file vtkPolyData.h.

Member Typedef Documentation

◆ Superclass

Definition at line 89 of file vtkPolyData.h.

◆ TaggedCellId

Definition at line 647 of file vtkPolyData.h.

◆ CellMap

Definition at line 648 of file vtkPolyData.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Scalar field critical point classification (for manifold 2D meshes).

Reference: J. Milnor "Morse Theory", Princeton University Press, 1963.

Given a pointId and an attribute representing a scalar field, this member returns the index of the critical point: vtkPolyData::MINIMUM (index 0): local minimum; vtkPolyData::SADDLE (index 1): local saddle; vtkPolyData::MAXIMUM (index 2): local maximum.

Other returned values are: vtkPolyData::REGULAR_POINT: regular point (the gradient does not vanish); vtkPolyData::ERR_NON_MANIFOLD_STAR: the star of the considered vertex is not manifold (could not evaluate the index) vtkPolyData::ERR_INCORRECT_FIELD: the number of entries in the scalar field array is different form the number of vertices in the mesh. vtkPolyData::ERR_NO_SUCH_FIELD: the specified scalar field does not exist.

Enumerator
ERR_NO_SUCH_FIELD 
ERR_INCORRECT_FIELD 
ERR_NON_MANIFOLD_STAR 
REGULAR_POINT 
MINIMUM 
SADDLE 
MAXIMUM 

Definition at line 603 of file vtkPolyData.h.

Constructor & Destructor Documentation

◆ vtkPolyData()

vtkPolyData::vtkPolyData ( )
protected

◆ ~vtkPolyData()

vtkPolyData::~vtkPolyData ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPolyData* vtkPolyData::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkPolyData::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPointSet.

◆ SafeDownCast()

static vtkPolyData* vtkPolyData::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPolyData::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPointSet.

◆ NewInstance()

vtkPolyData* vtkPolyData::NewInstance ( ) const

◆ PrintSelf()

void vtkPolyData::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ GetDataObjectType()

int vtkPolyData::GetDataObjectType ( )
inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 95 of file vtkPolyData.h.

◆ CopyStructure()

void vtkPolyData::CopyStructure ( vtkDataSet ds)
overridevirtual

Copy the geometric and topological structure of an input poly data object.

Reimplemented from vtkPointSet.

◆ GetNumberOfCells()

vtkIdType vtkPolyData::GetNumberOfCells ( )
inlineoverridevirtual

Standard vtkDataSet interface.

Implements vtkDataSet.

Definition at line 715 of file vtkPolyData.h.

◆ GetCell() [1/6]

vtkCell* vtkPolyData::GetCell ( vtkIdType  cellId)
overridevirtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

◆ GetCell() [2/6]

void vtkPolyData::GetCell ( vtkIdType  cellId,
vtkGenericCell cell 
)
overridevirtual

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.

◆ GetCellType()

int vtkPolyData::GetCellType ( vtkIdType  cellId)
inlineoverridevirtual

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.

Definition at line 722 of file vtkPolyData.h.

◆ GetCellBounds()

void vtkPolyData::GetCellBounds ( vtkIdType  cellId,
double  bounds[6] 
)
overridevirtual

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.

◆ GetCellNeighbors()

void vtkPolyData::GetCellNeighbors ( vtkIdType  cellId,
vtkIdList ptIds,
vtkIdList cellIds 
)
overridevirtual

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.

◆ CopyCells()

void vtkPolyData::CopyCells ( vtkPolyData pd,
vtkIdList idList,
vtkIncrementalPointLocator locator = nullptr 
)

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. This requires the use of an incremental point locator.

◆ GetCellPoints() [1/2]

void vtkPolyData::GetCellPoints ( vtkIdType  cellId,
vtkIdList ptIds 
)
overridevirtual

Copy a cells point ids into list provided.

(Less efficient.)

Implements vtkDataSet.

◆ GetPointCells() [1/3]

void vtkPolyData::GetPointCells ( vtkIdType  ptId,
vtkIdList cellIds 
)
overridevirtual

Efficient method to obtain cells using a particular point.

Make sure that routine BuildLinks() has been called.

Implements vtkDataSet.

◆ ComputeBounds()

void vtkPolyData::ComputeBounds ( )
overridevirtual

Compute the (X, Y, Z) bounds of the data.

Reimplemented from vtkPointSet.

◆ Squeeze()

void vtkPolyData::Squeeze ( )
overridevirtual

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.

◆ GetMaxCellSize()

int vtkPolyData::GetMaxCellSize ( )
overridevirtual

Return the maximum cell size in this poly data.

Implements vtkDataSet.

◆ SetVerts()

void vtkPolyData::SetVerts ( vtkCellArray v)

Set the cell array defining vertices.

◆ GetVerts()

vtkCellArray* vtkPolyData::GetVerts ( )

Get the cell array defining vertices.

If there are no vertices, an empty array will be returned (convenience to simplify traversal).

◆ SetLines()

void vtkPolyData::SetLines ( vtkCellArray l)

Set the cell array defining lines.

◆ GetLines()

vtkCellArray* vtkPolyData::GetLines ( )

Get the cell array defining lines.

If there are no lines, an empty array will be returned (convenience to simplify traversal).

◆ SetPolys()

void vtkPolyData::SetPolys ( vtkCellArray p)

Set the cell array defining polygons.

◆ GetPolys()

vtkCellArray* vtkPolyData::GetPolys ( )

Get the cell array defining polygons.

If there are no polygons, an empty array will be returned (convenience to simplify traversal).

◆ SetStrips()

void vtkPolyData::SetStrips ( vtkCellArray s)

Set the cell array defining triangle strips.

◆ GetStrips()

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).

◆ GetNumberOfVerts()

vtkIdType vtkPolyData::GetNumberOfVerts ( )
inline

Return the number of primitives of a particular type held.

Definition at line 202 of file vtkPolyData.h.

◆ GetNumberOfLines()

vtkIdType vtkPolyData::GetNumberOfLines ( )
inline

Definition at line 203 of file vtkPolyData.h.

◆ GetNumberOfPolys()

vtkIdType vtkPolyData::GetNumberOfPolys ( )
inline

Definition at line 204 of file vtkPolyData.h.

◆ GetNumberOfStrips()

vtkIdType vtkPolyData::GetNumberOfStrips ( )
inline

Definition at line 205 of file vtkPolyData.h.

◆ AllocateEstimate() [1/2]

bool vtkPolyData::AllocateEstimate ( vtkIdType  numCells,
vtkIdType  maxCellSize 
)

Preallocate memory for the internal cell arrays.

Each of the internal cell arrays (verts, lines, polys, and strips) will be resized to hold numCells cells of size maxCellSize.

Existing data is not preserved and the number of cells is set to zero.

Returns
True if allocation succeeds.

◆ AllocateEstimate() [2/2]

bool vtkPolyData::AllocateEstimate ( vtkIdType  numVerts,
vtkIdType  maxVertSize,
vtkIdType  numLines,
vtkIdType  maxLineSize,
vtkIdType  numPolys,
vtkIdType  maxPolySize,
vtkIdType  numStrips,
vtkIdType  maxStripSize 
)

Preallocate memory for the internal cell arrays.

Each of the internal cell arrays (verts, lines, polys, and strips) will be resized to hold the indicated number of cells of the specified cell size.

Existing data is not preserved and the number of cells is set to zero.

Returns
True if allocation succeeds.

◆ AllocateExact() [1/2]

bool vtkPolyData::AllocateExact ( vtkIdType  numCells,
vtkIdType  connectivitySize 
)

Preallocate memory for the internal cell arrays.

Each of the internal cell arrays (verts, lines, polys, and strips) will be resized to hold numCells cells and connectivitySize pointIds.

Existing data is not preserved and the number of cells is set to zero.

Returns
True if allocation succeeds.

◆ AllocateExact() [2/2]

bool vtkPolyData::AllocateExact ( vtkIdType  numVerts,
vtkIdType  vertConnSize,
vtkIdType  numLines,
vtkIdType  lineConnSize,
vtkIdType  numPolys,
vtkIdType  polyConnSize,
vtkIdType  numStrips,
vtkIdType  stripConnSize 
)

Preallocate memory for the internal cell arrays.

Each of the internal cell arrays (verts, lines, polys, and strips) will be resized to hold the indicated number of cells and the specified number of point ids (ConnSize).

Existing data is not preserved and the number of cells is set to zero.

Returns
True if allocation succeeds.

◆ AllocateCopy()

bool vtkPolyData::AllocateCopy ( vtkPolyData pd)

Preallocate memory for the internal cell arrays such that they are the same size as those in pd.

Existing data is not preserved and the number of cells is set to zero.

Returns
True if allocation succeeds.

◆ AllocateProportional()

bool vtkPolyData::AllocateProportional ( vtkPolyData pd,
double  ratio 
)

Preallocate memory for the internal cell arrays such that they are proportional to those in pd by a factor of ratio (for instance, ratio = 2 allocates twice as many cells).

Existing data is not preserved and the number of cells is set to zero.

Returns
True if allocation succeeds.

◆ Allocate() [1/2]

void vtkPolyData::Allocate ( vtkIdType  numCells = 1000,
int   vtkNotUsedextSize = 1000 
)
inline

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). extSize is no longer used.

Definition at line 284 of file vtkPolyData.h.

◆ Allocate() [2/2]

void vtkPolyData::Allocate ( vtkPolyData inPolyData,
vtkIdType  numCells = 1000,
int   vtkNotUsedextSize = 1000 
)
inline

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.

Definition at line 299 of file vtkPolyData.h.

◆ InsertNextCell() [1/2]

vtkIdType vtkPolyData::InsertNextCell ( int  type,
int  npts,
const 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.

◆ InsertNextCell() [2/2]

vtkIdType 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.

◆ Reset()

void vtkPolyData::Reset ( )

Begin inserting data all over again.

Memory is not freed but otherwise objects are returned to their initial state.

◆ BuildCells()

void vtkPolyData::BuildCells ( )

Create data structure that allows random access of cells.

BuildCells is expensive but necessary to make use of the faster non-virtual implementations of GetCell/GetCellPoints. One may check if cells need to be built via NeedToBuilds before invoking. Cells always need to be built/re-built after low level direct modifications to verts, lines, polys or strips cell arrays.

◆ NeedToBuildCells()

bool vtkPolyData::NeedToBuildCells ( )
inline

Check if BuildCells is needed.

Definition at line 341 of file vtkPolyData.h.

◆ BuildLinks()

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.

◆ DeleteCells()

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.

◆ DeleteLinks()

void vtkPolyData::DeleteLinks ( )

Release the upward links from point to cells that use each point.

◆ GetPointCells() [2/3]

void vtkPolyData::GetPointCells ( vtkIdType  ptId,
vtkIdType ncells,
vtkIdType *&  cells 
)
inline

Special (efficient) operations on poly data.

Use carefully (i.e., make sure that BuildLinks() has been called).

Definition at line 699 of file vtkPolyData.h.

◆ GetPointCells() [3/3]

void vtkPolyData::GetPointCells ( vtkIdType  ptId,
unsigned short &  ncells,
vtkIdType *&  cells 
)
inline

Definition at line 706 of file vtkPolyData.h.

◆ GetCellEdgeNeighbors()

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.

◆ GetCellPoints() [2/2]

unsigned char vtkPolyData::GetCellPoints ( vtkIdType  cellId,
vtkIdType npts,
vtkIdType const *&  pts 
)
inline

Get a list of point ids that define a cell.

The cell type is returned. Requires the the cells have been built with BuildCells.

Warning
Subsequent calls to this method may invalidate previous call results.

The pts pointer must not be modified.

Definition at line 857 of file vtkPolyData.h.

◆ IsTriangle()

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 732 of file vtkPolyData.h.

◆ IsEdge()

int vtkPolyData::IsEdge ( vtkIdType  p1,
vtkIdType  p2 
)

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.

◆ IsPointUsedByCell()

int vtkPolyData::IsPointUsedByCell ( vtkIdType  ptId,
vtkIdType  cellId 
)
inline

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 762 of file vtkPolyData.h.

◆ ReplaceCell() [1/2]

void vtkPolyData::ReplaceCell ( vtkIdType  cellId,
vtkIdList ids 
)

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. Use this method only when the dataset is set as Editable.

◆ ReplaceCell() [2/2]

void vtkPolyData::ReplaceCell ( vtkIdType  cellId,
int  npts,
const vtkIdType  pts[] 
)

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. Use this method only when the dataset is set as Editable.

◆ ReplaceCellPoint()

void vtkPolyData::ReplaceCellPoint ( vtkIdType  cellId,
vtkIdType  oldPtId,
vtkIdType  newPtId 
)
inline

Replace a point in the cell connectivity list with a different point.

Use this method only when the dataset is set as Editable.

Definition at line 841 of file vtkPolyData.h.

◆ ReverseCell()

void vtkPolyData::ReverseCell ( vtkIdType  cellId)

Reverse the order of point ids defining the cell.

Use this method only when the dataset is set as Editable.

◆ DeletePoint()

void vtkPolyData::DeletePoint ( vtkIdType  ptId)
inline

Mark a point/cell as deleted from this vtkPolyData.

Use this method only when the dataset is set as Editable.

Definition at line 780 of file vtkPolyData.h.

◆ DeleteCell()

void vtkPolyData::DeleteCell ( vtkIdType  cellId)
inline

Definition at line 786 of file vtkPolyData.h.

◆ RemoveDeletedCells()

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 cell arrays.

Calling RemoveDeletedCells will traverse the cell arrays and remove/compact the cell arrays as well as any cell data thus truly removing the cells from the polydata object. Use this method only when the dataset is set as Editable.

◆ InsertNextLinkedPoint() [1/2]

vtkIdType 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. Use this method only when the dataset is set as Editable.

◆ InsertNextLinkedPoint() [2/2]

vtkIdType vtkPolyData::InsertNextLinkedPoint ( double  x[3],
int  numLinks 
)

◆ InsertNextLinkedCell()

vtkIdType vtkPolyData::InsertNextLinkedCell ( int  type,
int  npts,
const 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.) Use this method only when the dataset is set as Editable.

◆ ReplaceLinkedCell()

void vtkPolyData::ReplaceLinkedCell ( vtkIdType  cellId,
int  npts,
const vtkIdType  pts[] 
)

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. Use this method only when the dataset is set as Editable.

◆ RemoveCellReference()

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.) Use this method only when the dataset is set as Editable.

Definition at line 792 of file vtkPolyData.h.

◆ AddCellReference()

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.) Use this method only when the dataset is set as Editable.

Definition at line 805 of file vtkPolyData.h.

◆ RemoveReferenceToCell()

void vtkPolyData::RemoveReferenceToCell ( vtkIdType  ptId,
vtkIdType  cellId 
)

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. Use this method only when the dataset is set as Editable.

◆ AddReferenceToCell()

void vtkPolyData::AddReferenceToCell ( vtkIdType  ptId,
vtkIdType  cellId 
)

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. Use this method only when the dataset is set as Editable.

◆ ResizeCellList()

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.) Use this method only when the dataset is set as Editable.

Definition at line 818 of file vtkPolyData.h.

◆ Initialize()

void vtkPolyData::Initialize ( )
overridevirtual

Restore object to initial state.

Release memory back to system.

Reimplemented from vtkPointSet.

◆ GetPiece()

virtual int vtkPolyData::GetPiece ( )
virtual

Get the piece and the number of pieces.

Similar to extent in 3D.

◆ GetNumberOfPieces()

virtual int vtkPolyData::GetNumberOfPieces ( )
virtual

◆ GetGhostLevel()

virtual int vtkPolyData::GetGhostLevel ( )
virtual

Get the ghost level.

◆ GetActualMemorySize()

unsigned long vtkPolyData::GetActualMemorySize ( )
overridevirtual

Return the actual size of the data in kibibytes (1024 bytes).

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.

◆ ShallowCopy()

void vtkPolyData::ShallowCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

Reimplemented from vtkPointSet.

◆ DeepCopy()

void vtkPolyData::DeepCopy ( vtkDataObject src)
overridevirtual

Reimplemented from vtkPointSet.

◆ RemoveGhostCells()

void vtkPolyData::RemoveGhostCells ( )

This method will remove any cell that is marked as ghost (has the vtkDataSetAttributes::DUPLICATECELL bit set).

It does not remove unused points.

◆ GetData() [1/2]

static vtkPolyData* vtkPolyData::GetData ( vtkInformation info)
static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

static vtkPolyData* vtkPolyData::GetData ( vtkInformationVector v,
int  i = 0 
)
static

◆ GetScalarFieldCriticalIndex() [1/3]

int vtkPolyData::GetScalarFieldCriticalIndex ( vtkIdType  pointId,
vtkDataArray scalarField 
)

◆ GetScalarFieldCriticalIndex() [2/3]

int vtkPolyData::GetScalarFieldCriticalIndex ( vtkIdType  pointId,
int  fieldId 
)

◆ GetScalarFieldCriticalIndex() [3/3]

int vtkPolyData::GetScalarFieldCriticalIndex ( vtkIdType  pointId,
const char *  fieldName 
)

◆ GetMeshMTime()

virtual vtkMTimeType vtkPolyData::GetMeshMTime ( )
virtual

Return the mesh (geometry/topology) modification time.

This time is different from the usual MTime which also takes into account the modification of data arrays. This function can be used to track the changes on the mesh separately from the data arrays (eg. static mesh over time with transient data).

◆ GetMTime()

vtkMTimeType vtkPolyData::GetMTime ( )
overridevirtual

Get MTime which also considers its cell array MTime.

Reimplemented from vtkPointSet.

◆ GetCell() [3/6]

unsigned char vtkPolyData::GetCell ( vtkIdType  cellId,
const vtkIdType *&  pts 
)

Get a pointer to the cell, ie [npts pid1 .

. pidn]. The cell type is returned. Requires the the cells have been built with BuildCells. The pts pointer must not be modified.

Warning
Internal cell storage has changed, and cell size is no longer stored with the cell point ids. The pts array returned here no longer exists in memory.

◆ GetCellArrayInternal()

vtkCellArray * vtkPolyData::GetCellArrayInternal ( vtkPolyData::TaggedCellId  tag)
inlineprotected

Definition at line 824 of file vtkPolyData.h.

◆ GetCell() [4/6]

virtual vtkCell* vtkDataSet::GetCell

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

THIS METHOD IS NOT THREAD SAFE.

◆ GetCell() [5/6]

virtual vtkCell* vtkDataSet::GetCell
inline

Definition at line 114 of file vtkDataSet.h.

◆ GetCell() [6/6]

virtual void vtkDataSet::GetCell

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

Member Data Documentation

◆ Vertex

vtkSmartPointer<vtkVertex> vtkPolyData::Vertex
protected

Definition at line 653 of file vtkPolyData.h.

◆ PolyVertex

vtkSmartPointer<vtkPolyVertex> vtkPolyData::PolyVertex
protected

Definition at line 654 of file vtkPolyData.h.

◆ Line

vtkSmartPointer<vtkLine> vtkPolyData::Line
protected

Definition at line 655 of file vtkPolyData.h.

◆ PolyLine

vtkSmartPointer<vtkPolyLine> vtkPolyData::PolyLine
protected

Definition at line 656 of file vtkPolyData.h.

◆ Triangle

vtkSmartPointer<vtkTriangle> vtkPolyData::Triangle
protected

Definition at line 657 of file vtkPolyData.h.

◆ Quad

vtkSmartPointer<vtkQuad> vtkPolyData::Quad
protected

Definition at line 658 of file vtkPolyData.h.

◆ Polygon

vtkSmartPointer<vtkPolygon> vtkPolyData::Polygon
protected

Definition at line 659 of file vtkPolyData.h.

◆ TriangleStrip

vtkSmartPointer<vtkTriangleStrip> vtkPolyData::TriangleStrip
protected

Definition at line 660 of file vtkPolyData.h.

◆ EmptyCell

vtkSmartPointer<vtkEmptyCell> vtkPolyData::EmptyCell
protected

Definition at line 661 of file vtkPolyData.h.

◆ Verts

vtkSmartPointer<vtkCellArray> vtkPolyData::Verts
protected

Definition at line 665 of file vtkPolyData.h.

◆ Lines

vtkSmartPointer<vtkCellArray> vtkPolyData::Lines
protected

Definition at line 666 of file vtkPolyData.h.

◆ Polys

vtkSmartPointer<vtkCellArray> vtkPolyData::Polys
protected

Definition at line 667 of file vtkPolyData.h.

◆ Strips

vtkSmartPointer<vtkCellArray> vtkPolyData::Strips
protected

Definition at line 668 of file vtkPolyData.h.

◆ Cells

vtkSmartPointer<CellMap> vtkPolyData::Cells
protected

Definition at line 672 of file vtkPolyData.h.

◆ Links

vtkSmartPointer<vtkCellLinks> vtkPolyData::Links
protected

Definition at line 673 of file vtkPolyData.h.

◆ LegacyBuffer

vtkNew<vtkIdList> vtkPolyData::LegacyBuffer
protected

Definition at line 675 of file vtkPolyData.h.

◆ DummyContainer

vtkPolyDataDummyContainter vtkPolyData::DummyContainer
staticprotected

Definition at line 678 of file vtkPolyData.h.


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