FbxThumbnail Class Reference

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

---

Search for all occurrences

---

Detailed Description

Simple class to hold RGBA values of a thumbnail image.

Definition at line 27 of file fbxthumbnail.h.

#include <fbxthumbnail.h>

Inheritance diagram for FbxThumbnail:

List of all members.

Public Member Functions
virtual FbxObject &	Copy (const FbxObject &pObject)
	Copy an object content into this object.
Protected Member Functions
virtual void	Construct (const FbxThumbnail *pFrom)
virtual void	ConstructProperties (bool pForceSet)
	Optional property constructor override, automatically called by default constructor.
virtual void	Destruct (bool pRecursive)
	Optional destructor override, automatically called by default destructor.
Protected Attributes
FbxThumbnailMembers *	mMembers
Thumbnail properties
enum	EDataFormat { eRGB_24, eRGBA_32 }
	Data format. More...
enum	EImageSize { eNotSet = 0, e64x64 = 64, e128x128 = 128, eCustomSize = -1 }
	Image size. More...
FbxPropertyT< FbxInt >	CustomHeight
	Pixel height of the thumbnail image.
FbxPropertyT< FbxInt >	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 FbxUChar *pImage)
	Fill the thumbnail image.
FbxUChar *	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 47 of file fbxthumbnail.h.

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

enum EImageSize

Search for all occurrences

Image size.

• eNotSet
• e64x64
• e128x128
• eCustomSize

Enumerator:

eNotSet	Search for all occurrences
e64x64	Search for all occurrences
e128x128	Search for all occurrences
eCustomSize	Search for all occurrences

Definition at line 70 of file fbxthumbnail.h.

    {
        eNotSet = 0,
        e64x64 = 64,
        e128x128 = 128,
        eCustomSize = -1
    };

---

Member Function Documentation

void SetDataFormat

(

EDataFormat

pDataFormat

)

Search for all occurrences

Set the data format.

Parameters:

pDataFormat

Data format identifier.

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.

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 FbxUChar *

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 eCustomSize the CustomHeight and CustomWidth properties must be set before calling this function.

Returns:

true if the thumbnail properties were set before calling this function. false otherwise.

FbxUChar* GetThumbnailImage

(

)

const

Search for all occurrences

Get the thumbnail image.

Returns:

Pointer to the image data, or NULL if the thumbnail is empty.

virtual FbxObject& Copy

(

const FbxObject &

pObject

)

[virtual]

Search for all occurrences

Copy an object content into this object.

Parameters:

pObject

The source object to copy data from.

Returns:

Returns the destination object being modified by the source.

Remarks:

This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.

Reimplemented from FbxObject.

virtual void Construct

(

const FbxThumbnail *

pFrom

)

[protected, virtual]

Search for all occurrences

virtual void ConstructProperties

(

bool

pForceSet

)

[protected, virtual]

Search for all occurrences

Optional property constructor override, automatically called by default constructor.

Parameters:

pForceSet

If the property value must be set regardless of default value.

Remarks:

If your object have properties, they must be initialized in this function.

Reimplemented from FbxObject.

virtual void Destruct

(

bool

pRecursive

)

[protected, virtual]

Search for all occurrences

Optional destructor override, automatically called by default destructor.

Parameters:

pRecursive

If true, children objects should be destroyed as well.

Remarks:

In case it is decided to override this function, do not forget to call ParentClass::Destruct(pResursive) at the end.

Reimplemented from FbxObject.

---

Member Data Documentation

FbxPropertyT<FbxInt> CustomHeight

Search for all occurrences

Pixel height of the thumbnail image.

Definition at line 38 of file fbxthumbnail.h.

FbxPropertyT<FbxInt> CustomWidth

Search for all occurrences

Pixel width of the thumbnail image.

Definition at line 41 of file fbxthumbnail.h.

FbxThumbnailMembers* mMembers [protected]

Search for all occurrences

Definition at line 136 of file fbxthumbnail.h.

---

The documentation for this class was generated from the following file:

• fbxsdk/scene/fbxthumbnail.h