vtkPoints Class Reference

represent and manipulate 3D points More...

#include <vtkPoints.h>

Inheritance diagram for vtkPoints:

Collaboration diagram for vtkPoints:

Public Types
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.
vtkPoints *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkTypeBool	Allocate (vtkIdType sz, vtkIdType ext=1000)
	Allocate initial memory size.
virtual void	Initialize ()
	Return object to instantiated state.
virtual void	SetData (vtkDataArray *)
	Set/Get the underlying data array.
vtkDataArray *	GetData ()
virtual int	GetDataType () const
	Return the underlying data type.
virtual void	SetDataType (int dataType)
	Specify the underlying data type of the object.
void	SetDataTypeToBit ()
void	SetDataTypeToChar ()
void	SetDataTypeToUnsignedChar ()
void	SetDataTypeToShort ()
void	SetDataTypeToUnsignedShort ()
void	SetDataTypeToInt ()
void	SetDataTypeToUnsignedInt ()
void	SetDataTypeToLong ()
void	SetDataTypeToUnsignedLong ()
void	SetDataTypeToFloat ()
void	SetDataTypeToDouble ()
void *	GetVoidPointer (const int id)
	Return a void pointer.
virtual void	Squeeze ()
	Reclaim any extra memory.
virtual void	Reset ()
	Make object look empty but do not delete memory.
unsigned long	GetActualMemorySize ()
	Return the memory in kibibytes (1024 bytes) consumed by this attribute data.
vtkIdType	GetNumberOfPoints () const
	Return number of points in array.
double *	GetPoint (vtkIdType id)
	Return a pointer to a double point x[3] for a specific id.
void	GetPoint (vtkIdType id, double x[3])
	Copy point components into user provided array v[3] for specified id.
void	SetPoint (vtkIdType id, const float x[3])
	Insert point into object.
void	SetPoint (vtkIdType id, const double x[3])
void	SetPoint (vtkIdType id, double x, double y, double z)
void	InsertPoints (vtkIdList *dstIds, vtkIdList *srcIds, vtkPoints *source)
	Copy the points indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array.
void	InsertPoints (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkPoints *source)
	Copy n consecutive points starting at srcStart from the source array to this array, starting at the dstStart location.
vtkIdType	InsertNextPoint (const float x[3])
	Insert point into next available slot.
vtkIdType	InsertNextPoint (const double x[3])
vtkIdType	InsertNextPoint (double x, double y, double z)
void	SetNumberOfPoints (vtkIdType numPoints)
	Specify the number of points for this object to hold.
vtkTypeBool	Resize (vtkIdType numPoints)
	Resize the internal array while conserving the data.
void	GetPoints (vtkIdList *ptId, vtkPoints *outPoints)
	Given a list of pt ids, return an array of points.
virtual void	ComputeBounds ()
	Determine (xmin,xmax, ymin,ymax, zmin,zmax) bounds of points.
double *	GetBounds ()
	Return the bounds of the points.
void	GetBounds (double bounds[6])
	Return the bounds of the points.
vtkMTimeType	GetMTime () override
	The modified time of the points.
void	Modified () override
	Update the modification time for this object and its Data.
virtual void	DeepCopy (vtkPoints *ad)
	Different ways to copy data.
virtual void	ShallowCopy (vtkPoints *ad)
	Different ways to copy data.
void	InsertPoint (vtkIdType id, const float x[3])
	Insert point into object.
void	InsertPoint (vtkIdType id, const double x[3])
	Insert point into object.
void	InsertPoint (vtkIdType id, double x, double y, double z)
	Insert point into object.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkPoints *	New (int dataType)
static vtkPoints *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPoints *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPoints (int dataType=VTK_FLOAT)
	~vtkPoints () 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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	Bounds [6]
vtkTimeStamp	ComputeTime
vtkDataArray *	Data
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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.

Online Examples:

Generate2DAMRDataSetWithPulse

KdTree

CellTypeSource

ConvexPointSet

PolygonIntersection

TableBasedClipDataSetWithPolyData2

Finance

ThresholdCells

SGrid

VisualizeStructuredGridCells

Definition at line 142 of file vtkPoints.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPoints::Superclass

Definition at line 149 of file vtkPoints.h.

Constructor & Destructor Documentation

vtkPoints()

vtkPoints::vtkPoints ( int  dataType = VTK_FLOAT )

protected

~vtkPoints()

vtkPoints::~vtkPoints ( )

overrideprotected

Member Function Documentation

New() [1/2]

static vtkPoints * vtkPoints::New ( int  dataType )

static

New() [2/2]

static vtkPoints * vtkPoints::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkPoints::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 vtkObjectBase.

Reimplemented in vtkPointsProjectedHull.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkPoints::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkPointsProjectedHull.

NewInstance()

vtkPoints * vtkPoints::NewInstance

(

)

const

PrintSelf()

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

Reimplemented in vtkPointsProjectedHull.

Allocate()

virtual vtkTypeBool vtkPoints::Allocate ( vtkIdType  sz, vtkIdType  ext = 1000  )

virtual

Allocate initial memory size.

ext is no longer used.

Initialize()

virtual void vtkPoints::Initialize ( )

virtual

Return object to instantiated state.

Reimplemented in vtkPointsProjectedHull.

SetData()

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

GetData()

vtkDataArray * vtkPoints::GetData ( )

inline

Definition at line 171 of file vtkPoints.h.

GetDataType()

virtual int vtkPoints::GetDataType ( ) const

virtual

Return the underlying data type.

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

SetDataType()

virtual void vtkPoints::SetDataType ( int  dataType )

virtual

Specify the underlying data type of the object.

Default is VTK_FLOAT.

SetDataTypeToBit()

void vtkPoints::SetDataTypeToBit ( )

inline

Definition at line 184 of file vtkPoints.h.

SetDataTypeToChar()

void vtkPoints::SetDataTypeToChar ( )

inline

Definition at line 185 of file vtkPoints.h.

SetDataTypeToUnsignedChar()

void vtkPoints::SetDataTypeToUnsignedChar ( )

inline

Definition at line 186 of file vtkPoints.h.

SetDataTypeToShort()

void vtkPoints::SetDataTypeToShort ( )

inline

Definition at line 187 of file vtkPoints.h.

SetDataTypeToUnsignedShort()

void vtkPoints::SetDataTypeToUnsignedShort ( )

inline

Definition at line 188 of file vtkPoints.h.

SetDataTypeToInt()

void vtkPoints::SetDataTypeToInt ( )

inline

Definition at line 189 of file vtkPoints.h.

SetDataTypeToUnsignedInt()

void vtkPoints::SetDataTypeToUnsignedInt ( )

inline

Definition at line 190 of file vtkPoints.h.

SetDataTypeToLong()

void vtkPoints::SetDataTypeToLong ( )

inline

Definition at line 191 of file vtkPoints.h.

SetDataTypeToUnsignedLong()

void vtkPoints::SetDataTypeToUnsignedLong ( )

inline

Definition at line 192 of file vtkPoints.h.

SetDataTypeToFloat()

void vtkPoints::SetDataTypeToFloat ( )

inline

Definition at line 193 of file vtkPoints.h.

SetDataTypeToDouble()

void vtkPoints::SetDataTypeToDouble ( )

inline

Definition at line 194 of file vtkPoints.h.

GetVoidPointer()

void * vtkPoints::GetVoidPointer ( const int  id )

inline

Return a void pointer.

For image pipeline interface and other special pointer manipulation.

Definition at line 200 of file vtkPoints.h.

Squeeze()

virtual void vtkPoints::Squeeze ( )

inlinevirtual

Reclaim any extra memory.

Definition at line 205 of file vtkPoints.h.

Reset()

void vtkPoints::Reset ( )

inlinevirtual

Make object look empty but do not delete memory.

Reimplemented in vtkPointsProjectedHull.

Definition at line 376 of file vtkPoints.h.

DeepCopy()

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.

ShallowCopy()

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.

GetActualMemorySize()

unsigned long vtkPoints::GetActualMemorySize

(

)

Return the memory in kibibytes (1024 bytes) 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.

GetNumberOfPoints()

vtkIdType vtkPoints::GetNumberOfPoints ( ) const

inline

Return number of points in array.

Definition at line 235 of file vtkPoints.h.

GetPoint() [1/2]

double * vtkPoints::GetPoint ( vtkIdType  id )

inline

Return a pointer to a double point x[3] 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 243 of file vtkPoints.h.

GetPoint() [2/2]

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

inline

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

Definition at line 252 of file vtkPoints.h.

SetPoint() [1/3]

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(). You should call Modified() finally after changing points using this method as it will not do it itself.

Definition at line 264 of file vtkPoints.h.

SetPoint() [2/3]

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

inline

Definition at line 268 of file vtkPoints.h.

SetPoint() [3/3]

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

inline

Definition at line 396 of file vtkPoints.h.

InsertPoint() [1/3]

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 280 of file vtkPoints.h.

InsertPoint() [2/3]

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 284 of file vtkPoints.h.

InsertPoint() [3/3]

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 402 of file vtkPoints.h.

InsertPoints() [1/2]

void vtkPoints::InsertPoints ( vtkIdList *  dstIds, vtkIdList *  srcIds, vtkPoints *  source  )

inline

Copy the points indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array.

Note that memory allocation is performed as necessary to hold the data.

Definition at line 296 of file vtkPoints.h.

InsertPoints() [2/2]

void vtkPoints::InsertPoints ( vtkIdType  dstStart, vtkIdType  n, vtkIdType  srcStart, vtkPoints *  source  )

inline

Copy n consecutive points starting at srcStart from the source array to this array, starting at the dstStart location.

Note that memory allocation is performed as necessary to hold the data.

Definition at line 306 of file vtkPoints.h.

InsertNextPoint() [1/3]

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

inline

Insert point into next available slot.

Returns id of slot.

Definition at line 314 of file vtkPoints.h.

InsertNextPoint() [2/3]

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

inline

Definition at line 315 of file vtkPoints.h.

InsertNextPoint() [3/3]

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

inline

Definition at line 408 of file vtkPoints.h.

SetNumberOfPoints()

void vtkPoints::SetNumberOfPoints ( vtkIdType  numPoints )

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 382 of file vtkPoints.h.

Resize()

vtkTypeBool vtkPoints::Resize ( vtkIdType  numPoints )

inline

Resize the internal array while conserving the data.

Returns 1 if resizing succeeded and 0 otherwise.

Definition at line 389 of file vtkPoints.h.

GetPoints()

void vtkPoints::GetPoints	(	vtkIdList *	ptId,
		vtkPoints *	outPoints
	)

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

ComputeBounds()

virtual void vtkPoints::ComputeBounds ( )

virtual

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

GetBounds() [1/2]

double * vtkPoints::GetBounds

(

)

Return the bounds of the points.

GetBounds() [2/2]

void vtkPoints::GetBounds

(

double

bounds[6]

)

Return the bounds of the points.

GetMTime()

vtkMTimeType vtkPoints::GetMTime ( )

overridevirtual

The modified time of the points.

Reimplemented from vtkObject.

Modified()

void vtkPoints::Modified ( )

overridevirtual

Update the modification time for this object and its Data.

As this object acts as a shell around a DataArray and forwards Set methods it needs to forward Modified as well.

Reimplemented from vtkObject.

Member Data Documentation

Bounds

double vtkPoints::Bounds[6]

protected

Definition at line 367 of file vtkPoints.h.

ComputeTime

vtkTimeStamp vtkPoints::ComputeTime

protected

Definition at line 368 of file vtkPoints.h.

Data

vtkDataArray* vtkPoints::Data

protected

Definition at line 369 of file vtkPoints.h.

---

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

• Common/Core/vtkPoints.h