FBViewingOptions Class Reference

#include <mobu-python-api.h>

Class Description

Viewing options for rendering.

The FBRenderer allows to get and set those options.

See the C++ reference

Inheritance diagram for FBViewingOptions:

Public Member Functions
	__reduce__ ()
bool	InPicking (FBViewingOptions arg1)
	Is the rendering routine during picking status. More...
bool	IsInSelectionBufferPicking (FBViewingOptions arg1)
	Is the rendering routine during picking status with GL selection buffer method. More...
bool	IsInColorBufferPicking (FBViewingOptions arg1)
	Is the rendering routine during picking status with GL color buffer method. More...
int	RenderCallbackPrefIndex (FBViewingOptions arg1)
	Current Render callback Settings Index. More...
	__init__ (...)

Public Attributes
object	DisplayMode
object	StereoDisplayMode
	Get a reference to the stereo display mode. More...
object	DisplayWhat
	Get a reference to the display mask. More...
object	PickingMode
	Get a reference to the picking mode. More...
object	ShowCameraLabel
	Show Camera Label when rendering. More...
object	ShowSafeArea
	Show Safe Area when rendering. More...
object	ShowTimeCode
	Show Time Code when rendering. More...
object	PaneIndex
	Current Viewer Pane being rendered. More...

Member Function Documentation

__init__

(

...

)

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

 FBViewingOptions()
 FBViewingOptions(const ORSDK2018::FBViewingOptions & )

__reduce__

(

)

bool InPicking

(

FBViewingOptions

arg1

)

Is the rendering routine during picking status.

Python Docstring:

InPicking( (FBViewingOptions)arg1) -> bool 

C++ Signature:

bool InPicking() 

See the C++ reference

bool IsInColorBufferPicking

(

FBViewingOptions

arg1

)

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

Python Docstring:

IsInColorBufferPicking( (FBViewingOptions)arg1) -> bool 

C++ Signature:

bool IsInColorBufferPicking() 

See the C++ reference

bool IsInSelectionBufferPicking

(

FBViewingOptions

arg1

)

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

Python Docstring:

IsInSelectionBufferPicking( (FBViewingOptions)arg1) -> bool 

C++ Signature:

bool IsInSelectionBufferPicking() 

See the C++ reference

int RenderCallbackPrefIndex

(

FBViewingOptions

arg1

)

Current Render callback Settings Index.

Python Docstring:

RenderCallbackPrefIndex( (FBViewingOptions)arg1) -> int 

C++ Signature:

unsigned int RenderCallbackPrefIndex() 

See the C++ reference

Member Data Documentation

object DisplayMode

object DisplayWhat

Get a reference to the display mask.

C++ Signature:

int & DisplayWhat() 

Returns

Reference to the current display mask.

See the C++ reference

object PaneIndex

Current Viewer Pane being rendered.

C++ Signature:

int PaneIndex() 

Returns

Index of the pane being rendered.

See the C++ reference

object PickingMode

Get a reference to the picking mode.

C++ Signature:

FBPickingMode & PickingMode() 

Returns

Reference to the current picking mode.

See the C++ reference

object ShowCameraLabel

Show Camera Label when rendering.

C++ Signature:

bool & ShowCameraLabel() 

See the C++ reference

object ShowSafeArea

Show Safe Area when rendering.

C++ Signature:

bool & ShowSafeArea() 

See the C++ reference

object ShowTimeCode

Show Time Code when rendering.

C++ Signature:

bool & ShowTimeCode() 

See the C++ reference

object StereoDisplayMode

Get a reference to the stereo display mode.

C++ Signature:

FBStereoDisplayMode & StereoDisplayMode() 

Returns

Reference to the current stereo display mode.

See the C++ reference