Wizt::VRenderContext Struct Reference

Base class for objects that may display something. More...

#include <ocean/Anemonia/VRenderContext.hpp>

Collaboration diagram for Wizt::VRenderContext:

[legend]

List of all members.

Classes

• struct Geometry
• struct PickId

  Information about the currently picked object. More...
  

• struct RenderObjectNotifier
• struct Size

Public Types

• typedef Eagle::tvector3 tvector3

Public Member Functions

• virtual double aspect () const =0

  Return the aspect ratio of the current viewer window, i.e. width / height. Returns 1.0 if no output medium is defined.
  

• bool BeginNewObjectRender ()
• int BeginNewRender (int MaxRenderObjects)
• int BeginNewSubObjectRender ()
• virtual bool isCancelled () const

  Virtual callback function that tells if this render context is supposed to be cancelled (stopped).
  

• bool isPickMode () const
• bool isSelected () const

  Specifies if the rendered object is currently selected by the user. This is a fast inline function which can be called frequently without performance impact by a rendering routine.
  

• bool isSubSelected () const

  Specifies if the subgroup of the rendered object is currently selected by the user.
  

• virtual int render (const ObjectSelection &RenderObjects, double &RenderTime, int MinLevel=RENDER_FIRST, int MaxLevel=RENDER_LAST)=0

  Implementation-specific function to traverse all objects that ought to be rendered.
  

• void setCurrentPick (const PickId &P)
• void setRenderObjectNotifier (RenderObjectNotifier *UseThisRenderObjectNotifier)
• void setSelectedFlag (const WeakPtr< VManagedObject > &V)
• virtual Geometry viewport () const =0

  Return the viewport properties of the render context, as set by glViewport();.
  

• VRenderContext (const RefPtr< VRenderPrecision > &Hints)

  Constructor, provide render hints.
  

• virtual ~VRenderContext ()

  Constructor.
  

Public Attributes

• VCamera CameraSettings

  Properties of the camera.
  

• Size CurrentTileID
• RefPtr< VRenderPrecision > Hints

  Additional information on how rendering should happen.
  

• Size Image

  For tiled rendering: Setup the Image size (in pixels) the size of one Tile (in pixels) and define the CurrentTileID (in integers telling the current ID of the tile to be rendered).
  

• struct {
  •    int    pixels
  •    int    x
  •    int    y
• } pick

  Local help structure used for picking.
  

• int priority
• Size Tile

---

Detailed Description

Base class for objects that may display something.

Examples:

ClippingPlane.cpp, ComputeGridStreamLines.cpp, ComputeMultiStreamLines.cpp, DemoSphere.cpp, and PointSprite.cpp.

---

Member Function Documentation

int Wizt::VRenderContext::BeginNewRender

(

int

MaxRenderObjects

)

[inline]

Returns:

The shift factor for the number of objects, i.e. retval = int(log2(MaxRenderObjects), such that MaxRenderObjects < 1<<retval.

virtual int Wizt::VRenderContext::render	(	const ObjectSelection &	RenderObjects,
		double &	RenderTime,
		int	MinLevel = RENDER_FIRST,
		int	MaxLevel = RENDER_LAST
	)			[pure virtual]

Implementation-specific function to traverse all objects that ought to be rendered.

Parameters:

RenderTime

The accumulative time (in seconds) used for rendering.

Returns:

The number of objects that had been actually rendered

Implemented in Wizt::VGLRenderContext.

---

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

• ocean/Anemonia/VRenderContext.hpp
• ocean/Anemonia/VRenderContext.cpp