nv::index::IPipe_subset_parameters Class Reference

Helper for setting the parameters of a single pipe inside a subset. More...

#include <ipipe_set_subset.h>

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

Public Member Functions
virtual bool	set_radius (mi::Float32 radius)=0
	Sets the radius of the pipe. More...
virtual void	set_color (const mi::math::Color_struct &color)=0
	Sets the color of a pipe. More...
virtual void	set_user_flags (mi::Uint32 flags)=0
	Sets custom user flags of a pipe. More...
virtual bool	set_property (const char *property_name)=0
	Sets the property that should be mapped onto the pipe. More...
virtual bool	set_property_coordinates (const mi::Float32 *property_coordinates, mi::Size nb_property_coordinates)=0
	Sets the per-vertex coordinates for mapping property data onto the pipe. More...
virtual void	set_property_coordinates_range (mi::Float32 coordinate_first, mi::Float32 coordinate_last)=0
	Specifies the domain-specific property coordinate values of the first and last vertex of the pipe. More...
virtual void	set_property_value_range (mi::Float32 value_min, mi::Float32 value_max)=0
	Sets the expected value range of the property data for the pipe. More...
virtual void	set_subset_status (mi::Float32 contains_start_point, mi::Float32 contains_end_point)=0
	Sets information about the given pipe for the current subset/subregion. More...

Detailed Description

Helper for setting the parameters of a single pipe inside a subset.

An instance of this interface is returned by IPipe_set_subset::add_pipe().

Member Function Documentation

set_color()

virtual void nv::index::IPipe_subset_parameters::set_color ( const mi::math::Color_struct &  color )

pure virtual

Sets the color of a pipe.

This is the base color only, which may be influenced by the assigned material during rendering, depending on the active rendering kernel program.

Parameters

[in]

color

Base color to be used for all vertices of the pipe.

set_property()

virtual bool nv::index::IPipe_subset_parameters::set_property ( const char *  property_name )

pure virtual

Sets the property that should be mapped onto the pipe.

The property must already have been reserverved by reserve_property().

Parameters

[in]

property_name

Unique name identifying the property, must already be reserved.

Returns

true on success, or false if property_name is invalid or the property was not yet reserved.

set_property_coordinates()

virtual bool nv::index::IPipe_subset_parameters::set_property_coordinates ( const mi::Float32 *  property_coordinates, mi::Size  nb_property_coordinates  )

pure virtual

Sets the per-vertex coordinates for mapping property data onto the pipe.

Parameters

[in]	property_coordinates	Array of 1D coordinates, or 0.
[in]	nb_property_coordinates	Number of coordinates in the array, must either be 0 or match the number of vertices given to add_pipe().

Returns

true on success, or false if one of the arguments is invalid.

set_property_coordinates_range()

virtual void nv::index::IPipe_subset_parameters::set_property_coordinates_range ( mi::Float32  coordinate_first, mi::Float32  coordinate_last  )

pure virtual

Specifies the domain-specific property coordinate values of the first and last vertex of the pipe.

If this is not set, or when coordinate_first <= coordinate_last, then the entire coordinate range will be used.

This should be used together with the corresponding parameters of IPipe_set_subset::set_property_data().

Parameters

[in]	coordinate_first	Domain-specific property coordinate value of the first vertex.
[in]	coordinate_last	Domain-specific property coordinate value of the last vertex.

set_property_value_range()

virtual void nv::index::IPipe_subset_parameters::set_property_value_range ( mi::Float32  value_min, mi::Float32  value_max  )

pure virtual

Sets the expected value range of the property data for the pipe.

The data values will be normalized (but not clipped/clamped) to [0 1], with value_min mapped to 0 and value_max mapped to 1.

If value_min or value_max is set to +/-infinity then the actual min/max value found in the data will be used.

Parameters

[in]	value_min	Data value that should be mapped to 0.
[in]	value_max	Data value that should be mapped to 1.

set_radius()

virtual bool nv::index::IPipe_subset_parameters::set_radius ( mi::Float32  radius )

pure virtual

Sets the radius of the pipe.

Parameters

[in]

radius

Radius to be used for all vertices of the pipe.

Returns

true on success, or false if the radius is 0 or negative.

set_subset_status()

virtual void nv::index::IPipe_subset_parameters::set_subset_status ( mi::Float32  contains_start_point, mi::Float32  contains_end_point  )

pure virtual

Sets information about the given pipe for the current subset/subregion.

Since it is not possible to determine from the vertex data alone whether the overall start and end point of the entire subregion is contained in the current subset, providing this information allows for better optimization. However, it is also safe to always set true (which is the default).

Parameters

[in]	contains_start_point	Pipe start point is contained in this subregion.
[in]	contains_end_point	Pipe end point is contained in this subregion.

set_user_flags()

virtual void nv::index::IPipe_subset_parameters::set_user_flags ( mi::Uint32  flags )

pure virtual

Sets custom user flags of a pipe.

The flags are passed through to rendering kernel programs and are not interpreted in any way by NVIDIA IndeX.

Parameters

[in]

flags

Custom user flags.

---

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

• ipipe_set_subset.h