fbevaluatemanager.h

Go to the documentation of this file.

#ifndef __FBEVALUATEMANAGER_H__
#define __FBEVALUATEMANAGER_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

enum FBParallelScheduleType
{
    kFBParallelScheduleSerial,      
    kFBParallelScheduleSimple,      
    kFBParallelScheduleAdvanced,    
};

FB_DEFINE_ENUM(FBSDK_DLL, ParallelScheduleType);

enum FBGlobalEvalCallbackTiming
{
    kFBGlobalEvalCallbackBeforeDAG,             
    kFBGlobalEvalCallbackAfterDAG,              
    kFBGlobalEvalCallbackAfterDeform,           
    kFBGlobalEvalCallbackSyn,                   
    kFBGlobalEvalCallbackBeforeRender,          
    kFBGlobalEvalCallbackAfterRender,           
    kFBGlobalEvalCallbackBeforePlottingFrame,   
    kFBGlobalEvalCallbackAfterPlottingFrame,    
};

typedef void (*kFBEvaluationGlobalFunctionCallback)(FBEvaluateInfo* pEvaluteInfo);

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

    FBGlobalEvalCallbackTiming GetTiming() const;

    FBEvaluateInfo* GetEvaluateInfo() const;
};

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

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

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

__FB_FORWARD( FBEvaluateManager );
class FBSDK_DLL FBEvaluateManager : public FBComponent 
{
    __FBClassDeclare( FBEvaluateManager,FBComponent );

    FBEvaluateManager(HIObject pObject=NULL);

public:
    FBPropertyBool                  ParallelPipeline;            
    FBPropertyBool                  ParallelDeformation;         
    FBPropertyBool                  UseGPUDeformation;           
    FBPropertyBool                  FrameSkipOptimization;       
    FBPropertyParallelScheduleType  ParallelScheduleType;        
    FBPropertyBool                  ParallelEvaluation;          
    FBPropertyBool                  DualQuaternionSkinning;      

    FBPropertyInt                   NodeCount;                   
    FBPropertyInt                   DeviceCount;                 

    void InvalidateDAG();

    bool IsInteractiveMode() const;


    void RegisterEvaluationGlobalFunction  (kFBEvaluationGlobalFunctionCallback pCallback, FBGlobalEvalCallbackTiming pTiming);

    void UnregisterEvaluationGlobalFunction(kFBEvaluationGlobalFunctionCallback pCallback, FBGlobalEvalCallbackTiming pTiming);

    FBPropertyEventCallbackEvalPipeline     OnEvaluationPipelineEvent;   
    FBPropertyEventCallbackRenderPipeline   OnRenderingPipelineEvent;    
    FBPropertyEventCallbackSynPoint         OnSynchronizationEvent;      


    static FBEvaluateManager& TheOne();
};


FBSDK_DLL void FBSchedulingDependencyOutput( bool pEnable );

#ifdef FBSDKUseNamespace
} // namespace FBSDKNamespace
#endif

#endif