vtkFloatArray Class Reference

dynamic, self-adjusting array of float More...

#include <vtkFloatArray.h>

Inheritance diagram for vtkFloatArray:

Collaboration diagram for vtkFloatArray:

List of all members.

Public Types
typedef vtkDataArray	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	GetDataType ()
void	GetTupleValue (vtkIdType i, float *tuple)
void	SetTupleValue (vtkIdType i, const float *tuple)
void	InsertTupleValue (vtkIdType i, const float *tuple)
vtkIdType	InsertNextTupleValue (const float *tuple)
float	GetValue (vtkIdType id)
void	SetValue (vtkIdType id, float value)
void	SetNumberOfValues (vtkIdType number)
void	InsertValue (vtkIdType id, float f)
vtkIdType	InsertNextValue (float f)
float *	GetValueRange (int comp)
void	GetValueRange (float range[2], int comp)
float *	GetValueRange ()
void	GetValueRange (float range[2])
float *	WritePointer (vtkIdType id, vtkIdType number)
float *	GetPointer (vtkIdType id)
void	SetArray (float *array, vtkIdType size, int save)
void	SetArray (float *array, vtkIdType size, int save, int deleteMethod)
Static Public Member Functions
static vtkFloatArray *	New ()
static int	IsTypeOf (const char *type)
static vtkFloatArray *	SafeDownCast (vtkObject *o)
static float	GetDataTypeValueMin ()
static float	GetDataTypeValueMax ()
Protected Member Functions
	vtkFloatArray (vtkIdType numComp=1)
	~vtkFloatArray ()

---

Detailed Description

dynamic, self-adjusting array of float

vtkFloatArray is an array of values of type float. It provides methods for insertion and retrieval of values and will automatically resize itself to hold new data.

Examples:

vtkFloatArray (Examples)

Tests:

vtkFloatArray (Tests)

Definition at line 42 of file vtkFloatArray.h.

---

Member Typedef Documentation

typedef vtkDataArray vtkFloatArray::Superclass

Reimplemented from vtkDataArray.

Definition at line 47 of file vtkFloatArray.h.

---

Constructor & Destructor Documentation

vtkFloatArray::vtkFloatArray

(

vtkIdType

numComp = 1

)

[protected]

vtkFloatArray::~vtkFloatArray

(

)

[protected]

---

Member Function Documentation

static vtkFloatArray* vtkFloatArray::New

(

)

[static]

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

Reimplemented from vtkObject.

virtual const char* vtkFloatArray::GetClassName

(

)

[virtual]

Reimplemented from vtkDataArray.

static int vtkFloatArray::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 vtkDataArray.

virtual int vtkFloatArray::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 vtkDataArray.

static vtkFloatArray* vtkFloatArray::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkDataArray.

void vtkFloatArray::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 vtkDataArray.

int vtkFloatArray::GetDataType

(

)

[inline, virtual]

Get the data type.

Implements vtkAbstractArray.

Definition at line 52 of file vtkFloatArray.h.

void vtkFloatArray::GetTupleValue	(	vtkIdType	i,
		float *	tuple
	)		[inline]

Copy the tuple value into a user-provided array.

Definition at line 58 of file vtkFloatArray.h.

void vtkFloatArray::SetTupleValue	(	vtkIdType	i,
		const float *	tuple
	)		[inline]

Set the tuple value at the ith location in the array.

Definition at line 64 of file vtkFloatArray.h.

void vtkFloatArray::InsertTupleValue	(	vtkIdType	i,
		const float *	tuple
	)		[inline]

Insert (memory allocation performed) the tuple into the ith location in the array.

Definition at line 71 of file vtkFloatArray.h.

vtkIdType vtkFloatArray::InsertNextTupleValue

(

const float *

tuple

)

[inline]

Insert (memory allocation performed) the tuple onto the end of the array.

Definition at line 78 of file vtkFloatArray.h.

float vtkFloatArray::GetValue

(

vtkIdType

id

)

[inline]

Get the data at a particular index.

Definition at line 84 of file vtkFloatArray.h.

void vtkFloatArray::SetValue	(	vtkIdType	id,
		float	value
	)		[inline]

Set the data at a particular index. Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.

Definition at line 91 of file vtkFloatArray.h.

void vtkFloatArray::SetNumberOfValues

(

vtkIdType

number

)

[inline]

Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for fast insertion.

Definition at line 99 of file vtkFloatArray.h.

void vtkFloatArray::InsertValue	(	vtkIdType	id,
		float	f
	)		[inline]

Insert data at a specified position in the array.

Definition at line 105 of file vtkFloatArray.h.

vtkIdType vtkFloatArray::InsertNextValue

(

float

f

)

[inline]

Insert data at the end of the array. Return its location in the array.

Definition at line 112 of file vtkFloatArray.h.

float* vtkFloatArray::GetValueRange

(

int

comp

)

[inline]

Get the range of array values for the given component in the native data type.

Definition at line 119 of file vtkFloatArray.h.

void vtkFloatArray::GetValueRange	(	float	range[2],
		int	comp
	)		[inline]

Get the range of array values for the given component in the native data type.

Definition at line 122 of file vtkFloatArray.h.

float* vtkFloatArray::GetValueRange

(

)

[inline]

Get the range of array values for the 0th component in the native data type.

Definition at line 130 of file vtkFloatArray.h.

void vtkFloatArray::GetValueRange

(

float

range[2]

)

[inline]

Get the range of array values for the 0th component in the native data type.

Definition at line 133 of file vtkFloatArray.h.

static float vtkFloatArray::GetDataTypeValueMin

(

)

[inline, static]

Get the minimum data value in its native type.

Definition at line 139 of file vtkFloatArray.h.

static float vtkFloatArray::GetDataTypeValueMax

(

)

[inline, static]

Get the maximum data value in its native type.

Definition at line 142 of file vtkFloatArray.h.

float* vtkFloatArray::WritePointer	(	vtkIdType	id,
		vtkIdType	number
	)		[inline]

Get the address of a particular data index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.

Definition at line 148 of file vtkFloatArray.h.

float* vtkFloatArray::GetPointer

(

vtkIdType

id

)

[inline]

Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.

Definition at line 155 of file vtkFloatArray.h.

void vtkFloatArray::SetArray	(	float *	array,
		vtkIdType	size,
		int	save
	)		[inline]

This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array.

Definition at line 166 of file vtkFloatArray.h.

void vtkFloatArray::SetArray	(	float *	array,
		vtkIdType	size,
		int	save,
		int	deleteMethod
	)		[inline]

This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array.

Definition at line 168 of file vtkFloatArray.h.

---

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

• dox/Common/vtkFloatArray.h