nv::index::IHeightfield_wireframe_style Class Reference

The interface class representing the wireframe style specific to heightfields. More...

#include <iwireframe_rendering_style.h>

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

Public Types
enum	Wireframe_topology {   WIREFRAME_TOPOLOGY_TRIANGLES = 1 ,   WIREFRAME_TOPOLOGY_QUADS = 2 }
	Wireframe topologies. More...

Public Member Functions
virtual void	set_wireframe_topology (Wireframe_topology topology)=0
	Set the wireframe topology to be used. More...
virtual Wireframe_topology	get_wireframe_topology () const =0
	Get the current wireframe topology. More...
virtual void	set_wireframe_resolution (mi::Uint32 resolution)=0
	Set the wireframe resolution. More...
virtual mi::Uint32	get_wireframe_resolution () const =0
	Get the current wireframe resolution. More...

Detailed Description

The interface class representing the wireframe style specific to heightfields.

Two different styles of outlining techniques are supported: triangles and patches.

In triangle outline style, the edges of all triangles that define the heightfield surface are highlighted using the width and color of the super class.

In patch outline style, the edges of all patches that are defined by four consecutive elevation values are highlighted using the width and color of the super class.

By default, the edges of all triangle are highlighted.

Member Enumeration Documentation

Wireframe_topology

enum nv::index::IHeightfield_wireframe_style::Wireframe_topology

Wireframe topologies.

Enumerator
WIREFRAME_TOPOLOGY_TRIANGLES	wireframe of the triangles that setup the heightfield's surface
WIREFRAME_TOPOLOGY_QUADS	wireframe of the quads that setup the heightfield's surface (similar to HF_WIREFRAME_STYLE_TRIANGLES but does not include diagonal edges)

Member Function Documentation

get_wireframe_resolution()

virtual mi::Uint32 nv::index::IHeightfield_wireframe_style::get_wireframe_resolution ( ) const

pure virtual

Get the current wireframe resolution.

N times the resolution of the heightfield mesh resolution

Returns

Returns the wireframe resolution. The default is 1.

get_wireframe_topology()

virtual Wireframe_topology nv::index::IHeightfield_wireframe_style::get_wireframe_topology ( ) const

pure virtual

Get the current wireframe topology.

Returns

Returns the wireframe topology. The default is WIREFRAME_TOPOLOGY_QUADS.

set_wireframe_resolution()

virtual void nv::index::IHeightfield_wireframe_style::set_wireframe_resolution ( mi::Uint32  resolution )

pure virtual

Set the wireframe resolution.

N times the resolution of the heightfield mesh resolution

Parameters

[in]

resolution

The wireframe resolution.

set_wireframe_topology()

virtual void nv::index::IHeightfield_wireframe_style::set_wireframe_topology ( Wireframe_topology  topology )

pure virtual

Set the wireframe topology to be used.

Parameters

[in]

topology

The wireframe topology.

---

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

• iwireframe_rendering_style.h