nv::index::ICanvas_viewport_list Class Reference

Defines a list of canvases with associated viewports. More...

#include <iviewport.h>

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

Public Member Functions
virtual mi::Size	size () const =0
	Returns the number of canvases and viewport-lists contained in the list. More...
virtual nv::index::IIndex_canvas *	get_canvas (mi::Size index) const =0
	Returns the canvas at the given position in the list. More...
virtual nv::index::IViewport_list *	get_viewport_list (mi::Size index) const =0
	Returns the viewport-list at the given position in the list. More...
virtual void	append (nv::index::IIndex_canvas *canvas, nv::index::IViewport_list *viewport_list)=0
	Appends a canvas/viewport-list pair to the end of the list. More...
virtual bool	insert (mi::Size index, nv::index::IIndex_canvas *canvas, nv::index::IViewport_list *viewport_list)=0
	Inserts a canvas/viewport-list pair into the list at the given position. More...
virtual bool	remove (mi::Size index)=0
	Removes the canvas/viewport-list pair at the given position from the list. More...
virtual void	clear ()=0
	Removes all canvas/viewport-list pairs from the list. More...

Detailed Description

Defines a list of canvases with associated viewports.

This allows rendering to multiple canvases, each having one or more viewports.

Note

This list must always contain all canvases. When only a subset of the canvases should be rendered, then it is still necessary to include all of them here, to ensure proper cache handling. However, the viewports in the canvases that should be skipped for rendering can be disabled by calling IViewport::set_enable().

This list is passed to the multi-canvas version of IIndex_rendering::render().

Member Function Documentation

append()

virtual void nv::index::ICanvas_viewport_list::append ( nv::index::IIndex_canvas *  canvas, nv::index::IViewport_list *  viewport_list  )

pure virtual

Appends a canvas/viewport-list pair to the end of the list.

This class takes ownership of the viewport-list.

Parameters

[in]	canvas	Canvas to append, this class does not take ownership.
[in]	viewport_list	Viewport-list to append, this class takes ownership.

clear()

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

pure virtual

Removes all canvas/viewport-list pairs from the list.

get_canvas()

virtual nv::index::IIndex_canvas * nv::index::ICanvas_viewport_list::get_canvas ( mi::Size  index ) const

pure virtual

Returns the canvas at the given position in the list.

Parameters

[in]

index

Position in the list.

Returns

Selected canvas, or 0 when index is invalid

get_viewport_list()

virtual nv::index::IViewport_list * nv::index::ICanvas_viewport_list::get_viewport_list ( mi::Size  index ) const

pure virtual

Returns the viewport-list at the given position in the list.

Parameters

[in]

index

Position in the list.

Returns

Selected viewport-list, or 0 when index is invalid

insert()

virtual bool nv::index::ICanvas_viewport_list::insert ( mi::Size  index, nv::index::IIndex_canvas *  canvas, nv::index::IViewport_list *  viewport_list  )

pure virtual

Inserts a canvas/viewport-list pair into the list at the given position.

This class takes ownership of the viewport-list.

Parameters

[in]	index	Position in the list.
[in]	canvas	Canvas to insert, this class does not take ownership.
[in]	viewport_list	Viewport-list to append, this class takes ownership.

Returns

true on success, false when index is invalid.

remove()

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

pure virtual

Removes the canvas/viewport-list pair at the given position from the list.

Parameters

[in]

index

Position in the list.

Returns

true on success, or false when index is invalid.

size()

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

pure virtual

Returns the number of canvases and viewport-lists contained in the list.

Returns

Number of canvas/viewport-list pairs stored in the list.

---

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

• iviewport.h