Interface class for a point set, which is a scene element and can be added the scene description. More...

#include <ipoint_set.h>

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

Public Types
enum	Point_style { FLAT_CIRCLE = 0 , SHADED_CIRCLE = 1 , FLAT_SQUARE = 2 , FLAT_TRIANGLE = 3 , SHADED_FLAT_CIRCLE = 4 }
	The point style defines the appearance of a point when rendered using the rasterizer. More...

Public Member Functions
virtual mi::Size	get_nb_vertices () const =0
	Get number of 3D points or vertices. More...

virtual const mi::math::Vector_struct< mi::Float32, 3 > *	get_vertices () const =0
	Get the pointer to the array of vertices (points). More...

virtual void	set_vertices (mi::math::Vector_struct< mi::Float32, 3 > *vertices, mi::Size nb_vertices)=0
	Set the pointer to the array of vertices (points). More...

virtual mi::Size	get_nb_colors () const =0
	Get number of color values. More...

virtual const mi::math::Color_struct *	get_colors () const =0
	Get the pointer to the array of per-vertex color values. More...

virtual void	set_colors (mi::math::Color_struct *colors, mi::Size nb_colors)=0
	Set the pointer to the array of per-vertex color values. More...

virtual mi::Size	get_nb_radii () const =0
	Get number of radii. More...

virtual const mi::Float32 *	get_radii () const =0
	Get the pointer to the array of per-vertex radii. More...

virtual void	set_radii (mi::Float32 *radii, mi::Size nb_radii)=0
	Set the pointer to the array of per-vertex radii. More...

virtual Point_style	get_point_style () const =0
	Get the point style. More...

virtual void	set_point_style (Point_style point_style)=0
	Set the point style. More...

Detailed Description

Interface class for a point set, which is a scene element and can be added the scene description.

Each point has its own color and radius.

Applications can derive from the interface class to implement user-defined point geometry that may have arbitrary (per-vertex) attributes that impact the rendering attributes (such as 3D position, color and radius).

Member Enumeration Documentation

^◆ Point_style

enum nv::index::IPoint_set::Point_style

The point style defines the appearance of a point when rendered using the rasterizer.

Enumerator
FLAT_CIRCLE	A flat monochrome disc centered at the point's origin and facing the camera.
SHADED_CIRCLE	A 3D sphere like appearance centered at the origin including depth in accordance to the radius and the center and shading in accordance to light sources.
FLAT_SQUARE	A flat monochrome square centered at the origin and facing the camera.
FLAT_TRIANGLE	A flat monochrome triangle centered at the origin and facing the camera.
SHADED_FLAT_CIRCLE	A 3D sphere like appearance centered at the origin including shading in accordance to light sources.

Member Function Documentation

^◆ get_colors()

virtual const mi::math::Color_struct * nv::index::IPoint_set::get_colors ( ) const

pure virtual

Get the pointer to the array of per-vertex color values.

Returns: The pointer to the array of per-vertex color values.

^◆ get_nb_colors()

virtual mi::Size nv::index::IPoint_set::get_nb_colors ( ) const

pure virtual

Get number of color values.

Returns: The number of color values.

^◆ get_nb_radii()

virtual mi::Size nv::index::IPoint_set::get_nb_radii ( ) const

pure virtual

Get number of radii.

Returns: The number of radii.

^◆ get_nb_vertices()

virtual mi::Size nv::index::IPoint_set::get_nb_vertices ( ) const

pure virtual

Get number of 3D points or vertices.

Returns: The number of vertices.

^◆ get_point_style()

virtual Point_style nv::index::IPoint_set::get_point_style ( ) const

pure virtual

Get the point style.

Returns: The point style.

^◆ get_radii()

virtual const mi::Float32 * nv::index::IPoint_set::get_radii ( ) const

pure virtual

Get the pointer to the array of per-vertex radii.

Returns: The pointer to the array of per-vertex radii.

^◆ get_vertices()

virtual const mi::math::Vector_struct< mi::Float32, 3 > * nv::index::IPoint_set::get_vertices ( ) const

pure virtual

Get the pointer to the array of vertices (points).

Returns: The pointer to the array of vertices.

^◆ set_colors()

virtual void nv::index::IPoint_set::set_colors	(	mi::math::Color_struct *	colors,
		mi::Size	nb_colors
	)

pure virtual

Set the pointer to the array of per-vertex color values.

The color of 3D point is multiplied by the associated material color.

Parameters

[in]	colors	The pointer to the array of colors.
[in]	nb_colors	The number of colors. The length of array.

^◆ set_point_style()

virtual void nv::index::IPoint_set::set_point_style ( Point_style point_style )

pure virtual

Set the point style.

Parameters

[in] point_style The point style to be set.

^◆ set_radii()

virtual void nv::index::IPoint_set::set_radii	(	mi::Float32 *	radii,
		mi::Size	nb_radii
	)

pure virtual

Set the pointer to the array of per-vertex radii.

Parameters

[in]	radii	The pointer to the array of radii.
[in]	nb_radii	The number of radii. The length of array.

^◆ set_vertices()

virtual void nv::index::IPoint_set::set_vertices	(	mi::math::Vector_struct< mi::Float32, 3 > *	vertices,
		mi::Size	nb_vertices
	)

pure virtual

Set the pointer to the array of vertices (points).

Parameters

[in]	vertices	The pointer to the array of vertices.
[in]	nb_vertices	The number of vertices. The length of array.

The documentation for this class was generated from the following file:

ipoint_set.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Point_style

Member Function Documentation

◆ get_colors()

◆ get_nb_colors()

◆ get_nb_radii()

◆ get_nb_vertices()

◆ get_point_style()

◆ get_radii()

◆ get_vertices()

◆ set_colors()

◆ set_point_style()

◆ set_radii()

◆ set_vertices()

^◆ Point_style

^◆ get_colors()

^◆ get_nb_colors()

^◆ get_nb_radii()

^◆ get_nb_vertices()

^◆ get_point_style()

^◆ get_radii()

^◆ get_vertices()

^◆ set_colors()

^◆ set_point_style()

^◆ set_radii()

^◆ set_vertices()