fbhud.h

Go to the documentation of this file.

#ifndef __FBHUD_H__
#define __FBHUD_H__
/**************************************************************************
 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.
 
 The coded instructions, statements, computer programs, and/or related 
 material (collectively the "Data") in these files contain unpublished 
 information proprietary to Autodesk, Inc. and/or its licensors, which is 
 protected by Canada and United States of America federal copyright law 
 and by international treaties.
 
 The Data may not be disclosed or distributed to third parties, in whole 
 or in part, without the prior written consent of Autodesk, Inc. 
 ("Autodesk").
 
 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
 FREE.
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
 
**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

    #define FBSDK_DLL K_DLLIMPORT
#endif

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

#ifndef K_NO_HUD

#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {
#endif

/* HUD horizontal alignment.*/
enum FBHUDElementHAlignment {
    kFBHUDLeft,         
    kFBHUDRight,        
    kFBHUDCenter,       
};

FB_DEFINE_ENUM( FBSDK_DLL, HUDElementHAlignment );

/* HUD vertical alignment.*/
enum FBHUDElementVAlignment {
    kFBHUDBottom,                   
    kFBHUDTop,                      
    kFBHUDVCenter = kFBHUDCenter,   
};

FB_DEFINE_ENUM( FBSDK_DLL, HUDElementVAlignment );

FB_FORWARD(FBViewingOptions);

__FB_FORWARD( FBHUDElement ); 
FB_DEFINE_COMPONENT( FBSDK_DLL, HUDElement );

class FBSDK_DLL FBHUDElement : public FBBox 
{
    //--- Open Reality declaration.
    __FBClassDeclare( FBHUDElement, FBBox );

protected:
    FBHUDElement( const char* pName, HIObject pObject=NULL );

public:
    FBPropertyBool Visibility;                      
    FBPropertyBool Show;                            
    FBPropertyHUDElementHAlignment Justification;   
    FBPropertyHUDElementHAlignment HorizontalDock;  
    FBPropertyHUDElementVAlignment VerticalDock;    
    FBPropertyDouble X;                             
    FBPropertyDouble Y;                             
    FBPropertyBool PositionByPercent;               
    FBPropertyBool ScaleByPercent;                  
    FBPropertyDouble Width;                         
    FBPropertyDouble Height;                        
    FBPropertyBool ScaleUniformly;                  

    struct Rect
    {
        double mX;              
        double mY;              
        double mWidth;          
        double mHeight;         
        double mWidthScale;     
        double mHeightScale;    
    };

    virtual void GetIntrinsicDimension(FBViewingOptions* pViewingOptins, int& pWidth, int & pHeight);

    virtual void DrawElement(FBViewingOptions* pViewingOption, Rect& pRect);

    virtual bool FbxStore(FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat);

    virtual bool FbxRetrieve(FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat);
};

#define FBStorableCustomHUDElementImplementation(ClassName, Desc)\
    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);\
    }\

  
// FBPropertyListHUDElement
FB_DEFINE_LIST( FBSDK_DLL, HUDElement );
FB_FORWARD( FBPropertyListHUDElement );

class FBSDK_DLL FBPropertyListHUDElement : public FBPropertyListComponent
{
public:
    FBPropertyListHUDElement();
    FBHUDElement* operator[](int pIndex);
};

__FB_FORWARD( FBHUDTextElement ); 
FB_DEFINE_COMPONENT( FBSDK_DLL, HUDTextElement );


class FBSDK_DLL FBHUDTextElement : public FBHUDElement 
{
    //--- Open Reality declaration.
    __FBClassDeclare( FBHUDTextElement , FBHUDElement );

public:
    FBHUDTextElement( const char* pName, HIObject pObject=NULL );

    FBStringList* GetFontList();

public:
    FBPropertyString                Content;                
    FBPropertyString                Font;                   
    FBPropertyColorAndAlpha         Color;                  
    FBPropertyColorAndAlpha         BackgroundColor;        
    FBPropertyBool                  ForceTimeCodeDisplay;   
    FBPropertyBool                  AdjustWidthToFitText;   
};


__FB_FORWARD( FBHUDRectElement ); 
FB_DEFINE_COMPONENT( FBSDK_DLL, HUDRectElement );

class FBSDK_DLL FBHUDRectElement : public FBHUDElement 
{
    //--- Open Reality declaration.
    __FBClassDeclareGroup( FBHUDRectElement , FBHUDElement );

public:
    FBHUDRectElement( const char* pName, HIObject pObject=NULL );

public:
    FBPropertyColorAndAlpha         Color;              
};


__FB_FORWARD( FBHUDTextureElement ); 
FB_DEFINE_COMPONENT( FBSDK_DLL, HUDTextureElement );

class FBSDK_DLL FBHUDTextureElement : public FBHUDElement 
{
    //--- Open Reality declaration.
    __FBClassDeclare( FBHUDTextureElement , FBHUDElement );
public:
    FBHUDTextureElement( const char* pName, HIObject pObject=NULL );

public:

    FBPropertyListTexture Texture;       
};


__FB_FORWARD( FBHUDFlashElement ); 
FB_DEFINE_COMPONENT( FBSDK_DLL, HUDFlashElement );

class FBSDK_DLL FBHUDFlashElement : public FBHUDElement 
{
    //--- Open Reality declaration.
    __FBClassDeclare( FBHUDFlashElement , FBHUDElement );
public:
    FBHUDFlashElement( const char* pName, HIObject pObject=NULL );

public:

    FBPropertyString FilePath;       
};

__FB_FORWARD( FBHUDBloopSlateElement ); 
FB_DEFINE_COMPONENT( FBSDK_DLL, HUDBloopSlateElement );

class FBSDK_DLL FBHUDBloopSlateElement : public FBHUDFlashElement
{
    __FBClassDeclare( FBHUDBloopSlateElement, FBHUDFlashElement );

public:
    FBHUDBloopSlateElement( const char* pName, HIObject pObject=NULL );

public:

    FBPropertyColorAndAlpha BackgroundColor;            
    FBPropertyColorAndAlpha ForegroundColor;            
    FBPropertyBool          Enable;                     
    FBPropertyTime          ShowAfterDelayOnRecordPlay; 
    FBPropertyTime          ShowDuration;               
};

__FB_FORWARD( FBHUDTimelineElement ); 
FB_DEFINE_COMPONENT( FBSDK_DLL, HUDTimelineElement );

class FBSDK_DLL FBHUDTimelineElement : public FBHUDFlashElement
{
    __FBClassDeclare( FBHUDTimelineElement, FBHUDFlashElement );

public:
    FBHUDTimelineElement( const char* pName, HIObject pObject=NULL );

public:

    FBPropertyColorAndAlpha HeadActiveColor;    
    FBPropertyColorAndAlpha HeadIdleColor;      
    FBPropertyTime HeadDuration;                

    FBPropertyColorAndAlpha CutActiveColor;     
    FBPropertyColorAndAlpha CutIdleColor;       

    FBPropertyColorAndAlpha TailActiveColor;    
    FBPropertyColorAndAlpha TailIdleColor;      
    FBPropertyTime TailDuration;                
};

__FB_FORWARD( FBHUD ); 
FB_DEFINE_COMPONENT( FBSDK_DLL, HUD );

class FBSDK_DLL FBHUD : public FBBox 
{
    //--- Open Reality declaration.
    __FBClassDeclare( FBHUD, FBBox );
public:
    FBHUD( const char* pName, HIObject pObject=NULL );

    enum EStockElement {
        eRecordLight,
        eFlashElement,
        eTextElement,
        eRectElement,
        eTextureElement,
        eBloopSlate,
        eTimeline
    };

    FBHUDElement* CreateElement( EStockElement pType, const char* pName );

    FBHUDElement* CreateCustomElement( const char* pHUDElementClassName, const char* pName );

public:
    FBPropertyBool              Visibility; 
    FBPropertyEvent             OnDisplay;  
    FBPropertyListHUDElement    Elements;   
};

// FBPropertyListHUD
FB_DEFINE_LIST( FBSDK_DLL, HUD );
FB_FORWARD( FBPropertyListHUD );

class FBSDK_DLL FBPropertyListHUD : public FBPropertyListComponent
{
public:
    FBPropertyListHUD();
    FBHUD* operator[](int pIndex);
};

__FB_FORWARD( FBHUDManager ); 
FB_DEFINE_COMPONENT( FBSDK_DLL, HUDManager );
class FBSDK_DLL FBHUDManager: public FBComponent
{
    __FBClassDeclare( FBHUDManager, FBComponent );

    FBHUDManager(HIObject pObject = NULL);

public:
    FBPropertyHUD DefaultHUD;       

    static FBHUDManager& TheOne();
};

#ifdef FBSDKUseNamespace
}
#endif

#endif //K_NO_HUD

#endif /* this must be the last line of this file */