vtkPoints Class Reference

#include <vtkPoints.h>

Inheritance diagram for vtkPoints:

[legend]Collaboration diagram for vtkPoints:

[legend]List of all members.

Detailed Description

represent and manipulate 3D points

vtkPoints represents 3D points. The data model for vtkPoints is an array of vx-vy-vz triplets accessible by (point or cell) id.

Created by:

Schroeder, Will

CVS contributions (if > 5%):

Schroeder, Will (44%)
Geveci, Berk (22%)
Martin, Ken (12%)

CVS logs (CVSweb):

.cxx (/Common/vtkPoints.cxx)
.h (/Common/vtkPoints.h)

Examples:: vtkPoints (Examples)

Tests:: vtkPoints (Tests)

Definition at line 50 of file vtkPoints.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

virtual int Allocate (const vtkIdType sz, const vtkIdType ext=1000)

virtual void Initialize ()

virtual int GetDataType ()

void * GetVoidPointer (const int id)

virtual void Squeeze ()

virtual void Reset ()

unsigned long GetActualMemorySize ()

vtkIdType GetNumberOfPoints ()

double * GetPoint (vtkIdType id)

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

void SetNumberOfPoints (vtkIdType number)

void GetPoints (vtkIdList *ptId, vtkPoints *fp)

virtual void ComputeBounds ()

double * GetBounds ()

void GetBounds (double bounds[6])

virtual void SetData (vtkDataArray *)

vtkDataArray * GetData ()

virtual void SetDataType (int dataType)

void SetDataTypeToBit ()

void SetDataTypeToChar ()

void SetDataTypeToUnsignedChar ()

void SetDataTypeToShort ()

void SetDataTypeToUnsignedShort ()

void SetDataTypeToInt ()

void SetDataTypeToUnsignedInt ()

void SetDataTypeToLong ()

void SetDataTypeToUnsignedLong ()

void SetDataTypeToFloat ()

void SetDataTypeToDouble ()

virtual void DeepCopy (vtkPoints *ad)

virtual void ShallowCopy (vtkPoints *ad)

void SetPoint (vtkIdType id, const float x[3])

void SetPoint (vtkIdType id, const double x[3])

void SetPoint (vtkIdType id, double x, double y, double z)

void InsertPoint (vtkIdType id, const float x[3])

void InsertPoint (vtkIdType id, const double x[3])

void InsertPoint (vtkIdType id, double x, double y, double z)

vtkIdType InsertNextPoint (const float x[3])

vtkIdType InsertNextPoint (const double x[3])

vtkIdType InsertNextPoint (double x, double y, double z)

Static Public Member Functions

vtkPoints * New (int dataType)

vtkPoints * New ()

int IsTypeOf (const char *type)

vtkPoints * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkPoints (int dataType=VTK_FLOAT)

~vtkPoints ()

Protected Attributes

double Bounds [6]

vtkTimeStamp ComputeTime

vtkDataArray * Data

Member Typedef Documentation

typedef vtkObject vtkPoints::Superclass

Reimplemented from vtkObject.
Definition at line 58 of file vtkPoints.h.

Constructor & Destructor Documentation

vtkPoints::vtkPoints ( int dataType = VTK_FLOAT ) [protected]

vtkPoints::~vtkPoints ( ) [protected]

Member Function Documentation

vtkPoints* vtkPoints::New ( int dataType ) [static]

vtkPoints* vtkPoints::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
Reimplemented in vtkPointsProjectedHull.

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

Reimplemented from vtkObject.

int vtkPoints::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 vtkObject.

virtual int vtkPoints::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 vtkObject.

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

Reimplemented from vtkObject.

void vtkPoints::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 vtkObject.
Reimplemented in vtkPointsProjectedHull.

virtual int vtkPoints::Allocate ( const vtkIdType sz,

const vtkIdType ext = 1000

) [virtual]

Allocate initial memory size.

virtual void vtkPoints::Initialize ( ) [virtual]

Return object to instantiated state.
Reimplemented in vtkPointsProjectedHull.
Referenced by vtkPointsProjectedHull::Reset().

virtual void vtkPoints::SetData ( vtkDataArray * ) [virtual]

Set/Get the underlying data array. This function must be implemented in a concrete subclass to check for consistency. (The tuple size must match the type of data. For example, 3-tuple data array can be assigned to a vector, normal, or points object, but not a tensor object, which has a tuple dimension of 9. Scalars, on the other hand, can have tuple dimension from 1-4, depending on the type of scalar.)

vtkDataArray* vtkPoints::GetData ( ) [inline]

Set/Get the underlying data array. This function must be implemented in a concrete subclass to check for consistency. (The tuple size must match the type of data. For example, 3-tuple data array can be assigned to a vector, normal, or points object, but not a tensor object, which has a tuple dimension of 9. Scalars, on the other hand, can have tuple dimension from 1-4, depending on the type of scalar.)
Definition at line 75 of file vtkPoints.h.

virtual int vtkPoints::GetDataType ( ) [virtual]

Return the underlying data type. An integer indicating data type is returned as specified in vtkSetGet.h.

virtual void vtkPoints::SetDataType ( int dataType ) [virtual]

Specify the underlying data type of the object.

void vtkPoints::SetDataTypeToBit ( ) [inline]

Specify the underlying data type of the object.
Definition at line 85 of file vtkPoints.h.
References VTK_BIT.

void vtkPoints::SetDataTypeToChar ( ) [inline]

Specify the underlying data type of the object.
Definition at line 86 of file vtkPoints.h.
References VTK_CHAR.

void vtkPoints::SetDataTypeToUnsignedChar ( ) [inline]

Specify the underlying data type of the object.
Definition at line 87 of file vtkPoints.h.
References VTK_UNSIGNED_CHAR.

void vtkPoints::SetDataTypeToShort ( ) [inline]

Specify the underlying data type of the object.
Definition at line 88 of file vtkPoints.h.
References VTK_SHORT.

void vtkPoints::SetDataTypeToUnsignedShort ( ) [inline]

Specify the underlying data type of the object.
Definition at line 89 of file vtkPoints.h.
References VTK_UNSIGNED_SHORT.

void vtkPoints::SetDataTypeToInt ( ) [inline]

Specify the underlying data type of the object.
Definition at line 90 of file vtkPoints.h.
References VTK_INT.

void vtkPoints::SetDataTypeToUnsignedInt ( ) [inline]

Specify the underlying data type of the object.
Definition at line 91 of file vtkPoints.h.
References VTK_UNSIGNED_INT.

void vtkPoints::SetDataTypeToLong ( ) [inline]

Specify the underlying data type of the object.
Definition at line 92 of file vtkPoints.h.
References VTK_LONG.

void vtkPoints::SetDataTypeToUnsignedLong ( ) [inline]

Specify the underlying data type of the object.
Definition at line 93 of file vtkPoints.h.
References VTK_UNSIGNED_LONG.

void vtkPoints::SetDataTypeToFloat ( ) [inline]

Specify the underlying data type of the object.
Definition at line 94 of file vtkPoints.h.
References VTK_FLOAT.

void vtkPoints::SetDataTypeToDouble ( ) [inline]

Specify the underlying data type of the object.
Definition at line 95 of file vtkPoints.h.
References VTK_DOUBLE.

void* vtkPoints::GetVoidPointer ( const int id ) [inline]

Return a void pointer. For image pipeline interface and other special pointer manipulation.
Definition at line 100 of file vtkPoints.h.

virtual void vtkPoints::Squeeze ( ) [inline, virtual]

Reclaim any extra memory.
Definition at line 103 of file vtkPoints.h.

virtual void vtkPoints::Reset ( ) [inline, virtual]

Make object look empty but do not delete memory.
Reimplemented in vtkPointsProjectedHull.
Definition at line 106 of file vtkPoints.h.

virtual void vtkPoints::DeepCopy ( vtkPoints * ad ) [virtual]

Different ways to copy data. Shallow copy does reference count (i.e., assigns pointers and updates reference count); deep copy runs through entire data array assigning values.

virtual void vtkPoints::ShallowCopy ( vtkPoints * ad ) [virtual]

Different ways to copy data. Shallow copy does reference count (i.e., assigns pointers and updates reference count); deep copy runs through entire data array assigning values.

unsigned long vtkPoints::GetActualMemorySize ( )

Return the memory in kilobytes consumed by this attribute data. Used to support streaming and reading/writing data. The value returned is guaranteed to be greater than or equal to the memory required to actually represent the data represented by this object. The information returned is valid only after the pipeline has been updated.

vtkIdType vtkPoints::GetNumberOfPoints ( ) [inline]

Return number of points in array.
Definition at line 125 of file vtkPoints.h.
References vtkIdType.
Referenced by vtkPointSet::GetNumberOfPoints().

double* vtkPoints::GetPoint ( vtkIdType id ) [inline]

Return a pointer to a double point x[3] for a specific id.
Definition at line 128 of file vtkPoints.h.
References vtkIdType.

void vtkPoints::GetPoint ( vtkIdType id,

double x[3]

) [inline]

Copy point components into user provided array v[3] for specified id.
Definition at line 131 of file vtkPoints.h.
References vtkIdType.

void vtkPoints::SetPoint ( vtkIdType id,

const float x[3]

) [inline]

Insert point into object. No range checking performed (fast!). Make sure you use SetNumberOfPoints() to allocate memory prior to using SetPoint().
Definition at line 137 of file vtkPoints.h.
References vtkIdType.

void vtkPoints::SetPoint ( vtkIdType id,

const double x[3]

) [inline]

Insert point into object. No range checking performed (fast!). Make sure you use SetNumberOfPoints() to allocate memory prior to using SetPoint().
Definition at line 138 of file vtkPoints.h.
References vtkIdType.

void vtkPoints::SetPoint ( vtkIdType id,

double x,

double y,

double z

) [inline]

Insert point into object. No range checking performed (fast!). Make sure you use SetNumberOfPoints() to allocate memory prior to using SetPoint().
Definition at line 197 of file vtkPoints.h.
References Data, vtkDataArray::SetTuple(), and vtkIdType.

void vtkPoints::InsertPoint ( vtkIdType id,

const float x[3]

) [inline]

Insert point into object. Range checking performed and memory allocated as necessary.
Definition at line 145 of file vtkPoints.h.
References vtkIdType.

void vtkPoints::InsertPoint ( vtkIdType id,

const double x[3]

) [inline]

Insert point into object. Range checking performed and memory allocated as necessary.
Definition at line 147 of file vtkPoints.h.
References vtkIdType.

void vtkPoints::InsertPoint ( vtkIdType id,

double x,

double y,

double z

) [inline]

Insert point into object. Range checking performed and memory allocated as necessary.
Definition at line 206 of file vtkPoints.h.
References Data, vtkDataArray::InsertTuple(), and vtkIdType.

vtkIdType vtkPoints::InsertNextPoint ( const float x[3] ) [inline]

Insert point into next available slot. Returns id of slot.
Definition at line 154 of file vtkPoints.h.
References vtkIdType.
Referenced by vtkNonLinearCell::InsertPoint().

vtkIdType vtkPoints::InsertNextPoint ( const double x[3] ) [inline]

Insert point into next available slot. Returns id of slot.
Definition at line 156 of file vtkPoints.h.
References vtkIdType.

vtkIdType vtkPoints::InsertNextPoint ( double x,

double y,

double z

) [inline]

Insert point into next available slot. Returns id of slot.
Definition at line 216 of file vtkPoints.h.
References Data, vtkDataArray::InsertNextTuple(), and vtkIdType.

void vtkPoints::SetNumberOfPoints ( vtkIdType number ) [inline]

Specify the number of points for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetPoint() method for fast insertion.
Definition at line 191 of file vtkPoints.h.
References Data, vtkDataArray::SetNumberOfComponents(), vtkDataArray::SetNumberOfTuples(), and vtkIdType.

void vtkPoints::GetPoints ( vtkIdList * ptId,

vtkPoints * fp

)

Given a list of pt ids, return an array of points.

virtual void vtkPoints::ComputeBounds ( ) [virtual]

Determine (xmin,xmax, ymin,ymax, zmin,zmax) bounds of points.

double* vtkPoints::GetBounds ( )

Return the bounds of the points.

void vtkPoints::GetBounds ( double bounds[6] )

Return the bounds of the points.

Member Data Documentation

double vtkPoints::Bounds[6] [protected]

Definition at line 182 of file vtkPoints.h.

vtkTimeStamp vtkPoints::ComputeTime [protected]

Definition at line 183 of file vtkPoints.h.

vtkDataArray* vtkPoints::Data [protected]

Definition at line 184 of file vtkPoints.h.
Referenced by InsertNextPoint(), InsertPoint(), SetNumberOfPoints(), and SetPoint().

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

dox/Common/vtkPoints.h


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	Allocate (const vtkIdType sz, const vtkIdType ext=1000)
virtual void	Initialize ()
virtual int	GetDataType ()
void *	GetVoidPointer (const int id)
virtual void	Squeeze ()
virtual void	Reset ()
unsigned long	GetActualMemorySize ()
vtkIdType	GetNumberOfPoints ()
double *	GetPoint (vtkIdType id)
void	GetPoint (vtkIdType id, double x[3])
void	SetNumberOfPoints (vtkIdType number)
void	GetPoints (vtkIdList ptId, vtkPoints fp)
virtual void	ComputeBounds ()
double *	GetBounds ()
void	GetBounds (double bounds[6])

virtual void	SetData (vtkDataArray *)
vtkDataArray *	GetData ()

virtual void	SetDataType (int dataType)
void	SetDataTypeToBit ()
void	SetDataTypeToChar ()
void	SetDataTypeToUnsignedChar ()
void	SetDataTypeToShort ()
void	SetDataTypeToUnsignedShort ()
void	SetDataTypeToInt ()
void	SetDataTypeToUnsignedInt ()
void	SetDataTypeToLong ()
void	SetDataTypeToUnsignedLong ()
void	SetDataTypeToFloat ()
void	SetDataTypeToDouble ()

virtual void	DeepCopy (vtkPoints *ad)
virtual void	ShallowCopy (vtkPoints *ad)

void	SetPoint (vtkIdType id, const float x[3])
void	SetPoint (vtkIdType id, const double x[3])
void	SetPoint (vtkIdType id, double x, double y, double z)

void	InsertPoint (vtkIdType id, const float x[3])
void	InsertPoint (vtkIdType id, const double x[3])
void	InsertPoint (vtkIdType id, double x, double y, double z)

vtkIdType	InsertNextPoint (const float x[3])
vtkIdType	InsertNextPoint (const double x[3])
vtkIdType	InsertNextPoint (double x, double y, double z)
Static Public Member Functions
vtkPoints *	New (int dataType)
vtkPoints *	New ()
int	IsTypeOf (const char *type)
vtkPoints *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPoints (int dataType=VTK_FLOAT)
	~vtkPoints ()
Protected Attributes
double	Bounds [6]
vtkTimeStamp	ComputeTime
vtkDataArray *	Data