FBRenderOptions Class Reference
 
 
 
FBRenderOptions Class Reference

This reference page is linked to from the following overview topics: About the SDK Components, Viewport Picking, Selection, and Manipulation, MotionBuilder 2014.


#include <mobu-python-api.h>


Class Description

Public Member Functions

def  __reduce__ ()
def  GetRenderingCamera ()
def  GetRenderFrameId ()
def  IsIDBufferPicking ()
def  IsIDBufferRendering ()
def  GetIDBufferPickingAlphaThreshold ()
def  IsOfflineRendering ()
def  GetViewerOptions ()
def  __init__ ()

Member Function Documentation

def __reduce__ ( )
def GetRenderingCamera ( )

Python Docstring:

GetRenderingCamera( (FBRenderOptions)arg1) -> object 

C++ Signature:

FBCamera * GetRenderingCamera() 

Get the rendering camera.

def GetRenderFrameId ( )

Python Docstring:

GetRenderFrameId( (FBRenderOptions)arg1) -> int 

C++ Signature:

int GetRenderFrameId() 

Get Render Frame ID.

Returns:
This return a new ID each time a new frame is drawn.
def IsIDBufferPicking ( )

Python Docstring:

IsIDBufferPicking( (FBRenderOptions)arg1) -> bool 

C++ Signature:

K_DEPRECATED_2014 bool IsIDBufferPicking() 

Get IDBuffer Rendering request status (for display or picking)

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

Python Docstring:

IsIDBufferRendering( (FBRenderOptions)arg1) -> bool 

C++ Signature:

bool IsIDBufferRendering() 

Get IDBuffer Rendering request status (for display or picking)

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

Python Docstring:

GetIDBufferPickingAlphaThreshold( (FBRenderOptions)arg1) -> float 

C++ Signature:

float GetIDBufferPickingAlphaThreshold() 

Get IDBuffer Picking Alpha threshold.

Returns:
ID Buffer picking alpha threshold value.
def IsOfflineRendering ( )

Python Docstring:

IsOfflineRendering( (FBRenderOptions)arg1) -> bool 

C++ Signature:

bool IsOfflineRendering() 

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

Returns:
true if the render comes from offline render mode.
def GetViewerOptions ( )

Python Docstring:

GetViewerOptions( (FBRenderOptions)arg1) -> FBViewingOptions 

C++ Signature:

FBViewingOptions * GetViewerOptions() 
def __init__ ( )

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

C++ Signature:

 FBRenderOptions(HKRenderOptions pOptions)