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 <fbshader.h>


Class Description

Definition at line 344 of file fbshader.h.

Public Member Functions

  FBRenderOptions (HKRenderOptions pOptions)
FBCamera GetRenderingCamera ()
  Get the rendering camera.
int  GetRenderFrameId () const
  Get Render Frame ID.
K_DEPRECATED_2014 bool  IsIDBufferPicking () const
  Get IDBuffer Rendering request status (for display or picking)
bool  IsIDBufferRendering () const
  Get IDBuffer Rendering request status (for display or picking)
float  GetIDBufferPickingAlphaThreshold () const
  Get IDBuffer Picking Alpha threshold.
bool  IsOfflineRendering () const
  Check if the render request comes from offline render mode (as opposed to viewport refresh).
FBViewingOptions GetViewerOptions () const

Public Attributes

HKRenderOptions  mRenderOptions
  Pointer to render options.

Constructor & Destructor Documentation

FBRenderOptions::FBRenderOptions ( HKRenderOptions  pOptions )

Member Function Documentation

FBCamera* FBRenderOptions::GetRenderingCamera ( )

Get the rendering camera.

int FBRenderOptions::GetRenderFrameId ( ) const

Get Render Frame ID.

Returns:
This return a new ID each time a new frame is drawn.
K_DEPRECATED_2014 bool FBRenderOptions::IsIDBufferPicking ( ) const

Get IDBuffer Rendering request status (for display or picking)

Deprecated:
As the function name is confuing, use IsIDBufferRendering() instead.
Returns:
true if need to render Model (or subitem)'s UniqueColorID into GL Color Buffer.
bool FBRenderOptions::IsIDBufferRendering ( ) const

Get IDBuffer Rendering request status (for display or picking)

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

Get IDBuffer Picking Alpha threshold.

Returns:
ID Buffer picking alpha threshold value.
bool FBRenderOptions::IsOfflineRendering ( ) const

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.
FBViewingOptions* FBRenderOptions::GetViewerOptions ( ) const

Member Data Documentation

Pointer to render options.

Definition at line 382 of file fbshader.h.


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