fbsdk/fbfilereference.h Source File
 
 
 
fbsdk/fbfilereference.h
Go to the documentation of this file.
00001 #ifndef __FBFILEREFERENCE_H__
00002 #define __FBFILEREFERENCE_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 <kaydara.h>
00052 
00053 #include <fbsdk/fbcomponent.h>
00054 #include <fbsdk/fbnamespace.h>
00055 
00056 #ifdef FBSDKUseNamespace
00057         namespace FBSDKNamespace {
00058 #endif
00059 
00060 __FB_FORWARD( FBFileReference );
00061 FB_DEFINE_COMPONENT( FBSDK_DLL, FileReference );
00062 
00063 FB_FORWARD( FBPropertyListFileReference );
00064 
00065 FB_DEFINE_LIST( FBSDK_DLL, FileReference );
00066 
00069 class FBSDK_DLL FBPropertyListFileReference : public FBPropertyListComponent
00070 {
00071 public:
00072         FBPropertyListFileReference();
00077         FBFileReference* operator[](int pIndex);
00078 };
00079 
00081 // FBFileReference
00083 
00086 class FBSDK_DLL FBFileReference : public FBNamespace
00087 {
00088         //--- Open Reality declaration.
00089         __FBClassDeclare(FBFileReference, FBNamespace);
00090 
00091     void Init();
00092 
00093 protected:
00094 
00100         FBFileReference(const char* pMultiLevelNamespace, HIObject pObject);
00101 
00102 public:
00103 
00109     FBFileReference(const char* pSingleLevelNamespace, FBNamespace* pParentNSObj);
00110 
00111         FBPropertyString                                ReferenceFilePath;              
00112         FBPropertyBool                                  IsLoaded;                               
00113         
00120     bool BakeRefEditToFile(const char* pFilePath = NULL);
00121 
00126     void RevertRefEdit(FBPlug* pPlug = NULL, FBPlugModificationFlag pModificationFlag = kFBAllModifiedMask);
00127 
00131     void ApplyRefEditPyScriptFromFile( const char* pRefEditPyScriptFilePath );
00132 
00136     void ApplyRefEditPyScriptFromString( const char* pRefEditPyScript );
00137 
00143     bool DuplicateFileRef(const FBStringList& pDstNameSpaceList, bool pWithRefEdit = false);
00144 
00149     const char* GetRefEdit(const char* pFilePath = NULL);
00150 
00155     bool ClearRefEdit(const char* pFilePath);
00156 
00160     bool ClearAllRefEdit();
00161 
00168     bool SwapReferenceFilePath(const char* pFilePath, bool pApplyAvailableRefEdit = true, bool pMergeCurrentRefEdit = true);
00169 
00173     void GetRefFileList(FBStringList& pRefFileList) const;
00174 
00175 };
00176 
00178 
00179 #ifdef FBSDKUseNamespace
00180         }
00181 #endif
00182 
00183 
00184 #endif /* this must be the last line of this file */