fbsdk/fbconstructionhistory.h Source File
 
 
 
fbsdk/fbconstructionhistory.h
Go to the documentation of this file.
00001 #ifndef __FBCONSTRUCTIONHISTORY_H__
00002 #define __FBCONSTRUCTIONHISTORY_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 #include <fbsdk/fbcomponent.h>
00051 #include <fbsdk/fbarray.h>
00052 #include <fbsdk/fbplug.h>
00053 #include <fbsdk/fbstring.h>
00054 
00055 #ifdef FBSDKUseNamespace
00056     namespace FBSDKNamespace {
00057 #endif
00058 
00060 // FBConstructionHistory
00062 __FB_FORWARD( FBConstructionHistory );
00063 FB_FORWARD( FBConstructionOperation );
00064 FB_DEFINE_COMPONENT( FBSDK_DLL, FBConstructionHistory );
00065 
00066 FB_DEFINE_ARRAY(FBSDK_DLL, Plug);
00067 
00068 class FBSDK_DLL FBConstructionOperation {
00069 
00070         friend class FBConstructionHistory;
00071 public:
00072 
00075     FBConstructionOperation();
00076 
00077         const char*     GetLanguage();
00078         int                     GetLanguageVersion();
00079         const char*     GetScript();
00080     const char* GetOrigin();
00081         int                     GetCommandId();
00082     bool        GetExecuteAsLocalOperation();
00083 
00084         void            SetLanguage( const char* language );
00085         void            SetLanguageVersion( int version );
00086         void            SetScript( const char* script );
00087         void            SetCommandId( int commandId );
00088     void        SetOrigin( const char* origin );
00089     void        SetExecuteAsLocalOperation( bool bIsLocal );
00090 
00091 private:
00092 
00093         FBString        mScript;
00094         int                     mCommandId;
00095         FBString        mLanguage;
00096     FBString    mOrigin;
00097         int                     mVersion;
00098     bool        mExecuteAsLocal;
00099 };
00100 
00101 class FBSDK_DLL FBConstructionOperationArray : public FBArrayTemplate<FBConstructionOperation*>
00102 {
00106     FBConstructionOperationArray( const FBConstructionHistory& );
00107 
00111     FBConstructionOperationArray& operator=( const FBConstructionHistory& );
00112 
00113 public:
00114 
00117     FBConstructionOperationArray();
00118 
00121         ~FBConstructionOperationArray();
00122 };
00123 
00125 enum FBConstructionHistoryState {
00126         kFBConstructionHistory_Listening,               
00127         kFBConstructionHistory_Replaying                
00128 };
00129 
00130 class FBSDK_DLL FBEventConstructionHistoryChange : public FBEvent 
00131 {
00132 public:
00133 
00137     FBEventConstructionHistoryChange( HKEventBase pEvent );             
00138 
00144     int GetCommandId();
00145 };
00146 
00150 class FBSDK_DLL FBConstructionHistory : public FBComponent 
00151 {
00152     __FBClassDeclare( FBConstructionHistory, FBComponent );
00153 
00157     FBConstructionHistory( const FBConstructionHistory& );
00158 
00162     FBConstructionHistory& operator=( const FBConstructionHistory& );
00163 
00164 public:
00165 
00168     FBConstructionHistory();
00169 
00176         void GetDeltaOperations( FBConstructionOperationArray* pOperations, int sinceCommandId = -1);
00177 
00184         int RunOperation ( FBConstructionOperation& operation );
00185 
00191     FBConstructionHistoryState  GetState();
00192 
00196     FBPropertyEvent                     OnChange;
00197 
00201     static FBConstructionHistory& TheOne();
00202 
00203 };
00204 
00205 #ifdef FBSDKUseNamespace
00206     }
00207 #endif
00208 #endif
00209