fbsdk/fbdeck.h Source File
 
 
 
fbsdk/fbdeck.h
Go to the documentation of this file.
00001 #ifndef __FBDECK_H__
00002 #define __FBDECK_H__
00003 /**************************************************************************
00004  Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
00005  All Rights Reserved.
00006  
00007  The coded instructions, statements, computer programs, and/or related 
00008  material (collectively the "Data") in these files contain unpublished 
00009  information proprietary to Autodesk, Inc. and/or its licensors, which is 
00010  protected by Canada and United States of America federal copyright law 
00011  and by international treaties.
00012  
00013  The Data may not be disclosed or distributed to third parties, in whole 
00014  or in part, without the prior written consent of Autodesk, Inc. 
00015  ("Autodesk").
00016  
00017  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00018  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
00019  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
00020  ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
00021  OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
00022  PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
00023  WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
00024  FREE.
00025  
00026  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
00027  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
00028  EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
00029  DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
00030  OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
00031  DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
00032  LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
00033  LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
00034  DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
00035  BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
00036  
00037 **************************************************************************/
00038 
00043 #include <kaydaradef.h>
00044 #ifndef FBSDK_DLL 
00045 
00048         #define FBSDK_DLL K_DLLIMPORT
00049 #endif
00050 
00051 #include <fbsdk/fbcomponent.h>
00052 
00053 #ifdef FBSDKUseNamespace
00054         namespace FBSDKNamespace {
00055 #endif
00056 
00064 #define FBRegisterDeck( UniqueNameStr, ClassName, Label, Description, IconFilename ) \
00065         HIObject RegisterDeck##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
00066         { \
00067           ClassName *Class = new ClassName(pName); \
00068                 Class->UniqueName = UniqueNameStr; \
00069                 if (Class->FBCreate()) { \
00070                         Class->ThreadSync();    \
00071                         return Class->GetHIObject(); \
00072                 } else { \
00073                         delete Class; \
00074                         return NULL; \
00075                 } \
00076         } \
00077         FBLibraryModule( ClassName )    \
00078         {       \
00079                 FBRegisterObject( ClassName,"Decks",Label,Description,RegisterDeck##ClassName, true, IconFilename );    \
00080         }
00081 
00085 #define FBDeckDeclare( ClassName  ) \
00086         FBClassDeclare( ClassName,FBDeck ); \
00087   public: \
00088         ClassName(const char* pName):FBDeck(pName) { FBClassInit; } \
00089   private:
00090 
00094 #define FBDeckImplementation( ThisComponent ) \
00095                 FBClassImplementation( ThisComponent )
00096 
00098 // FBDeck
00100 __FB_FORWARD( FBDeck );
00101 //
00102 
00104 enum FBDeckTransportMode{       
00105         kFBDeckTransportNone,           
00106         kFBDeckTransportSlave,          
00107         kFBDeckTransportMaster          
00108 };
00109 
00110 FB_DEFINE_ENUM          ( FBSDK_DLL, DeckTransportMode );
00111 FB_DEFINE_COMPONENT     ( FBSDK_DLL, Deck );
00112 
00114 class FBSDK_DLL FBDeck : public FBComponent {
00115         __FBClassDeclare( FBDeck,FBComponent );
00116 public:
00117         const char* UniqueName;                                                 
00118         void    ThreadSync();
00119 
00124         FBDeck(const char* pName, HIObject pObject=NULL);       
00125 
00126     IObject_Declare(K_IMPLEMENTATION);                  
00127 
00128         //--- Real-Time deck callback
00129         virtual void    DeckStatusUpdateNotify();                       
00130         virtual void    DeckAutoCommandsNotify();                       
00131 
00132         //--- Operations
00133         virtual void    Rewind          ();                                             
00134         virtual void    Stop            ();                                             
00135 
00138         virtual void    Play            (double pSpeed = 1.0);  
00139         virtual void    Forward         ();                                             
00140 
00143         virtual void    ReversePlay     (double pSpeed = 1.0);  
00144         virtual void    StepBack        ();                                             
00145         virtual void    StepForward     ();                                             
00146         virtual void    Eject           ();                                             
00147 
00150         virtual void    CueAt           (FBTime pTime);
00151 
00152         //--- Time
00156         virtual FBTime  GetTime         ();
00157 
00158         //--- FBX store/retrieve
00160 
00161         virtual bool    FbxStore        ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat );
00162         virtual bool    FbxRetrieve     ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat );
00164 
00165         //--- Icon
00166         FBPropertyString                                IconFilename;                   
00167 
00168         //--- Settings
00169         FBPropertyBool                                  Online;                                 
00170         FBPropertyTime                                  Offset;                                 
00171         FBPropertyTime                                  Latency;                                
00172         FBPropertyTime                                  PreRoll;                                
00173         FBPropertyTime                                  PostRoll;                               
00174         FBPropertyDeckTransportMode             TransportControl;               
00175 
00176         //--- State
00177         FBPropertyBool                                  CassetteInside;                 
00178         FBPropertyBool                                  PlayingForward;                 
00179         FBPropertyBool                                  PlayingBackward;                
00180         FBPropertyBool                                  EE;                                             
00181         FBPropertyBool                                  StandBy;                                
00182 };
00183 
00185 // FBPropertyListDeck
00188 class FBSDK_DLL FBPropertyListDeck : public FBPropertyListComponent
00189 {
00190 public:
00191         FBPropertyListDeck();
00196         FBDeck* operator[](int pIndex);
00197 };
00198 
00199 #ifdef FBSDKUseNamespace
00200         }
00201 #endif
00202 #endif