KFbxCameraManipulator Class Reference

Search for all occurrences

---

Detailed Description

This class can be used to provide basic camera manipulation in any program using this library.

Definition at line 54 of file kfbxmanipulators.h.

#include <kfbxmanipulators.h>

Inheritance diagram for KFbxCameraManipulator:

List of all members.

Public Types
enum	eAlignment { eNoAlignment, eCameraToLookAt, eLookAtToCamera }
enum	eAction { eNoAction, eOrbit, eDolly, ePan }
Public Member Functions
void	Initialize (const KFbxCamera &pCamera, eAlignment pCamAlign)
	Set the camera used for the manipulation.
bool	ManipBegin (eAction pAction, int pMouseX, int pMouseY)
	Begin manipulation of the camera.
bool	ManipNotify (int pMouseX, int pMouseY)
	Notify manipulation of latest input.
void	ManipEnd ()
	End manipulation.
eAction	GetCurrentAction () const
	Retrieve current manipulation action.
void	FrameAll ()
	Change camera position and look at to frame all objects.
void	FrameSelected ()
	Change camera position and look at to frame all selected objects.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.

---

Member Enumeration Documentation

enum eAlignment

Search for all occurrences

Enumerator:

eNoAlignment	Search for all occurrences
eCameraToLookAt	Search for all occurrences
eLookAtToCamera	Search for all occurrences

Definition at line 59 of file kfbxmanipulators.h.

{eNoAlignment, eCameraToLookAt, eLookAtToCamera};

enum eAction

Search for all occurrences

Enumerator:

eNoAction	Search for all occurrences
eOrbit	Search for all occurrences
eDolly	Search for all occurrences
ePan	Search for all occurrences

Definition at line 60 of file kfbxmanipulators.h.

{eNoAction, eOrbit, eDolly, ePan};

---

Member Function Documentation

void Initialize	(	const KFbxCamera &	pCamera,
		eAlignment	pCamAlign
	)

Search for all occurrences

Set the camera used for the manipulation.

Parameters:

pCamera	Camera that will be used for the manipulation.
pCamAlign	How the camera should be aligned during camera manipulator initialization.

bool ManipBegin	(	eAction	pAction,
		int	pMouseX,
		int	pMouseY
	)

Search for all occurrences

Begin manipulation of the camera.

Parameters:

pAction	The action performed for this manipulation scope.
pMouseX	Horizontal position of the mouse cursor.
pMouseY	Vertical position of the mouse cursor.

Returns:

If TRUE, manipulation successfully initialized.

bool ManipNotify	(	int	pMouseX,
		int	pMouseY
	)

Search for all occurrences

Notify manipulation of latest input.

Parameters:

pMouseX	Horizontal position of the mouse cursor.
pMouseY	Vertical position of the mouse cursor.

void ManipEnd

(

)

Search for all occurrences

End manipulation.

eAction GetCurrentAction

(

)

const

Search for all occurrences

Retrieve current manipulation action.

void FrameAll

(

)

Search for all occurrences

Change camera position and look at to frame all objects.

Remarks:

The camera must be in a scene for this function to work properly.

void FrameSelected

(

)

Search for all occurrences

Change camera position and look at to frame all selected objects.

Remarks:

The camera must be in a scene for this function to work properly.

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.

---

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

• fbxfilesdk/kfbxplugins/kfbxmanipulators.h