FBFbxManager Class Reference

#include
<fbfbx.h>

Inheritance diagram for FBFbxManager:

[legend]

List of all members.

Detailed Description

FBX interface for loading/saving files into the application.

This class permits the loading and saving of scene without using the user-interface. Each process is split into three steps, and between the first and second, the developer can setup the different options for each operation. For instance, when loading, LoadBegin() is called, the options for the file can then be set, and then Load() is called to begin the actual import of the data from the scene.

Warning:: The manager cannot perform 2 actions at the same time!

Definition at line 270 of file fbfbx.h.


Public Member Functions
	FBFbxManager ()
	Constructor.
bool	LoadBegin (void *pFileAddress, kULong pFileMemoryLength, bool pMerge=false)
	Begin the file load process.
bool	LoadBegin (char *pFilename, bool pMerge=false)
	Begin the file load process.
bool	Load ()
	File load process.
bool	LoadIsCompleted ()
	Query the file load process.
bool	LoadEnd ()
	End the file load process.
bool	SaveBegin (char *pFilename)
	Begin the file save process.
bool	Save ()
	Actual file save process.
bool	SaveEnd ()
	End the file save process.
bool	SaveCharacterRigAndAnimation (char *pFileName, HFBCharacter pCharacter, bool pSaveCharacter, bool pSaveRig, bool pSaveExtensions)
	Save the rig and its animation in a file.
bool	LoadAnimationOnCharacter (char *pFileName, HFBCharacter pCharacter, bool pReplaceRig, bool pCopyMissingExtensions, bool pUpdateLimits, bool pIgnoreConflicts, FBFbxManagerLoadAnimationMethod pTransferMethod, HFBPlotOptions pPlotOptions, bool pProcessAnimationOnExtensions, bool pRetargetOnBaseLayer, bool pResetHierarchy)
	Load a rig and its animation from a file.
bool	SetOptionsFromHistory (char *pHistoryFile=NULL)
	Use the options saved to a history config file to setup the current options.
bool	SetHistoryFromOptions (char *pHistoryFile=NULL)
	Update a history config file with the current options.
Public Attributes
FBPropertyFbxManagerState	State
	Read Only Property: Current state of the manager.
FBPropertyString	CustomImportNamespace
	Read Write Property: Namespace we append to every objects on a Load (import/open/merge)
FBArrayFbxTake	Takes
	List: Scene takes.
FBPropertyScene	Scene
	Read Write Property: This is the scene in wich you want to load
General options.
FBPropertyBool	Async
	Read Write Property: Use asynchronous operation. False by default.
Load specific options.
Warning: These options are not present in the history file. Thus will not be affected by 'SetOptionsFromHistory()' and 'SetHistoryFromOptions()'.
FBPropertyBool	ClearBeforeLoad
	Read Write Property: Clear the scene before load. False by default.
FBPropertyTakeSpanOnLoad	TakeSpan
	Read Write Property: Indicate how the take start and end point should be set. By default it is read from the file.
Save specific options.
All of these options are false by default, except for 'EmbedMedia' which is true by default. Warning: These options are not present in the history file. Thus will not be affected by 'SetOptionsFromHistory()' and 'SetHistoryFromOptions()'.
FBPropertyBool	ConvertImageToTiff
	Read Write Property: Only considered if EmbedMedia is true. Will convert the embeded media to tiff format when possible.
FBPropertyBool	EmbedMedia
	Read Write Property: Embed all media in the FBX file itself. When saving in ASCII mode it is not possible to embed media.
FBPropertyBool	SaveSelectedModelsOnly
	Read Write Property: Indicate that only the selected models will be saved.
FBPropertyBool	UseASCIIFormat
	Read Write Property: Indicate if the resulting FBX file will be in binary or ASCII mode.
Scene settings options.
FBPropertyBool	BaseCameras
	Read Write Property: Consider base camera settings.
FBPropertyBool	CameraSwitcherSettings
	Read Write Property: Consider camera switcher settings.
FBPropertyBool	CurrentCameraSettings
	Read Write Property: Consider current camera settings.
FBPropertyBool	GlobalLightingSettings
	Read Write Property: Consider global Lighting settings.
FBPropertyBool	TransportSettings
	Read Write Property: Consider transport control settings.
Element settings options.
FBPropertyElementAction	Actors
	Read Write Property: Handling of the Actors elements.
FBPropertyElementAction	ActorFaces
	Read Write Property: Handling of the Actor Faces elements.
FBPropertyElementAction	Audio
	Read Write Property: Handling of the Audio elements.
FBPropertyElementAction	Bones
	Read Write Property: Handling of the Bones elements.
FBPropertyElementAction	Cameras
	Read Write Property: Handling of the Cameras elements.
FBPropertyElementAction	Characters
	Read Write Property: Handling of the Characters elements.
FBPropertyElementAction	CharacterFaces
	Read Write Property: Handling of the Character Faces elements.
FBPropertyElementAction	CharacterExtensions
	Read Write Property: Handling of the Character Extensions.
FBPropertyElementAction	Constraints
	Read Write Property: Handling of the Constraints elements.
FBPropertyElementAction	Devices
	Read Write Property: Handling of the Devices elements.
FBPropertyElementAction	Groups
	Read Write Property: Handling of the Groups elements.
FBPropertyElementAction	KeyingGroups
	Read Write Property: Handling of the Keying Groups elements.
FBPropertyElementAction	Lights
	Read Write Property: Handling of the Lights elements.
FBPropertyElementAction	Materials
	Read Write Property: Handling of the Materials elements.
FBPropertyElementAction	Models
	Read Write Property: Handling of the Models elements.
FBPropertyElementAction	Notes
	Read Write Property: Handling of the Notes elements.
FBPropertyElementAction	OpticalData
	Read Write Property: Handling of the Optical Data elements.
FBPropertyElementAction	PhysicalProperties
	Read Write Property: Handling of the Physical Properties elements.
FBPropertyElementAction	Poses
	Read Write Property: Handling of the Poses elements.
FBPropertyElementAction	Scripts
	Read Write Property: Handling of the Scripts elements.
FBPropertyElementAction	Sets
	Read Write Property: Handling of the Sets elements.
FBPropertyElementAction	Shaders
	Read Write Property: Handling of the Shaders elements.
FBPropertyElementAction	Solvers
	Read Write Property: Handling of the Solvers elements.
FBPropertyElementAction	Story
	Read Write Property: Handling of the Story elements.
FBPropertyElementAction	Textures
	Read Write Property: Handling of the Textures elements.
FBPropertyElementAction	Video
	Read Write Property: Handling of the Video elements.
Element animation settings options.
Not all elements type have animation associated with them.
FBPropertyBool	ActorFacesAnimation
	Read Write Property: Handling of the Actor Faces animation.
FBPropertyBool	BonesAnimation
	Read Write Property: Handling of the Bones animation.
FBPropertyBool	CamerasAnimation
	Read Write Property: Handling of the Cameras animation.
FBPropertyBool	CharactersAnimation
	Read Write Property: Handling of the Characters animation.
FBPropertyBool	CharacterFacesAnimation
	Read Write Property: Handling of the Character Faces animation.
FBPropertyBool	ConstraintsAnimation
	Read Write Property: Handling of the Constraints animation.
FBPropertyBool	DevicesAnimation
	Read Write Property: Handling of the Devices animation.
FBPropertyBool	LightsAnimation
	Read Write Property: Handling of the Lights animation.
FBPropertyBool	MaterialsAnimation
	Read Write Property: Handling of the Materials animation.
FBPropertyBool	ModelsAnimation
	Read Write Property: Handling of the Models animation.
FBPropertyBool	NotesAnimation
	Read Write Property: Handling of the Notes animation.
FBPropertyBool	PhysicalPropertiesAnimation
	Read Write Property: Handling of the Physical Properties animation.
FBPropertyBool	ShadersAnimation
	Read Write Property: Handling of the Shaders animation.
FBPropertyBool	SolversAnimation
	Read Write Property: Handling of the Solvers animation.
FBPropertyBool	TexturesAnimation
	Read Write Property: Handling of the Textures animation.

Constructor & Destructor Documentation

FBFbxManager ( )

Constructor.

Member Function Documentation

bool LoadBegin	(	void *	pFileAddress,
		kULong	pFileMemoryLength,
		bool	pMerge = `false`
	)

Begin the file load process.

This is the first call when loading a file via the SDK IN MEMORY.

Parameters:

	pFileAddress	Adress where the file is.
	pFileMemoryLength	Length of the File.
	pMerge	Indicate if we are merging or appending to the current scene.

Returns:: true if successful.

bool LoadBegin	(	char *	pFilename,
		bool	pMerge = `false`
	)

Begin the file load process.

This is the first call when loading a file via the SDK.

Parameters:

	pFilename	Name of file to load.
	pMerge	Indicate if we are merging or appending to the current scene.

Returns:: true if successful.

bool Load ( )

File load process.

If the load is asynchronous, this will return right away, otherwise, this is the actual loading process of the file.

Returns:: true if successful.

bool LoadIsCompleted ( )

Query the file load process.

Returns:: true if file load is finished.

bool LoadEnd ( )

End the file load process.

Regardless of the type of load (asynchronous or not, this will wait until the load is finished.

Returns:: true if successful.

bool SaveBegin ( char * pFilename )

Begin the file save process.

This is the first call when saving a file via the SDK.

Parameters:

pFilename

Name of file to save.

Returns:: true if successful.

bool Save ( )

Actual file save process.

Returns:: true if successful.

bool SaveEnd ( )

End the file save process.

Returns:: true if successful.

bool SaveCharacterRigAndAnimation	(	char *	pFileName,
		HFBCharacter	pCharacter,
		bool	pSaveCharacter,
		bool	pSaveRig,
		bool	pSaveExtensions
	)

Save the rig and its animation in a file.

Parameters:

	pFileName	File name.
	pCharacter	Character to save.
	pSaveCharacter	Set to true if the character should be saved.
	pSaveRig	Set to true if the rig (and its children) should be saved.
	pSaveExtensions	Set to true if the character extensions (and their children) should be saved.

bool LoadAnimationOnCharacter	(	char *	pFileName,
		HFBCharacter	pCharacter,
		bool	pReplaceRig,
		bool	pCopyMissingExtensions,
		bool	pUpdateLimits,
		bool	pIgnoreConflicts,
		FBFbxManagerLoadAnimationMethod	pTransferMethod,
		HFBPlotOptions	pPlotOptions,
		bool	pProcessAnimationOnExtensions,
		bool	pRetargetOnBaseLayer,
		bool	pResetHierarchy
	)

Load a rig and its animation from a file.

Parameters:

	pFileName	File name.
	pCharacter	Target character.
	pReplaceRig	Set to true if the current rig should be replaced by the rig in the file.
	pCopyMissingExtensions	Set to true if the character extensions on the rig in the file should be copied to the target rig.
	pUpdateLimits	Set to true if we should change the limits on the target rig.
	pIgnoreConflicts	Set to true to ignore conflicts between objects in character extensions and objects in the scene. Conflicting objects will be merged in the extension.
	pTransferMethod	How should the animation should be tranfered on the target rig.
	pPlotOptions	If the animation should be plotted on the target rig, these plot options will be used. Set to NULL if animation will not be plotted.
	pProcessAnimationOnExtensions	Set to true if animation on character extensions should also be transferred.
	pRetargetOnBaseLayer	If the transfer method is retarget, set this parameter to control where the retarget correction will be made (on base layer or on another layer).
	pResetHierarchy	Set to true if we should reset the character hierarchy.

Returns:: true if successful.

bool SetOptionsFromHistory ( char * pHistoryFile = NULL )

Use the options saved to a history config file to setup the current options.

Parameters:

pHistoryFile

Indicate the name of the history file to use. If NULL the default system file will be used. This file will be created/read from the folder bin/config. Should the first character be a '@' it will be replaced by the machine name. Using the default value is equivalent to using the string "@History.txt" as an argument.

Returns:: true if the options were indeed set from the history file.

bool SetHistoryFromOptions ( char * pHistoryFile = NULL )

Update a history config file with the current options.

Parameters:

pHistoryFile

Returns:: true if the options were indeed saved to the history file.

Member Data Documentation

FBPropertyFbxManagerState State

Read Only Property: Current state of the manager.

Definition at line 396 of file fbfbx.h.

FBPropertyBool Async

Read Write Property: Use asynchronous operation. False by default.

Definition at line 402 of file fbfbx.h.

FBPropertyBool ClearBeforeLoad

Read Write Property: Clear the scene before load. False by default.

Definition at line 410 of file fbfbx.h.

FBPropertyTakeSpanOnLoad TakeSpan

Read Write Property: Indicate how the take start and end point should be set. By default it is read from the file.

Definition at line 411 of file fbfbx.h.

FBPropertyBool ConvertImageToTiff

Read Write Property: Only considered if EmbedMedia is true. Will convert the embeded media to tiff format when possible.

Definition at line 420 of file fbfbx.h.

FBPropertyBool EmbedMedia

Read Write Property: Embed all media in the FBX file itself. When saving in ASCII mode it is not possible to embed media.

Definition at line 421 of file fbfbx.h.

FBPropertyBool SaveSelectedModelsOnly

Read Write Property: Indicate that only the selected models will be saved.

Definition at line 422 of file fbfbx.h.

FBPropertyBool UseASCIIFormat

Read Write Property: Indicate if the resulting FBX file will be in binary or ASCII mode.

Definition at line 423 of file fbfbx.h.

FBPropertyBool BaseCameras

Read Write Property: Consider base camera settings.

Definition at line 430 of file fbfbx.h.

FBPropertyBool CameraSwitcherSettings

Read Write Property: Consider camera switcher settings.

Definition at line 431 of file fbfbx.h.

FBPropertyBool CurrentCameraSettings

Read Write Property: Consider current camera settings.

Definition at line 432 of file fbfbx.h.

FBPropertyBool GlobalLightingSettings

Read Write Property: Consider global Lighting settings.

Definition at line 433 of file fbfbx.h.

FBPropertyBool TransportSettings

Read Write Property: Consider transport control settings.

Definition at line 434 of file fbfbx.h.

FBPropertyString CustomImportNamespace

Read Write Property: Namespace we append to every objects on a Load (import/open/merge)

Definition at line 437 of file fbfbx.h.

FBPropertyElementAction Actors

Read Write Property: Handling of the Actors elements.

Definition at line 442 of file fbfbx.h.

FBPropertyElementAction ActorFaces

Read Write Property: Handling of the Actor Faces elements.

Definition at line 443 of file fbfbx.h.

FBPropertyElementAction Audio

Read Write Property: Handling of the Audio elements.

Definition at line 444 of file fbfbx.h.

FBPropertyElementAction Bones

Read Write Property: Handling of the Bones elements.

Definition at line 445 of file fbfbx.h.

FBPropertyElementAction Cameras

Read Write Property: Handling of the Cameras elements.

Definition at line 446 of file fbfbx.h.

FBPropertyElementAction Characters

Read Write Property: Handling of the Characters elements.

Definition at line 447 of file fbfbx.h.

FBPropertyElementAction CharacterFaces

Read Write Property: Handling of the Character Faces elements.

Definition at line 448 of file fbfbx.h.

FBPropertyElementAction CharacterExtensions

Read Write Property: Handling of the Character Extensions.

Definition at line 449 of file fbfbx.h.

FBPropertyElementAction Constraints

Read Write Property: Handling of the Constraints elements.

Definition at line 450 of file fbfbx.h.

FBPropertyElementAction Devices

Read Write Property: Handling of the Devices elements.

Definition at line 451 of file fbfbx.h.

FBPropertyElementAction Groups

Read Write Property: Handling of the Groups elements.

Definition at line 452 of file fbfbx.h.

FBPropertyElementAction KeyingGroups

Read Write Property: Handling of the Keying Groups elements.

Definition at line 453 of file fbfbx.h.

FBPropertyElementAction Lights

Read Write Property: Handling of the Lights elements.

Definition at line 454 of file fbfbx.h.

FBPropertyElementAction Materials

Read Write Property: Handling of the Materials elements.

Definition at line 455 of file fbfbx.h.

FBPropertyElementAction Models

Read Write Property: Handling of the Models elements.

Definition at line 456 of file fbfbx.h.

FBPropertyElementAction Notes

Read Write Property: Handling of the Notes elements.

Definition at line 457 of file fbfbx.h.

FBPropertyElementAction OpticalData

Read Write Property: Handling of the Optical Data elements.

Definition at line 458 of file fbfbx.h.

FBPropertyElementAction PhysicalProperties

Read Write Property: Handling of the Physical Properties elements.

Definition at line 459 of file fbfbx.h.

FBPropertyElementAction Poses

Read Write Property: Handling of the Poses elements.

Definition at line 460 of file fbfbx.h.

FBPropertyElementAction Scripts

Read Write Property: Handling of the Scripts elements.

Definition at line 461 of file fbfbx.h.

FBPropertyElementAction Sets

Read Write Property: Handling of the Sets elements.

Definition at line 462 of file fbfbx.h.

FBPropertyElementAction Shaders

Read Write Property: Handling of the Shaders elements.

Definition at line 463 of file fbfbx.h.

FBPropertyElementAction Solvers

Read Write Property: Handling of the Solvers elements.

Definition at line 464 of file fbfbx.h.

FBPropertyElementAction Story

Read Write Property: Handling of the Story elements.

Definition at line 465 of file fbfbx.h.

FBPropertyElementAction Textures

Read Write Property: Handling of the Textures elements.

Definition at line 466 of file fbfbx.h.

FBPropertyElementAction Video

Read Write Property: Handling of the Video elements.

Definition at line 467 of file fbfbx.h.

FBPropertyBool ActorFacesAnimation

Read Write Property: Handling of the Actor Faces animation.

Definition at line 475 of file fbfbx.h.

FBPropertyBool BonesAnimation

Read Write Property: Handling of the Bones animation.

Definition at line 476 of file fbfbx.h.

FBPropertyBool CamerasAnimation

Read Write Property: Handling of the Cameras animation.

Definition at line 477 of file fbfbx.h.

FBPropertyBool CharactersAnimation

Read Write Property: Handling of the Characters animation.

Definition at line 478 of file fbfbx.h.

FBPropertyBool CharacterFacesAnimation

Read Write Property: Handling of the Character Faces animation.

Definition at line 479 of file fbfbx.h.

FBPropertyBool ConstraintsAnimation

Read Write Property: Handling of the Constraints animation.

Definition at line 480 of file fbfbx.h.

FBPropertyBool DevicesAnimation

Read Write Property: Handling of the Devices animation.

Definition at line 481 of file fbfbx.h.

FBPropertyBool LightsAnimation

Read Write Property: Handling of the Lights animation.

Definition at line 482 of file fbfbx.h.

FBPropertyBool MaterialsAnimation

Read Write Property: Handling of the Materials animation.

Definition at line 483 of file fbfbx.h.

FBPropertyBool ModelsAnimation

Read Write Property: Handling of the Models animation.

Definition at line 484 of file fbfbx.h.

FBPropertyBool NotesAnimation

Read Write Property: Handling of the Notes animation.

Definition at line 485 of file fbfbx.h.

FBPropertyBool PhysicalPropertiesAnimation

Read Write Property: Handling of the Physical Properties animation.

Definition at line 486 of file fbfbx.h.

FBPropertyBool ShadersAnimation

Read Write Property: Handling of the Shaders animation.

Definition at line 487 of file fbfbx.h.

FBPropertyBool SolversAnimation

Read Write Property: Handling of the Solvers animation.

Definition at line 488 of file fbfbx.h.

FBPropertyBool TexturesAnimation

Read Write Property: Handling of the Textures animation.

Definition at line 489 of file fbfbx.h.

FBArrayFbxTake Takes

List: Scene takes.

Definition at line 493 of file fbfbx.h.

FBPropertyScene Scene

Read Write Property: This is the scene in wich you want to load

Definition at line 495 of file fbfbx.h.

Please send us your comments about this page.

FBFbxManager Class Reference

Detailed Description

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation