NVIDIA Iray API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::ITriangle_connectivity Class Referenceabstract

A connectivity class for triangle mesh geometry and their attributes. More...

Inheritance diagram for mi::ITriangle_connectivity:
Inheritance graph
[legend]

Public Member Functions

Methods related to the mapping represented by the connectivity
virtual Uint32  triangles_size () const =0
  Returns the number of triangles. More...
 
virtual Sint32  set_triangle_indices (Triangle_handle_struct t, const Uint32 *indices)=0
  Sets the vertex indices of a triangle. More...
 
virtual Sint32  set_triangle_indices (Triangle_handle_struct t, Uint32 v0, Uint32 v1, Uint32 v2)=0
  Sets the vertex indices of a triangle. More...
 
virtual Sint32  set_triangle_indices (Triangle_handle_struct t, const Triangle_point_indices_struct &triangle)=0
  Sets the vertex indices of a triangle. More...
 
virtual Uint32  get_triangle_index (Triangle_handle_struct t, Uint32 vertex) const =0
  Returns the index at the vertex vertex of triangle t. More...
 
virtual
Triangle_point_indices_struct 
triangle_point_indices (Triangle_handle_struct t) const =0
  Returns the indices for all three vertices of triangle t. More...
 
virtual bool  is_valid_connectivity () const =0
  Indicates whether this connectivity is valid. More...
 
Methods related to the attached mesh attributes
virtual bool  has_attribute (Mesh_attribute_name name) const =0
  Indicates whether the connectivity has a particular mesh attribute. More...
 
virtual IAttribute_vector create_attribute_vector (Mesh_attribute_name name, Uint32 dim=1) const =0
  Creates a non-per-primitive mesh attribute. More...
 
virtual const IAttribute_vector access_attribute_vector (Mesh_attribute_name name) const =0
  Returns a per-primitive mesh attribute. More...
 
virtual IAttribute_vector edit_attribute_vector (Mesh_attribute_name name)=0
  Detaches and returns a per-primitive mesh attribute. More...
 
virtual Sint32  attach_attribute_vector (IAttribute_vector *attr)=0
  Attaches a given per-primitive mesh attribute to the mesh. More...
 
Miscellaneous methods
virtual Connectivity_map_type  get_map_type () const =0
  Returns the type of the connectivity. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x47cf1faa, 0x609d, 0x44ee, 0xa3, 0x6a, 0xca, 0x02, 0x92, 0xf7, 0x6a, 0x40 >
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< 0x47cf1faa, 0x609d, 0x44ee, 0xa3, 0x6a, 0xca, 0x02, 0x92, 0xf7, 0x6a, 0x40 >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

A connectivity class for triangle mesh geometry and their attributes.

A triangle connectivity maps vertices of a triangle mesh to indices. The vertices of the triangle mesh are identified by a pair of a triangle handle and a (local) vertex index in [0,3). Connectivities may have attached attribute vectors which use the connectivity information.

The meaning of the index associated with each vertex of the mesh is as follows: If the connectivity is the mesh connectivity, then this index identifies the point that belongs to a given vertex. Otherwise, the connectivity is called custom connectivity, and the index identifies an entry in an attribute vector that is associated with the given vertex. Note that attribute vectors can also be attached to the mesh connectivity (in which case an entry in the attribute vector is associated with the point mapped to the given vertex).

Attributes that have the same topological layout as the geometry typically use the mesh connectivity, e.g., normals for every point in the mesh. It is also possible to use an attribute connectivity with the same mapping as the mesh connectivity, however, using the mesh connectivity is more efficient. The use of a separate custom connectivity is necessary if the topological layout of the attribute is different from the geometry, e.g., for texture spaces with seams. Custom connectivities can also be useful to reduce the size of the attribute vector by sharing the same attribute value, e.g., for sharing the same normal between many points because of flat regions in the mesh.

Since the number of triangles is dictated by the mesh that the connectivity is associated with, it can only be changed by corresponding calls to the mi::ITriangle_mesh instance. It is possible to add points and triangles and to set the indices of the connectivities in alternating order, if so desired. The only constraint is that the largest connectivity index is smaller than the number of points (for the mesh connectivity) and smaller than the sizes of the attached attribute vectors (for all connectivities).

To create mesh attributes with the same connectivity, you can use a single connectivity and attach all these attribute to the same connectivity. However, when the mesh is retrieved from the DB no guarantee is given whether the attributes still share the connectivity or not.

Note
You must not release the mesh from which this connectivity was obtained before you release the connectivity.
See Also
mi::ITriangle_mesh
mi::IAttribute_vector