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

abstract class for specifying dataset behavior More...

#include <vtkPointSet.h>

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

Public Types

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...
 
vtkPointSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetEditable (bool)
 Specify whether this dataset is editable after creation. More...
 
virtual bool GetEditable ()
 
virtual void EditableOn ()
 
virtual void EditableOff ()
 
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...
 
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 ()
 
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...
 
virtual void SetPoints (vtkPoints *)
 Specify point array to define point coordinates. More...
 
virtual vtkPointsGetPoints ()
 
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 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 vtkIdType GetNumberOfCells ()=0
 Determine the number of cells composing the dataset. 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...
 
virtual void GetCellBounds (vtkIdType cellId, double bounds[6])
 Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
virtual int GetCellType (vtkIdType cellId)=0
 Get type of 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, vtkIdList *ptIds)=0
 Topological inquiry to get points defining cell. More...
 
virtual void GetPointCells (vtkIdType ptId, vtkIdList *cellIds)=0
 Topological inquiry to get cells using point. 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...
 
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...
 
virtual int GetMaxCellSize ()=0
 Convenience method returns largest cell size in dataset. More...
 
int GetDataObjectType () override
 Return the type of data object. 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 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 Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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

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
 

Detailed Description

abstract class for specifying dataset behavior

vtkPointSet is an abstract class 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

Definition at line 62 of file vtkPointSet.h.

Member Typedef Documentation

◆ Superclass

Standard methdos for type information and printing.

Definition at line 69 of file vtkPointSet.h.

Constructor & Destructor Documentation

◆ vtkPointSet()

vtkPointSet::vtkPointSet ( )
protected

◆ ~vtkPointSet()

vtkPointSet::~vtkPointSet ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPointSet::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 vtkDataSet.

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPointSet::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkPointSet* vtkPointSet::NewInstance ( ) const

◆ PrintSelf()

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

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

◆ 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

◆ EditableOn()

virtual void vtkPointSet::EditableOn ( )
virtual

◆ EditableOff()

virtual void vtkPointSet::EditableOff ( )
virtual

◆ Initialize()

void vtkPointSet::Initialize ( )
overridevirtual

Reset to an empty state and free any memory.

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkUnstructuredGrid, and vtkStructuredGrid.

◆ CopyStructure()

void vtkPointSet::CopyStructure ( vtkDataSet pd)
overridevirtual

Copy the geometric structure of an input point set object.

Implements vtkDataSet.

Reimplemented in vtkUnstructuredGrid, vtkPolyData, and vtkStructuredGrid.

◆ GetNumberOfPoints()

vtkIdType vtkPointSet::GetNumberOfPoints ( )
inlineoverridevirtual

See vtkDataSet for additional information.

Implements vtkDataSet.

Reimplemented in vtkStructuredGrid.

Definition at line 234 of file vtkPointSet.h.

◆ GetPoint() [1/2]

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

Copy point coordinates into user provided array x[3] for specified point id.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

Reimplemented in vtkStructuredGrid.

Definition at line 102 of file vtkPointSet.h.

◆ FindPoint() [1/2]

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

Implements vtkDataSet.

◆ FindPoint() [2/2]

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

Definition at line 104 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

Locate cell based on global coordinate x and tolerance squared.

If cell and cellId is non-nullptr, then search starts from this cell and looks at immediate neighbors. Returns cellId >= 0 if inside, < 0 otherwise. The parametric coordinates are provided in pcoords[3]. The interpolation weights are returned in weights[]. (The number of weights is equal to the number of points in the found cell). Tolerance is used to control how close the point is to be considered "in" the cell. THIS METHOD IS NOT THREAD SAFE.

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

This is a version of the above method that can be used with multithreaded applications.

A vtkGenericCell must be passed in to be used in internal calls that might be made to GetCell() THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ 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 117 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

Definition at line 130 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

◆ SetCellLocator()

virtual void vtkPointSet::SetCellLocator ( vtkAbstractCellLocator )
virtual

Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCelloperation.

◆ GetCellLocator()

virtual vtkAbstractCellLocator* vtkPointSet::GetCellLocator ( )
virtual

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

Reimplemented in vtkPolyData.

◆ 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

◆ 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 vtkPolyData, vtkUnstructuredGrid, and vtkStructuredGrid.

◆ ShallowCopy()

void vtkPointSet::ShallowCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkUnstructuredGrid, and vtkStructuredGrid.

◆ DeepCopy()

void vtkPointSet::DeepCopy ( vtkDataObject src)
overridevirtual

◆ Register()

void vtkPointSet::Register ( vtkObjectBase o)
overridevirtual

Overwritten to handle the data/locator loop.

Reimplemented from vtkObjectBase.

◆ UnRegister()

void vtkPointSet::UnRegister ( vtkObjectBase o)
overridevirtual

Decrease the reference count (release by another object).

This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).

Reimplemented from vtkObjectBase.

◆ 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

◆ ReportReferences()

void vtkPointSet::ReportReferences ( vtkGarbageCollector )
overrideprotectedvirtual

Reimplemented from vtkObjectBase.

Member Data Documentation

◆ Editable

bool vtkPointSet::Editable
protected

Definition at line 220 of file vtkPointSet.h.

◆ Points

vtkPoints* vtkPointSet::Points
protected

Definition at line 221 of file vtkPointSet.h.

◆ PointLocator

vtkAbstractPointLocator* vtkPointSet::PointLocator
protected

Definition at line 222 of file vtkPointSet.h.

◆ CellLocator

vtkAbstractCellLocator* vtkPointSet::CellLocator
protected

Definition at line 223 of file vtkPointSet.h.


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