1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
|
Usage
vtkUnsignedShortArray is an array of values of type unsigned
short. It provides methods for insertion and retrieval of
values and will automatically resize itself to hold new
data.
To create an instance of class vtkUnsignedShortArray, simply
invoke its constructor as follows
obj = vtkUnsignedShortArray
Methods
The class vtkUnsignedShortArray has several methods that can
be used. They are listed below. Note that the documentation
is translated automatically from the VTK sources, and may
not be completely intelligible. When in doubt, consult the
VTK website. In the methods listed below, obj is an instance
of the vtkUnsignedShortArray class.
* string = obj.GetClassName ()
* int = obj.IsA (string name)
* vtkUnsignedShortArray = obj.NewInstance ()
* vtkUnsignedShortArray = obj.SafeDownCast (vtkObject o)
* int = obj.GetDataType () - Copy the tuple value into a
user-provided array.
* obj.GetTupleValue (vtkIdType i, short tuple) - Set the
tuple value at the ith location in the array.
* obj.SetTupleValue (vtkIdType i, short tuple) - Insert
(memory allocation performed) the tuple into the ith
location in the array.
* obj.InsertTupleValue (vtkIdType i, short tuple) - Insert
(memory allocation performed) the tuple onto the end of
the array.
* vtkIdType = obj.InsertNextTupleValue (short tuple) - Get
the data at a particular index.
* short = obj.GetValue (vtkIdType id) - Set the data at a
particular index. Does not do range checking. Make sure
you use the method SetNumberOfValues() before inserting
data.
* obj.SetValue (vtkIdType id, short value) - 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.
* obj.SetNumberOfValues (vtkIdType number) - Insert data at
a specified position in the array.
* obj.InsertValue (vtkIdType id, short f) - Insert data at
the end of the array. Return its location in the array.
* vtkIdType = obj.InsertNextValue (short f) - 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.
* obj.SetArray (short array, vtkIdType size, int save) -
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.
* obj.SetArray (short array, vtkIdType size, int save, int
deleteMethod)
* FreeMat_Documentation
* Visualization_Toolkit_Common_Classes
* Generated on Thu Jul 25 2013 17:18:30 for FreeMat by
doxygen_ 1.8.1.1
|