nv::index::IPath_style Class Reference

Interface class representing the styles that can be applied to a path. More...

#include <ipath.h>

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

Public Types
enum	Cap_style {   CAP_STYLE_NONE = 0 ,   CAP_STYLE_FLAT = 1 ,   CAP_STYLE_ROUND = 2 }
	caps style More...
enum	Interpolation
	Available interpolation techniques. More...
enum	Color_source
	Available color sources. More...

Public Member Functions
virtual Cap_style	get_cap_style () const =0
	Get cap style. More...
virtual void	set_cap_style (Cap_style cap_style)=0
	Set the cap style. More...
virtual Interpolation	get_interpolation () const =0
	Get the interpolation technique. More...
virtual void	set_interpolation (Interpolation technique)=0
	Set the interpolation technique.Look for 'interpolation' enum for details. More...
virtual Color_source	get_color_source () const =0
	Get the color source. More...
virtual void	set_color_source (Color_source source)=0
	Set the color source. More...
virtual void	set_upsampling (bool enable, mi::Uint32 up_factor=2, mi::Float32 tension=0.f)=0
	Enable/Disable the upsampling of the path. More...
virtual void	get_upsampling (bool &enable, mi::Uint32 &up_factor, mi::Float32 &tension) const =0
	Get the current upsampling state. More...

Detailed Description

Interface class representing the styles that can be applied to a path.

Currently, the style merely defines the interpolation technique. Only one style can be active at a time.

Member Enumeration Documentation

Cap_style

enum nv::index::IPath_style::Cap_style

caps style

Enumerator
CAP_STYLE_NONE	No caps.
CAP_STYLE_FLAT	flat caps (default).

Color_source

enum nv::index::IPath_style::Color_source

Available color sources.

Interpolation

enum nv::index::IPath_style::Interpolation

Available interpolation techniques.

Member Function Documentation

get_cap_style()

virtual Cap_style nv::index::IPath_style::get_cap_style ( ) const

pure virtual

Get cap style.

Look for 'Cap_style' enum for details.

Returns

The cap style chosen for subsequent paths in the scene description.

get_color_source()

virtual Color_source nv::index::IPath_style::get_color_source ( ) const

pure virtual

Get the color source.

Look for 'Color_source' enum for details.

Returns

The current color source used by the points of the path

get_interpolation()

virtual Interpolation nv::index::IPath_style::get_interpolation ( ) const

pure virtual

Get the interpolation technique.

Look for 'interpolation' enum for details.

Returns

The interpolation technique chosen for subsequent paths in the scene description.

get_upsampling()

virtual void nv::index::IPath_style::get_upsampling ( bool &  enable, mi::Uint32 &  up_factor, mi::Float32 &  tension  ) const

pure virtual

Get the current upsampling state.

Parameters

[out]	enable	The upsampling enable/disable state
[out]	up_factor	The increase in the sampling rate. up_scaling >= 2.
[out]	tension	The tension of the fitting curve. 0.0 < tension < 1.0

set_cap_style()

virtual void nv::index::IPath_style::set_cap_style ( Cap_style  cap_style )

pure virtual

Set the cap style.

Look for 'Cap_style' enum for details.

Parameters

[in]

cap_style

The cap style to be used by subsequent paths in the scene description.

set_color_source()

virtual void nv::index::IPath_style::set_color_source ( Color_source  source )

pure virtual

Set the color source.

Look for 'Color_source' enum for details.

Parameters

[in]

source

The color source to be used by the path

set_interpolation()

virtual void nv::index::IPath_style::set_interpolation ( Interpolation  technique )

pure virtual

Set the interpolation technique.Look for 'interpolation' enum for details.

Parameters

[in]

technique

The interpolation technique to be used by subsequent paths in the scene description.

set_upsampling()

virtual void nv::index::IPath_style::set_upsampling ( bool  enable, mi::Uint32  up_factor = 2, mi::Float32  tension = 0.f  )

pure virtual

Enable/Disable the upsampling of the path.

Increase the number of points by fitting a cubic spline over the original path producing a smoother path.

Parameters

[in]	enable	Enable/disable the upsampling (default = disabled)
[in]	up_factor	The increase in the sampling rate. up_scaling >= 2 (default=2)
[in]	tension	The tension of the fitting curve. 0 < tension < 1.0 tension = 0.0 (lowest, default); 1.0 (highest)

---

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

• ipath.h