nv::index::IViewport_list Class Reference

Defines a list of viewports that will be rendered onto a canvas. More...

#include <iviewport.h>

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

Public Member Functions
virtual mi::Size	size () const =0
	Returns the number of viewports contained in the list. More...
virtual nv::index::IViewport *	get (mi::Size index) const =0
	Returns the viewport at the given position in the list. More...
virtual void	append (nv::index::IViewport *viewport)=0
	Appends a viewport to the end of the list. More...
virtual bool	insert (mi::Size index, nv::index::IViewport *viewport)=0
	Inserts a viewport into the list at the given position. More...
virtual bool	remove (mi::Size index)=0
	Removes the viewport at the given position from the list. More...
virtual void	clear ()=0
	Removes all viewports from the list. More...
virtual void	set_advisory_enabled (bool enable)=0
	Enables or disables the advisory output. More...
virtual bool	get_advisory_enabled () const =0
	Returns whether if the advisory output is enabled. More...

Detailed Description

Defines a list of viewports that will be rendered onto a canvas.

This list is passed to the multi-view version of IIndex_rendering::render() as well as IIndex_scene_query::pick(). The order of the viewports in the list defines the rendering order.

For testing and debugging the multi-view support, extra advisory log output can be enabled.

Member Function Documentation

append()

virtual void nv::index::IViewport_list::append ( nv::index::IViewport *  viewport )

pure virtual

Appends a viewport to the end of the list.

This class takes ownership of the viewport.

Parameters

[in]

viewport

Viewport to append, this class takes ownership.

clear()

virtual void nv::index::IViewport_list::clear ( )

pure virtual

Removes all viewports from the list.

get()

virtual nv::index::IViewport * nv::index::IViewport_list::get ( mi::Size  index ) const

pure virtual

Returns the viewport at the given position in the list.

Parameters

[in]

index

Position in the list.

Returns

Selected viewport, or 0 when index is invalid

get_advisory_enabled()

virtual bool nv::index::IViewport_list::get_advisory_enabled ( ) const

pure virtual

Returns whether if the advisory output is enabled.

Returns

true when advisory is enabled

insert()

virtual bool nv::index::IViewport_list::insert ( mi::Size  index, nv::index::IViewport *  viewport  )

pure virtual

Inserts a viewport into the list at the given position.

This class takes ownership of the viewport.

Parameters

[in]	index	Position in the list.
[in]	viewport	Viewport to insert, this class takes ownership.

Returns

true on success, false when index is invalid.

remove()

virtual bool nv::index::IViewport_list::remove ( mi::Size  index )

pure virtual

Removes the viewport at the given position from the list.

Parameters

[in]

index

Position in the list.

Returns

true on success, or false when index is invalid.

set_advisory_enabled()

virtual void nv::index::IViewport_list::set_advisory_enabled ( bool  enable )

pure virtual

Enables or disables the advisory output.

When the advisory is enabled, extra debug messages related to multi-view support will be printed to the log.

The advisory output is disabled by default.

Parameters

[in]

enable

Advisory output state

size()

virtual mi::Size nv::index::IViewport_list::size ( ) const

pure virtual

Returns the number of viewports contained in the list.

Returns

Number of viewports

---

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

• iviewport.h