fbtracker.h

Go to the documentation of this file.

#ifndef __FBTRACKER_H__
#define __FBTRACKER_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/fbcore.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

/**************************************************************************
 **************************************************************************/
FBSDK_DLL FBTimeMode FBGetSyncTimeMode();

/**************************************************************************
 **************************************************************************/
__FB_FORWARD( FBDeviceSyncPacket );
class FBSDK_DLL FBDeviceSyncPacket : public FBComponent
{
    __FBClassDeclare( FBDeviceSyncPacket, FBComponent );
  public:
    FBDeviceSyncPacket();           

  public:
    FBPropertyInt   OriginalSync;   
    FBPropertyInt   CorrectedSync;  
    FBPropertyInt   DeviceSync;     
};

/**************************************************************************
 **************************************************************************/
__FB_FORWARD( FBDeviceSync );
class FBSDK_DLL FBDeviceSync : public FBDevice
{
    __FBClassDeclare( FBDeviceSync, FBDevice );
  public:
    FBDeviceSync(char* pName, HIObject pObject=NULL);
    virtual void PrintDebugAnimInfo     ( int pSync, FBDeviceSyncPacket* pSyncPacket, HFBEvaluateInfo pEvaluateInfo );
    virtual void PrintDebugIOInfo       ( FBDeviceSyncPacket* pSyncPacket, FBDeviceNotifyInfo& pDeviceNotifyInfo );
    virtual void PrintDebugIONotifyInfo ( FBDeviceNotifyInfo& pInfo, int pPacketCount );

    // Standard device virtual functions creation/destruction
    virtual bool FBCreate   ();
    virtual void FBDestroy  ();

    // Overloaded FBDevice functions
    virtual bool AnimationNodeNotify( HFBAnimationNode pAnimationNode, HFBEvaluateInfo pEvaluateInfo    );
    virtual bool FbxStore           ( HFBFbxObject pFbxObject,kFbxObjectStore pStoreWhat    );
    virtual bool FbxRetrieve        ( HFBFbxObject pFbxObject,kFbxObjectStore pStoreWhat    );

    virtual bool DeviceSyncAnimationNodeNotify( HFBAnimationNode pAnimationNode, HFBEvaluateInfo pEvaluateInfo, int pCorrectedSync ) = 0;

    //--- Packet registration
    virtual void PacketRegister( HFBDeviceSyncPacket pPacket );

    //--- DeviceIONotify() calls
    virtual HFBDeviceSyncPacket PacketLock ();
    virtual void PacketUnlock ( HFBDeviceSyncPacket pPacket, bool pValidPacket );

    //--- AnimationNodeNotify() calls
    virtual HFBDeviceSyncPacket PacketFetch( int pRequestedSync );
    virtual void PacketRelease( HFBDeviceSyncPacket pPacket );

    //--- Queue management
    virtual HFBDeviceSyncPacket PacketRemove( int pPacketIndex );
    virtual int PacketGetCount();

  public:
    FBPropertyInt       PacketBufferSize;       
    FBPropertyInt       SyncDelay;              
    FBPropertyBool      DebugInfo;              
};

/**************************************************************************
 **************************************************************************/
__FB_FORWARD( FBDeviceCameraPacket );
class FBSDK_DLL FBDeviceCameraPacket : public FBDeviceSyncPacket
{
    __FBClassDeclare( FBDeviceCameraPacket, FBDeviceSyncPacket );
public:
    FBDeviceCameraPacket();             

    FBPropertyVector3d  Position;       
    FBPropertyVector3d  Rotation;       
    FBPropertyVector3d  Offset;         
    FBPropertyVector2d  FieldOfView;    
    FBPropertyVector2d  OpticalCenter;  
    FBPropertyDouble    Focus;          
    FBPropertyDouble    Zoom;           
    FBPropertyTime      Time;           
};
FB_DEFINE_COMPONENT( FBSDK_DLL, DeviceCameraPacket );

/**************************************************************************
 **************************************************************************/
__FB_FORWARD( FBDeviceCameraInstrument );
class FBSDK_DLL FBDeviceCameraInstrument : public FBDeviceInstrument
{
    __FBClassDeclare( FBDeviceCameraInstrument, FBDeviceInstrument );
  public:
    FBDeviceCameraInstrument( HFBDevice pDevice );

    virtual bool LoadLensTables( char* pFilename );
    virtual void ProcessLensData( FBDeviceCameraPacket* pDataPacket );

    // See parent class.
    virtual bool InstrumentWriteData( HFBEvaluateInfo pEvaluateInfo ) override;
    virtual void InstrumentRecordFrame( FBTime pRecordTime, FBDeviceNotifyInfo& pNotifyInfo ) override;
    virtual bool FbxStore( HFBFbxObject pFbxObject,kFbxObjectStore pStoreWhat ) override;
    virtual bool FbxRetrieve( HFBFbxObject pFbxObject,kFbxObjectStore pStoreWhat ) override;

    // Packet of information
    FBPropertyDeviceCameraPacket    Packet;         
    FBPropertyDeviceCameraPacket    RecordPacket;   
    // Lens options
    FBPropertyBool      LensTableLoaded;            
    FBPropertyString    LensCalibrationFilename;    

    FBPropertyBool      ManualFovMode;              
    FBPropertyDouble    ManualFovX;                 
    FBPropertyDouble    ManualFovY;                 
    FBPropertyBool      ManualCenterMode;           
    FBPropertyDouble    ManualCenterX;              
    FBPropertyDouble    ManualCenterY;              
    FBPropertyBool      LensFovInDegrees;           
    FBPropertyBool      InvertZoom;                 
    FBPropertyBool      InvertFocus;                
    FBPropertyDouble    ZoomMultiplier;             
    FBPropertyDouble    NodalMultiplier;            
    FBPropertyVector3d  TranslationOffset;          
    FBPropertyVector3d  RotationOffset;             
    FBPropertyDouble    AspectRatio;                
};

/**************************************************************************
 **************************************************************************/
__FB_FORWARD( FBDeviceCamera );
class FBSDK_DLL FBDeviceCamera : public FBDeviceSync
{
    __FBClassDeclare( FBDeviceCamera,FBDeviceSync );
  public:
    FBDeviceCamera(char *pName, HIObject pObject=NULL);

    // Standard device virtual functions creation/destruction
    virtual bool FBCreate   ();
    virtual void FBDestroy  ();

    // Overloaded parent functions
    virtual bool DeviceSyncAnimationNodeNotify  ( HFBAnimationNode pAnimationNode, HFBEvaluateInfo pEvaluateInfo, int pCorrectedSync );
    virtual void DeviceIONotify                 ( kDeviceIOs pAction, FBDeviceNotifyInfo& pDeviceNotifyInfo );
    virtual bool ModelTemplateBindNotify( HFBModel pModel,int pIndex, HFBModelTemplate pModelTemplate       );
    virtual bool FbxStore               ( HFBFbxObject pFbxObject,kFbxObjectStore pStoreWhat    );
    virtual bool FbxRetrieve            ( HFBFbxObject pFbxObject,kFbxObjectStore pStoreWhat    );
    virtual void RecordingInitAnimation ( HFBAnimationNode pAnimationNode );
    virtual void RecordingDoneAnimation ( HFBAnimationNode pAnimationNode );

    virtual bool DeviceCameraAnimationNodeNotify( HFBEvaluateInfo pEvaluateInfo, HFBDeviceCameraPacket pDstPacket, HFBDeviceSyncPacket pSrcPacket );
    virtual void DeviceCameraEvalData( FBDeviceNotifyInfo& pNotifyInfo );
    virtual void DeviceCameraRecordFrame( FBTime &pRecordTime, FBDeviceNotifyInfo& pNotifyInfo );
    virtual bool DeviceCameraWriteData( HFBEvaluateInfo pEvaluateInfo );
    virtual bool LoadLensTables( char* pFilename );
    virtual void ProcessLensData( HFBDeviceCameraPacket pDataPacket );
  
  public:
    FBPropertyBool      UsingCustomInstruments; 
    FBPropertyInt       NumberOfInstruments;    
    FBPropertyString    ModelTemplatePrefix;    
};
   
#ifdef FBSDKUseNamespace
}
#endif
#endif