Wizt::Viewer Class Reference

A viewer is a Vish object that takes a VSceneLayers as input (a selection of Vish objects which can render something) and provides a FrameBuffer as output. More...

#include </home/werner/origo/vish/ocean/Anemonia/Viewer.hpp>

List of all members.

Public Member Functions

• const SeagrassWeakPtr_t & getSeagrass ()
• void setSeagrass (const SeagrassWeakPtr_t &theSeagrass)
• Viewer (const VFrameBuffer &Renderer, const string &name, int p, const RefPtr< VCreationPreferences > &ViewerCreationPreferences, const RefPtr< VCreationPreferences > &ViewerScenePreferences=NullPtr())

  Construct a viewer, specify a renderer.
  

Scene functions

• int render (VRenderContext &Context, int MinLevel=RENDER_FIRST, int MaxLevel=RENDER_LAST) const

  Render the entire scene.
  

• RefPtr< TouchList > pick (VRenderContext &Context, int x, int y, int DX, int DY) const

  Pick the object at the selected pixel coordinates (x,y), and return its subgroup identifier, too.
  

• RefPtr< BoundingBall > getBoundingBox (const RefPtr< ValuePool > &Context) const

  Get the bounding box of a scene.
  

• RefPtr< BoundingBall > getBoundingBox () const

  Get the bounding box of the objects contained in this viewer's scene.
  

Public Attributes

• int DepthLayers

  The number of layers for depth peeling.
  

• int Height
• TypedSlot< VFrameBuffer > myFrameBuffer

  INPUT: A frame buffer, to be attached to a MetaViewer as input, but also available to another object that might request grabbing a FrameBuffer.
  

• TypedSlot< VSceneLayers > mySceneLayers

  INPUT: Scene layers, ready to render.
  

• SeagrassWeakPtr_t mySeagrass

  The associated Seagrass cache for Anemones.
  

• RefPtr< ValuePool > myValuePool

  Optional local value pool.
  

• WeakPtr< ValuePoolProvider > myValuePoolProvider

  Optional reference to some object which wants to know which ValuePool is active.
  

• VPolyOutput< ViewerState,
  MetaViewer > myViewerState

  OUTPUT: A frame buffer, to be attached to a MetaViewer as input, but also available to another object that might request grabbing a FrameBuffer.
  

• int Width

---

Detailed Description

A viewer is a Vish object that takes a VSceneLayers as input (a selection of Vish objects which can render something) and provides a FrameBuffer as output.

All objects providing a FrameBuffer as output are collected by a MetaViewer, which provides different means to display those FameBuffer.

A viewer may provide its own ValuePool, so any rendering is relative to this context.

The ValuePool may also be shared with some external ValuePool, so multiple Viewer may display the same parameter set.

---

Constructor & Destructor Documentation

Wizt::Viewer::Viewer	(	const VFrameBuffer &	Renderer,
		const string &	name,
		int	p,
		const RefPtr< VCreationPreferences > &	ViewerCreationPreferences,
		const RefPtr< VCreationPreferences > &	ViewerScenePreferences = NullPtr()
	)

Construct a viewer, specify a renderer.

possibly make use of CreationPreferences here to attach to a non-default scene, if that would be of use.

---

Member Function Documentation

int Wizt::Viewer::render	(	VRenderContext &	Context,
		int	MinLevel = RENDER_FIRST,
		int	MaxLevel = RENDER_LAST
	)		const

Render the entire scene.

Calls VSceneLayers::render(), which calls VRenderContext::render(). Called by GLRenderer::grab().

Parameters:

Context	The render context
MinLevel	The start layer of object categories to be rendered
MaxLevel	The end layer of object categories to be rendered

Returns:

The number of objects rendered, or negative if there is no VScene connected

---

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

• ocean/Anemonia/Viewer.hpp
• ocean/Anemonia/Viewer.cpp