concrete class for storing a set of points More...

#include <vtkPointSet.h>

Inheritance diagram for vtkPointSet:

Collaboration diagram for vtkPointSet:

Public Member Functions
int	GetDataObjectType () override
	Standard vtkDataSet API methods. More...

void	Initialize () override
	Reset to an empty state and free any memory. More...

void	CopyStructure (vtkDataSet *pd) override
	Copy the geometric structure of an input point set object. More...

vtkCell *	GetCell (vtkIdType) override
	This method always return a `vtkEmptyCell`, as there is no cell in a `vtkPointSet`. More...

void	GetCell (vtkIdType, vtkGenericCell *cell) override
	This method sets cell to be an empty cell. More...

int	GetCellType (vtkIdType) override
	This method always returns `VTK_EMPTY_CELL`, as there is no cell in a `vtkPointSet`. More...

vtkIdType	GetCellSize (vtkIdType) override
	This method always returns 1, as all cells are point in a pure `vtkPointSet`. More...

double *	GetPoint (vtkIdType ptId) override
	See vtkDataSet for additional information. More...

vtkCellIterator *	NewCellIterator () override
	Return an iterator that traverses the cells in this data set. More...

void	BuildCellLocator ()
	Build the cell locator. More...

vtkMTimeType	GetMTime () override
	Get MTime which also considers its vtkPoints MTime. More...

void	ComputeBounds () override
	Compute the (X, Y, Z) bounds of the data. More...

void	Squeeze () override
	Reclaim any unused memory. More...

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes). More...


virtual void	SetEditable (bool)
	Specify whether this dataset is editable after creation. More...

virtual bool	GetEditable ()
	Specify whether this dataset is editable after creation. More...

virtual void	EditableOn ()
	Specify whether this dataset is editable after creation. More...

virtual void	EditableOff ()
	Specify whether this dataset is editable after creation. More...


vtkIdType	GetNumberOfPoints () override
	See vtkDataSet for additional information. More...

void	GetPoint (vtkIdType ptId, double x[3]) override
	See vtkDataSet for additional information. More...

vtkIdType	FindPoint (double x[3]) override
	See vtkDataSet for additional information. More...

vtkIdType	FindPoint (double x, double y, double z)
	See vtkDataSet for additional information. More...

vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights) override
	See vtkDataSet for additional information. More...

vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
	See vtkDataSet for additional information. More...


vtkIdType	GetNumberOfCells () override
	This method always returns 0, as there are no cells in a `vtkPointSet`. More...

int	GetMaxCellSize () override
	This method always returns 0, as there are no cells in a `vtkPointSet`. More...


void	GetCellPoints (vtkIdType, vtkIdList *idList) override
	This method resets parameter idList, as there is no cell in a `vtkPointSet`. More...

void	GetPointCells (vtkIdType, vtkIdList *idList) override
	This method resets parameter idList, as there is no cell in a `vtkPointSet`. More...

virtual void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)=0
	This method resets parameter idList, as there is no cell in a `vtkPointSet`. More...

virtual void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const &pts, vtkIdList ptIds)
	This method resets parameter idList, as there is no cell in a `vtkPointSet`. More...


void	BuildPointLocator ()
	Build the internal point locator . More...

void	BuildLocator ()
	Build the internal point locator . More...


virtual void	SetPointLocator (vtkAbstractPointLocator *)
	Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods. More...

virtual vtkAbstractPointLocator *	GetPointLocator ()
	Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods. More...


virtual void	SetCellLocator (vtkAbstractCellLocator *)
	Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCell() operation. More...

virtual vtkAbstractCellLocator *	GetCellLocator ()
	Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCell() operation. More...


virtual void	SetPoints (vtkPoints *)
	Specify point array to define point coordinates. More...

virtual vtkPoints *	GetPoints ()
	Specify point array to define point coordinates. More...


void	ShallowCopy (vtkDataObject *src) override
	Shallow and Deep copy. More...

void	DeepCopy (vtkDataObject *src) override
	Shallow and Deep copy. More...


bool	UsesGarbageCollector () const override
	Overwritten to handle the data/locator loop. More...

Public Member Functions inherited from vtkDataSet
vtkDataSet *	NewInstance () const

virtual void	CopyAttributes (vtkDataSet *ds)
	Copy the attributes associated with the specified dataset to this instance of vtkDataSet. More...

virtual vtkCell *	GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))

void	SetCellOrderAndRationalWeights (vtkIdType cellId, vtkGenericCell *cell)

virtual void	GetCellBounds (vtkIdType cellId, double bounds[6])
	Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. More...

virtual void	GetCellTypes (vtkCellTypes *types)
	Get a list of types of cells in a dataset. More...

virtual void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const &pts, vtkIdList ptIds)
	Topological inquiry to get points defining cell. More...

virtual void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds)
	Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). More...

int	GetCellNumberOfFaces (vtkIdType cellId, unsigned char &cellType, vtkGenericCell *cell)
	Get the number of faces of a cell. More...

virtual vtkCell *	FindAndGetCell (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...

vtkCellData *	GetCellData ()
	Return a pointer to this dataset's cell data. More...

vtkPointData *	GetPointData ()
	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...

double	GetLength2 ()
	Return the squared 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...

vtkFieldData *	GetAttributesAsFieldData (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...

vtkUnsignedCharArray *	GetPointGhostArray ()
	Gets the array that defines the ghost type of each point. More...

void	UpdatePointGhostArrayCache ()
	Updates the pointer to the point ghost array. More...

vtkUnsignedCharArray *	AllocatePointGhostArray ()
	Allocate ghost array for points. More...

vtkUnsignedCharArray *	GetCellGhostArray ()
	Get the array that defines the ghost type of each cell. More...

void	UpdateCellGhostArrayCache ()
	Updates the pointer to the cell ghost array. More...

vtkUnsignedCharArray *	AllocateCellGhostArray ()
	Allocate ghost array for cells. More...

vtkUnsignedCharArray *	GetGhostArray (int type) override
	Returns the ghost array for the given type (point or cell). More...

vtkIdType	FindPoint (double x, double y, double z)
	Locate the closest point to the global coordinate x. More...

virtual void	GenerateGhostArray (int zeroExt[6])
	Normally called by pipeline executives or algorithms only. More...

virtual void	GenerateGhostArray (int zeroExt[6], bool cellOnly)
	Normally called by pipeline executives or algorithms only. More...

Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const

void	ReleaseData ()
	Release data back to system to conserve memory resource. More...

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 vtkDataSetAttributes *	GetAttributes (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...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object. More...

virtual int	GetDataReleased ()
	Get the flag indicating the data has been released. More...

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object. More...

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object. More...

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. 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...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. 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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkPointSet *	New ()
	Standard instantiation method. More...

static vtkPointSet *	ExtendedNew ()


static vtkPointSet *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkPointSet *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataSet *	SafeDownCast (vtkObjectBase *o)

static vtkDataSet *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkDataSet *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (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 vtkInformation *	GetNamedFieldInformation (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 vtkInformation *	SetActiveAttribute (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 *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e. More...

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

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 ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
	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...

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 ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
bool	Editable

vtkPoints *	Points

vtkAbstractPointLocator *	PointLocator

vtkAbstractCellLocator *	CellLocator

Protected Attributes inherited from vtkDataSet
vtkCellData *	CellData

vtkPointData *	PointData

vtkCallbackCommand *	DataObserver

vtkTimeStamp	ComputeTime

double	Bounds [6]

double	Center [3]

double	ScalarRange [2]

vtkTimeStamp	ScalarRangeComputeTime

vtkUnsignedCharArray *	PointGhostArray
	These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...

vtkUnsignedCharArray *	CellGhostArray
	These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...

bool	PointGhostArrayCached
	These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...

bool	CellGhostArrayCached
	These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkDataSet	Superclass
	Standard methods for type information and printing. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type information and printing. More...

static vtkPointSet *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and printing. More...

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for type information and printing. More...

vtkPointSet *	NewInstance () const
	Standard methods for type information and printing. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and printing. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for type information and printing. More...

Additional Inherited Members
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

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

concrete class for storing a set of points

vtkPointSet is an concrete class representing a set of points that specifies the interface for datasets that explicitly use "point" arrays to represent geometry. For example, vtkPolyData, vtkUnstructuredGrid, and vtkStructuredGrid require point arrays to specify point positions, while vtkImageData represents point positions implicitly (and hence is not a subclass of vtkImageData).

Note: The vtkPolyData and vtkUnstructuredGrid datasets (derived classes of vtkPointSet) are often used in geometric computation (e.g., vtkDelaunay2D). In most cases during filter execution the output geometry and/or topology is created once and provided as output; however in a very few cases the underlying geometry/topology may be created and then incrementally modified. This has implications on the use of supporting classes like locators and cell links topological structures which may be required to support incremental editing operations. Consequently, there is a flag, Editable, that controls whether the dataset can be incrementally edited after it is initially created. By default, and for performance reasons, vtkPointSet derived classes are created as non-editable. The few methods that require incremental editing capabilities are documented in derived classes.

Another important feature of vtkPointSet classes is the use of an internal locator to speed up certain operations like FindCell(). Depending on the application and desired performance, different locators (either a cell or point locator) of different locator types may be used, along with different strategies for using the locators to perform various operations. See the class vtkFindCellStrategy for more information

See also: vtkPolyData vtkStructuredGrid vtkUnstructuredGrid vtkFindCellStrategy

Online Examples:

VoxelsOnBoundary

ProcrustesAlignmentFilter

ExtractFaces

Tests:: vtkPointSet (Tests)

Definition at line 109 of file vtkPointSet.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataSet vtkPointSet::Superclass

Standard methods for type information and printing.

Definition at line 122 of file vtkPointSet.h.

Constructor & Destructor Documentation

◆ vtkPointSet()

vtkPointSet::vtkPointSet ( )

protected

◆ ~vtkPointSet()

vtkPointSet::~vtkPointSet ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPointSet* vtkPointSet::New ( )

static

Standard instantiation method.

◆ ExtendedNew()

static vtkPointSet* vtkPointSet::ExtendedNew ( )

static

◆ IsTypeOf()

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

static

Standard methods for type information and printing.

◆ IsA()

virtual vtkTypeBool vtkPointSet::IsA ( const char * type )

virtual

Standard methods for type information and printing.

Reimplemented from vtkDataSet.

Reimplemented in vtkLabelHierarchy, vtkUnstructuredGrid, vtkStructuredGrid, vtkPolyData, vtkPath, and vtkExplicitStructuredGrid.

◆ SafeDownCast()

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

static

Standard methods for type information and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPointSet::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type information and printing.

Reimplemented from vtkDataSet.

Reimplemented in vtkLabelHierarchy, vtkUnstructuredGrid, vtkStructuredGrid, vtkPolyData, vtkPath, and vtkExplicitStructuredGrid.

◆ NewInstance()

vtkPointSet* vtkPointSet::NewInstance ( ) const

Standard methods for type information and printing.

◆ PrintSelf()

void vtkPointSet::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard methods for type information and printing.

Reimplemented from vtkDataSet.

Reimplemented in vtkLabelHierarchy, vtkUnstructuredGridBase, vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

◆ GetDataObjectType()

int vtkPointSet::GetDataObjectType ( )

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Reimplemented in vtkUnstructuredGridBase, vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

Definition at line 129 of file vtkPointSet.h.

◆ SetEditable()

virtual void vtkPointSet::SetEditable ( bool )

virtual

Specify whether this dataset is editable after creation.

Meaning, once the points and cells are defined, can the dataset be incrementally modified. By default, this dataset is non-editable (i.e., "static") after construction. The reason for this is performance: cell links and locators can be built (and destroyed) much faster is it is known that the data is static (see vtkStaticCellLinks, vtkStaticPointLocator, vtkStaticCellLocator).

◆ GetEditable()

virtual bool vtkPointSet::GetEditable ( )

virtual

Specify whether this dataset is editable after creation.

Meaning, once the points and cells are defined, can the dataset be incrementally modified. By default, this dataset is non-editable (i.e., "static") after construction. The reason for this is performance: cell links and locators can be built (and destroyed) much faster is it is known that the data is static (see vtkStaticCellLinks, vtkStaticPointLocator, vtkStaticCellLocator).

◆ EditableOn()

virtual void vtkPointSet::EditableOn ( )

virtual

Specify whether this dataset is editable after creation.

Meaning, once the points and cells are defined, can the dataset be incrementally modified. By default, this dataset is non-editable (i.e., "static") after construction. The reason for this is performance: cell links and locators can be built (and destroyed) much faster is it is known that the data is static (see vtkStaticCellLinks, vtkStaticPointLocator, vtkStaticCellLocator).

◆ EditableOff()

virtual void vtkPointSet::EditableOff ( )

virtual

Specify whether this dataset is editable after creation.

Meaning, once the points and cells are defined, can the dataset be incrementally modified. By default, this dataset is non-editable (i.e., "static") after construction. The reason for this is performance: cell links and locators can be built (and destroyed) much faster is it is known that the data is static (see vtkStaticCellLinks, vtkStaticPointLocator, vtkStaticCellLocator).

◆ Initialize()

void vtkPointSet::Initialize ( )

overridevirtual

Reset to an empty state and free any memory.

Reimplemented from vtkDataSet.

Reimplemented in vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

◆ CopyStructure()

void vtkPointSet::CopyStructure ( vtkDataSet * pd )

overridevirtual

Copy the geometric structure of an input point set object.

Implements vtkDataSet.

Reimplemented in vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

◆ GetNumberOfPoints()

vtkIdType vtkPointSet::GetNumberOfPoints ( )

inlineoverridevirtual

See vtkDataSet for additional information.

Implements vtkDataSet.

Reimplemented in vtkStructuredGrid.

Definition at line 334 of file vtkPointSet.h.

◆ GetPoint() [1/2]

void vtkPointSet::GetPoint	(	vtkIdType	ptId,
		double	x[3]
	)

inlineoverridevirtual

See vtkDataSet for additional information.

Reimplemented from vtkDataSet.

Reimplemented in vtkStructuredGrid.

Definition at line 161 of file vtkPointSet.h.

◆ FindPoint() [1/2]

vtkIdType vtkPointSet::FindPoint ( double x[3] )

overridevirtual

See vtkDataSet for additional information.

Implements vtkDataSet.

◆ FindPoint() [2/2]

vtkIdType vtkPointSet::FindPoint	(	double	x,
		double	y,
		double	z
	)

inline

See vtkDataSet for additional information.

Definition at line 163 of file vtkPointSet.h.

◆ FindCell() [1/2]

vtkIdType vtkPointSet::FindCell	(	double	x[3],
		vtkCell *	cell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

overridevirtual

See vtkDataSet for additional information.

Implements vtkDataSet.

◆ FindCell() [2/2]

vtkIdType vtkPointSet::FindCell	(	double	x[3],
		vtkCell *	cell,
		vtkGenericCell *	gencell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

overridevirtual

See vtkDataSet for additional information.

Implements vtkDataSet.

◆ GetNumberOfCells()

vtkIdType vtkPointSet::GetNumberOfCells ( )

inlineoverridevirtual

This method always returns 0, as there are no cells in a vtkPointSet.

Implements vtkDataSet.

Reimplemented in vtkLabelHierarchy, vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

Definition at line 174 of file vtkPointSet.h.

◆ GetMaxCellSize()

int vtkPointSet::GetMaxCellSize ( )

inlineoverridevirtual

This method always returns 0, as there are no cells in a vtkPointSet.

Implements vtkDataSet.

Reimplemented in vtkLabelHierarchy, vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

Definition at line 175 of file vtkPointSet.h.

◆ GetCell() [1/2]

vtkCell* vtkPointSet::GetCell ( vtkIdType )

overridevirtual

This method always return a vtkEmptyCell, as there is no cell in a vtkPointSet.

Implements vtkDataSet.

Reimplemented in vtkLabelHierarchy, vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

◆ GetCellPoints() [1/3]

void vtkPointSet::GetCellPoints	(	vtkIdType	,
		vtkIdList *	idList
	)

inlineoverridevirtual

This method resets parameter idList, as there is no cell in a vtkPointSet.

Implements vtkDataSet.

Reimplemented in vtkLabelHierarchy, vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

Definition at line 190 of file vtkPointSet.h.

◆ GetPointCells()

void vtkPointSet::GetPointCells	(	vtkIdType	,
		vtkIdList *	idList
	)

inlineoverridevirtual

This method resets parameter idList, as there is no cell in a vtkPointSet.

Implements vtkDataSet.

Reimplemented in vtkLabelHierarchy, vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

Definition at line 191 of file vtkPointSet.h.

◆ GetCell() [2/2]

void vtkPointSet::GetCell	(	vtkIdType	,
		vtkGenericCell *	cell
	)

inlineoverridevirtual

This method sets cell to be an empty cell.

Implements vtkDataSet.

Reimplemented in vtkLabelHierarchy, vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

Definition at line 197 of file vtkPointSet.h.

◆ GetCellType()

int vtkPointSet::GetCellType ( vtkIdType )

inlineoverridevirtual

This method always returns VTK_EMPTY_CELL, as there is no cell in a vtkPointSet.

Implements vtkDataSet.

Reimplemented in vtkLabelHierarchy, vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

Definition at line 203 of file vtkPointSet.h.

◆ GetCellSize()

vtkIdType vtkPointSet::GetCellSize ( vtkIdType )

inlineoverridevirtual

This method always returns 1, as all cells are point in a pure vtkPointSet.

Reimplemented from vtkDataSet.

Reimplemented in vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

Definition at line 209 of file vtkPointSet.h.

◆ GetPoint() [2/2]

double* vtkPointSet::GetPoint ( vtkIdType ptId )

inlineoverridevirtual

See vtkDataSet for additional information.

WARNING: Just don't use this error-prone method, the returned pointer and its values are only valid as long as another method invocation is not performed. Prefer GetPoint() with the return value in argument.

Implements vtkDataSet.

Reimplemented in vtkStructuredGrid.

Definition at line 217 of file vtkPointSet.h.

◆ NewCellIterator()

vtkCellIterator* vtkPointSet::NewCellIterator ( )

overridevirtual

Return an iterator that traverses the cells in this data set.

Reimplemented from vtkDataSet.

Reimplemented in vtkUnstructuredGrid.

◆ BuildPointLocator()

void vtkPointSet::BuildPointLocator ( )

Build the internal point locator .

In a multi-threaded environment, call this method in a single thread before using FindCell() or FindPoint().

◆ BuildLocator()

void vtkPointSet::BuildLocator ( )

inline

Build the internal point locator .

In a multi-threaded environment, call this method in a single thread before using FindCell() or FindPoint().

Definition at line 230 of file vtkPointSet.h.

◆ BuildCellLocator()

void vtkPointSet::BuildCellLocator ( )

Build the cell locator.

In a multi-threaded environment, call this method in a single thread before using FindCell().

◆ SetPointLocator()

virtual void vtkPointSet::SetPointLocator ( vtkAbstractPointLocator * )

virtual

Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods.

By default a vtkStaticPointLocator is used, unless the class is set as Editable, in which case a vtkPointLocator is used.

◆ GetPointLocator()

virtual vtkAbstractPointLocator* vtkPointSet::GetPointLocator ( )

virtual

Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods.

By default a vtkStaticPointLocator is used, unless the class is set as Editable, in which case a vtkPointLocator is used.

◆ SetCellLocator()

virtual void vtkPointSet::SetCellLocator ( vtkAbstractCellLocator * )

virtual

Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCell() operation.

◆ GetCellLocator()

virtual vtkAbstractCellLocator* vtkPointSet::GetCellLocator ( )

virtual

Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCell() operation.

◆ GetMTime()

vtkMTimeType vtkPointSet::GetMTime ( )

overridevirtual

Get MTime which also considers its vtkPoints MTime.

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData.

◆ ComputeBounds()

void vtkPointSet::ComputeBounds ( )

overridevirtual

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

Reimplemented from vtkDataSet.

◆ Squeeze()

void vtkPointSet::Squeeze ( )

overridevirtual

Reclaim any unused memory.

Reimplemented from vtkDataSet.

Reimplemented in vtkUnstructuredGrid, and vtkPolyData.

◆ SetPoints()

virtual void vtkPointSet::SetPoints ( vtkPoints * )

virtual

Specify point array to define point coordinates.

Reimplemented in vtkLabelHierarchy.

◆ GetPoints()

virtual vtkPoints* vtkPointSet::GetPoints ( )

virtual

Specify point array to define point coordinates.

◆ GetActualMemorySize()

unsigned long vtkPointSet::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 vtkDataSet.

Reimplemented in vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

◆ ShallowCopy()

void vtkPointSet::ShallowCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

Reimplemented in vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

◆ DeepCopy()

void vtkPointSet::DeepCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

Reimplemented in vtkUnstructuredGridBase, vtkUnstructuredGrid, vtkStructuredGrid, and vtkPolyData.

◆ UsesGarbageCollector()

bool vtkPointSet::UsesGarbageCollector ( ) const

inlineoverridevirtual

Overwritten to handle the data/locator loop.

Reimplemented from vtkObjectBase.

Definition at line 304 of file vtkPointSet.h.

◆ GetData() [1/2]

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

static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

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

static

Retrieve an instance of this class from an information object.

◆ ReportReferences()

void vtkPointSet::ReportReferences ( vtkGarbageCollector * )

overrideprotectedvirtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkUnstructuredGrid, and vtkPolyData.

◆ GetCellPoints() [2/3]

virtual void vtkDataSet::GetCellPoints

This method resets parameter idList, as there is no cell in a vtkPointSet.

◆ GetCellPoints() [3/3]

virtual void vtkDataSet::GetCellPoints

This method resets parameter idList, as there is no cell in a vtkPointSet.

Member Data Documentation

◆ Editable

bool vtkPointSet::Editable

protected

Definition at line 319 of file vtkPointSet.h.

◆ Points

vtkPoints* vtkPointSet::Points

protected

Definition at line 320 of file vtkPointSet.h.

◆ PointLocator

vtkAbstractPointLocator* vtkPointSet::PointLocator

protected

Definition at line 321 of file vtkPointSet.h.

◆ CellLocator

vtkAbstractCellLocator* vtkPointSet::CellLocator

protected

Definition at line 322 of file vtkPointSet.h.

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

Common/DataModel/vtkPointSet.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPointSet()

◆ ~vtkPointSet()

Member Function Documentation

◆ New()

◆ ExtendedNew()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetDataObjectType()

◆ SetEditable()

◆ GetEditable()

◆ EditableOn()

◆ EditableOff()

◆ Initialize()

◆ CopyStructure()

◆ GetNumberOfPoints()

◆ GetPoint() [1/2]

◆ FindPoint() [1/2]

◆ FindPoint() [2/2]

◆ FindCell() [1/2]

◆ FindCell() [2/2]

◆ GetNumberOfCells()

◆ GetMaxCellSize()

◆ GetCell() [1/2]

◆ GetCellPoints() [1/3]

◆ GetPointCells()

◆ GetCell() [2/2]

◆ GetCellType()

◆ GetCellSize()

◆ GetPoint() [2/2]

◆ NewCellIterator()

◆ BuildPointLocator()

◆ BuildLocator()

◆ BuildCellLocator()

◆ SetPointLocator()

◆ GetPointLocator()

◆ SetCellLocator()

◆ GetCellLocator()

◆ GetMTime()

◆ ComputeBounds()

◆ Squeeze()

◆ SetPoints()

◆ GetPoints()

◆ GetActualMemorySize()

◆ ShallowCopy()

◆ DeepCopy()

◆ UsesGarbageCollector()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ ReportReferences()

◆ GetCellPoints() [2/3]

◆ GetCellPoints() [3/3]

Member Data Documentation

◆ Editable

◆ Points

◆ PointLocator

◆ CellLocator