KFbxGlobalCameraSettings Class Reference

#include <kfbxglobalcamerasettings.h>

List of all members.

---

Detailed Description

This class contains the global camera settings.

Definition at line 77 of file kfbxglobalcamerasettings.h.

Default Camera
enum	EViewingMode
void	RestoreDefaultSettings ()
	Restore default settings.
bool	SetDefaultCamera (char *pCameraName)
	Set the default camera.
char *	GetDefaultCamera ()
	Get default camera name.
void	SetDefaultViewingMode (EViewingMode pViewingMode)
	Set default viewing mode.
EViewingMode	GetDefaultViewingMode ()
	Get default viewing mode.
Error Management
The same error object is shared among instances of this class.
enum	EError
KError &	GetError ()
	Retrieve error object.
EError	GetLastErrorID ()
	Get last error code.
char *	GetLastErrorString ()
	Get last error string.
Producer Cameras
Producer cameras are global cameras used in MotionBuilder to view the scene. They are not animatable but their default position can be set.
KFbxCamera &	GetCameraProducerPerspective ()
	Get a reference to producer perspective camera.
KFbxCamera &	GetCameraProducerTop ()
	Get a reference to producer top camera.
KFbxCamera &	GetCameraProducerBottom ()
	Get a reference to producer bottom camera.
KFbxCamera &	GetCameraProducerFront ()
	Get reference to producer front camera.
KFbxCamera &	GetCameraProducerBack ()
	Get reference to producer back camera.
KFbxCamera &	GetCameraProducerRight ()
	Get reference to producer right camera.
KFbxCamera &	GetCameraProducerLeft ()
	Get reference to producer left camera.
Public Member Functions
const KFbxGlobalCameraSettings &	operator= (const KFbxGlobalCameraSettings &pGlobalCameraSettings)
	Assignment operator.

---

Member Function Documentation

void RestoreDefaultSettings

(

)

Restore default settings.

bool SetDefaultCamera

(

char *

pCameraName

)

Set the default camera.

Parameters:

pCameraName

Name of the default camera.

Returns:

true if camera name is valid, false otherwise.

Remarks:

A valid camera name is either one of the defined tokens (PRODUCER_PERSPECTIVE, PRODUCER_TOP, PRODUCER_FRONT, PRODUCER_RIGHT, CAMERA_SWITCHER) or the name of a camera inserted in the node tree under the scene's root node.

char* GetDefaultCamera

(

)

Get default camera name.

Returns:

The default camera name, or an empty string if the camera name has not been set

void SetDefaultViewingMode

(

EViewingMode

pViewingMode

)

Set default viewing mode.

Parameters:

pViewingMode

Set default viewing mode to either eSTANDARD, eXRAY or eMODELS_ONLY.

EViewingMode GetDefaultViewingMode

(

)

Get default viewing mode.

Returns:

The currently set Viewing mode.

KFbxCamera& GetCameraProducerPerspective

(

)

Get a reference to producer perspective camera.

Returns:

The reference to the internal Perspective camera.

KFbxCamera& GetCameraProducerTop

(

)

Get a reference to producer top camera.

Returns:

The reference to the internal Top camera.

KFbxCamera& GetCameraProducerBottom

(

)

Get a reference to producer bottom camera.

Returns:

The reference to the internal Bottom camera.

KFbxCamera& GetCameraProducerFront

(

)

Get reference to producer front camera.

Returns:

The reference to the internal Front camera.

KFbxCamera& GetCameraProducerBack

(

)

Get reference to producer back camera.

Returns:

The reference to the internal Back camera.

KFbxCamera& GetCameraProducerRight

(

)

Get reference to producer right camera.

Returns:

The reference to the internal Right camera.

KFbxCamera& GetCameraProducerLeft

(

)

Get reference to producer left camera.

Returns:

The reference to the internal Left camera.

const KFbxGlobalCameraSettings& operator=

(

const KFbxGlobalCameraSettings &

pGlobalCameraSettings

)

Assignment operator.

KError& GetError

(

)

Retrieve error object.

Returns:

Reference to error object.

EError GetLastErrorID

(

)

Get last error code.

Returns:

Last error code.

char* GetLastErrorString

(

)

Get last error string.

Returns:

Textual description of the last error.