vtkUnsignedCharArray Class Reference

#include <vtkUnsignedCharArray.h>

Inheritance diagram for vtkUnsignedCharArray:

[legend]Collaboration diagram for vtkUnsignedCharArray:

[legend]List of all members.

Detailed Description

dynamic, self-adjusting array of unsigned char

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

Created by:

Schroeder, Will

CVS contributions (if > 5%):

Schroeder, Will (43%)
King, Brad (18%)
Martin, Ken (15%)
Henderson, Amy (5%)
Geveci, Berk (5%)

CVS logs (CVSweb):

.h (/Common/vtkUnsignedCharArray.h)
.cxx (/Common/vtkUnsignedCharArray.cxx)

Tests:: vtkUnsignedCharArray (Tests)

Definition at line 53 of file vtkUnsignedCharArray.h.

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

unsigned char GetValue (vtkIdType id)

void SetValue (vtkIdType id, unsigned char value)

void SetNumberOfValues (vtkIdType number)

void InsertValue (vtkIdType id, unsigned char f)

vtkIdType InsertNextValue (unsigned char f)

unsigned char * WritePointer (vtkIdType id, vtkIdType number)

unsigned char * GetPointer (vtkIdType id)

void SetArray (unsigned char *array, vtkIdType size, int save)

Static Public Member Functions

vtkUnsignedCharArray * New ()

int IsTypeOf (const char *type)

vtkUnsignedCharArray * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkUnsignedCharArray (vtkIdType numComp=1)

~vtkUnsignedCharArray ()

Member Typedef Documentation

typedef vtkDataArray vtkUnsignedCharArray::Superclass

Reimplemented from vtkDataArray.
Definition at line 58 of file vtkUnsignedCharArray.h.

Constructor & Destructor Documentation

vtkUnsignedCharArray::vtkUnsignedCharArray ( vtkIdType numComp = 1 ) [protected]

vtkUnsignedCharArray::~vtkUnsignedCharArray ( ) [protected]

Member Function Documentation

vtkUnsignedCharArray* vtkUnsignedCharArray::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
Referenced by vtkStructuredVisibilityConstraint::Blank().

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

Reimplemented from vtkDataArray.

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

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

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

Reimplemented from vtkDataArray.

void vtkUnsignedCharArray::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 vtkUnsignedCharArray::GetDataType ( ) [inline, virtual]

Get the data type.
Implements vtkDataArray.
Definition at line 63 of file vtkUnsignedCharArray.h.

unsigned char vtkUnsignedCharArray::GetValue ( vtkIdType id ) [inline]

Get the data at a particular index.
Definition at line 69 of file vtkUnsignedCharArray.h.
References vtkIdType.
Referenced by vtkStructuredVisibilityConstraint::IsVisible().

void vtkUnsignedCharArray::SetValue ( vtkIdType id,

unsigned char 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 76 of file vtkUnsignedCharArray.h.
References vtkIdType.
Referenced by vtkStructuredVisibilityConstraint::Blank(), and vtkStructuredVisibilityConstraint::UnBlank().

void vtkUnsignedCharArray::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 84 of file vtkUnsignedCharArray.h.
References vtkIdType.

void vtkUnsignedCharArray::InsertValue ( vtkIdType id,

unsigned char f

) [inline]

Insert data at a specified position in the array.
Definition at line 90 of file vtkUnsignedCharArray.h.
References vtkIdType.

vtkIdType vtkUnsignedCharArray::InsertNextValue ( unsigned char f ) [inline]

Insert data at the end of the array. Return its location in the array.
Definition at line 97 of file vtkUnsignedCharArray.h.
References vtkIdType.

unsigned char* vtkUnsignedCharArray::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 105 of file vtkUnsignedCharArray.h.
References vtkIdType.
Referenced by vtkLookupTable::WritePointer().

unsigned char* vtkUnsignedCharArray::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 112 of file vtkUnsignedCharArray.h.
References vtkIdType.

void vtkUnsignedCharArray::SetArray ( unsigned char * 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 123 of file vtkUnsignedCharArray.h.
References vtkIdType.

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

dox/Common/vtkUnsignedCharArray.h


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

unsigned char	GetValue (vtkIdType id)

void	SetValue (vtkIdType id, unsigned char value)

void	SetNumberOfValues (vtkIdType number)

void	InsertValue (vtkIdType id, unsigned char f)

vtkIdType	InsertNextValue (unsigned char f)

unsigned char *	WritePointer (vtkIdType id, vtkIdType number)

unsigned char *	GetPointer (vtkIdType id)

void	SetArray (unsigned char *array, vtkIdType size, int save)
Static Public Member Functions
vtkUnsignedCharArray *	New ()
int	IsTypeOf (const char *type)
vtkUnsignedCharArray *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkUnsignedCharArray (vtkIdType numComp=1)
	~vtkUnsignedCharArray ()