Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

vtkPointSet Class Reference

abstract class for specifying dataset behavior. More...

#include <vtkPointSet.h>

Inheritance diagram for vtkPointSet:

[legend]Collaboration diagram for vtkPointSet:

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	Initialize ()
void	CopyStructure (vtkDataSet *pd)
int	GetNumberOfPoints ()
float *	GetPoint (int ptId)
void	GetPoint (int ptId, float x[3])
int	FindPoint (float x[3])
int	FindPoint (float x, float y, float z)
int	FindCell (float x[3], vtkCell cell, int cellId, float tol2, int &subId, float pcoords[3], float weights)
int	FindCell (float x[3], vtkCell cell, vtkGenericCell gencell, int cellId, float tol2, int &subId, float pcoords[3], float *weights)
unsigned long	GetMTime ()
void	ComputeBounds ()
void	Squeeze ()
virtual void	SetPoints (vtkPoints *)
virtual vtkPoints *	GetPoints ()
void	UnRegister (vtkObject *o)
virtual int	GetNetReferenceCount ()
unsigned long	GetActualMemorySize ()
void	ShallowCopy (vtkDataObject *src)
void	DeepCopy (vtkDataObject *src)
Static Public Methods
int	IsTypeOf (const char *type)
vtkPointSet *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkPointSet ()
	~vtkPointSet ()
	vtkPointSet (const vtkPointSet &)
void	operator= (const vtkPointSet &)
Protected Attributes
vtkPoints *	Points
vtkPointLocator *	Locator

Detailed Description

abstract class for specifying dataset behavior.

Date:: 2000/12/10 20:08:14

Revision:: 1.50

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

Examples:: vtkPointSet (examples)

Definition at line 64 of file vtkPointSet.h.

Constructor & Destructor Documentation

vtkPointSet::vtkPointSet ( ) [protected]

vtkPointSet::~vtkPointSet ( ) [protected]

vtkPointSet::vtkPointSet ( const vtkPointSet & ) [inline, protected]

Definition at line 123 of file vtkPointSet.h.

Member Function Documentation

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataSet.
Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataSet.
Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
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 * ds ) [virtual]

Copy the geometric structure of an input point set object.
Reimplemented from vtkDataSet.
Reimplemented in vtkPolyData, vtkStructuredGrid, and vtkUnstructuredGrid.

int vtkPointSet::GetNumberOfPoints ( ) [inline, virtual]

See vtkDataSet for additional information.
Reimplemented from vtkDataSet.
Reimplemented in vtkStructuredGrid.
Definition at line 131 of file vtkPointSet.h.
Referenced by vtkStructuredGrid::GetNumberOfPoints().

float* vtkPointSet::GetPoint ( int ptId ) [inline, virtual]

Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. THIS METHOD IS NOT THREAD SAFE.
Reimplemented from vtkDataSet.
Reimplemented in vtkStructuredGrid.
Definition at line 78 of file vtkPointSet.h.
Referenced by vtkStructuredGrid::GetPoint().

void vtkPointSet::GetPoint ( int ptId,

float p[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 79 of file vtkPointSet.h.

int vtkPointSet::FindPoint ( float x[3] ) [virtual]

Reimplemented from vtkDataSet.

int vtkPointSet::FindPoint ( float x,

float y,

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

int vtkPointSet::FindCell ( float x[3],

vtkCell * cell,

int cellId,

float tol2,

int & subId,

float pcoords[3],

float * 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.
Reimplemented from vtkDataSet.

int vtkPointSet::FindCell ( float x[3],

vtkCell * cell,

vtkGenericCell * gencell,

int cellId,

float tol2,

int & subId,

float pcoords[3],

float * weights

) [virtual]

This is a version of the above method that can be used with multithreaded applications. A vtkGenericCell must be passes 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
Reimplemented from 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]

void vtkPointSet::UnRegister ( vtkObject * 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.

void vtkPointSet::operator= ( const vtkPointSet & ) [inline, protected]

Definition at line 124 of file vtkPointSet.h.

Member Data Documentation

vtkPoints* vtkPointSet::Points [protected]

Definition at line 126 of file vtkPointSet.h.

vtkPointLocator* vtkPointSet::Locator [protected]

Definition at line 127 of file vtkPointSet.h.

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

common/vtkPointSet.h

Generated on Wed Nov 21 12:57:34 2001 for VTK by

vtkPointSet Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation