Interface class for 3D paths. More...

#include <ipath.h>

Inherits mi::base::Interface_declare< 0xe284adf5, ... >.

Public Member Functions
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 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...

virtual const mi::Uint32 *	get_material_ids () const =0
	Get a pointer to the list of material ids. More...

virtual void	set_material_ids (mi::Uint32 *ids, mi::Uint32 nb_ids)=0
	Set a pointer to the list of material ids. More...

Detailed Description

Interface class for 3D 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.

Note: This shape type still supports the per-object supersampling, but the full screen antialiasing take precedence, see IConfig_settings::set_rendering_samples().

Member Function Documentation

^◆ get_color_map_indexes()

virtual const mi::Uint32 * nv::index::IPath_3D::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_3D::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_material_ids()

virtual const mi::Uint32 * nv::index::IPath_3D::get_material_ids ( ) const

pure virtual

Get a pointer to the list of material ids.

Zero based integer values with index to the list of materials defined in the scene description for the same group as this path

Returns: The pointer to the list of material ids. nullptr when no material ids are set.

^◆ get_nb_points()

virtual mi::Uint32 nv::index::IPath_3D::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_3D::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 nb_points == 0.

^◆ get_radii()

virtual const mi::Float32 * nv::index::IPath_3D::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_3D::get_radius ( ) const

pure virtual

Get the radius of the path.

Returns: The radius of the internal representation for the path (line).

^◆ set_color_map_indexes()

virtual void nv::index::IPath_3D::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_3D::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_material_ids()

virtual void nv::index::IPath_3D::set_material_ids	(	mi::Uint32 *	ids,
		mi::Uint32	nb_ids
	)

pure virtual

Set a pointer to the list of material ids.

Zero based integer values with index to the list of materials defined in the scene description for the same group as this path

Parameters

[in]	ids	The pointer to the list of material ids.
[in]	nb_ids	The number of ids. The length of array. nb_ids is expected to be the same value as nb_points. When they are not the same a warning message is raised: nb_ids < nb_points: The missing ids use the last id nb_ids > nb_points: The extra ids are ignored

^◆ set_points()

virtual void nv::index::IPath_3D::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_3D::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 points '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_3D::set_radius ( mi::Float32 radius )

pure virtual

set the radius 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:

ipath.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ get_color_map_indexes()

◆ get_colors()

◆ get_material_ids()

◆ get_nb_points()

◆ get_points()

◆ get_radii()

◆ get_radius()

◆ set_color_map_indexes()

◆ set_colors()

◆ set_material_ids()

◆ set_points()

◆ set_radii()

◆ set_radius()

^◆ get_color_map_indexes()

^◆ get_colors()

^◆ get_material_ids()

^◆ get_nb_points()

^◆ get_points()

^◆ get_radii()

^◆ get_radius()

^◆ set_color_map_indexes()

^◆ set_colors()

^◆ set_material_ids()

^◆ set_points()

^◆ set_radii()

^◆ set_radius()