nv::index::IWireframe_rendering_style Class Reference

The interface class representing an attribute to render triangle based geometries in wireframe style. More...

#include <iwireframe_rendering_style.h>

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

Public Types
enum	Wireframe_style {   WIREFRAME_STYLE_OUTLINE = 1 ,   WIREFRAME_STYLE_WIREFRAME = 2 }
	Wireframe rendering styles. More...

Public Member Functions
virtual void	set_wireframe_style (Wireframe_style style)=0
	Set the wireframe style to be used. More...
virtual Wireframe_style	get_wireframe_style () const =0
	Get the current wireframe style. More...
virtual void	set_wireframe_width (mi::Float32 width)=0
	Set the outline/wireframe width to be used, specified in object units. More...
virtual mi::Float32	get_wireframe_width () const =0
	Get the current outline/wireframe width, specified in object units. More...
virtual void	set_wireframe_color (const mi::math::Color_struct &color)=0
	Set the outline/wireframe color to be used. More...
virtual mi::math::Color_struct	get_wireframe_color () const =0
	Get the current outline/wireframe color. More...

Detailed Description

The interface class representing an attribute to render triangle based geometries in wireframe style.

The class provides two different styles: outline and wireframe.

In outline style, the visible edges of the geometry will be rendered as a thin outline on top of the geometry with a given width and color.

In wireframe style, only the visible edges will be rendered as a thin wireframe model, skipping completely the triangles of the geometry model. The wireframe will use a given width and color.

By default, all edges of the geometry are visible. However, edge visibility can be specified per triangle for geometric types that support triangle flag data. (See, for example, the ITriangle_mesh class for details.)

Member Enumeration Documentation

Wireframe_style

enum nv::index::IWireframe_rendering_style::Wireframe_style

Wireframe rendering styles.

Enumerator
WIREFRAME_STYLE_OUTLINE	outlines rendered on top of the geometry
WIREFRAME_STYLE_WIREFRAME	pure wireframe rendering (triangles are not rendered)

Member Function Documentation

get_wireframe_color()

virtual mi::math::Color_struct nv::index::IWireframe_rendering_style::get_wireframe_color ( ) const

pure virtual

Get the current outline/wireframe color.

Returns

Returns the outline/wireframe color. Default is (0, 0, 0, 1).

get_wireframe_style()

virtual Wireframe_style nv::index::IWireframe_rendering_style::get_wireframe_style ( ) const

pure virtual

Get the current wireframe style.

Returns

Returns the wireframe style. Default is WIREFRAME_STYLE_OUTLINE.

get_wireframe_width()

virtual mi::Float32 nv::index::IWireframe_rendering_style::get_wireframe_width ( ) const

pure virtual

Get the current outline/wireframe width, specified in object units.

Returns

Returns the outline/wireframe width. Default is 1.0.

set_wireframe_color()

virtual void nv::index::IWireframe_rendering_style::set_wireframe_color ( const mi::math::Color_struct &  color )

pure virtual

Set the outline/wireframe color to be used.

Parameters

[in]

color

The outline/wireframe color.

set_wireframe_style()

virtual void nv::index::IWireframe_rendering_style::set_wireframe_style ( Wireframe_style  style )

pure virtual

Set the wireframe style to be used.

Parameters

[in]

style

The wireframe style.

set_wireframe_width()

virtual void nv::index::IWireframe_rendering_style::set_wireframe_width ( mi::Float32  width )

pure virtual

Set the outline/wireframe width to be used, specified in object units.

Parameters

[in]

width

The outline/wireframe width.

---

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

• iwireframe_rendering_style.h