vtkPoints2D Class Reference

#include <vtkPoints2D.h>

Inheritance diagram for vtkPoints2D:

Inheritance graph
[legend]
Collaboration diagram for vtkPoints2D:

Collaboration graph
[legend]

List of all members.


Detailed Description

represent and manipulate 2D points

vtkPoints2D represents 2D points. The data model for vtkPoints2D is an array of vx-vy doublets accessible by (point or cell) id.

Tests:
vtkPoints2D (Tests)

Definition at line 34 of file vtkPoints2D.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[2])
void SetNumberOfPoints (vtkIdType number)
void GetPoints (vtkIdList *ptId, vtkPoints2D *fp)
virtual void ComputeBounds ()
double * GetBounds ()
void GetBounds (double bounds[4])
virtual void SetData (vtkDataArray *)
vtkDataArrayGetData ()
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 (vtkPoints2D *ad)
virtual void ShallowCopy (vtkPoints2D *ad)
void SetPoint (vtkIdType id, const float x[2])
void SetPoint (vtkIdType id, const double x[2])
void SetPoint (vtkIdType id, double x, double y)
void InsertPoint (vtkIdType id, const float x[2])
void InsertPoint (vtkIdType id, const double x[2])
void InsertPoint (vtkIdType id, double x, double y)
vtkIdType InsertNextPoint (const float x[2])
vtkIdType InsertNextPoint (const double x[2])
vtkIdType InsertNextPoint (double x, double y)

Static Public Member Functions

static vtkPoints2DNew (int dataType)
static vtkPoints2DNew ()
static int IsTypeOf (const char *type)
static vtkPoints2DSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPoints2D (int dataType=VTK_FLOAT)
 ~vtkPoints2D ()

Protected Attributes

double Bounds [4]
vtkTimeStamp ComputeTime
vtkDataArrayData

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 42 of file vtkPoints2D.h.


Constructor & Destructor Documentation

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

vtkPoints2D::~vtkPoints2D (  )  [protected]


Member Function Documentation

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

static vtkPoints2D* vtkPoints2D::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

static int vtkPoints2D::IsTypeOf ( const char *  name  )  [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 vtkObject.

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

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

Reimplemented from vtkObject.

void vtkPoints2D::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.

virtual int vtkPoints2D::Allocate ( const vtkIdType  sz,
const vtkIdType  ext = 1000 
) [virtual]

Allocate initial memory size.

virtual void vtkPoints2D::Initialize (  )  [virtual]

Return object to instantiated state.

virtual void vtkPoints2D::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* vtkPoints2D::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 59 of file vtkPoints2D.h.

virtual int vtkPoints2D::GetDataType (  )  [virtual]

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

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

Specify the underlying data type of the object.

void vtkPoints2D::SetDataTypeToBit (  )  [inline]

Specify the underlying data type of the object.

Definition at line 69 of file vtkPoints2D.h.

void vtkPoints2D::SetDataTypeToChar (  )  [inline]

Specify the underlying data type of the object.

Definition at line 70 of file vtkPoints2D.h.

void vtkPoints2D::SetDataTypeToUnsignedChar (  )  [inline]

Specify the underlying data type of the object.

Definition at line 71 of file vtkPoints2D.h.

void vtkPoints2D::SetDataTypeToShort (  )  [inline]

Specify the underlying data type of the object.

Definition at line 72 of file vtkPoints2D.h.

void vtkPoints2D::SetDataTypeToUnsignedShort (  )  [inline]

Specify the underlying data type of the object.

Definition at line 73 of file vtkPoints2D.h.

void vtkPoints2D::SetDataTypeToInt (  )  [inline]

Specify the underlying data type of the object.

Definition at line 74 of file vtkPoints2D.h.

void vtkPoints2D::SetDataTypeToUnsignedInt (  )  [inline]

Specify the underlying data type of the object.

Definition at line 75 of file vtkPoints2D.h.

void vtkPoints2D::SetDataTypeToLong (  )  [inline]

Specify the underlying data type of the object.

Definition at line 76 of file vtkPoints2D.h.

void vtkPoints2D::SetDataTypeToUnsignedLong (  )  [inline]

Specify the underlying data type of the object.

Definition at line 77 of file vtkPoints2D.h.

void vtkPoints2D::SetDataTypeToFloat (  )  [inline]

Specify the underlying data type of the object.

Definition at line 78 of file vtkPoints2D.h.

void vtkPoints2D::SetDataTypeToDouble (  )  [inline]

Specify the underlying data type of the object.

Definition at line 79 of file vtkPoints2D.h.

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

Return a void pointer. For image pipeline interface and other special pointer manipulation.

Definition at line 84 of file vtkPoints2D.h.

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

Reclaim any extra memory.

Definition at line 87 of file vtkPoints2D.h.

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

Make object look empty but do not delete memory.

Definition at line 90 of file vtkPoints2D.h.

virtual void vtkPoints2D::DeepCopy ( vtkPoints2D 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 vtkPoints2D::ShallowCopy ( vtkPoints2D 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 vtkPoints2D::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 vtkPoints2D::GetNumberOfPoints (  )  [inline]

Return number of points in array.

Definition at line 109 of file vtkPoints2D.h.

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

Return a pointer to a double point x[2] for a specific id. 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.

Definition at line 115 of file vtkPoints2D.h.

void vtkPoints2D::GetPoint ( vtkIdType  id,
double  x[2] 
) [inline]

Copy point components into user provided array v[2] for specified id.

Definition at line 118 of file vtkPoints2D.h.

void vtkPoints2D::SetPoint ( vtkIdType  id,
const float  x[2] 
) [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 124 of file vtkPoints2D.h.

void vtkPoints2D::SetPoint ( vtkIdType  id,
const double  x[2] 
) [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 125 of file vtkPoints2D.h.

void vtkPoints2D::SetPoint ( vtkIdType  id,
double  x,
double  y 
) [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 184 of file vtkPoints2D.h.

void vtkPoints2D::InsertPoint ( vtkIdType  id,
const float  x[2] 
) [inline]

Insert point into object. Range checking performed and memory allocated as necessary.

Definition at line 132 of file vtkPoints2D.h.

void vtkPoints2D::InsertPoint ( vtkIdType  id,
const double  x[2] 
) [inline]

Insert point into object. Range checking performed and memory allocated as necessary.

Definition at line 134 of file vtkPoints2D.h.

void vtkPoints2D::InsertPoint ( vtkIdType  id,
double  x,
double  y 
) [inline]

Insert point into object. Range checking performed and memory allocated as necessary.

Definition at line 190 of file vtkPoints2D.h.

vtkIdType vtkPoints2D::InsertNextPoint ( const float  x[2]  )  [inline]

Insert point into next available slot. Returns id of slot.

Definition at line 141 of file vtkPoints2D.h.

vtkIdType vtkPoints2D::InsertNextPoint ( const double  x[2]  )  [inline]

Insert point into next available slot. Returns id of slot.

Definition at line 143 of file vtkPoints2D.h.

vtkIdType vtkPoints2D::InsertNextPoint ( double  x,
double  y 
) [inline]

Insert point into next available slot. Returns id of slot.

Definition at line 196 of file vtkPoints2D.h.

void vtkPoints2D::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 178 of file vtkPoints2D.h.

void vtkPoints2D::GetPoints ( vtkIdList ptId,
vtkPoints2D fp 
)

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

virtual void vtkPoints2D::ComputeBounds (  )  [virtual]

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

double* vtkPoints2D::GetBounds (  ) 

Return the bounds of the points.

void vtkPoints2D::GetBounds ( double  bounds[4]  ) 

Return the bounds of the points.


Member Data Documentation

double vtkPoints2D::Bounds[4] [protected]

Definition at line 169 of file vtkPoints2D.h.

Definition at line 170 of file vtkPoints2D.h.

Definition at line 171 of file vtkPoints2D.h.


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

Generated on Mon Sep 27 18:41:36 2010 for VTK by  doxygen 1.5.6