This reference page is linked to from the following overview topics: Data types & properties.

Rendering engine. More...

#include
<kaydaradef.h>

#include <fbsdk/fbmanipulator.h>
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbmodel.h>
#include <fbcontrols/fbcontrols.h>

Go to the source code of this file.

Classes
class	FBViewingOptions
	Viewing options for rendering. More...
struct	FBPickInfos
	Picking information structure. More...
class	FBViewerInfos
	Scene information display. More...
class	FBRenderer
	Open Reality renderer interface. More...
Defines
#define	FBSDK_DLL K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...
Typedefs
typedef class FBSDK_DLL FBArrayTemplate< FBPickInfos >	FBPickInfosList
	typedef class FBSDK_DLL FBArrayTemplate<FBPickInfos> FBPickInfosList
Enumerations
enum	FBDisplayMode { kFBDisplayModeDefault = 0, kFBDisplayModeTexture, kFBDisplayModeHardShade, kFBDisplayModeFlatShade, kFBDisplayModeWireFrame, kFBDisplayModeCount }
	Model display options. More...
enum	FBStereoDisplayMode { kFBStereoDisplayCenterEye = 0, kFBStereoDisplayLeftEye, kFBStereoDisplayRightEye, kFBStereoDisplayActive, kFBStereoDisplayHorizontalInterlace, kFBStereoDisplayCheckerboard, kFBStereoDisplayAnaglyph, kFBStereoDisplayAnaglyphLuminance, kFBStereoDisplayFreeviewParallel, kFBStereoDisplayFreeviewCrossed, kFBStereoDisplayModeCount = 10 }
enum	FBDisplayWhat { kFBDisplayNone = 0, kFBDisplayNull = (1 << 0), kFBDisplayMarker = (1 << 1), kFBDisplaySkeleton = (1 << 2), kFBDisplayCenter = (1 << 3), kFBDisplayLight = (1 << 4), kFBDisplayCamera = (1 << 5), kFBDisplay3dIcon = (1 << 6), kFBDisplayAll = 0xff }
	Model display mask This mask determines what types of models are displayed by the renderer. More...
enum	FBPickingMode { kFBPickingModeStandard = 0, kFBPickingModeXRay, kFBPickingModeModelsOnly, kFBPickingModeCount }
	3D picking mode. More...
enum	FBDeviceKeyboardKey { kFBDKeyPageUp, kFBDKeyPageDown, kFBDKeyEnd, kFBDKeyHome, kFBDKeyArrowLeft, kFBDKeyArrowUp, kFBDKeyArrowRight, kFBDKeyArrowDown, kFBDKeyReturn, kFBDKeyEscape, kFBDKeySpace, kFBDKey1, kFBDKey2, kFBDKey3, kFBDKey4, kFBDKey5, kFBDKey6, kFBDKey7, kFBDKey8, kFBDKey9, kFBDKey0, kFBDKeyF1, kFBDKeyF2, kFBDKeyF3, kFBDKeyF4, kFBDKeyF5, kFBDKeyF6, kFBDKeyF7, kFBDKeyF8, kFBDKeyF9, kFBDKeyF10, kFBDKeyF11, kFBDKeyF12 }
	Keyboard keys (for input). More...
Functions
	__FB_FORWARD (FBRenderer)
	FB_FORWARD (FBView)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Renderer)
	FB_FORWARD (FBViewingOptions)
	FB_DEFINE_ENUM (FBSDK_DLL, DeviceKeyboardKey)
bool	operator== (const FBPickInfos &pLhs, const FBPickInfos &pRhs)
	__FB_FORWARD (FBViewerInfos)
	FB_DEFINE_COMPONENT (FBSDK_DLL, ViewerInfos)

Detailed Description

Rendering engine.

Definition in file fbrenderer.h.

Define Documentation

#define FBSDK_DLL K_DLLIMPORT

Search for all occurrences

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbrenderer.h.

Typedef Documentation

typedef class FBSDK_DLL FBArrayTemplate<FBPickInfos> FBPickInfosList

Search for all occurrences

typedef class FBSDK_DLL FBArrayTemplate<FBPickInfos> FBPickInfosList

Definition at line 249 of file fbrenderer.h.

Enumeration Type Documentation

enum FBDisplayMode

Search for all occurrences

Model display options.

Enumerator:

kFBDisplayModeDefault	Use default display mode. Search for all occurrences
kFBDisplayModeTexture	Textures are displayed. Search for all occurrences
kFBDisplayModeHardShade	Hard shading. Search for all occurrences
kFBDisplayModeFlatShade	Flat shading. Search for all occurrences
kFBDisplayModeWireFrame	Wire-frame rendering. Search for all occurrences
kFBDisplayModeCount	End of enum, this value indicates the number of display modes available. Search for all occurrences

Definition at line 71 of file fbrenderer.h.

                   {
    kFBDisplayModeDefault = 0,  
    kFBDisplayModeTexture,      
    kFBDisplayModeHardShade,    
    kFBDisplayModeFlatShade,    
    kFBDisplayModeWireFrame,    
    kFBDisplayModeCount         
};

enum FBStereoDisplayMode

Search for all occurrences

Enumerator:

kFBStereoDisplayCenterEye	Display in Center Eye Camera, No Stereo effect. Search for all occurrences
kFBStereoDisplayLeftEye	Display in Left Eye Caerma, No Stereo effect. Search for all occurrences
kFBStereoDisplayRightEye	Display in Right Eye Caerma, No Stereo effect. Search for all occurrences
kFBStereoDisplayActive	Display in active mode. User must enable OpenGL quad stereo buffer, and choose approriate stereo mode in video card hardware's config app. Search for all occurrences
kFBStereoDisplayHorizontalInterlace	Display in Horizontal Interlace stereo mode. Search for all occurrences
kFBStereoDisplayCheckerboard	Display in Checkboard Interlace stereo mode. Search for all occurrences
kFBStereoDisplayAnaglyph	Display in Analygh stereo mode. Search for all occurrences
kFBStereoDisplayAnaglyphLuminance	Display in Luminance Analygh stereo mode. Search for all occurrences
kFBStereoDisplayFreeviewParallel	Display in parallel free view stereo mode. Search for all occurrences
kFBStereoDisplayFreeviewCrossed	Display in crossed free view stereo mode. Search for all occurrences
kFBStereoDisplayModeCount	update this count value when add new mode Search for all occurrences

Definition at line 80 of file fbrenderer.h.

{
    kFBStereoDisplayCenterEye = 0,          
    kFBStereoDisplayLeftEye,                
    kFBStereoDisplayRightEye,               
    kFBStereoDisplayActive,                 
    kFBStereoDisplayHorizontalInterlace,    
    kFBStereoDisplayCheckerboard,           
    kFBStereoDisplayAnaglyph,               
    kFBStereoDisplayAnaglyphLuminance,       
    kFBStereoDisplayFreeviewParallel,       
    kFBStereoDisplayFreeviewCrossed,        
    kFBStereoDisplayModeCount = 10          
};

enum FBDisplayWhat

Search for all occurrences

Model display mask This mask determines what types of models are displayed by the renderer.

Enumerator:

kFBDisplayNone	Nothing is displayed. Search for all occurrences
kFBDisplayNull	Null models are displayed. Search for all occurrences
kFBDisplayMarker	Markers are displayed. Search for all occurrences
kFBDisplaySkeleton	Skeletons and bones are displayed. Search for all occurrences
kFBDisplayCenter	Centers are displayed. Search for all occurrences
kFBDisplayLight	Lights are displayed. Search for all occurrences
kFBDisplayCamera	Cameras are displayed. Search for all occurrences
kFBDisplay3dIcon	3D icons are displayed (3D icons are 3D elements that do not exist in the scene). Search for all occurrences
kFBDisplayAll	Everything is displayed. Search for all occurrences

Definition at line 99 of file fbrenderer.h.

                   {
    kFBDisplayNone      = 0,            
    kFBDisplayNull      = (1 << 0),     
    kFBDisplayMarker    = (1 << 1),     
    kFBDisplaySkeleton  = (1 << 2),     
    kFBDisplayCenter    = (1 << 3),     
    kFBDisplayLight     = (1 << 4),     
    kFBDisplayCamera    = (1 << 5),     
    kFBDisplay3dIcon    = (1 << 6),     
    kFBDisplayAll       = 0xff          
};

enum FBPickingMode

Search for all occurrences

3D picking mode.

Enumerator:

kFBPickingModeStandard	Standard picking mode. Search for all occurrences
kFBPickingModeXRay	X-Ray picking mode (obstructed models are displayed in overlay). Search for all occurrences
kFBPickingModeModelsOnly	Models-only mode (no nulls or skeletons are displayed). Search for all occurrences
kFBPickingModeCount	End of enum, this valued indicates the number of picking modes available. Search for all occurrences

Definition at line 113 of file fbrenderer.h.

                   {
    kFBPickingModeStandard = 0,     
    kFBPickingModeXRay,             
    kFBPickingModeModelsOnly,       
    kFBPickingModeCount             
};

enum FBDeviceKeyboardKey

Search for all occurrences

Keyboard keys (for input).

Enumerator:

kFBDKeyPageUp	Page Up. Search for all occurrences
kFBDKeyPageDown	Page Down. Search for all occurrences
kFBDKeyEnd	End. Search for all occurrences
kFBDKeyHome	Home. Search for all occurrences
kFBDKeyArrowLeft	Left. Search for all occurrences
kFBDKeyArrowUp	Up. Search for all occurrences
kFBDKeyArrowRight	Right. Search for all occurrences
kFBDKeyArrowDown	Down. Search for all occurrences
kFBDKeyReturn	Return. Search for all occurrences
kFBDKeyEscape	Escape. Search for all occurrences
kFBDKeySpace	Space bar. Search for all occurrences
kFBDKey1	'1'. Search for all occurrences
kFBDKey2	'2'. Search for all occurrences
kFBDKey3	'3'. Search for all occurrences
kFBDKey4	'4'. Search for all occurrences
kFBDKey5	'5'. Search for all occurrences
kFBDKey6	'6'. Search for all occurrences
kFBDKey7	'7'. Search for all occurrences
kFBDKey8	'8'. Search for all occurrences
kFBDKey9	'9'. Search for all occurrences
kFBDKey0	'0'. Search for all occurrences
kFBDKeyF1	'F1'. Search for all occurrences
kFBDKeyF2	'F2'. Search for all occurrences
kFBDKeyF3	'F3'. Search for all occurrences
kFBDKeyF4	'F4'. Search for all occurrences
kFBDKeyF5	'F5' Search for all occurrences
kFBDKeyF6	'F6'. Search for all occurrences
kFBDKeyF7	'F7'. Search for all occurrences
kFBDKeyF8	'F8'. Search for all occurrences
kFBDKeyF9	'F9'. Search for all occurrences
kFBDKeyF10	'F10'. Search for all occurrences
kFBDKeyF11	'F11'. Search for all occurrences
kFBDKeyF12	'F12'. Search for all occurrences

Definition at line 122 of file fbrenderer.h.

                         {
    kFBDKeyPageUp,          
    kFBDKeyPageDown,        
    kFBDKeyEnd,             
    kFBDKeyHome,            
    kFBDKeyArrowLeft,       
    kFBDKeyArrowUp,         
    kFBDKeyArrowRight,      
    kFBDKeyArrowDown,       
    kFBDKeyReturn,          
    kFBDKeyEscape,          
    kFBDKeySpace,           
    kFBDKey1,               
    kFBDKey2,               
    kFBDKey3,               
    kFBDKey4,               
    kFBDKey5,               
    kFBDKey6,               
    kFBDKey7,               
    kFBDKey8,               
    kFBDKey9,               
    kFBDKey0,               
    kFBDKeyF1,              
    kFBDKeyF2,              
    kFBDKeyF3,              
    kFBDKeyF4,              
    kFBDKeyF5,              
    kFBDKeyF6,              
    kFBDKeyF7,              
    kFBDKeyF8,              
    kFBDKeyF9,              
    kFBDKeyF10,             
    kFBDKeyF11,             
    kFBDKeyF12              
};