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 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
|
Usage
vtkGenericAttribute is an abstract class that defines an API
for attribute data. Attribute data is data associated with
the topology or geometry of a dataset (i.e., points, cells,
etc.). vtkGenericAttribute is part of the adaptor framework
(see GenericFiltering/README.html).
vtkGenericAttribute provides a more general interface to
attribute data than its counterpart vtkDataArray (which
assumes a linear, contiguous array). It adopts an iterator
interface, and allows attributes to be associated with
points, edges, faces, or edges.
To create an instance of class vtkGenericAttribute, simply
invoke its constructor as follows
obj = vtkGenericAttribute
Methods
The class vtkGenericAttribute 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 vtkGenericAttribute class.
* string = obj.GetClassName ()
* int = obj.IsA (string name)
* vtkGenericAttribute = obj.NewInstance ()
* vtkGenericAttribute = obj.SafeDownCast (vtkObject o)
* string = obj.GetName () - Name of the attribute. (e.g.
"velocity")
Postcondition:
result_may_not_exist: result!=0 || result==0
* int = obj.GetNumberOfComponents () - Dimension of the
attribute. (1 for scalar, 3 for velocity)
Postcondition:
positive_result: result>=0
GetType()==VTK_SCALARS implies result==1
(GetType()==VTK_VECTORS||(GetType()==VTK_NORMALS)||
(GetType()==VTK_TCOORDS) implies result==3
GetType()==VTK_TENSORS implies result==6
* int = obj.GetCentering () - Is the attribute centered
either on points, cells or boundaries?
Postcondition:
valid_result: (result==vtkPointCentered)||
(result==vtkCellCentered)
* int = obj.GetType () - Type of the attribute: scalar,
vector, normal, texture coordinate, tensor
Postcondition:
valid_result: (result==vtkDataSetAttributes::
SCALARS) ||(result==vtkDataSetAttributes::VECTORS)
||(result==vtkDataSetAttributes::NORMALS) ||
(result==vtkDataSetAttributes::TCOORDS) ||
(result==vtkDataSetAttributes::TENSORS)
* int = obj.GetComponentType () - Type of the components of
the attribute: int, float, double
Postcondition:
valid_result: (result==VTK_BIT) ||(result==VTK_CHAR)
||(result==VTK_UNSIGNED_CHAR) ||(result==VTK_SHORT)
||(result==VTK_UNSIGNED_SHORT)||(result==VTK_INT) ||
(result==VTK_UNSIGNED_INT) ||(result==VTK_LONG) ||
(result==VTK_UNSIGNED_LONG) ||(result==VTK_FLOAT) ||
(result==VTK_DOUBLE) ||(result==VTK_ID_TYPE)
* vtkIdType = obj.GetSize () - Number of tuples.
Postcondition:
valid_result: result>=0
* long = obj.GetActualMemorySize () - Size in kilobytes
taken by the attribute.
* obj.GetRange (int component, double range[2]) - Range of
the attribute component `component'. If `component'==-1,
it returns the range of the magnitude (euclidean norm).
THREAD SAFE
Precondition:
valid_component: (component>=-1)&&
(component<GetNumberOfComponents())
* double = obj.GetMaxNorm () - Return the maximum euclidean
norm for the tuples.
Postcondition:
positive_result: result>=0
* obj.GetTuple (vtkGenericAdaptorCell c, double tuple) - Put
attribute at all points of cell `c' in `tuple'.
Precondition:
c_exists: c!=0
c_valid: !c->IsAtEnd()
tuple_exists: tuple!=0
valid_tuple: sizeof(tuple)>=GetNumberOfComponents
()*c->GetCell()->GetNumberOfPoints()
* obj.GetTuple (vtkGenericCellIterator c, double tuple) -
Put attribute at all points of cell `c' in `tuple'.
Precondition:
c_exists: c!=0
c_valid: !c->IsAtEnd()
tuple_exists: tuple!=0
valid_tuple: sizeof(tuple)>=GetNumberOfComponents
()*c->GetCell()->GetNumberOfPoints()
* obj.GetTuple (vtkGenericPointIterator p, double tuple) -
Put the value of the attribute at position `p' into
`tuple'.
Precondition:
p_exists: p!=0
p_valid: !p->IsAtEnd()
tuple_exists: tuple!=0
valid_tuple_size: sizeof
(tuple)>=GetNumberOfComponents()
* obj.GetComponent (int i, vtkGenericCellIterator c, double
values) - Put component `i' of the attribute at all points
of cell `c' in `values'.
Precondition:
valid_component: (i>=0) &&
(i<GetNumberOfComponents())
c_exists: c!=0
c_valid: !c->IsAtEnd()
values_exist: values!=0
valid_values: sizeof(values)>=c->GetCell()-
>GetNumberOfPoints()
* double = obj.GetComponent (int i, vtkGenericPointIterator
p) - Value of the component `i' of the attribute at
position `p'.
Precondition:
valid_component: (i>=0) &&
(i<GetNumberOfComponents())
p_exists: p!=0
p_valid: !p->IsAtEnd()
* obj.DeepCopy (vtkGenericAttribute other) - Recursive
duplication of `other' in `this'.
Precondition:
other_exists: other!=0
not_self: other!=this
* obj.ShallowCopy (vtkGenericAttribute other) - Update
`this' using fields of `other'.
Precondition:
other_exists: other!=0
not_self: other!=this
* FreeMat_Documentation
* Visualization_Toolkit_Filtering_Classes
* Generated on Thu Jul 25 2013 17:18:30 for FreeMat by
doxygen_ 1.8.1.1
|