fbhud.h File Reference

HUD (Head Up Display) More...

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbproperties.h>
#include <fbsdk/fbtexture.h>

Go to the source code of this file.

Classes

class  FBHUDElement
 Heads Up display. More...
struct  FBHUDElement::Rect
 HUD element rectangle for drawing in the view. More...
class  FBPropertyListHUDElement
 PropertyList: Handle. More...
class  FBHUDTextElement
 Heads Up display. More...
class  FBHUDRectElement
 Heads Up display. More...
class  FBHUDTextureElement
 Heads Up display. More...
class  FBHUDFlashElement
 Heads Up display. More...
class  FBHUDBloopSlateElement
 Heads Up display. More...
class  FBHUDTimelineElement
 Heads Up display. More...
class  FBHUD
 Heads Up display. More...
class  FBPropertyListHUD
 PropertyList: Handle. More...

Defines

#define FBSDK_DLL   K_DLLIMPORT
 Be sure that FBSDK_DLL is defined only once...
#define FBStorableCustomHUDElementImplementation(ClassName, Desc)
 Custom Storable HUDELement Class implementation.

Enumerations

enum  FBHUDElementHAlignment { kFBHUDLeft, kFBHUDRight, kFBHUDCenter }
enum  FBHUDElementVAlignment { kFBHUDBottom, kFBHUDTop, kFBHUDVCenter = kFBHUDCenter }

Functions

 FB_DEFINE_ENUM (FBSDK_DLL, HUDElementHAlignment)
 FB_DEFINE_ENUM (FBSDK_DLL, HUDElementVAlignment)
 FB_FORWARD (FBViewingOptions)
 __FB_FORWARD (FBHUDElement)
 FB_DEFINE_COMPONENT (FBSDK_DLL, HUDElement)
 FB_DEFINE_LIST (FBSDK_DLL, HUDElement)
 FB_FORWARD (FBPropertyListHUDElement)
 __FB_FORWARD (FBHUDTextElement)
 FB_DEFINE_COMPONENT (FBSDK_DLL, HUDTextElement)
 __FB_FORWARD (FBHUDRectElement)
 FB_DEFINE_COMPONENT (FBSDK_DLL, HUDRectElement)
 __FB_FORWARD (FBHUDTextureElement)
 FB_DEFINE_COMPONENT (FBSDK_DLL, HUDTextureElement)
 __FB_FORWARD (FBHUDFlashElement)
 FB_DEFINE_COMPONENT (FBSDK_DLL, HUDFlashElement)
 __FB_FORWARD (FBHUDBloopSlateElement)
 FB_DEFINE_COMPONENT (FBSDK_DLL, HUDBloopSlateElement)
 __FB_FORWARD (FBHUDTimelineElement)
 FB_DEFINE_COMPONENT (FBSDK_DLL, HUDTimelineElement)
 __FB_FORWARD (FBHUD)
 FB_DEFINE_COMPONENT (FBSDK_DLL, HUD)
 FB_DEFINE_LIST (FBSDK_DLL, HUD)
 FB_FORWARD (FBPropertyListHUD)

Detailed Description

HUD (Head Up Display)

Definition in file fbhud.h.


Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbhud.h.

#define FBStorableCustomHUDElementImplementation (   ClassName,
  Desc 
)
Value:
const char* ClassName::FbxGetObjectSubType(){ return #ClassName; }\
    HIObject RegisterStorable##ClassName##Create(HIObject /*pOwner*/, const char* pName, void* /*pData*/){\
    ClassName* Class = new ClassName(pName);\
    Class->mAllocated = true;\
    if( Class->FBCreate() ){\
    return Class->GetHIObject();\
    } else {\
    delete Class;\
    return NULL;}}\
    FBLibraryModule(ClassName##Storable){\
    FBString lGroup = "FbxStorable/HUDElement";\
    FBRegisterObject(ClassName##R2, lGroup, #ClassName, Desc, RegisterStorable##ClassName##Create, true, NULL);\
    }\

Custom Storable HUDELement Class implementation.

This should be placed in the source code file for a custom HUDElement class. See OpenReality sample project orhudelement_template for usage example.

Definition at line 159 of file fbhud.h.


Enumeration Type Documentation

Enumerator:
kFBHUDLeft 

Left alignment.

kFBHUDRight 

Right alignment.

kFBHUDCenter 

Center.

Definition at line 63 of file fbhud.h.

Enumerator:
kFBHUDBottom 

Bottom alignment.

kFBHUDTop 

Top alignment.

kFBHUDVCenter 

Center.

Definition at line 73 of file fbhud.h.


Function Documentation

FB_DEFINE_ENUM ( FBSDK_DLL  ,
HUDElementHAlignment   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
HUDElementVAlignment   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
HUDElement   
)
FB_DEFINE_LIST ( FBSDK_DLL  ,
HUDElement   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
HUDTextElement   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
HUDRectElement   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
HUDTextureElement   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
HUDFlashElement   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
HUDBloopSlateElement   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
HUDTimelineElement   
)
__FB_FORWARD ( FBHUD  )
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
HUD   
)
FB_DEFINE_LIST ( FBSDK_DLL  ,
HUD   
)