FBViewingOptions Class Reference
 
 
 
FBViewingOptions Class Reference

This reference page is linked to from the following overview topics: About the SDK Components, MotionBuilder 2014.


#include <mobu-python-api.h>


Class Description

Viewing options for rendering. The FBRenderer allows to get and set those options.

Public Member Functions

def  __reduce__ ()
def  InPicking ()
def  IsInSelectionBufferPicking ()
def  IsInColorBufferPicking ()
def  RenderCallbackPrefIndex ()
def  __init__ ()

Public Attributes

object  DisplayMode
object  StereoDisplayMode
object  DisplayWhat
object  PickingMode
object  ShowCameraLabel
object  ShowSafeArea
object  ShowTimeCode

Member Function Documentation

def __reduce__ ( )
def InPicking ( )

Python Docstring:

InPicking( (FBViewingOptions)arg1) -> bool 

C++ Signature:

K_DEPRECATED_2014 bool InPicking() 

Is the rendering routine during picking status.

def IsInSelectionBufferPicking ( )

Python Docstring:

IsInSelectionBufferPicking( (FBViewingOptions)arg1) -> bool 

C++ Signature:

bool IsInSelectionBufferPicking() 

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

def IsInColorBufferPicking ( )

Python Docstring:

IsInColorBufferPicking( (FBViewingOptions)arg1) -> bool 

C++ Signature:

bool IsInColorBufferPicking() 

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

def RenderCallbackPrefIndex ( )

Python Docstring:

RenderCallbackPrefIndex( (FBViewingOptions)arg1) -> int 

C++ Signature:

unsigned int RenderCallbackPrefIndex() 

Current Render callback Settings Index.

def __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 FBViewingOptions & )

Member Data Documentation

C++ Signature:

FBStereoDisplayMode & StereoDisplayMode() 

Get a reference to the stereo display mode.

Returns:
Reference to the current stereo display mode.
object DisplayWhat

C++ Signature:

int & DisplayWhat() 

Get a reference to the display mask.

Returns:
Reference to the current display mask.
object PickingMode

C++ Signature:

FBPickingMode & PickingMode() 

Get a reference to the picking mode.

Returns:
Reference to the current picking mode.

C++ Signature:

bool & ShowCameraLabel() 

Show Camera Label when rendering.

object ShowSafeArea

C++ Signature:

bool & ShowSafeArea() 

Show Safe Area when rendering.

object ShowTimeCode

C++ Signature:

bool & ShowTimeCode() 

Show Time Code when rendering.