KFbxCameraStereo Class Reference

#include <kfbxcamerastereo.h>

Inheritance diagram for KFbxCameraStereo:

[legend]

List of all members.

---

Detailed Description

This node attribute contains methods for accessing the properties of a stereo camera.

Generally, a set of stereoRig contains the center camera, the left camera and the right camera. KFbxCameraStereo is used to represent the center camera. The left and right camera could be KFbxCamera. KFbxCameraStereo contains stereo properties. The left and right camera can also be get and set via related methods in KFbxCameraStereo class.

Definition at line 61 of file kfbxcamerastereo.h.

Public Types
enum	ECameraStereo
	Types of Stereo camera. More...
Public Member Functions
virtual EAttributeType	GetAttributeType () const
	Return the type of node attribute which is EAttributeType::eCAMERA_STEREO.
void	Reset ()
	Reset the stereo camera to default values.
KFbxCamera *	GetLeftCamera ()
	Get the left camera which connect to property LeftCamera.
KFbxCamera *	GetRightCamera ()
	Get the right camera which connect to property RightCamera.
bool	SetLeftCamera (KFbxCamera *pCamera)
	Set the left camera, connect property LeftCamera to pCamera.
bool	SetRightCamera (KFbxCamera *pCamera)
	Set the right camera, connect property RightCamera to pCamera.
KFbxXMatrix	GetLeftCameraLocalMatrix ()
	Get local matrix of left camera.
KFbxXMatrix	GetLeftCameraGlobalMatrix ()
	Get global matrix of left camera.
KFbxXMatrix	GetRightCameraLocalMatrix ()
	Get local matrix of right camera.
KFbxXMatrix	GetRightCameraGlobalMatrix ()
	Get global matrix of right camera.
KFbxXMatrix	GetStereoCameraLocalMatrix ()
	Get local matrix of stereo camera.
KFbxXMatrix	GetStereoCameraGlobalMatrix ()
	Get global matrix of stereo camera.
double	ReevaluateLeftCameraFilmOffsetX ()
	Reevaluate the FilmOffsetX of left camera.
double	ReevaluateRightCameraFilmOffsetX ()
	Reevaluate the FilmOffsetX of right camera.
Public Attributes
KFbxTypedProperty< ECameraStereo >	Stereo
	This property handles the types of Stereo camera.
KFbxTypedProperty< fbxDouble1 >	InteraxialSeparation
	This property handles the distance between left and right cameras.
KFbxTypedProperty< fbxDouble1 >	ZeroParallax
	This property handles the distance on the camera view axis where the zero parallax plane occurs.
KFbxTypedProperty< fbxDouble1 >	ToeInAdjust
	This property is to offset the computed toe-in effect when it's in Converged mode.
KFbxTypedProperty< fbxDouble1 >	FilmOffsetRightCam
	This property handles the film offset for the right camera.
KFbxTypedProperty< fbxDouble1 >	FilmOffsetLeftCam
	This property handles the film offset for the left camera.
KFbxTypedProperty< fbxDouble1 >	ZeroOffset
	This property used to control the FilmOffsetX of left and right camera.
KFbxTypedProperty< fbxReference >	RightCamera
	This property has the right camera connected to it.
KFbxTypedProperty< fbxReference >	LeftCamera
	This property has the left camera connected to it.

---

Member Enumeration Documentation

enum ECameraStereo

Types of Stereo camera.

• eNONE Disable the stereo effect.(Default value)
• eCONVERGED Computes the zero parallax plane by toeing in the cameras.
• eOFF_AXIS Computes the convergence plane by shifting the frustum using camera film back.
• ePARALLEL A parallel camera setup where there is effectively no convergence plane.

Definition at line 80 of file kfbxcamerastereo.h.

---

Member Function Documentation

virtual EAttributeType GetAttributeType

(

)

const [virtual]

Return the type of node attribute which is EAttributeType::eCAMERA_STEREO.

Reimplemented from KFbxCamera.

void Reset

(

)

Reset the stereo camera to default values.

Reimplemented from KFbxCamera.

KFbxCamera* GetLeftCamera

(

)

Get the left camera which connect to property LeftCamera.

Returns:

a pointer to KFbxCamera.

Remarks:

current KFbxCameraStereo should work with two KFbxCamera, left camera and right camera. Use this method to get the left camera.

KFbxCamera* GetRightCamera

(

)

Get the right camera which connect to property RightCamera.

Returns:

a pointer to KFbxCamera.

Remarks:

current KFbxCameraStereo should work with two KFbxCamera, left camera and right camera. Use this method to get the right camera.

bool SetLeftCamera

(

KFbxCamera *

pCamera

)

Set the left camera, connect property LeftCamera to pCamera.

Parameters:

pCamera

The camera to set

Returns:

true if it's successful, otherwise return false.

Remarks:

current KFbxCameraStereo should work with two KFbxCamera, left camera and right camera. Use this method to set the left camera.

bool SetRightCamera

(

KFbxCamera *

pCamera

)

Set the right camera, connect property RightCamera to pCamera.

Parameters:

pCamera

The camera to set

Returns:

true if it's successful, otherwise return false.

Remarks:

current KFbxCameraStereo should work with two KFbxCamera, left camera and right camera. Use this method to set the right camera.

KFbxXMatrix GetLeftCameraLocalMatrix

(

)

Get local matrix of left camera.

Returns:

KFbxXMatrix.

Remarks:

Use this method to reevaluate the local transformation of left camera.

KFbxXMatrix GetLeftCameraGlobalMatrix

(

)

Get global matrix of left camera.

Returns:

KFbxXMatrix.

Remarks:

Use this method to reevaluate the global transformation of left camera.

KFbxXMatrix GetRightCameraLocalMatrix

(

)

Get local matrix of right camera.

Returns:

KFbxXMatrix.

Remarks:

Use this method to reevaluate the local transformation of right camera.

KFbxXMatrix GetRightCameraGlobalMatrix

(

)

Get global matrix of right camera.

Returns:

KFbxXMatrix.

Remarks:

Use this method to reevaluate the global transformation of right camera.

KFbxXMatrix GetStereoCameraLocalMatrix

(

)

Get local matrix of stereo camera.

Returns:

KFbxXMatrix.

Remarks:

Use this method to reevaluate the local transformation of stereo camera(center camera).

KFbxXMatrix GetStereoCameraGlobalMatrix

(

)

Get global matrix of stereo camera.

Returns:

KFbxXMatrix.

Remarks:

Use this method to reevaluate the global transformation of stereo camera(center camera).

double ReevaluateLeftCameraFilmOffsetX

(

)

Reevaluate the FilmOffsetX of left camera.

It's computed through stereo camera properties.

Returns:

Current FilmOffsetX value.

Remarks:

This method does NOT set the FilmOffsetX of left camera

double ReevaluateRightCameraFilmOffsetX

(

)

Reevaluate the FilmOffsetX of right camera.

It's computed through stereo camera properties.

Returns:

Current FilmOffsetX value

Remarks:

this method does NOT set the FilmOffsetX of right camera

---

Member Data Documentation

KFbxTypedProperty<ECameraStereo> Stereo

This property handles the types of Stereo camera.

To access this property do: Stereo.Get(). To set this property do: Stereo.Set(ECameraStereo).

Remarks:

Default Value is eOFF_AXIS. It is the safer way to compute stereo image pairs and avoids keystone artifacts.

Definition at line 185 of file kfbxcamerastereo.h.

KFbxTypedProperty<fbxDouble1> InteraxialSeparation

This property handles the distance between left and right cameras.

To access this property do: InteraxialSeparation.Get(). To set this property do: InteraxialSeparation.Set(fbxDouble1).

Remarks:

Default Value is 0.0

Definition at line 194 of file kfbxcamerastereo.h.

KFbxTypedProperty<fbxDouble1> ZeroParallax

This property handles the distance on the camera view axis where the zero parallax plane occurs.

To access this property do: ZeroParallax.Get(). To set this property do: ZeroParallax.Set(fbxDouble1).

Remarks:

Default Value is 0.0

Definition at line 203 of file kfbxcamerastereo.h.

KFbxTypedProperty<fbxDouble1> ToeInAdjust

This property is to offset the computed toe-in effect when it's in Converged mode.

To access this property do: ToeInAdjust.Get(). To set this property do: ToeInAdjust.Set(fbxDouble1).

Remarks:

Default Value is 0.0. This value is specified in degrees and acts as an offset to the computed toe-in.

Definition at line 213 of file kfbxcamerastereo.h.

KFbxTypedProperty<fbxDouble1> FilmOffsetRightCam

This property handles the film offset for the right camera.

To access this property do: FilmOffsetRightCam.Get(). To set this property do: FilmOffsetRightCam.Set(fbxDouble1).

Remarks:

Default Value is 0.0

Definition at line 222 of file kfbxcamerastereo.h.

KFbxTypedProperty<fbxDouble1> FilmOffsetLeftCam

This property handles the film offset for the left camera.

To access this property do: FilmOffsetLeftCam.Get(). To set this property do: FilmOffsetLeftCam.Set(fbxDouble1).

Remarks:

Default Value is 0.0

Definition at line 231 of file kfbxcamerastereo.h.

KFbxTypedProperty<fbxDouble1> ZeroOffset

This property used to control the FilmOffsetX of left and right camera.

To access this property do: ZeroOffset.Get(). To set this property do: ZeroOffset.Set(fbxDouble1).

Remarks:

its value is always 0.

Definition at line 240 of file kfbxcamerastereo.h.

KFbxTypedProperty<fbxReference> RightCamera

This property has the right camera connected to it.

To access this property do: GetRightCamera(). To set this property do: SetRightCamera(KFbxCamera* pCamera).

Remarks:

they are connected as source objects

Definition at line 249 of file kfbxcamerastereo.h.

KFbxTypedProperty<fbxReference> LeftCamera

This property has the left camera connected to it.

To access this property do: GetLeftCamera(). To set this property do: SetLeftCamera(KFbxCamera* pCamera).

Remarks:

they are connected as source objects

Definition at line 258 of file kfbxcamerastereo.h.