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

Detailed Description

This class contains scene thumbnails and user-defined summary data.

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

Definition at line 52 of file kfbxdocumentinfo.h.

#include <kfbxdocumentinfo.h>

Inheritance diagram for KFbxDocumentInfo:

[legend]

List of all members.

Public Member Functions
void	Clear ()
	Clears the content.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
Scene Thumbnail.
Comment.
KFbxThumbnail *	GetSceneThumbnail ()
	Returns the thumbnail for the scene.
void	SetSceneThumbnail (KFbxThumbnail *pSceneThumbnail)
	Sets the thumbnail for the scene.
Public Attributes
Public properties
KFbxTypedProperty< fbxString >	LastSavedUrl
	This property contains the last saved URL.
KFbxTypedProperty< fbxString >	Url
	This property contains the URL.
KFbxProperty	Original
	Parent property for all properties related to creation.
KFbxTypedProperty< fbxString >	Original_ApplicationVendor
	This property contains the name of the original application vendor.
KFbxTypedProperty< fbxString >	Original_ApplicationName
	This property contains the original application name.
KFbxTypedProperty< fbxString >	Original_ApplicationVersion
	This property contains the version of the original application.
KFbxTypedProperty< fbxString >	Original_FileName
	This property contains the original file name.
KFbxTypedProperty< fbxDateTime >	Original_DateTime_GMT
	This property contains the original date and time.
KFbxProperty	LastSaved
	The parent property for all last saved-related properties.
KFbxTypedProperty< fbxString >	LastSaved_ApplicationVendor
	This property contains the last saved application vendor.
KFbxTypedProperty< fbxString >	LastSaved_ApplicationName
	This property contains the last saved application name.
KFbxTypedProperty< fbxString >	LastSaved_ApplicationVersion
	This property contains the last saved application version.
KFbxTypedProperty< fbxDateTime >	LastSaved_DateTime_GMT
	This property contains the last saved date and time.
KFbxTypedProperty< fbxString >	EmbeddedUrl
	This property points at the ".fbm" folder that is created when reading a FBX file that has embedded data.
User-defined summary data.
These are user-completed fields that identify or classify the files.
KString	mTitle
KString	mSubject
	Title.
KString	mAuthor
	Subject.
KString	mKeywords
	Author.
KString	mRevision
	Keywords.
KString	mComment
	Revision.
Protected Member Functions
	KFbxDocumentInfo (KFbxSdkManager &pManager, char const *pName)
	Object Constructors and Destructor.
bool	ConstructProperties (bool pForceSet)
Protected Attributes
KFbxThumbnail *	mSceneThumbnail
Friends
class	KStreamFbx

Constructor & Destructor Documentation

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

Object Constructors and Destructor.

Member Function Documentation

KFbxThumbnail* GetSceneThumbnail ( )

Search for all occurrences

Returns the thumbnail for the scene.

Returns:: Pointer to the thumbnail.

Examples:: ImportScene/main.cxx.

void SetSceneThumbnail ( KFbxThumbnail * pSceneThumbnail )

Search for all occurrences

Sets the thumbnail for the scene.

Parameters:

pSceneThumbnail Pointer to the thumbnail.

Examples:: ExportScene01/main.cxx.

void Clear ( )

Search for all occurrences

Clears the content.

Resets all the strings to an empty string and clears the pointer to the thumbnail.

virtual KFbxObject& Copy ( const KFbxObject & 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 KFbxObject.

bool ConstructProperties ( bool pForceSet ) [protected, virtual]

Search for all occurrences

Reimplemented from KFbxObject.

Friends And Related Function Documentation

friend class KStreamFbx [friend]

Search for all occurrences

Definition at line 240 of file kfbxdocumentinfo.h.

Member Data Documentation

KFbxTypedProperty<fbxString> LastSavedUrl

Search for all occurrences

This property contains the last saved URL.

To retrieve the value of this property, use LastSavedUrl.Get(). To set the value of this property, use LastSavedUrl.Set(fbxString).

The default value is empty.

Definition at line 68 of file kfbxdocumentinfo.h.

KFbxTypedProperty<fbxString> Url

Search for all occurrences

This property contains the URL.

To retrieve the value of this property, use Url.Get(). To set the value of this property, use Url.Set(fbxString).

The default value is empty.

Definition at line 77 of file kfbxdocumentinfo.h.

KFbxProperty Original

Search for all occurrences

Parent property for all properties related to creation.

These properties should be set once when the file is created, and you should not change them during subsequent save or reload operations. The default properties are listed below, but application vendors can add new properties under this parent property.

Definition at line 85 of file kfbxdocumentinfo.h.

KFbxTypedProperty<fbxString> Original_ApplicationVendor

Search for all occurrences

This property contains the name of the original application vendor.

To retrieve the value of this property, use Original_ApplicationVendor.Get(). To set the value of this property, use Original_ApplicationVendor.Set(fbxString).

The default value is empty.

Definition at line 94 of file kfbxdocumentinfo.h.

KFbxTypedProperty<fbxString> Original_ApplicationName

Search for all occurrences

This property contains the original application name.

To retrieve the value of this property, use Original_ApplicationName.Get(). To set the value of this property, use Original_ApplicationName.Set(fbxString).

The default value is empty.

Definition at line 103 of file kfbxdocumentinfo.h.

KFbxTypedProperty<fbxString> Original_ApplicationVersion

Search for all occurrences

This property contains the version of the original application.

To retrieve the value of this property, use Original_ApplicationVersion.Get(). To set the value of this property, use Original_ApplicationVersion.Set(fbxString).

The default value is empty.

Definition at line 112 of file kfbxdocumentinfo.h.

KFbxTypedProperty<fbxString> Original_FileName

Search for all occurrences

This property contains the original file name.

To retrieve the value of this property, use Original_FileName.Get(). To set the value of this property, use Original_FileName.Set(fbxString).

The default value is empty.

Definition at line 121 of file kfbxdocumentinfo.h.

KFbxTypedProperty<fbxDateTime> Original_DateTime_GMT

Search for all occurrences

This property contains the original date and time.

To retrieve the value of this property, use Original_DateTime_GMT.Get(). To set the value of this property, use Original_DateTime_GMT.Set(fbxString).

The default value is 0.

Remarks:: The date/time should use GMT time format.

Definition at line 131 of file kfbxdocumentinfo.h.

KFbxProperty LastSaved

Search for all occurrences

The parent property for all last saved-related properties.

These properties update every time a file is saved. The default properties are below, but application vendors can add new properties under this parent property. The file creator must set both the original and last saved properties.

Definition at line 139 of file kfbxdocumentinfo.h.

KFbxTypedProperty<fbxString> LastSaved_ApplicationVendor

Search for all occurrences

This property contains the last saved application vendor.

To retrieve the value of this property, use LastSaved_ApplicationVendor.Get(). To set the value of this property, use LastSaved_ApplicationVendor.Set(fbxString).

The default value is empty.

Definition at line 148 of file kfbxdocumentinfo.h.

KFbxTypedProperty<fbxString> LastSaved_ApplicationName

Search for all occurrences

This property contains the last saved application name.

To retrieve the value of this property, use LastSaved_ApplicationName.Get(). To set the value of this property, use LastSaved_ApplicationName.Set(fbxString).

The default value is empty.

Definition at line 157 of file kfbxdocumentinfo.h.

KFbxTypedProperty<fbxString> LastSaved_ApplicationVersion

Search for all occurrences

This property contains the last saved application version.

To retrieve the value of this property, use LastSaved_ApplicationVersion.Get(). To set the value of this property, use LastSaved_ApplicationVersion.Set(fbxString).

The default value is empty.

Definition at line 166 of file kfbxdocumentinfo.h.

KFbxTypedProperty<fbxDateTime> LastSaved_DateTime_GMT

Search for all occurrences

This property contains the last saved date and time.

To retrieve the value of this property, use LastSaved_DateTime_GMT.Get(). To set the value of this property, use LastSaved_DateTime_GMT.Set(fbxString).

The default value is 0.