Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkPointSet Class Reference

#include <vtkPointSet.h>

Inheritance diagram for vtkPointSet:

Inheritance graph
[legend]
Collaboration diagram for vtkPointSet:

Collaboration graph
[legend]
List of all members.

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 and vtkUnstructuredGrid require point arrays to specify point position, while vtkStructuredPoints generates point positions implicitly.

See also:
vtkPolyData vtkStructuredGrid vtkUnstructuredGrid

Definition at line 37 of file vtkPointSet.h.

Public Types

typedef vtkDataSet Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Initialize ()
void CopyStructure (vtkDataSet *pd)
vtkIdType GetNumberOfPoints ()
double * GetPoint (vtkIdType ptId)
void GetPoint (vtkIdType ptId, double x[3])
vtkIdType FindPoint (double x[3])
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)
vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
unsigned long GetMTime ()
void ComputeBounds ()
void Squeeze ()
virtual void SetPoints (vtkPoints *)
virtual vtkPointsGetPoints ()
virtual void UnRegister (vtkObjectBase *o)
virtual int GetNetReferenceCount ()
unsigned long GetActualMemorySize ()
void ShallowCopy (vtkDataObject *src)
void DeepCopy (vtkDataObject *src)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPointSetSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPointSet ()
 ~vtkPointSet ()

Protected Attributes

vtkPointsPoints
vtkPointLocatorLocator


Member Typedef Documentation

typedef vtkDataSet vtkPointSet::Superclass
 

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

Definition at line 40 of file vtkPointSet.h.


Constructor & Destructor Documentation

vtkPointSet::vtkPointSet  )  [protected]
 

vtkPointSet::~vtkPointSet  )  [protected]
 


Member Function Documentation

virtual const char* vtkPointSet::GetClassName  )  [virtual]
 

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

static int vtkPointSet::IsTypeOf const char *  type  )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

virtual int vtkPointSet::IsA const char *  type  )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

static vtkPointSet* vtkPointSet::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

void vtkPointSet::PrintSelf ostream &  os,
vtkIndent  indent
[virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

void vtkPointSet::Initialize  )  [virtual]
 

Reset to an empty state and free any memory.

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

void vtkPointSet::CopyStructure vtkDataSet pd  )  [virtual]
 

Copy the geometric structure of an input point set object.

Implements vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

vtkIdType vtkPointSet::GetNumberOfPoints  )  [inline, virtual]
 

See vtkDataSet for additional information.

Implements vtkDataSet.

Reimplemented in vtkStructuredGrid.

Definition at line 111 of file vtkPointSet.h.

References vtkPoints::GetNumberOfPoints(), and Points.

Referenced by vtkStructuredGrid::GetNumberOfPoints().

double* vtkPointSet::GetPoint vtkIdType  ptId  )  [inline, virtual]
 

Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

Reimplemented in vtkStructuredGrid.

Definition at line 52 of file vtkPointSet.h.

Referenced by vtkStructuredGrid::GetPoint().

void vtkPointSet::GetPoint vtkIdType  ptId,
double  x[3]
[inline, virtual]
 

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 53 of file vtkPointSet.h.

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

Implements vtkDataSet.

vtkIdType vtkPointSet::FindPoint double  x,
double  y,
double  z
[inline]
 

Locate the closest point to the global coordinate x. Return the point id. If point id < 0; then no point found. (This may arise when point is outside of dataset.) THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

Definition at line 55 of file vtkPointSet.h.

References vtkDataSet::FindPoint().

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

Locate cell based on global coordinate x and tolerance squared. If cell and cellId is non-NULL, 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.

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

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.

unsigned long vtkPointSet::GetMTime  )  [virtual]
 

Get MTime which also considers its vtkPoints MTime.

Reimplemented from vtkDataSet.

void vtkPointSet::ComputeBounds  )  [virtual]
 

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

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData.

void vtkPointSet::Squeeze  )  [virtual]
 

Reclaim any unused memory.

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, and vtkUnstructuredGrid.

virtual void vtkPointSet::SetPoints vtkPoints  )  [virtual]
 

Specify point array to define point coordinates.

virtual vtkPoints* vtkPointSet::GetPoints  )  [virtual]
 

virtual void vtkPointSet::UnRegister vtkObjectBase o  )  [virtual]
 

Detect reference loop PointSet <-> locator.

Reimplemented from vtkDataObject.

virtual int vtkPointSet::GetNetReferenceCount  )  [virtual]
 

Get the net reference count. That is the count minus any self created loops. This is used in the Source/Data registration to properly free the objects.

Reimplemented from vtkDataObject.

unsigned long vtkPointSet::GetActualMemorySize  )  [virtual]
 

Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE.

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

void vtkPointSet::ShallowCopy vtkDataObject src  )  [virtual]
 

Shallow and Deep copy.

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

void vtkPointSet::DeepCopy vtkDataObject src  )  [virtual]
 

Reimplemented from vtkDataSet.

Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.


Member Data Documentation

vtkPoints* vtkPointSet::Points [protected]
 

Definition at line 103 of file vtkPointSet.h.

Referenced by GetNumberOfPoints().

vtkPointLocator* vtkPointSet::Locator [protected]
 

Definition at line 104 of file vtkPointSet.h.


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