scg3  0.6
scg::Renderer Class Referenceabstract

Base class for all renderers (abstract). More...

#include "Renderer.h"

Inheritance diagram for scg::Renderer:
[legend]
Collaboration diagram for scg::Renderer:
[legend]

Public Member Functions

 Renderer ()
 
virtual ~Renderer ()=0
 
virtual void initViewer (Viewer *viewer, FrameBufferSize *frameBufferSize)=0
 
virtual void initRenderState ()
 
void destroyScene ()
 
NodeSP getScene ()
 
void setScene (NodeSP scene)
 
CameraSP getCamera ()
 
void setCamera (CameraSP camera)
 
void setLighting (bool isLightingEnabled)
 
bool isLightingEnabled () const
 
void setGlobalAmbientLight (const glm::vec4 &globalAmbientLight)
 
virtual std::string getInfo ()
 
virtual void render ()=0
 

Protected Attributes

Viewerviewer_
 
NodeSP scene_
 
CameraSP camera_
 
RenderStateUP renderState_
 

Detailed Description

Base class for all renderers (abstract).

Definition at line 45 of file Renderer.h.

Constructor & Destructor Documentation

◆ Renderer()

scg::Renderer::Renderer ( )

Constructor.

◆ ~Renderer()

virtual scg::Renderer::~Renderer ( )
pure virtual

Destructor.

Member Function Documentation

◆ destroyScene()

void scg::Renderer::destroyScene ( )

Destroy scene graph.

◆ getCamera()

CameraSP scg::Renderer::getCamera ( )

Get camera.

◆ getInfo()

virtual std::string scg::Renderer::getInfo ( )
virtual

Get information about the scene graph (e.g., number of triangles).

Reimplemented in scg::StandardRenderer, and scg::StereoRenderer.

◆ getScene()

NodeSP scg::Renderer::getScene ( )

Get scene.

◆ initRenderState()

virtual void scg::Renderer::initRenderState ( )
virtual

Initialize render state after an OpenGL context has been created.

Reimplemented in scg::StereoRenderer.

◆ initViewer()

virtual void scg::Renderer::initViewer ( Viewer viewer,
FrameBufferSize frameBufferSize 
)
pure virtual

Initialize viewer properties before an OpenGL context has been created.

Parameters
viewerviewer that uses the renderer
frameBufferSizeframe buffer size to be used by viewer to create OpenGL context (cf. FrameBufferSize), can be modified for specific requirements (e.g., stencil buffer)

Implemented in scg::StereoRendererActive, scg::StandardRenderer, and scg::StereoRenderer.

◆ isLightingEnabled()

bool scg::Renderer::isLightingEnabled ( ) const

Check if lighting is enabled.

◆ render()

virtual void scg::Renderer::render ( )
pure virtual

◆ setCamera()

void scg::Renderer::setCamera ( CameraSP  camera)

Set camera.

◆ setGlobalAmbientLight()

void scg::Renderer::setGlobalAmbientLight ( const glm::vec4 &  globalAmbientLight)

Set global ambient light of render state.

◆ setLighting()

void scg::Renderer::setLighting ( bool  isLightingEnabled)

Enable or disable lighting of render state.

Default: enabled

◆ setScene()

void scg::Renderer::setScene ( NodeSP  scene)

Set scene.

Member Data Documentation

◆ camera_

CameraSP scg::Renderer::camera_
protected

Definition at line 131 of file Renderer.h.

◆ renderState_

RenderStateUP scg::Renderer::renderState_
protected

Definition at line 132 of file Renderer.h.

◆ scene_

NodeSP scg::Renderer::scene_
protected

Definition at line 130 of file Renderer.h.

◆ viewer_

Viewer* scg::Renderer::viewer_
protected

Definition at line 129 of file Renderer.h.


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