Interface class for 2D paths.
More...
#include <ipath.h>
Inherits mi::base::Interface_declare< 0xae7cff77, ... >.
|
| virtual mi::Float32 | get_radius () const =0 |
| | Get the radius of the path. More...
|
| |
| virtual void | set_radius (mi::Float32 radius)=0 |
| | set the radius (in pixels units) of the path More...
|
| |
| virtual mi::Uint32 | get_nb_points () const =0 |
| | Get the number of path points. More...
|
| |
| virtual const mi::math::Vector_struct< mi::Float32, 3 > * | get_points () const =0 |
| | Get the pointer to the array of path points. More...
|
| |
| virtual void | set_points (mi::math::Vector_struct< mi::Float32, 3 > *points, mi::Uint32 nb_points)=0 |
| | Set the pointer to the array of points. More...
|
| |
| virtual const mi::Float32 * | get_radii () const =0 |
| | Get the pointer to the array of radii per point. More...
|
| |
| virtual void | set_radii (mi::Float32 *radii, mi::Uint32 nb_radii)=0 |
| | Set the pointer to the array of radii per point. More...
|
| |
| virtual const mi::math::Color_struct * | get_colors () const =0 |
| | Get the pointer to the array of colors per segment/point. More...
|
| |
| virtual void | set_colors (mi::math::Color_struct *colors, mi::Uint32 nb_colors)=0 |
| | Set the pointer to the array of color per segment/point. More...
|
| |
| virtual const mi::Uint32 * | get_color_map_indexes () const =0 |
| | Get the pointer to the array of color map indexes per segment/point. More...
|
| |
| virtual void | set_color_map_indexes (mi::Uint32 *indexes, mi::Uint32 nb_indexes)=0 |
| | Set the pointer to the array of colormap indexes per segment/point. More...
|
| |
Interface class for 2D paths.
The path is represented by a collection of 3D points connected by an unique and continuous line path. Every point contains data represented as colors.
◆ get_color_map_indexes()
| virtual const mi::Uint32 * nv::index::IPath_2D::get_color_map_indexes |
( |
| ) |
const |
|
pure virtual |
Get the pointer to the array of color map indexes per segment/point.
- Returns
- The pointer to the array of color map indexes per segment/point. nullptr when color map indices are empty
◆ get_colors()
| virtual const mi::math::Color_struct * nv::index::IPath_2D::get_colors |
( |
| ) |
const |
|
pure virtual |
Get the pointer to the array of colors per segment/point.
- Returns
- The pointer to the array of colors per segment/point. nullptr when colors are empty
◆ get_nb_points()
| virtual mi::Uint32 nv::index::IPath_2D::get_nb_points |
( |
| ) |
const |
|
pure virtual |
Get the number of path points.
- Returns
- The number of path points.
◆ get_points()
| virtual const mi::math::Vector_struct< mi::Float32, 3 > * nv::index::IPath_2D::get_points |
( |
| ) |
const |
|
pure virtual |
Get the pointer to the array of path points.
- Returns
- The pointer to the array of path points. nullptr when points are empty
◆ get_radii()
| virtual const mi::Float32 * nv::index::IPath_2D::get_radii |
( |
| ) |
const |
|
pure virtual |
Get the pointer to the array of radii per point.
- Returns
- The pointer to the array of radii per point. nullptr when radii are empty
◆ get_radius()
| virtual mi::Float32 nv::index::IPath_2D::get_radius |
( |
| ) |
const |
|
pure virtual |
Get the radius of the path.
- Returns
- The radius (in pixel units) of the internal representation for the path (line).
◆ set_color_map_indexes()
| virtual void nv::index::IPath_2D::set_color_map_indexes |
( |
mi::Uint32 * |
indexes, |
|
|
mi::Uint32 |
nb_indexes |
|
) |
| |
|
pure virtual |
Set the pointer to the array of colormap indexes per segment/point.
- Parameters
-
| [in] | indexes | The pointer to the array of color map indexes. |
| [in] | nb_indexes | The number of indexes. The length of array When nb_indexes doesn't match the number of point 'nb_points', the following is used: nb_indexes < nb_points: The missing indexes use the last index
nb_indexes > nb_points: The extra indexes are ignored
|
◆ set_colors()
| virtual void nv::index::IPath_2D::set_colors |
( |
mi::math::Color_struct * |
colors, |
|
|
mi::Uint32 |
nb_colors |
|
) |
| |
|
pure virtual |
Set the pointer to the array of color per segment/point.
- Parameters
-
| [in] | colors | The pointer to the array of colors. |
| [in] | nb_colors | The number of colors. The length of array When nb_colors doesn't match the number of point 'nb_points', the following is used: nb_colors < nb_points: The missing colors use the last color
nb_colors > nb_points: The extra colors are ignored
|
◆ set_points()
| virtual void nv::index::IPath_2D::set_points |
( |
mi::math::Vector_struct< mi::Float32, 3 > * |
points, |
|
|
mi::Uint32 |
nb_points |
|
) |
| |
|
pure virtual |
Set the pointer to the array of points.
This method is expected to be called before set_color/set_color_maps_indexs/set_material_ids
- Parameters
-
| [in] | points | The pointer to the array of points. |
| [in] | nb_points | The number of vertices. The length of array. |
◆ set_radii()
| virtual void nv::index::IPath_2D::set_radii |
( |
mi::Float32 * |
radii, |
|
|
mi::Uint32 |
nb_radii |
|
) |
| |
|
pure virtual |
Set the pointer to the array of radii per point.
- Parameters
-
| [in] | radii | The pointer to the array of radii. |
| [in] | nb_radii | The number of radii. The length of array. When nb_radii doesn't match the number of point 'nb_points', the following is used: nb_radii < nb_points: The missing radii use the last radius
nb_radii > nb_points: The extra radii are ignored
|
◆ set_radius()
| virtual void nv::index::IPath_2D::set_radius |
( |
mi::Float32 |
radius | ) |
|
|
pure virtual |
set the radius (in pixels units) of the path
- Parameters
-
| [in] | radius | The radius of the internal representation for the path (line). |
The documentation for this class was generated from the following file:
