This reference page is linked to from the following overview topics: List of Python FBX classes.

Detailed Description

Simple class to hold RGBA values of a thumbnail image.

Examples:: ExportScene01/main.cxx, and ImportScene/main.cxx.

Definition at line 53 of file kfbxthumbnail.h.

#include <kfbxthumbnail.h>

Inheritance diagram for KFbxThumbnail:

[legend]

List of all members.

Public Member Functions
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
Protected Member Functions
	KFbxThumbnail (KFbxSdkManager &pManager, char const *pName)
	Constructor.
virtual void	Construct (const KFbxThumbnail *pFrom)
virtual bool	ConstructProperties (bool pForceSet)
virtual void	Destruct (bool pRecursive, bool pDependents)
Protected Attributes
KFbxSdkManager *	mManager
KFbxThumbnailMembers *	mMembers
Thumbnail properties
enum	EDataFormat { eRGB_24, eRGBA_32 }
	Data format. More...
enum	EImageSize { eNOT_SET = 0, e64x64 = 64, e128x128 = 128, eCUSTOM_SIZE = -1 }
	Image size. More...
KFbxTypedProperty< fbxInteger1 >	CustomHeight
	Pixel height of the thumbnail image.
KFbxTypedProperty< fbxInteger1 >	CustomWidth
	Pixel width of the thumbnail image.
void	SetDataFormat (EDataFormat pDataFormat)
	Set the data format.
EDataFormat	GetDataFormat () const
	Get the data format.
void	SetSize (EImageSize pImageSize)
	Set the thumbnail dimensions.
EImageSize	GetSize () const
	Get the thumbnail dimensions.
unsigned long	GetSizeInBytes () const
	Get the thumbnail dimensions in bytes.
Thumbnail data access
bool	SetThumbnailImage (const kUByte *pImage)
	Fill the thumbnail image.
kUByte *	GetThumbnailImage () const
	Get the thumbnail image.

Member Enumeration Documentation

enum EDataFormat

Search for all occurrences

Data format.

eRGB_24
eRGBA_32

Enumerator:

eRGB_24	Search for all occurrences
eRGBA_32	Search for all occurrences

Definition at line 74 of file kfbxthumbnail.h.

    {
        eRGB_24, // 3 components
        eRGBA_32 // 4 components
    } EDataFormat;

enum EImageSize

Search for all occurrences

Image size.

eNOT_SET
e64x64
e128x128
eCUSTOM_SIZE

Enumerator:

eNOT_SET	Search for all occurrences
e64x64	Search for all occurrences
e128x128	Search for all occurrences
eCUSTOM_SIZE	Search for all occurrences

Definition at line 97 of file kfbxthumbnail.h.

    {
        eNOT_SET = 0,
        e64x64   = 64,
        e128x128 = 128,
        eCUSTOM_SIZE = -1
    } EImageSize;

Constructor & Destructor Documentation

KFbxThumbnail	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		`[protected]`

Constructor.

Member Function Documentation

void SetDataFormat ( EDataFormat pDataFormat )

Search for all occurrences

Set the data format.

Parameters:

pDataFormat Data format identifier.

Examples:: ExportScene01/main.cxx.

EDataFormat GetDataFormat ( ) const

Search for all occurrences

Get the data format.

Returns:: Data format identifier for the thumbnail.

void SetSize ( EImageSize pImageSize )

Search for all occurrences

Set the thumbnail dimensions.

Parameters:

pImageSize Image size identifier.

Examples:: ExportScene01/main.cxx.

EImageSize GetSize ( ) const

Search for all occurrences

Get the thumbnail dimensions.

Returns:: Image size identifier.

unsigned long GetSizeInBytes ( ) const

Search for all occurrences

Get the thumbnail dimensions in bytes.

Returns:: Thumbnail size in bytes.

bool SetThumbnailImage ( const kUByte * pImage )

Search for all occurrences

Fill the thumbnail image.

Parameters:

pImage Pointer to the image data. A copy of the image data will be made.

Remarks:: This pointer must point to a buffer region that is at least Width * Height * Component count bytes long. This pointer points to the upper left corner of the image.; You must set the data format and the dimensions before calling this function. If the image size is set to eCUSTOM_SIZE the CustomHeight and CustomWidth properties must be set before calling this function.