iregular_heightfield.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
#ifndef NVIDIA_INDEX_REGULAR_HEIGHTFIELD_H
#define NVIDIA_INDEX_REGULAR_HEIGHTFIELD_H
 
#include <mi/dice.h>
#include <mi/base/interface_declare.h>
#include <mi/math/color.h>
 
#include <nv/index/iattribute.h>
#include <nv/index/idistributed_data.h>
 
namespace nv {
 
namespace index {
 
class IHeightfield_geometry_settings :
    public mi::base::Interface_declare<0xc1529d11,0x1fa2,0x47b0,0x95,0xa2,0x76,0x1f,0x44,0xc5,0xaf,0x1c,
                                       nv::index::IAttribute>
{
public:
    enum Geometry_type
    {
        TYPE_NONE             = 0,
        TYPE_ISOLATED_POINTS  = 1,
        TYPE_CONNECTING_LINES = 2,
        TYPE_SEED_POINTS      = 4,
        TYPE_SEED_LINES       = 8,
        TYPE_ALL              = 0xFF,
    };
 
    enum Color_mode
    {
        MODE_FIXED            = 0,
        MODE_MATERIAL         = 1,
        MODE_VOLUME_TEXTURE   = 2,
        MODE_COMPUTED_TEXTURE = 3,
    };
 
    enum Render_mode
    {
        RENDER_DEFAULT        = 0,
        RENDER_Z_AXIS_ALIGNED = 1,
        RENDER_SCREEN_ALIGNED = 2,
        RENDER_RASTERIZED     = 3,
        RENDER_NONE           = 4,
    };
 
    virtual void set_type_mask(mi::Uint32 type_mask) = 0;
 
    virtual mi::Uint32 get_type_mask() const = 0;
 
    virtual void set_visible(bool visible) = 0;
 
    virtual bool get_visible() const = 0;
 
    virtual void set_color(const mi::math::Color_struct& color) = 0;
 
    virtual const mi::math::Color_struct& get_color() const = 0;
 
    virtual void set_color_mode(Color_mode color_mode) = 0;
 
    virtual Color_mode get_color_mode() const = 0;
 
    virtual void set_render_mode(Render_mode render_mode) = 0;
 
    virtual Render_mode get_render_mode() const = 0;
 
    virtual void set_geometry_size(mi::Float32 size) = 0;
 
    virtual mi::Float32 get_geometry_size() const = 0;
 
    virtual void set_opacity_ramp_distances(
        const mi::math::Vector_struct<mi::Float32, 2>& distances) = 0;
 
    virtual const mi::math::Vector_struct<mi::Float32, 2>& get_opacity_ramp_distances() const = 0;
 
    virtual void set_render_offset(mi::Float32 offset) = 0;
 
    virtual mi::Float32 get_render_offset() const = 0;
};
 
class IRegular_heightfield :
    public mi::base::Interface_declare<0x7a8db268,0x1c5b,0x4579,0xa4,0x42,0x0d,0x5f,0xb5,0xaa,0x9d,0x5b,
                                       nv::index::IDistributed_data>
{
public:
    virtual void set_name(const char* name) = 0;
 
    virtual const char* get_name() const = 0;
 
    virtual mi::math::Matrix_struct<mi::Float32, 4, 4> get_transform() const = 0;
 
    virtual mi::neuraylib::Tag_struct get_import_strategy() const = 0;
 
 
    virtual void set_IJK_bounding_box(
        const mi::math::Bbox_struct<mi::Float32, 3>& bbox) = 0;
 
    virtual mi::math::Bbox_struct<mi::Float32, 3> get_IJK_bounding_box() const = 0;
 
    virtual void set_IJK_region_of_interest(
        const mi::math::Bbox_struct<mi::Float32, 3>& ijk_roi_bbox) = 0;
 
    virtual mi::math::Bbox_struct<mi::Float32, 3> get_IJK_region_of_interest() const = 0;
 
    virtual mi::math::Bbox_struct<mi::Float32, 3> get_XYZ_clipped_bounding_box() const = 0;
 
 
    virtual void set_colormap_mapping(bool enable) = 0;
 
    virtual bool get_colormap_mapping() const = 0;
 
    virtual void assign_colormap(mi::neuraylib::Tag_struct tag) = 0;
 
    virtual mi::neuraylib::Tag_struct assigned_colormap() const = 0;
 
 
    virtual void add_seed_points(
        mi::math::Vector_struct<mi::Float32, 3>* points,
        mi::Uint32                               nb_points) = 0;
 
    virtual mi::Uint32 get_nb_seed_points() const = 0;
 
    virtual void get_seed_point(
        mi::Uint32                                index,
        mi::math::Vector_struct<mi::Float32, 3>&  seed_point) const = 0;
 
    virtual void remove_seed_point(
        mi::Uint32 index) = 0;
 
    virtual void add_isolated_pick(
        const mi::math::Vector_struct<mi::Float32, 2>&  ij_coordinate,
        mi::Float32                                     elevation) = 0;
 
    virtual void add_seed_line(
        mi::math::Vector_struct<mi::Float32, 3>* vertices,
        mi::Uint32                               nb_vertices) = 0;
 
    virtual mi::Uint32 get_nb_seed_lines() const = 0;
 
    virtual mi::math::Vector_struct<mi::Float32, 3>* get_seed_line(
        mi::Uint32  index,
        mi::Uint32& nb_vertices) const = 0;
 
    virtual void remove_seed_line(
        mi::Uint32 index) = 0;
 
};
 
}} // namespace index / nv
 
#endif // NVIDIA_INDEX_REGULAR_HEIGHTFIELD_H