FlightGear next
FGRenderer Class Referencefinal

#include <renderer.hxx>

Public Types

typedef std::vector< SGSceneryPick > PickList
 

Public Member Functions

 FGRenderer ()
 
 ~FGRenderer ()
 
void init ()
 Initialize the renderer.
 
void postinit ()
 Called after init() was called, the graphics window has been created and the CameraGroup has been initialized.
 
void setupView ()
 Setup the scene graph root.
 
bool runInitOperation ()
 Run a graphics operation that retrieves some OpenGL parameters.
 
void resize (int width, int height)
 Handle a window resize event.
 
void resize (int width, int height, int x, int y)
 
void update ()
 Update rendering-related parameters.
 
PickList pick (const osg::Vec2 &windowPos)
 Pick into the scene and return the pick callbacks on the way.
 
void addCanvasCamera (osg::Camera *camera)
 Add a Canvas RTT camera to the renderer.
 
void removeCanvasCamera (osg::Camera *camera)
 Remove a Canvas RTT camera from the renderer.
 
osgViewer::ViewerBase * getViewerBase () const
 
osg::ref_ptr< osgViewer::CompositeViewer > getCompositeViewer ()
 Both should only be used on reset.
 
void setCompositeViewer (osg::ref_ptr< osgViewer::CompositeViewer > composite_viewer)
 
osg::FrameStamp * getFrameStamp () const
 
osgViewer::View * getView ()
 
const osgViewer::View * getView () const
 
void setView (osgViewer::View *view)
 
flightgear::FGEventHandlergetEventHandler ()
 
const flightgear::FGEventHandlergetEventHandler () const
 
void setEventHandler (flightgear::FGEventHandler *event_handler)
 
SGSky * getSky () const
 
SplashScreengetSplash ()
 

Detailed Description

Definition at line 30 of file renderer.hxx.

Member Typedef Documentation

◆ PickList

typedef std::vector<SGSceneryPick> FGRenderer::PickList

Definition at line 81 of file renderer.hxx.

Constructor & Destructor Documentation

◆ FGRenderer()

FGRenderer::FGRenderer ( )

Definition at line 212 of file renderer.cxx.

◆ ~FGRenderer()

FGRenderer::~FGRenderer ( )

Definition at line 216 of file renderer.cxx.

Member Function Documentation

◆ addCanvasCamera()

void FGRenderer::addCanvasCamera ( osg::Camera * camera)

Add a Canvas RTT camera to the renderer.

Parameters
cameraA valid pointer to an already configured osg::Camera.

Definition at line 731 of file renderer.cxx.

◆ getCompositeViewer()

osg::ref_ptr< osgViewer::CompositeViewer > FGRenderer::getCompositeViewer ( )

Both should only be used on reset.

Definition at line 788 of file renderer.cxx.

◆ getEventHandler() [1/2]

FGEventHandler * FGRenderer::getEventHandler ( )

Definition at line 838 of file renderer.cxx.

◆ getEventHandler() [2/2]

const FGEventHandler * FGRenderer::getEventHandler ( ) const

Definition at line 844 of file renderer.cxx.

◆ getFrameStamp()

osg::FrameStamp * FGRenderer::getFrameStamp ( ) const

Definition at line 800 of file renderer.cxx.

◆ getSky()

SGSky * FGRenderer::getSky ( ) const

Definition at line 856 of file renderer.cxx.

◆ getSplash()

SplashScreen * FGRenderer::getSplash ( )

Definition at line 862 of file renderer.cxx.

◆ getView() [1/2]

osgViewer::View * FGRenderer::getView ( )

Definition at line 807 of file renderer.cxx.

◆ getView() [2/2]

const osgViewer::View * FGRenderer::getView ( ) const

Definition at line 820 of file renderer.cxx.

◆ getViewerBase()

osgViewer::ViewerBase * FGRenderer::getViewerBase ( ) const

Definition at line 782 of file renderer.cxx.

◆ init()

void FGRenderer::init ( )

Initialize the renderer.

Constructor does nothing. This is the first function that must be called when initializing the renderer.

Definition at line 233 of file renderer.cxx.

◆ pick()

FGRenderer::PickList FGRenderer::pick ( const osg::Vec2 & windowPos)

Pick into the scene and return the pick callbacks on the way.

Parameters
windowPosA 2D coordinate in window space.

Definition at line 685 of file renderer.cxx.

◆ postinit()

void FGRenderer::postinit ( )

Called after init() was called, the graphics window has been created and the CameraGroup has been initialized.

Definition at line 337 of file renderer.cxx.

◆ removeCanvasCamera()

void FGRenderer::removeCanvasCamera ( osg::Camera * camera)

Remove a Canvas RTT camera from the renderer.

Parameters
cameraA valid pointer to a previously added Canvas camera.

Definition at line 755 of file renderer.cxx.

◆ resize() [1/2]

void FGRenderer::resize ( int width,
int height )

Handle a window resize event.

Parameters
widthWindow width.
heightWindow height.
xWindow horizontal position.
yWindow vertical position.

Definition at line 625 of file renderer.cxx.

◆ resize() [2/2]

void FGRenderer::resize ( int width,
int height,
int x,
int y )

Definition at line 606 of file renderer.cxx.

◆ runInitOperation()

bool FGRenderer::runInitOperation ( )

Run a graphics operation that retrieves some OpenGL parameters.

Should be called until it returns true.

Returns
True when done, false when still busy (call again).

Definition at line 457 of file renderer.cxx.

◆ setCompositeViewer()

void FGRenderer::setCompositeViewer ( osg::ref_ptr< osgViewer::CompositeViewer > composite_viewer)

Definition at line 794 of file renderer.cxx.

◆ setEventHandler()

void FGRenderer::setEventHandler ( flightgear::FGEventHandler * event_handler)

Definition at line 850 of file renderer.cxx.

◆ setupView()

void FGRenderer::setupView ( )

Setup the scene graph root.

Add the sky and scenery to the scene graph root and initialize some common rendering options.

Definition at line 361 of file renderer.cxx.

◆ setView()

void FGRenderer::setView ( osgViewer::View * view)

Definition at line 827 of file renderer.cxx.

◆ update()

void FGRenderer::update ( )

Update rendering-related parameters.

This is called right before OSG's viewer->frame() on the main thread. The actual drawing/rendering is done internally by OSG.

Definition at line 483 of file renderer.cxx.


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