kfbxthumbnail.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXTHUMBNAIL_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXTHUMBNAIL_H
00006 
00007 /**************************************************************************************
00008 
00009  Copyright (C) 2001 - 2010 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 #include <fbxfilesdk/fbxfilesdk_def.h>
00042 
00043 #include <fbxfilesdk/kfbxplugins/kfbxobject.h>
00044 
00045 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00046 
00047 class KFbxThumbnailMembers;
00048 class KFbxSdkManager;
00049 
00053 class KFBX_DLL KFbxThumbnail : public KFbxObject
00054 {
00055     KFBXOBJECT_DECLARE(KFbxThumbnail,KFbxObject);
00056 
00057 public:
00058 
00063 
00065     KFbxTypedProperty<fbxInteger1> CustomHeight;
00066 
00068     KFbxTypedProperty<fbxInteger1> CustomWidth;
00069 
00074     typedef enum 
00075     {
00076         eRGB_24, // 3 components
00077         eRGBA_32 // 4 components
00078     } EDataFormat;
00079 
00083     void SetDataFormat(EDataFormat pDataFormat);
00084 
00088     EDataFormat GetDataFormat() const;
00089 
00090 
00097     typedef enum 
00098     {
00099         eNOT_SET = 0,
00100         e64x64   = 64,
00101         e128x128 = 128,
00102         eCUSTOM_SIZE = -1
00103     } EImageSize;
00104 
00108     void SetSize(EImageSize pImageSize);    
00109 
00113     EImageSize GetSize() const;
00114 
00118     unsigned long GetSizeInBytes() const;
00119 
00120 
00122 
00127 
00142     bool SetThumbnailImage(const kUByte* pImage);
00143 
00148     kUByte* GetThumbnailImage() const;
00149 
00151 
00152 
00154 //
00155 //  WARNING!
00156 //
00157 //  Anything beyond these lines may not be documented accurately and is 
00158 //  subject to change without notice.
00159 //
00161 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00162 
00163     virtual KFbxObject& Copy(const KFbxObject& pObject);
00164 
00165 protected:
00167     KFbxThumbnail(KFbxSdkManager& pManager, char const* pName);
00168 
00169     virtual void Construct(const KFbxThumbnail* pFrom);
00170     virtual bool ConstructProperties( bool pForceSet );
00171     virtual void Destruct(bool pRecursive, bool pDependents);
00172 
00173     // Members
00174     KFbxSdkManager* mManager;
00175     KFbxThumbnailMembers* mMembers;
00176 
00177 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS 
00178 };
00179 
00180 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00181 
00182 #endif // FBXFILESDK_KFBXPLUGINS_KFBXTHUMBNAIL_H
00183