KFbxGlobalCameraSettings Class Reference

#include <kfbxglobalcamerasettings.h>

List of all members.

---

Detailed Description

This class contains the global camera settings.

Remarks:

This class exists for FBX version 6.x and earlier. The new FBX v7.x file format that is now the default no longer uses it. The relevant data (a subset of this class) has been moved to the KFbxGlobalSettings object and should be used instead.

Definition at line 71 of file kfbxglobalcamerasettings.h.

Default camera settings.
enum	EViewingMode {    eSTANDARD,    eXRAY,    eMODELS_ONLY }
	Viewing modes. More...
bool	SetDefaultCamera (char *pCameraName)
	Sets the default camera.
char *	GetDefaultCamera () const
	Returns the default camera name.
void	RestoreDefaultSettings ()
	Restores the default settings.
void	SetDefaultViewingMode (EViewingMode pViewingMode)
	Sets the default viewing mode.
EViewingMode	GetDefaultViewingMode () const
	Returns the default viewing mode.
Error Management
The same error object is shared among instances of this class.
enum	EError {    eNULL_PARAMETER,    eUNKNOWN_CAMERA_NAME,    eERROR_COUNT }
	Error identifiers, most of these are only used internally. More...
KError &	GetError ()
	Retrieves the error object.
EError	GetLastErrorID () const
	Returns last error code.
const char *	GetLastErrorString () const
	Returns the last error string.
Producer Cameras
Producer cameras are global cameras in MotionBuilder you use to view the scene. You cannot animate Producer cameras but you can specify their default positions.
void	CreateProducerCameras ()
	Creates the default Producer cameras.
void	DestroyProducerCameras ()
	Destroys the default Producer cameras.
bool	IsProducerCamera (KFbxCamera *pCamera) const
	Checks if the camera is a Producer camera.
KFbxCameraSwitcher *	GetCameraSwitcher () const
	Returns the Camera Switcher.
void	SetCameraSwitcher (KFbxCameraSwitcher *pSwitcher)
	Sets the Camera Switcher.
KFbxCamera *	GetCameraProducerPerspective () const
	Returns a reference to the Producer perspective camera.
KFbxCamera *	GetCameraProducerTop () const
	Returns a reference to the Producer top camera.
KFbxCamera *	GetCameraProducerBottom () const
	Returns a reference to the Producer bottom camera.
KFbxCamera *	GetCameraProducerFront () const
	Returns a reference to the Producer front camera.
KFbxCamera *	GetCameraProducerBack () const
	Returns a reference to the Producer back camera.
KFbxCamera *	GetCameraProducerRight () const
	Returns a reference to the Producer right camera.
KFbxCamera *	GetCameraProducerLeft () const
	Returns a reference to the Producer left camera.
Public Member Functions
const KFbxGlobalCameraSettings &	operator= (const KFbxGlobalCameraSettings &pGlobalCameraSettings)
	Assignment operator.

---

Member Enumeration Documentation

enum EViewingMode

Viewing modes.

• eSTANDARD
• eXRAY
• eMODELS_ONLY

Enumerator:

eSTANDARD
eXRAY
eMODELS_ONLY

Definition at line 101 of file kfbxglobalcamerasettings.h.

enum EError

Error identifiers, most of these are only used internally.

• eNULL_PARAMETER
• eUNKNOWN_CAMERA_NAME
• eERROR_COUNT

Enumerator:

eNULL_PARAMETER
eUNKNOWN_CAMERA_NAME
eERROR_COUNT

Definition at line 220 of file kfbxglobalcamerasettings.h.

---

Member Function Documentation

bool SetDefaultCamera

(

char *

pCameraName

)

Sets the default camera.

Parameters:

pCameraName

Name of the default camera.

Returns:

True if camera name is valid, returns false if it is not valid.

Remarks:

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

char* GetDefaultCamera

(

)

const

Returns the default camera name.

Returns:

The default camera name, or returns an empty string if no camera name has been specified.

void RestoreDefaultSettings

(

)

Restores the default settings.

void SetDefaultViewingMode

(

EViewingMode

pViewingMode

)

Sets the default viewing mode.

Parameters:

pViewingMode

Viewing mode to set(eSTANDARD, eXRAY or eMODELS_ONLY).

EViewingMode GetDefaultViewingMode

(

)

const

Returns the default viewing mode.

Returns:

The currently set Viewing mode.

void CreateProducerCameras

(

)

Creates the default Producer cameras.

void DestroyProducerCameras

(

)

Destroys the default Producer cameras.

bool IsProducerCamera

(

KFbxCamera *

pCamera

)

const

Checks if the camera is a Producer camera.

Parameters:

pCamera

The camera to check.

Returns:

True if it is a producer camera, returns false if it is not a producer camera.

KFbxCameraSwitcher* GetCameraSwitcher

(

)

const

Returns the Camera Switcher.

Returns:

A pointer to the Camera Switcher.

Remarks:

This node has a KFbxNodeAttribute::eCAMERA_SWITCHER node attribute type. This node is not saved when there is no camera in the scene. Nodes inserted below are never saved. Camera indices start at 1. Out of range indices are clamped between 1 and the number of cameras in the scene. The index of a camera refers to its order of appearance when searching the node tree depth first. If a camera is added or removed after camera indices have been set, the camera indices must be updated. It is easier to set camera indices once every camera have been set. Camera index keys must be set using constant interpolation to ensure that camera switches occur exactly at key time.

void SetCameraSwitcher

(

KFbxCameraSwitcher *

pSwitcher

)

Sets the Camera Switcher.

Parameters:

pSwitcher

The Camera Switcher to be set.

KFbxCamera* GetCameraProducerPerspective

(

)

const

Returns a reference to the Producer perspective camera.

Returns:

The reference to the internal Perspective camera.

KFbxCamera* GetCameraProducerTop

(

)

const

Returns a reference to the Producer top camera.

Returns:

The reference to the internal Top camera.

KFbxCamera* GetCameraProducerBottom

(

)

const

Returns a reference to the Producer bottom camera.

Returns:

The reference to the internal Bottom camera.

KFbxCamera* GetCameraProducerFront

(

)

const

Returns a reference to the Producer front camera.

Returns:

The reference to the internal Front camera.

KFbxCamera* GetCameraProducerBack

(

)

const

Returns a reference to the Producer back camera.

Returns:

The reference to the internal Back camera.

KFbxCamera* GetCameraProducerRight

(

)

const

Returns a reference to the Producer right camera.

Returns:

The reference to the internal Right camera.

KFbxCamera* GetCameraProducerLeft

(

)

const

Returns a reference to the Producer left camera.

Returns:

The reference to the internal Left camera.

const KFbxGlobalCameraSettings& operator=

(

const KFbxGlobalCameraSettings &

pGlobalCameraSettings

)

Assignment operator.

Parameters:

pGlobalCameraSettings

KFbxGlobalCameraSettings object assigned to this one.

KError& GetError

(

)

Retrieves the error object.

Returns:

Reference to the error object.

EError GetLastErrorID

(

)

const

Returns last error code.

Returns:

Last error code.

const char* GetLastErrorString

(

)

const

Returns the last error string.

Returns:

Text description of the last error.