FBX SDK Reference Guide: kfbxglobalcamerasettings.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_GLOBAL_CAMERA_SETTINGS_H_
00005 #define _FBXSDK_GLOBAL_CAMERA_SETTINGS_H_
00006 
00007 /**************************************************************************************
00008 
00009  Copyright  2001 - 2008 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 
00042 #include <kaydaradef.h>
00043 #ifndef KFBX_DLL
00044     #define KFBX_DLL K_DLLIMPORT
00045 #endif
00046 
00047 #include <kaydara.h>
00048 
00049 #include <klib/kstring.h>
00050 #include <klib/kerror.h>
00051 
00052 #ifndef MB_FBXSDK
00053 #include <kbaselib_nsuse.h>
00054 #endif
00055 
00056 #include <fbxfilesdk_nsbegin.h>
00057 
00058 class KFbxNode;
00059 class KFbxSdkManager;
00060 class KFbxScene;
00061 class KFbxCamera;
00062 class KFbxCameraSwitcher;
00063 class KFbxGlobalCameraSettingsProperties;
00064 
00065 #define PRODUCER_PERSPECTIVE "Producer Perspective"
00066 #define PRODUCER_TOP "Producer Top"
00067 #define PRODUCER_FRONT "Producer Front"
00068 #define PRODUCER_BACK "Producer Back"
00069 #define PRODUCER_RIGHT "Producer Right"
00070 #define PRODUCER_LEFT "Producer Left"
00071 #define PRODUCER_BOTTOM "Producer Bottom"
00072 #define CAMERA_SWITCHER "Camera Switcher"
00073 
00074 
00078 class KFBX_DLL KFbxGlobalCameraSettings
00079 {
00080 
00085     public:
00093         bool SetDefaultCamera(char* pCameraName);
00094 
00098         char* GetDefaultCamera();
00099 
00101         void RestoreDefaultSettings();
00102 
00108         typedef enum
00109         {
00110             eSTANDARD,
00111             eXRAY,
00112             eMODELS_ONLY
00113         } EViewingMode;
00114 
00118         void SetDefaultViewingMode(EViewingMode pViewingMode);
00119 
00123         EViewingMode GetDefaultViewingMode();
00124 
00126 
00133 
00136         void CreateProducerCameras();
00137 
00140         void DestroyProducerCameras();
00141 
00145         bool IsProducerCamera(KFbxCamera* pCamera);
00146 
00165         KFbxCameraSwitcher* GetCameraSwitcher();
00166 
00170         void                SetCameraSwitcher(KFbxCameraSwitcher* pSwitcher);
00171 
00175         KFbxCamera* GetCameraProducerPerspective();
00176 
00180         KFbxCamera* GetCameraProducerTop();
00181 
00185         KFbxCamera* GetCameraProducerBottom();
00186 
00190         KFbxCamera* GetCameraProducerFront();
00191 
00195         KFbxCamera* GetCameraProducerBack();
00196 
00200         KFbxCamera* GetCameraProducerRight();
00201 
00205         KFbxCamera* GetCameraProducerLeft();
00206 
00208 
00210         const KFbxGlobalCameraSettings& operator=(const KFbxGlobalCameraSettings& pGlobalCameraSettings);
00211 
00217 
00221         KError& GetError();
00222 
00228         typedef enum
00229         {
00230             eNULL_PARAMETER,
00231             eUNKNOWN_CAMERA_NAME,
00232             eERROR_COUNT
00233         } EError;
00234 
00238         EError GetLastErrorID() const;
00239 
00243         const char* GetLastErrorString() const;
00244 
00246 
00248     //
00249     //  WARNING!
00250     //
00251     //  Anything beyond these lines may not be documented accurately and is
00252     //  subject to change without notice.
00253     //
00255 
00256     #ifndef DOXYGEN_SHOULD_SKIP_THIS
00257         bool CopyProducerCamera(KString pCameraName, const KFbxCamera* pCamera);
00258         int  GetProducerCamerasCount() { return 7; }
00259     private:
00260         KFbxGlobalCameraSettings(KFbxSdkManager& pManager, KFbxScene& pScene);
00261         ~KFbxGlobalCameraSettings();
00262 
00263         KFbxGlobalCameraSettingsProperties* mPH;
00264 
00265         friend class KFbxScene;
00266 
00267     #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00268 
00269 };
00270 
00271 #include <fbxfilesdk_nsend.h>
00272 
00273 #endif // #ifndef _FBXSDK_GLOBAL_CAMERA_SETTINGS_H_
00274 
00275