fbrenderer.h File Reference

#include <kaydaradef.h>
#include <fbsdk/fbmanipulator.h>
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbmodel.h>
#include <fbsdk/fbcamera.h>
#include <fbsdk/fblight.h>
#include <fbsdk/fbshader.h>
#include <fbcontrols/fbcontrols.h>

File Description

Rendering engine.

Definition in file fbrenderer.h.

Classes
class	FBViewingOptions
	Viewing options for rendering. More...
struct	FBPickInfos
	Picking information structure. More...
class	FBRendererCallback
	Open Reality renderer callback interface. More...
class	FBPropertyListRendererCallback
	PropertyList: Texture More...
class	FBRenderer
	Open Reality renderer interface. More...

Namespaces
	ORSDK2018

Macros
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once... More...
#define	FBRegisterRendererCallback(UniqueNameStr, ClassName, Label, Description, IconFilename)
	FBRendererCallback class registration. More...
#define	FBRendererCallbackDeclare(ClassName, Parent )
	FBRendererCallback class declaration. More...
#define	FBRendererCallbackImplementation(ThisComponent)   FBClassImplementation( ThisComponent )
	FBRendererCallback class implementation. More...

Typedefs
typedef class FBPropertyBase< FBRenderer *, kFBPT_object >	FBPropertyBaseRenderer
typedef class FBPropertyBaseComponent< FBRenderer * >	FBPropertyRenderer
typedef class FBPropertyBaseEnum< enum FBDeviceKeyboardKey >	FBPropertyDeviceKeyboardKey
typedef class FBArrayTemplate< FBPickInfos >	FBPickInfosList
	typedef class FBSDK_DLL FBArrayTemplate<FBPickInfos> FBPickInfosList More...
typedef class FBPropertyBase< FBRendererCallback *, kFBPT_object >	FBPropertyBaseRendererCallback
typedef class FBPropertyBaseComponent< FBRendererCallback * >	FBPropertyRendererCallback

Enumerations
enum	FBDisplayMode {   kFBDisplayModeDefault = 0, kFBDisplayModeTexture, kFBDisplayModeHardShade, kFBDisplayModeFlatShade,   kFBDisplayModeWireFrame, kFBDisplayModeCount }
	Model display options. More...
enum	FBArrangeMode { kHorizontalMode, kVerticalMode }
	Modes for arranging objects in schematic view. 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
bool	operator== (const FBPickInfos &pLhs, const FBPickInfos &pRhs)
FBPickInfosList *	FBCreatePickInfosList ()
	Create a FBPickInfosList object. More...
void	FBDestroyPickInfosList (FBPickInfosList *pPickInfosList)
	Delete a FBPickInfosList object. More...

Macro Definition Documentation

#define FBRegisterRendererCallback	(		UniqueNameStr,
			ClassName,
			Label,
			Description,
			IconFilename
	)

Value:

HIObject CreateRendererCallback##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
    ClassName *Class = new ClassName( pName ); \
    if (Class->FBCreate()) { \
    return Class->GetHIObject(); \
    } else { \
    delete Class; \
    return NULL; \
    } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
    FBRegisterObject( ClassName##R1,"renderer/callback/ogl",Label,Description,CreateRendererCallback##ClassName,true, IconFilename );   \
    }

FBRendererCallback class registration.

Parameters

UniqueNameStr	Unique name.
ClassName	RendererCallback class name.
Label	Short description.
Description	Long description.
IconFilename	Name of the file containing the icon.

Examples:

Definition at line 386 of file fbrenderer.h.

#define FBRendererCallbackDeclare	(		ClassName,
			Parent
	)

Value:

FBClassDeclare( ClassName,Parent); \
public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
private:

FBRendererCallback class declaration.

Parameters

ClassName	FBRendererCallback class name.
Parent	Class parent.

Examples:

Definition at line 406 of file fbrenderer.h.

#define FBRendererCallbackImplementation

(

ThisComponent

)

FBClassImplementation( ThisComponent )

FBRendererCallback class implementation.

Parameters

ThisComponent

Class to implement.

Examples:

Definition at line 415 of file fbrenderer.h.

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbrenderer.h.

Go to the source code of this file.