Merge topic 'release-update-to-index-2.1-final'

1e14b9ca Updating public headers
Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Ben Boeckel <ben.boeckel@kitware.com>
Merge-request: !3516

Plugins/pvNVIDIAIndeX/include/nv/index/idiagnostic_rendering_properties.h

 /******************************************************************************
  * Copyright 2019 NVIDIA Corporation. All rights reserved.
  *****************************************************************************/
-/**
-   \file
-   \brief        Scene attribute controlling diagnostic rendering.
-*/
+/// \file
+/// \brief Scene attribute controlling diagnostic rendering.
 
 #ifndef NVIDIA_INDEX_IDIAGNOSTIC_RENDERING_PROPERTIES_H
 #define NVIDIA_INDEX_IDIAGNOSTIC_RENDERING_PROPERTIES_H
 
-#include <mi/dice.h>
 #include <nv/index/iattribute.h>
 
-
 namespace nv {
 namespace index {
 
@@ -22,8 +18,9 @@ class IDiagnostic_rendering_properties :
                                        nv::index::IAttribute>
 {
 public:
-    /// Property idendifiers.
-    enum Property {
+    /// Property identifiers.
+    enum Property
+    {
         MODE,               ///< [uint]     (0)     Render mode 0:off, 1:subregions + scene, 2:subregions only
         OPACITY,            ///< [float]    (0.25)  Opacity of surfaces of subregion boxes.
         OPACITY_FRONT,      ///< [float]    (1)     Opacity factor of front (near) surfaces of subregion boxes.
@@ -39,20 +36,21 @@ public:
     };
 
     /// Underlying datatype of a property.
-    enum Property_type {
+    enum Property_type
+    {
         INVALID_TYPE,
         SIGNED_INT32,
         UNSIGNED_INT32,
         FLOAT32
     };
 
-    virtual bool            set_property(int prop, double value) = 0;
-    virtual double          get_property(int prop) const = 0;
+    virtual bool            set_property(mi::Sint32 prop, mi::Float64 value) = 0;
+    virtual mi::Float64     get_property(mi::Sint32 prop) const = 0;
     virtual mi::Uint32      get_propert_count() const = 0;
-    virtual Property_type   get_property_type(int prop) const = 0;
-    virtual const char*     get_property_name(int prop) const = 0;
+    virtual Property_type   get_property_type(mi::Sint32 prop) const = 0;
+    virtual const char*     get_property_name(mi::Sint32 prop) const = 0;
 };
 
-}} //nv::index
+}} // namespace index / nv
 
-#endif
+#endif // NVIDIA_INDEX_IDIAGNOSTIC_RENDERING_PROPERTIES_H

Plugins/pvNVIDIAIndeX/include/nv/index/idistributed_data_import_callback.h

@@ -48,14 +48,15 @@ class IDistributed_data_import_callback :
                                        mi::neuraylib::ISerializable>
 {
 public:
-    /// Shall provide the memory size of the dataset that is contained in the given bounding box.
+    /// Shall provide the size of the dataset that is contained in the given bounding box.
+    /// The size should approximate the number of primary items in the bounding box (e.g. voxels, cells, pixels).
+    /// If the size is zero, the bounding box region will be seen as empty, and not considered for further processing.
     ///
     /// \param[in] bounding_box             The bounding box of the subset in the dataset's local space.
     /// \param[in] dice_transaction         The DiCE database transaction that the
     ///                                     operation runs in.
     ///
-    /// \return                             Returns the estimated size of the memory allocated
-    ///                                     for the dataset subset, which is contained in the given 3D area.
+    /// \return                             Returns the approximate number of items contained in the given 3D area.
     ///
     virtual mi::Size estimate(
         const mi::math::Bbox_struct<mi::Float32, 3>&    bounding_box,
@@ -142,14 +143,15 @@ class Distributed_discrete_data_import_callback :
     public mi::neuraylib::Base<id1,id2,id3,id4,id5,id6,id7,id8,id9,id10,id11,I>
 {
 public:
-    /// Shall provide the memory size of the dataset that is contained in the given bounding box.
+    /// Shall provide the size of the dataset that is contained in the given bounding box.
+    /// The size should approximate the number of primary items in the bounding box (e.g. voxels, cells, pixels).
+    /// If the size is zero, the bounding box region will be seen as empty, and not considered for further processing.
     ///
     /// \param[in] bounding_box             The bounding box of the subset in the dataset's local space.
     /// \param[in] dice_transaction         The DiCE database transaction that the
     ///                                     operation runs in.
     ///
-    /// \return                             Returns the estimated size of the memory allocated
-    ///                                     for the dataset subset, which is contained in the given 3D area.
+    /// \return                             Returns the approximate number of items contained in the given 3D area.
     ///
     virtual mi::Size estimate(
         const mi::math::Bbox_struct<mi::Sint32, 3>&     bounding_box,
@@ -162,8 +164,7 @@ public:
     /// \param[in] dice_transaction         he DiCE database transaction that the
     ///                                     operation runs in.
     ///
-    /// \return                             Returns the estimated size of the memory allocated
-    ///                                     for the dataset subset, which is contained in the given 3D area.
+    /// \return                             Returns the approximate number of items contained in the given 3D area.
     ///
     virtual mi::Size estimate(
         const mi::math::Bbox_struct<mi::Float32, 3>&    bounding_box,

Plugins/pvNVIDIAIndeX/include/nv/index/iline_set.h

@@ -84,6 +84,8 @@ public:
     virtual Line_type get_line_type() const = 0;
 
     /// Set the line type. look Line_style enum for details.
+    /// The application needs to call this once for initialization.
+    /// Once a line_type was set, a change is not supported.
     ///
     /// \param[in] type  The line type.
     ///

Plugins/pvNVIDIAIndeX/include/nv/index/version.h

+/******************************************************************************
+ * Copyright 2019 NVIDIA Corporation. All rights reserved.
+ *****************************************************************************/
+/// \file
+/// \brief NVIDIA IndeX version information.
+
+#ifndef NVIDIA_INDEX_VERSION_H
+#define NVIDIA_INDEX_VERSION_H
+
+/// NVIDIA IndeX library major and minor version number without qualifier in a string
+/// representation, such as \c "2.0".
+#define NVIDIA_INDEX_LIBRARY_VERSION_STRING "2.1"
+
+/// NVIDIA IndeX library major and minor version number with qualifier in a string representation,
+/// such as \c "2.0" or \c "2.0-beta2".
+#define NVIDIA_INDEX_LIBRARY_VERSION_QUALIFIED_STRING "2.1"
+
+/// NVIDIA IndeX library major version.
+#define NVIDIA_INDEX_LIBRARY_VERSION_MAJOR 2
+
+/// NVIDIA IndeX library minor version.
+#define NVIDIA_INDEX_LIBRARY_VERSION_MINOR 1
+
+/// NVIDIA IndeX library version qualifier.
+#define NVIDIA_INDEX_LIBRARY_VERSION_QUALIFIER ""
+
+/// Revision indicating the build of the NVIDIA IndeX library that corresponds to this header file.
+/// This string may consist of two numbers separated by a dot.
+#define NVIDIA_INDEX_LIBRARY_REVISION_STRING "317600.4377"
+
+/// Major (branch) number of NVIDIA IndeX revision.
+#define NVIDIA_INDEX_LIBRARY_REVISION_MAJOR 317600
+
+/// Minor number of NVIDIA IndeX revision. May be 0 if there is no minor revision.
+#define NVIDIA_INDEX_LIBRARY_REVISION_MINOR 4377
+
+#endif // NVIDIA_INDEX_VERSION_H