fbapplication.h

Go to the documentation of this file.

#ifndef __FBPAPPLICATION_H__
#define __FBPAPPLICATION_H__
/**************************************************************************
Copyright (c) 1994 - 2013 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>

#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {;
#endif

// FBBatchOptions
FB_FORWARD( FBBatchOptions );

enum FBBatchProcessType
{
    kFBBatchProcessTypeLoad,    
    kFBBatchProcessTypeSave,    
    kFBBatchProcessTypeConvert  
};
FB_DEFINE_ENUM( FBSDK_DLL, BatchProcessType );

enum FBBatchFileFormat
{
    kFBBatchFileFormatTRC,      
    kFBBatchFileFormatC3D,      
    kFBBatchFileFormatAMC,      
    kFBBatchFileFormatBVH,      
    kFBBatchFileFormatHTR,      
    kFBBatchFileFormatFBX       
};
FB_DEFINE_ENUM( FBSDK_DLL, BatchFileFormat );

enum FBBatchOnTakeExist
{
    kFBBatchOnTakeExistOverwrite,   
    kFBBatchOnTakeExistSkip         
};
FB_DEFINE_ENUM( FBSDK_DLL, BatchOnTakeExist );

enum FBBatchOnContainsBatchTakes
{
    kFBBatchOnContainsBatchTakesSaveBatchTakesOnly, 
    kFBBatchOnContainsBatchTakesSaveAllTakes        
};
FB_DEFINE_ENUM( FBSDK_DLL, BatchOnContainsBatchTakes );

enum FBBatchStatus
{
    kFBBatchStatusSuccess,
    kFBBatchStatusError,
    kFBBatchStatusCharacterNotSpecified,
    kFBBatchStatusCharacterNotCharacterized,
    kFBBatchStatusCharacterHasNoReference,
    kFBBatchStatusInputActorNotSpecified,
    kFBBatchStatusActorInputMarkersetNotSpecified,
    kFBBatchStatusActorInputMarkersetHasNoReferenceModel,
    kFBBatchStatusActorInputMarkersetNotCorrectlyAssociated,
    kFBBatchStatusInputCharacterNotCharacterized,
    kFBBatchStatusInputCharacterHasNoReference,
    kFBBatchStatusInputDirectoryNotValid,
    kFBBatchStatusAsfSkeletonFileNotSpecified,
    kFBBatchStatusCantOpenAsfSkeletonFile,
    kFBBatchStatusOutputDirectoryNotValid
};

class FBSDK_DLL FBBatchOptions
{
public:

    FBBatchOptions();

    FBBatchFileFormat       mInputFileFormat;           
    FBBatchFileFormat       mOutputFileFormat;          

    FBBatchProcessType      mProcessType;               

    FBString                mInputDirectory;            
    FBString                mOutputDirectory;           
    FBString                mSkeletonFile;              

#if !defined(K_NO_CHARACTER)
    FBCharacter*            mCharacter;                 
#endif

    bool                    mStartAnimationAtZero;      
    bool                    mFrameAnimation;            
    bool                    mOverwriteScaling;          
    bool                    mKeepDummyBones;            
    bool                    mWriteRate;                 
    bool                    mWriteTranslation;          
    bool                    mPlotToCharacter;           
    bool                    mPlotToControlSet;          
    bool                    mUseSingleTake;             
    bool                    mUseBatchSuffix;            
    bool                    mKeepCharacterConstraint;   

    FBBatchOnTakeExist          mOnTakeExistAction;             
    FBBatchOnContainsBatchTakes mOnContainsBatchTakesAction;    
};


// FBPlotOptions
FB_FORWARD( FBPlotOptions );

enum FBRotationFilter
{
    kFBRotationFilterNone,
    kFBRotationFilterGimbleKiller,
    kFBRotationFilterUnroll
};
FB_DEFINE_ENUM( FBSDK_DLL, RotationFilter );

enum FBPlotTangentMode
{
    kFBPlotTangentModeSmooth,
    kFBPlotTangentModeSmoothClamp,
    kFBPlotTangentModeSpline,
    kFBPlotTangentModeSplineClamp,
    kFBPlotTangentModeAuto
};
FB_DEFINE_ENUM( FBSDK_DLL, RotationFilter );

class FBSDK_DLL FBPlotOptions
{
public:

    FBPlotOptions();

    bool                mPlotAllTakes;                  
    bool                mPlotOnFrame;                   
    FBTime              mPlotPeriod;                    
    FBRotationFilter    mRotationFilterToApply;         
    FBPlotTangentMode   mPlotTangentMode;               
    bool                mUseConstantKeyReducer;         
    bool                mConstantKeyReducerKeepOneKey;  
    bool                mPlotTranslationOnRootOnly;     
    bool                mPreciseTimeDiscontinuities;    
    bool                mPlotLockedProperties;          
    bool                mPlotAuxEffectors;              
    bool                mEvaluateDeformation;           
};

#if !defined(K_NO_AUDIO)
// FBAudioRenderOptions
FB_FORWARD( FBAudioRenderOptions );

class FBSDK_DLL FBAudioRenderOptions
{
public:

    FBAudioRenderOptions();

    FBTimeSpan              TimeSpan;       
    FBAudioChannelMode      ChannelMode;    
    FBAudioBitDepthMode     BitDepthMode;   
    FBAudioRateMode         RateMode;       
    FBString                OutputFileName; 
};
#endif

__FB_FORWARD( FBApplication );
#if !defined(K_NO_CHARACTER)
__FB_FORWARD( FBCharacter );
#endif
#if !defined(K_NO_ACTOR)
__FB_FORWARD( FBActor );
#endif
#if !defined(K_NO_CHARACTER)
FB_DEFINE_COMPONENT( FBSDK_DLL, Character );
#endif
#if !defined(K_NO_ACTOR)
FB_DEFINE_COMPONENT( FBSDK_DLL, Actor );
#endif

enum FBViewerMode { 
    kFBViewerModeOneWindow,     
    kFBViewerModeTwoWindow,     
    kFBViewerModeThreeWindow,   
    kFBViewerModeFourWindow,    
    kFBViewerModeSchematic      
};

#if !defined(K_NO_ONECLICK)
enum FBOneClickApplication
{
    kFBOneClickNone, 
    kFBOneClickMaya, 
    kFBOneClick3dsMax, 
    kFBOneClickSoftimage, 
};
#endif

// FBEventOverrideFileOpen
class FBSDK_DLL FBEventOverrideFileOpen : public FBEvent 
{
public:
    FBEventOverrideFileOpen( HKEventBase pEvent );

    FBPropertyString    FilePath;           
    FBPropertyBool      WillOverride;       
};

// FBPropertyEventOverrideFileOpen
class FBSDK_DLL FBPropertyEventOverrideFileOpen : public FBPropertyEvent
{
  public:
    virtual void Add    ( HICallback pOwner, kICallbackHandler pHandler );
    virtual void Remove ( HICallback pOwner, kICallbackHandler pHandler );
};

FB_FORWARD(FBMotionFileOptions);

class FBSDK_DLL FBApplication : public FBComponent 
{
    __FBClassDeclare( FBApplication,FBComponent );
public:
    FBApplication(HIObject pObject=NULL);

    FBPropertyEvent OnFileNewCompleted;     
    FBPropertyEvent OnFileNew;              
    FBPropertyEvent OnFileOpenCompleted;    
    FBPropertyEvent OnFileOpen;             
    FBPropertyEvent OnFileMerge;            
    FBPropertyEvent OnFileSaveCompleted;    
    FBPropertyEvent OnFileSave;             
    FBPropertyEvent OnFileExit;             

    FBPropertyEventOverrideFileOpen OnOverrideFileOpen;     

    bool Minimize(bool pBlocking=true);

    bool Maximize();

    void UpdateAllWidgets();

    void FlushEventQueue();

    bool FileNew(bool  pAskUser = false, bool pClearSceneName = true);

    bool FileOpen( const char* pFilename, bool pShowUIMsg = false, FBFbxOptions* pOptions = NULL );

    bool FileOpen( void* pBuffer, kULong pBufferLength );       

    bool GetMaxFrameCount(void* pBuffer, kULong pBufferLength, kLong* pFrameCount, int pTimeScale); 

    bool FileMerge( const char* pFilename, bool pShowUIMsg = false, FBFbxOptions* pOptions = NULL );

    bool FileMerge( FBStringList& pPathlist, bool pShowUIMsg = false, FBFbxOptions* pOptions = NULL );

    bool FileAppend( const char* pFilename, bool pShowUIMsg = false, FBFbxOptions* pOptions = NULL );

    bool FileSave( const char* pFilename = NULL, FBFbxOptions* pOptions = NULL );

    void FileExit( bool pSave = false, int pExitCode = 0);

    bool FileImport( FBString pFilename, bool pMatchModels = false, bool pCreateUnmatchedModels = true );

    bool FileImportWithOptions( FBMotionFileOptions* pOptions );

    bool FileExport( FBString pFilename );

    FBBatchStatus FileBatch( FBBatchOptions* pBatchOptions, FBPlotOptions* pPlotOptions = NULL );

    bool FileImportBatch( const char* pName, FBBatchOptions* pBatchOptions, FBModel* pReference );

    bool FileExportBatch( const char* pName, FBTake* pTake, FBBatchOptions* pBatchOptions, FBModelList &pExportModels );

#if !defined(K_NO_CHARACTER)

    bool SaveCharacterRigAndAnimation( const char* pFileName, FBCharacter* pCharacter, FBFbxOptions* pFbxOptions);

    bool LoadAnimationOnCharacter( const char* pFileName, FBCharacter* pCharacter,  FBFbxOptions* pFbxOptions, FBPlotOptions* pPlotOptions);
#endif

    bool IsValidBatchFile( const char* pFilename );

#if !defined(K_NO_ONECLICK)

    bool OneClickSendAsNewScene( FBOneClickApplication pApplication );

    bool OneClickUpdateCurrentScene();

    bool OneClickAddToCurrentScene();

    void OneClickSelectPreviouslySentObject();

    FBOneClickApplication OneClickIsConnectedTo();
#endif

    bool FileRender( FBVideoGrabOptions* pRenderOptions = NULL );

#if !defined(K_NO_AUDIO)

    bool AudioRender( FBAudioRenderOptions* pAudioRenderOptions  = NULL);
#endif

    bool ExecuteScript(FBString pFilename);

    K_DEPRECATED_2016 void SwitchViewerCamera( FBCamera &pCamera );

public:
    FBPropertyString        FBXFileName;            
#if !defined(K_NO_ACTOR)
    FBPropertyActor         CurrentActor;           
#endif
#if !defined(K_NO_CHARACTER)
    FBPropertyCharacter     CurrentCharacter;       
#endif

    static FBApplication& TheOne();

    const char* GetSceneTitle();

    void SetSceneTitle(const char* pTitle);

    const char* GetSceneSubject();

    void SetSceneSubject(const char* pSubject);

    const char* GetSceneAuthor();

    void SetSceneAuthor(const char* pAuthor);

    const char* GetSceneKeywords();

    void SetSceneKeywords(const char* pKeywords);

    const char* GetSceneRevisionNumber();

    void SetSceneRevisionNumber(const char* pRevNumber);

    const char* GetSceneComment();
    
    void SetSceneComment(const char* pComment);
};

FBSDK_DLL void FBPreventUIUpdateBegin();

FBSDK_DLL void FBPreventUIUpdateEnd();

FBSDK_DLL bool FBPreventUIUpdateIsOn();

FBSDK_DLL void FBMergeTransactionBegin();

FBSDK_DLL void FBMergeTransactionEnd();

FBSDK_DLL bool FBMergeTransactionIsOn();

FBSDK_DLL void FBMergeTransactionFileRefEditBegin();

FBSDK_DLL void FBMergeTransactionFileRefEditEnd();

FBSDK_DLL bool FBMergeTransactionFileRefEditIsOn();

#ifdef FBSDKUseNamespace
} // namespace FBSDKNamespace
#endif

#endif