FBX C++ API Reference
fbxthumbnail.h
Go to the documentation of this file.
1 /****************************************************************************************
2 
3  Copyright (C) 2015 Autodesk, Inc.
4  All rights reserved.
5 
6  Use of this software is subject to the terms of the Autodesk license agreement
7  provided at the time of installation or download, or which otherwise accompanies
8  this software in either electronic or hard copy form.
9 
10 ****************************************************************************************/
11 
13 #ifndef _FBXSDK_SCENE_THUMBNAIL_H_
14 #define _FBXSDK_SCENE_THUMBNAIL_H_
15 
16 #include <fbxsdk/fbxsdk_def.h>
17 
18 #include <fbxsdk/core/fbxobject.h>
19 
20 #include <fbxsdk/fbxsdk_nsbegin.h>
21 
22 class FbxThumbnailMembers;
23 
28 {
30 
31 public:
36 
39 
42 
48  {
49  eRGB_24, // 3 components
50  eRGBA_32 // 4 components
51  };
52 
56  void SetDataFormat(EDataFormat pDataFormat);
57 
61  EDataFormat GetDataFormat() const;
62 
63 
71  {
72  eNotSet = 0,
73  e64x64 = 64,
74  e128x128 = 128,
75  eCustomSize = -1
76  };
77 
81  void SetSize(EImageSize pImageSize);
82 
86  EImageSize GetSize() const;
87 
91  unsigned long GetSizeInBytes() const;
92 
93 
95 
100 
115  bool SetThumbnailImage(const FbxUChar* pImage);
116 
121  FbxUChar* GetThumbnailImage() const;
122 
124 
125 /*****************************************************************************************************************************
126 ** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
127 *****************************************************************************************************************************/
128 #ifndef DOXYGEN_SHOULD_SKIP_THIS
129  virtual FbxObject& Copy(const FbxObject& pObject);
130 
131 protected:
132  virtual void Construct(const FbxObject* pFrom);
133  virtual void ConstructProperties(bool pForceSet);
134  virtual void Destruct(bool pRecursive);
135 
136  FbxThumbnailMembers* mMembers;
137 #endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
138 };
139 
140 #include <fbxsdk/fbxsdk_nsend.h>
141 
142 #endif /* _FBXSDK_SCENE_THUMBNAIL_H_ */
#define FBXSDK_OBJECT_DECLARE(Class, Parent)
Macro used to declare a new class derived from FbxObject.
Definition: fbxobject.h:61
FBX SDK environment definition.
EImageSize
Image size.
Definition: fbxthumbnail.h:70
virtual FbxObject & Copy(const FbxObject &pObject)
Copy an object content into this object.
unsigned char FbxUChar
Definition: fbxtypes.h:36
EDataFormat
Data format.
Definition: fbxthumbnail.h:47
FbxPropertyT< FbxInt > CustomHeight
Pixel height of the thumbnail image.
Definition: fbxthumbnail.h:38
The base class of most FBX objects.
Definition: fbxobject.h:157
FbxPropertyT< FbxInt > CustomWidth
Pixel width of the thumbnail image.
Definition: fbxthumbnail.h:41
virtual void Construct(const FbxObject *pFrom)
Optional constructor override, automatically called by default constructor.
#define FBXSDK_DLL
Definition: fbxarch.h:173
virtual void Destruct(bool pRecursive)
Optional destructor override, automatically called by default destructor.
virtual void ConstructProperties(bool pForceSet)
Optional property constructor override, automatically called by default constructor.
Simple class to hold RGBA values of a thumbnail image.
Definition: fbxthumbnail.h:27