Open Reality Reference Guide
FBViewingOptions Class Reference

Viewing options for rendering. More...

#include <fbrenderer.h>

Public Member Functions

FBCameraGetViewingCamera ()
 Get a reference to the current viewing camera. More...
 
FBModelShadingModeShadingMode ()
 Get a reference to the display mode. More...
 
FBStereoDisplayModeStereoDisplayMode ()
 Get a reference to the stereo display mode. More...
 
int & DisplayWhat ()
 Get a reference to the display mask. More...
 
FBPickingModePickingMode ()
 Get a reference to the picking mode. More...
 
bool & ShowTimeCode ()
 Show Time Code when rendering. More...
 
bool & ShowSafeArea ()
 Show Safe Area when rendering. More...
 
bool & ShowCameraLabel ()
 Show Camera Label when rendering. More...
 
bool IsInSelectionBufferPicking () const
 Is the rendering routine during picking status with GL selection buffer method. More...
 
bool IsInColorBufferPicking () const
 Is the rendering routine during picking status with GL color buffer method. More...
 
unsigned int RenderCallbackPrefIndex () const
 Current Render callback Settings Index. More...
 
int PaneIndex () const
 Current Viewer Pane being rendered. More...
 

Detailed Description

Viewing options for rendering.

The FBRenderer allows to get and set those options.

Definition at line 175 of file fbrenderer.h.

Member Function Documentation

◆ DisplayWhat()

int& DisplayWhat ( )

Get a reference to the display mask.

Returns
Reference to the current display mask.

◆ GetViewingCamera()

FBCamera* GetViewingCamera ( )

Get a reference to the current viewing camera.

◆ IsInColorBufferPicking()

bool IsInColorBufferPicking ( ) const

Is the rendering routine during picking status with GL color buffer method.

◆ IsInSelectionBufferPicking()

bool IsInSelectionBufferPicking ( ) const

Is the rendering routine during picking status with GL selection buffer method.

◆ PaneIndex()

int PaneIndex ( ) const

Current Viewer Pane being rendered.

Returns
Index of the pane being rendered.

◆ PickingMode()

FBPickingMode& PickingMode ( )

Get a reference to the picking mode.

Returns
Reference to the current picking mode.

◆ RenderCallbackPrefIndex()

unsigned int RenderCallbackPrefIndex ( ) const

Current Render callback Settings Index.

◆ ShadingMode()

FBModelShadingMode& ShadingMode ( )

Get a reference to the display mode.

Returns
Reference to the current display mode.

◆ ShowCameraLabel()

bool& ShowCameraLabel ( )

Show Camera Label when rendering.

◆ ShowSafeArea()

bool& ShowSafeArea ( )

Show Safe Area when rendering.

◆ ShowTimeCode()

bool& ShowTimeCode ( )

Show Time Code when rendering.

◆ StereoDisplayMode()

FBStereoDisplayMode& StereoDisplayMode ( )

Get a reference to the stereo display mode.

Returns
Reference to the current stereo display mode.

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