Interface representing an attribute vector for triangle meshes, polygon meshes, and subdivision surfaces. More...
Public Member Functions | |
General methods | |
| virtual Uint32 | size () const =0 |
| Returns the size of the attribute vector, i.e., number of elements. More... |
|
| virtual Uint32 | capacity () const =0 |
| Returns the capacity reserved in the vector for elements. More... |
|
| virtual void | resize (Uint32 size)=0 |
| Resizes the size of the attribute vector. More... |
|
| virtual void | reserve (Uint32 size)=0 |
Reserves new capacity size for elements. More... |
|
| virtual void | clear ()=0 |
| Clears the attribute vector. More... |
|
| virtual bool | is_valid_attribute () const =0 |
| Indicates whether this attribute vector is valid. More... |
|
| virtual Uint32 | array_size () const =0 |
| Returns the array size of the vector elements. More... |
|
Elements of type mi::Uint32 | |
| virtual Uint32 | get_uint32 (Uint32 index) const =0 |
Returns the value of type mi::Uint32 at position index. More... |
|
| virtual Sint32 | append_uint32 (Uint32 u)=0 |
| Appends a value of type mi::Uint32 to the attribute vector. More... |
|
| virtual Sint32 | set_uint32 (Uint32 index, Uint32 u)=0 |
Sets the value of type mi::Uint32 at position index to the new value u. More... |
|
Elements of type mi::Float32_3 | |
| virtual const Float32_3_struct & | get_vector3 (Uint32 index) const =0 |
Returns the value of type mi::Float32_3 at position index. More... |
|
| virtual Sint32 | append_vector3 (const Float32_3_struct &v)=0 |
| Appends a new 3d-vector to the attribute vector. More... |
|
| virtual Sint32 | set_vector3 (Uint32 index, const Float32_3_struct &v)=0 |
Sets the 3d-vector at position index to the new 3d-vector v. More... |
|
Elements of type mi::Float32_3[] | |
| virtual const Float32_3_struct * | get_vector3 (Uint32 index, Uint32 n) const =0 |
Returns a pointer to the n values of type mi::Float32_3 at position index. More... |
|
| virtual Sint32 | append_vector3 (const Float32_3_struct *v, Uint32 n)=0 |
Appends n 3d-vectors to the attribute vector from the array v. More... |
|
| virtual Sint32 | set_vector3 (Uint32 index, const Float32_3_struct *v, Uint32 n)=0 |
Sets the n 3d-vectors starting at position index to the new 3d-vectors v. More... |
|
Elements of type mi::Float32 | |
| virtual const Float32 * | get_float32 (Uint32 index, Uint32 n) const =0 |
Returns a pointer to the n value of type mi::Float32 at position index. More... |
|
| virtual Sint32 | append_float32 (const Float32 *f, Uint32 n)=0 |
Appends n floats to the attribute vector from the array f. More... |
|
| virtual Sint32 | set_float32 (Uint32 index, const Float32 *f, Uint32 n)=0 |
Sets the n floats at position index to the new floats f. More... |
|
Additional Inherited Members | |
 Public Types inherited from mi::base::Interface_declare< 0xfbe79601, 0x3c89, 0x4a8d, 0xbf, 0x0d, 0xae, 0x21, 0x59, 0x9a, 0xbf, 0x80 >
| |
| typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface > |
Self |
| Own type. More... |
|
| typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 > |
IID |
| Declares the interface ID (IID) of this interface. More... |
|
|
Static Public Member Functions inherited from mi::base::Interface_declare< 0xfbe79601, 0x3c89, 0x4a8d, 0xbf, 0x0d, 0xae, 0x21, 0x59, 0x9a, 0xbf, 0x80 >
| |
| static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
Interface representing an attribute vector for triangle meshes, polygon meshes, and subdivision surfaces.
Attribute vectors are used for mesh attributes, which are an extension of the regular attributes (see mi::IAttribute_set). They are only supported for scene elements that represent geometry, namely triangle meshes, polygon meshes, and subdivision surfaces. In contrast to regular attributes which exist only once per object, mesh attributes are always a vector of values with one vector element per primitive, per point, or per vertex. Note that a vector element in itself can be an array. For different mesh attributes and their types see mi::Mesh_attribute_name.
Attributes vectors are basically dynamic arrays supporting a limited set of element types. They need to be sufficiently large such that the indices in the corresponding indexing structure are valid. That is, for per-primitive attributes their size needs to be at least the number of primitives. For per-point attributes, their size needs to be at least the number of points. And for per-vertex attributes, their size needs to be at least the largest used index plus 1.
Attribute vectors cannot be created on their own; they have to be requested from an mi::ITriangle_mesh, mi::IPolygon_mesh, mi::ISubdivision_surface, or their corresponding connectivities.
This interface allows to resize an attribute vector, and to retrieve and to change the vector elements. Note that attributes have a particular type which determines the variant of the various methods on this interface to use. For example, material indices are of type mi::Uint32. Hence, for such an attribute one would use get_uint32(), append_uint32(), and set_uint32(). Other methods to retrieve or change the vector elements will fail as they do not match the actual type of the vector elements.
Appends n floats to the attribute vector from the array f.
NULL pointer).n does not match the array size of the attribute.Appends a value of type mi::Uint32 to the attribute vector.
|
pure virtual |
Appends a new 3d-vector to the attribute vector.
|
pure virtual |
Appends n 3d-vectors to the attribute vector from the array v.
NULL pointer).n does not match the array size of the attribute.
|
pure virtual |
Returns the array size of the vector elements.
The array size of the vector elements equals the dim parameter during creation of the attribute vector, see mi::ITriangle_mesh::create_attribute_vector(), mi::ITriangle_connectivity::create_attribute_vector(), mi::IPolygon_mesh::create_attribute_vector(), and mi::IPolygon_connectivity::create_attribute_vector(). For example, the array size is 1 for normal vectors, and 2 for surface derivatives.
|
pure virtual |
Returns the capacity reserved in the vector for elements.
|
pure virtual |
Clears the attribute vector.
Equivalent to calling resize() with argument 0.
|
pure virtual |
Returns a pointer to the n value of type mi::Float32 at position index.
NULL if the attribute is invalid, index is out of bounds, n is not equal to array_size(), or the attribute does not store elements of type mi::Float32 (or arrays thereof). Returns the value of type mi::Uint32 at position index.
index is out of bounds, or the attribute does not store elements of type mi::Uint32.
|
pure virtual |
Returns the value of type mi::Float32_3 at position index.
index is out of bounds, or the attribute does not store elements of type mi::Float32_3.
|
pure virtual |
Returns a pointer to the n values of type mi::Float32_3 at position index.
NULL if the attribute is invalid, index is out of bounds, n is not equal to array_size(), or the attribute does not store elements of type mi::Float32_3 (or arrays thereof).
|
pure virtual |
Indicates whether this attribute vector is valid.
An attribute vector becomes invalid after it has been (re)attached to the corresponding mesh or connectivity and may no longer been used.
|
pure virtual |
Reserves new capacity size for elements.
|
pure virtual |
Resizes the size of the attribute vector.
|
pure virtual |
Sets the n floats at position index to the new floats f.
index is out of bounds.NULL pointer).n does not match the array size of the attribute.Sets the value of type mi::Uint32 at position index to the new value u.
index is out of bounds.
|
pure virtual |
Sets the 3d-vector at position index to the new 3d-vector v.
index is out of bounds.
|
pure virtual |
Sets the n 3d-vectors starting at position index to the new 3d-vectors v.
index is out of bounds.NULL pointer).n does not match the array size of the attribute.
|
pure virtual |
Returns the size of the attribute vector, i.e., number of elements.