FbxCameraManipulator Class Reference
 
 
 
FbxCameraManipulator Class Reference

This reference page is linked to from the following overview topics: FBX SDK 2014.


#include <fbxmanipulators.h>


Class Description

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

Definition at line 30 of file fbxmanipulators.h.

Inheritance diagram for FbxCameraManipulator:
FbxObject FbxEmitter

List of all members.

Public Types

enum   EAction {
  eNone, eOrbit, eDolly, ePan,
  eFreePan
}
  All possible manipulation actions that can be performed on a camera using this manipulator. More...

Public Member Functions

void  Begin (EAction pAction, float pX, float pY)
  Begin manipulation of the camera.
void  Notify (float pX, float pY, float pZ=0)
  Notify manipulation of latest input.
void  End ()
  End current manipulation.
void  FrameAll (const FbxTime &pTime=FBXSDK_TIME_INFINITE, int pOnAnimLayer=0)
  Change camera position, rotation and LookAt node to frame all objects.
void  FrameSelected (const FbxTime &pTime=FBXSDK_TIME_INFINITE, int pOnAnimLayer=0)
  Change camera position, rotation and LookAt to frame all selected objects.
EAction  GetCurrentAction () const
  Retrieve current manipulation action.

Public Attributes

FbxPropertyT< FbxReference Camera
  The camera controlled by the manipulator.
FbxPropertyT< FbxFloat ViewportWidth
  Width of the camera viewport, in pixels.
FbxPropertyT< FbxFloat ViewportHeight
  Height of the camera viewport, in pixels.
FbxPropertyT< FbxBool Restore
  Restore the camera transform upon destruction of the manipulator.

Member Enumeration Documentation

enum EAction

All possible manipulation actions that can be performed on a camera using this manipulator.

Enumerator:
eNone 

No action.

eOrbit 

Orbiting camera around LootAt/Interest position.

eDolly 

Moving camera closer or away from its LookAt/Intest position.

ePan 

Panning camera up, down and sideways.

eFreePan 

Panning and dollying all at once.

Definition at line 36 of file fbxmanipulators.h.


Member Function Documentation

void Begin ( EAction  pAction,
float  pX,
float  pY 
)

Begin manipulation of the camera.

Parameters:
pAction The action performed for this manipulation scope.
pX Begin horizontal position of the manipulation, in pixels.
pY Begin vertical position of the manipulation, in pixels.
void Notify ( float  pX,
float  pY,
float  pZ = 0 
)

Notify manipulation of latest input.

Parameters:
pX Horizontal position of the manipulation, in pixels.
pY Vertical position of the manipulation, in pixels.
pZ Depth position of the manipulation, in pixels. Only used by eDollyPan action.
void End ( )

End current manipulation.

void FrameAll ( const FbxTime pTime = FBXSDK_TIME_INFINITE,
int  pOnAnimLayer = 0 
)

Change camera position, rotation and LookAt node to frame all objects.

Parameters:
pTime Current time.
pOnAnimLayer Specify which animation layer to use for the evaluation.
void FrameSelected ( const FbxTime pTime = FBXSDK_TIME_INFINITE,
int  pOnAnimLayer = 0 
)

Change camera position, rotation and LookAt to frame all selected objects.

Parameters:
pTime Current time.
pOnAnimLayer Specify which animation layer to use for the evaluation.
EAction GetCurrentAction ( ) const

Retrieve current manipulation action.

Returns:
The action currently performed by the camera manipulator.

Member Data Documentation

The camera controlled by the manipulator.

Definition at line 75 of file fbxmanipulators.h.

Width of the camera viewport, in pixels.

This is used to accurately calculate to movement speed.

Remarks:
If this property is not correctly set, movements will be erronous.

Definition at line 79 of file fbxmanipulators.h.

Height of the camera viewport, in pixels.

This is used to accurately calculate to movement speed.

Remarks:
If this property is not correctly set, movements will be erronous.

Definition at line 83 of file fbxmanipulators.h.

Restore the camera transform upon destruction of the manipulator.

Definition at line 86 of file fbxmanipulators.h.


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