FBRenderOptions Class Reference

#include <mobu-python-api.h>

Class Description

See the C++ reference

Inheritance diagram for FBRenderOptions:

Public Member Functions
	__reduce__ ()
object	GetRenderingCamera (FBRenderOptions arg1)
	Get the rendering camera. More...
int	GetRenderFrameId (FBRenderOptions arg1)
	Get Render Frame ID. More...
bool	IsIDBufferPicking (FBRenderOptions arg1)
	Get IDBuffer Rendering request status (for display or picking) More...
bool	IsIDBufferRendering (FBRenderOptions arg1)
	Get IDBuffer Rendering request status (for display or picking) More...
float	GetIDBufferPickingAlphaThreshold (FBRenderOptions arg1)
	Get IDBuffer Picking Alpha threshold. More...
bool	IsOfflineRendering (FBRenderOptions arg1)
	Check if the render request comes from offline render mode (as opposed to viewport refresh). More...
FBViewingOptions	GetViewerOptions (FBRenderOptions arg1)
	__init__ (...)

Member Function Documentation

__init__

(

...

)

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

C++ Signature:

 FBRenderOptions(HKRenderOptions pOptions) 

See the C++ reference

__reduce__

(

)

float GetIDBufferPickingAlphaThreshold

(

FBRenderOptions

arg1

)

Get IDBuffer Picking Alpha threshold.

Python Docstring:

GetIDBufferPickingAlphaThreshold( (FBRenderOptions)arg1) -> float 

C++ Signature:

float GetIDBufferPickingAlphaThreshold() 

Returns

ID Buffer picking alpha threshold value.

See the C++ reference

int GetRenderFrameId

(

FBRenderOptions

arg1

)

Get Render Frame ID.

Python Docstring:

GetRenderFrameId( (FBRenderOptions)arg1) -> int 

C++ Signature:

int GetRenderFrameId() 

Returns

This return a new ID each time a new frame is drawn.

See the C++ reference

object GetRenderingCamera

(

FBRenderOptions

arg1

)

Get the rendering camera.

Python Docstring:

GetRenderingCamera( (FBRenderOptions)arg1) -> object 

C++ Signature:

ORSDK2018::FBCamera * GetRenderingCamera() 

See the C++ reference

FBViewingOptions GetViewerOptions

(

FBRenderOptions

arg1

)

Python Docstring:

GetViewerOptions( (FBRenderOptions)arg1) -> FBViewingOptions 

C++ Signature:

ORSDK2018::FBViewingOptions * GetViewerOptions() 

See the C++ reference

bool IsIDBufferPicking

(

FBRenderOptions

arg1

)

Get IDBuffer Rendering request status (for display or picking)

Python Docstring:

IsIDBufferPicking( (FBRenderOptions)arg1) -> bool 

C++ Signature:

bool IsIDBufferPicking() 

Returns

true if need to render Model (or subitem)'s UniqueColorID into GL Color Buffer.

See the C++ reference

bool IsIDBufferRendering

(

FBRenderOptions

arg1

)

Get IDBuffer Rendering request status (for display or picking)

Python Docstring:

IsIDBufferRendering( (FBRenderOptions)arg1) -> bool 

C++ Signature:

bool IsIDBufferRendering() 

Returns

true if need to render Model (or subitem)'s UniqueColorID into GL Color Buffer.

See the C++ reference

bool IsOfflineRendering

(

FBRenderOptions

arg1

)

Check if the render request comes from offline render mode (as opposed to viewport refresh).

Python Docstring:

IsOfflineRendering( (FBRenderOptions)arg1) -> bool 

C++ Signature:

bool IsOfflineRendering() 

Returns

true if the render comes from offline render mode.

See the C++ reference