fbdeck.h

Go to the documentation of this file.

#ifndef __FBDECK_H__
#define __FBDECK_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>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

#define FBRegisterDeck( UniqueNameStr, ClassName, Label, Description, IconFilename ) \
    HIObject RegisterDeck##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName(pName); \
        Class->UniqueName = UniqueNameStr; \
        if (Class->FBCreate()) { \
            Class->ThreadSync();    \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName,"Decks",Label,Description,RegisterDeck##ClassName, true, IconFilename );    \
    }

#define FBDeckDeclare( ClassName  ) \
    FBClassDeclare( ClassName,FBDeck ); \
  public: \
    ClassName(const char* pName):FBDeck(pName) { FBClassInit; } \
  private:

#define FBDeckImplementation( ThisComponent ) \
        FBClassImplementation( ThisComponent )

// FBDeck
__FB_FORWARD( FBDeck );
//

enum FBDeckTransportMode{   
    kFBDeckTransportNone,       
    kFBDeckTransportSlave,      
    kFBDeckTransportMaster      
};

FB_DEFINE_ENUM      ( FBSDK_DLL, DeckTransportMode );
FB_DEFINE_COMPONENT ( FBSDK_DLL, Deck );

class FBSDK_DLL FBDeck : public FBComponent {
    __FBClassDeclare( FBDeck,FBComponent );
public:
    const char* UniqueName;                         
    void    ThreadSync();

    FBDeck(const char* pName, HIObject pObject=NULL);   

    IObject_Declare(K_IMPLEMENTATION);          

    //--- Real-Time deck callback
    virtual void    DeckStatusUpdateNotify();           
    virtual void    DeckAutoCommandsNotify();           

    //--- Operations
    virtual void    Rewind      ();                     
    virtual void    Stop        ();                     

    virtual void    Play        (double pSpeed = 1.0);  
    virtual void    Forward     ();                     

    virtual void    ReversePlay (double pSpeed = 1.0);  
    virtual void    StepBack    ();                     
    virtual void    StepForward ();                     
    virtual void    Eject       ();                     

    virtual void    CueAt       (FBTime pTime);

    //--- Time
    virtual FBTime  GetTime     ();

    //--- FBX store/retrieve
    virtual bool    FbxStore    ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat );
    virtual bool    FbxRetrieve ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat );

    //--- Icon
    FBPropertyString                IconFilename;           

    //--- Settings
    FBPropertyBool                  Online;                 
    FBPropertyTime                  Offset;                 
    FBPropertyTime                  Latency;                
    FBPropertyTime                  PreRoll;                
    FBPropertyTime                  PostRoll;               
    FBPropertyDeckTransportMode     TransportControl;       

    //--- State
    FBPropertyBool                  CassetteInside;         
    FBPropertyBool                  PlayingForward;         
    FBPropertyBool                  PlayingBackward;        
    FBPropertyBool                  EE;                     
    FBPropertyBool                  StandBy;                
};

// FBPropertyListDeck
class FBSDK_DLL FBPropertyListDeck : public FBPropertyListComponent
{
public:
    FBPropertyListDeck();
    FBDeck* operator[](int pIndex);
};

#ifdef FBSDKUseNamespace
    }
#endif
#endif