fbsystem.h

Go to the documentation of this file.

#ifndef __FBSYSTEM_H__
#define __FBSYSTEM_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

// Essential includes
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbdata.h>   // FBPropertyListTake

#include <fbsdk/fbio.h>     // FBPropertyListCommPort
#include <fbsdk/fbshader.h>
#include <fbsdk/fbmodel.h>
#include <fbsdk/fbevaluateinfo.h>
#if !defined(K_NO_CONSTRUCTION_HISTORY)
    #include <fbsdk/fbconstructionhistory.h>
#endif

// For 'lean version' we don't need the plugin headers.
#if !defined(K_NO_AUDIO)
#include <fbsdk/fbaudio.h>
#endif

#if !defined(K_NO_VIDEO)
#include <fbsdk/fbvideo.h>
#endif

#if !defined(K_NO_DECK)
#include <fbsdk/fbdeck.h>           // FBPropertyListDeck
#endif

#if !defined(K_NO_ASSETMNG)
#include <fbsdk/fbassetmng.h>   // FBPropertyAssetMng
#endif

#if !defined(K_NO_MANIPULATOR)
#include <fbsdk/fbmanipulator.h>    // FBPropertyListManipulator
#endif

#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {;
#endif

#if !defined(K_NO_CHARACTER)
    FB_FORWARD( FBCharacter );
#endif

    struct FBVideoGrabOptions;

    FB_DEFINE_COMPONENT( FBSDK_DLL, Take );
    FB_DEFINE_COMPONENT( FBSDK_DLL, Renderer );

    class FBSDK_DLL FBEventVideoFrameRendering: public FBEvent 
    {
    public:
        FBEventVideoFrameRendering( HKEventBase pEvent );

        typedef enum{
            eBeginRendering = 1,  
            eRendering,           
            eEndRendering         
        }EState;

        kInt64 GetFrameNumber();

        kInt64 GetFrameCount();

        FBEventVideoFrameRendering::EState GetState();

    private:
        kInt64  mFrameNumber;    
        kInt64  mFrameCount;     
        EState  mState;          
    };

    // FBSystem
    __FB_FORWARD( FBSystem );

    class FBSDK_DLL FBSystem : public FBComponent {
        __FBClassDeclare( FBSystem,FBComponent );
    public:
        FBSystem();

        FBPropertyString                        ConfigPath;                 // < <b>Read Only Property:</b> Location where the config folder is.
        FBPropertyString                        UserConfigPath;             // < <b>Read Only Property:</b> Location where the user config folder is.
        FBPropertyString                        ApplicationPath;            
        FBPropertyString                        TempPath;                   
        
        FBPropertyEventUIIdle                   OnUIIdle;                   
        FBPropertyEventVideoFrameRendering      OnVideoFrameRendering;      
        
        FBPropertyEventConnectionNotify         OnConnectionNotify;         
        FBPropertyEventConnectionDataNotify     OnConnectionDataNotify;     
        FBPropertyEventConnectionStateNotify    OnConnectionStateNotify;    
        FBPropertyEventConnectionKeyingNotify   OnConnectionKeyingNotify;   

        FBPropertyString                        ComputerName;               
        FBPropertyDouble                        Version;                    
        FBPropertyString                        BuildId;                    
        FBPropertyString                        BuildVersion;               


        FBPropertyBool                          SuspendMessageBoxes;        

        FBPropertyBool                          AreMessageBoxesSuspended;   


        FBPropertyTime                          SystemTime;                 
        FBPropertyTime                          LocalTime;                  
        FBPropertyTake                          CurrentTake;                

        FBPropertyScene                         Scene;                      
#if !defined(K_NO_CONSTRUCTION_HISTORY)
        FBPropertyConstructionHistory           ConstructionHistory;        
#endif
        FBPropertyModel                         SceneRootModel;             
        FBPropertyModel                         RootModel;                  
        FBPropertyString                        PathImages;                 
        FBPropertyString                        PathMeshs;                  

#if !defined(K_NO_AUDIO)
        FBPropertyListAudioIn                   AudioInputs;                
        FBPropertyListAudioOut                  AudioOutputs;               
#endif

#if !defined(K_NO_VIDEO)
        FBPropertyListVideoIn                   VideoInputs;                
        FBPropertyListVideoOut                  VideoOutputs;               
#endif                                                                  

        FBPropertyListCommPort                  CommPorts;                  
        FBPropertyRenderer                      Renderer;                   

        FBPropertyDouble                        FrameRate;                  
        FBPropertyDouble                        ProcessMemory;              
        FBPropertyDouble                        ProcessMemoryPeak;          
        FBPropertyVector2d                      DesktopSize;                
        FBPropertyBool                          FullScreenViewer;           

#if !defined(K_NO_ASSETMNG)
        FBPropertyAssetMng                      AssetManager;               
#endif

#if !defined(K_NO_MANIPULATOR)
        FBPropertyListManipulator               Manipulators;   
#endif

        static bool  LibraryLoad(const char *pPath);
        static void* LibraryGetProcAddress(const char *pPath, const char *pFunctionName);
        static bool  LibraryFree(const char *pPath);

        static FBString CurrentDirectory();

        static FBString MakeFullPath(const char* pRelativeFilePath);

        static FBSystem& TheOne();

        const FBStringList &GetCommandLineArgs() const;

        const FBStringList& GetPythonStartupPath() const;

        const FBStringList& GetPluginPath() const;

        typedef enum {
            ePluginItemDescription,     
            ePluginItemFileName,        
            ePluginItemIconName         
        } EPluginItemInfo;

        const FBStringList& GetLoadedPluginItemsName() const;

        const FBStringList& GetLoadedPluginItemInfo( const char* pPluginItemName ) const;

        const FBStringList& GetLoadedPluginItemGroups( const char* pPluginItemName ) const;
    };

#ifndef K_NO_TRIGGER
    // FBTriggerManager
    __FB_FORWARD( FBTriggerManager );
    class FBSDK_DLL FBTriggerManager :public FBComponent 
    {
        __FBClassDeclare( FBTriggerManager, FBComponent );
    public:
        FBTriggerManager();

        int GetGroupCount();

        char* GetGroupName( int pIndex );

        bool GetGroupActive( int pIndex );

        void SetGroupActive( int pIndex, bool pState );

        FBPropertyBool      Active;     
    };
#endif


    // FBKeyControl
    __FB_FORWARD( FBKeyControl );
    enum FBNewKeyInterpolationType  {
        kFBNewKeyInterpolation_None = -1,       
        kFBNewKeyInterpolation_Auto,            
        kFBNewKeyInterpolation_Spline,          
        kFBNewKeyInterpolation_SplineClamp,     
        kFBNewKeyInterpolation_Linear,          
        kFBNewKeyInterpolation_Step,            
        kFBNewKeyInterpolation_TCB,             
        kFBNewKeyInterpolation_Smooth,          
        kFBNewKeyInterpolation_SmoothClamp,     
        kFBNewKeyInterpolation_Fixed,           
        kFBNewKeyInterpolation_Custom0,         
        kFBNewKeyInterpolation_Custom1,         
        kFBNewKeyInterpolation_Custom2,         
    };
    FB_DEFINE_ENUM( FBSDK_DLL, NewKeyInterpolationType );

    class FBSDK_DLL FBKeyControl : public FBComponent
    {
        __FBClassDeclare(FBKeyControl, FBComponent);

    public:
        FBKeyControl(HIObject pObject=NULL);

        void MoveKeys( FBTimeSpan pTimeSpan, FBModel *pPivot, FBVector3d pT, FBVector3d pR, FBVector3d pS, FBTime pTime, FBModelList *pModelList = NULL );

        FBPropertyBool  AutoKey;    
        FBPropertyNewKeyInterpolationType NewKeyInterpolationType;  
    };

    // FBPointCacheManager
    __FB_FORWARD( FBPointCacheManager );

    class FBSDK_DLL FBPointCacheManager : public FBComponent
    {
        __FBClassDeclare(FBPointCacheManager, FBComponent);

        FBPointCacheManager(HIObject pObject=NULL);

    public:
        FBPropertyListObject   Models;                  

        FBPropertyBool         ApplyGlobalTransform;    
        FBPropertyAction       SetTransformReference;   

        FBPropertyBool         ApplyCacheOnNewModel;    
        FBPropertyModel        NewModelRoot;            

        FBPropertyBool         AllowCacheResampling;    
        FBPropertyBool         AlwaysAskForPath;        
        FBPropertyString       DefaultPath;             
        FBPropertyBool         CacheNormal;             
        FBPropertyBool         CacheAABBox;             
        FBPropertyBool         CreateMultiChannelCache; 
        FBPropertyBool         CreateFilePerFrameCache; 
        FBPropertyInt          SaveEveryFrame;          

        static FBPointCacheManager& TheOne();
    };

    // FBFileMonitoringManager
    __FB_FORWARD( FBFileMonitoringManager );
    enum FBFileMonitoringType   {
        kFBFileMonitoring_InvalidIndex, 
        kFBFileMonitoring_MAINSCENE,    
        kFBFileMonitoring_ANIMATIONCLIP,
        kFBFileMonitoring_FILEREFERENCE,
        kFBFileMonitoring_PYTHONEDITORSCRIPT, 
    };

    FB_DEFINE_ENUM( FBSDK_DLL, FileMonitoringType );

    __FB_FORWARD( FBEventFileChange );

    class FBSDK_DLL FBEventFileChange: public FBEvent 
    {
    public:

        FBEventFileChange( HKEventBase pEvent );        

        FBPropertyFileMonitoringType    Type;        
        FBPropertyString                Path;        
    };

    class FBSDK_DLL FBFileMonitoringManager : public FBComponent
    {
        __FBClassDeclare(FBFileMonitoringManager, FBComponent);

        FBFileMonitoringManager(HIObject pObject=NULL);

    public:
        void AddFileToMonitor(FBString pFilePath, FBFileMonitoringType pFileMonitoringType );

        void RemoveFileFromMonitor(FBString pFilePath);

        void PauseFileMonitoring(bool pPause = true);

        void CleanFileMonitoring(bool pIncludePythonEditorScripts = true);

    public:
        FBPropertyEvent    OnFileChangeMainScene;           
        FBPropertyEvent    OnFileChangeAnimationClip;       
        FBPropertyEvent    OnFileChangeFileReference;       
        FBPropertyEvent    OnFileChangePythonEditorScript;  

        static FBFileMonitoringManager& TheOne();
    };

    // FBCriticalSection
    FB_FORWARD( FBCriticalSection );

    class FBSDK_DLL FBCriticalSection
    {
        void *mPtr;     
    public:
        FBCriticalSection();

        ~FBCriticalSection();

        bool Init();

        void Enter();

        void Leave();
    };

    // FBFastLock
    FB_FORWARD( FBFastLock );

    class FBSDK_DLL FBFastLock 
    {
        void *mPtr;     
    public:
        FBFastLock();

        ~FBFastLock();

        void Lock();

        void Unlock();
    };


    // Global utility functions

    FBSDK_DLL void FBSleep( kULong MilliSeconds );

    enum FBTraceLevel
    {
        kFBNO_TRACE           = 0,    //<! Tracing disabled
        kFBCRITICAL_TRACE     = 1,    //<! Critical traces
        kFBNORMAL_TRACE       = 10,   //<! Descriptive traces
        kFBALL_TRACE          = 20    //<! Default value, all traces. 
    };

    FBSDK_DLL   void FBTraceSetLevel( unsigned int pNewLevel );

    FBSDK_DLL   unsigned int FBTraceGetLevel(); 

    FBSDK_DLL void FBTrace( const char* pFormatString, ... );

    FBSDK_DLL void FBTraceWithLevel( unsigned int pLevel, const char* pFormatString, ... );

    typedef void (*FBTraceStubFct)(unsigned int pLevel, const char *pStr);

    FBSDK_DLL   bool FBRegisterTraceStubFct(FBTraceStubFct pFct);

    FBSDK_DLL   bool FBUnRegisterTraceStubFct(FBTraceStubFct pFct);

    FBSDK_DLL void FBObjectLifeLogEnable(bool pEnable);
    
    FBSDK_DLL unsigned int  FBObjectGetGlobalUniqueId();

    FBSDK_DLL void FBObjectPrintLivings(unsigned int pStartUniqueId);

    FBSDK_DLL unsigned int  FBObjectGetLivingCount();

    FBSDK_DLL void FBMakeFullPath( FBString &pFullPath, const char *pRootPath, const char *pFilePath );

    class FBSDK_DLL FBVisitDirectoryCallback
    {
    public:
        virtual ~FBVisitDirectoryCallback();
        virtual void FileVisited(const char*  pSrc) const;
        virtual void DirectoryVisited(const char*  pSrc) const;
        bool DoIt( const char* pSrcPath, bool pRecursive ) const;
    };

FB_FORWARD( FBDirMap );
class FBSDK_DLL FBDirMap
{
public:
    virtual ~FBDirMap();
    static void Add(FBString pSourceDir, FBString pTargetDir);

    static int GetCount();

    static FBString GetSource(int pIndex);

    static FBString GetTarget(int pIndex);

    static void Clear();

    static FBString Map(FBString pPath);
};

#ifdef FBSDKUseNamespace
}
#endif
#endif