This reference page is linked to from the following overview topics: FBX Node Attributes, Cameras, List of Python FBX classes.
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.
- See also:
- KFbxCamera KFbxCameraSwitcher
- Examples:
Definition at line 55 of file kfbxcamerastereo.h.
#include <kfbxcamerastereo.h>
Public Types |
|
| enum | ECameraStereo { eNONE, eCONVERGED, eOFF_AXIS, ePARALLEL } |
|
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 () const |
| Get the left camera which connect to
property LeftCamera. |
|
| KFbxCamera * | GetRightCamera () const |
| 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 () const |
| Get local matrix of left camera. |
|
| KFbxXMatrix | GetLeftCameraGlobalMatrix () const |
| Get global matrix of left camera. |
|
| KFbxXMatrix | GetRightCameraLocalMatrix () const |
| Get local matrix of right camera. |
|
| KFbxXMatrix | GetRightCameraGlobalMatrix () const |
| Get global matrix of right camera. |
|
| double | ReevaluateLeftCameraFilmOffsetX () const |
| Reevaluate the FilmOffsetX of left camera.
|
|
| double | ReevaluateRightCameraFilmOffsetX () const |
| Reevaluate the FilmOffsetX of right camera.
|
|
| bool | ConnectProperties () |
| connect left and right camera property to
stereo 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< fbxReference > | RightCamera |
| This property has the right camera connected
to it. |
|
| KFbxTypedProperty< fbxReference > | LeftCamera |
| This property has the left camera connected
to it. |
|
| KFbxTypedProperty< fbxString > | PrecompFileName |
| This property handles the precomp file name.
|
|
| KFbxTypedProperty< fbxString > | RelativePrecompFileName |
| This property handles the relative precomp
file name. |
|
Protected Member Functions |
|
| KFbxCameraStereo (KFbxSdkManager &pManager, char const *pName) | |
| virtual bool | ConstructProperties (bool pForceSet) |
| virtual KStringList | GetTypeFlags () const |
| Used to retrieve the KProperty list from an
attribute. |
|
Friends |
|
| class | KFbxGlobalCameraSettings |
| class | KFbxNode |
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 72 of file kfbxcamerastereo.h.
{
eNONE,
eCONVERGED,
eOFF_AXIS,
ePARALLEL
} ECameraStereo;
Constructor & Destructor Documentation
| KFbxCameraStereo | ( | KFbxSdkManager & | pManager, |
| char const * | pName | ||
| ) | [protected] |
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 | ( | ) | const |
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.
- Examples:
- StereoCamera/main.cxx.
| KFbxCamera* GetRightCamera | ( | ) | const |
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.
- Examples:
- StereoCamera/main.cxx.
| 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.
- Examples:
- StereoCamera/main.cxx.
| 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.
- Examples:
- StereoCamera/main.cxx.
| KFbxXMatrix GetLeftCameraLocalMatrix | ( | ) | const |
Get local matrix of left camera.
- Returns:
- KFbxXMatrix.
- Remarks:
- Use this method to reevaluate the local transformation of left camera.
- Examples:
- StereoCamera/main.cxx.
| KFbxXMatrix GetLeftCameraGlobalMatrix | ( | ) | const |
Get global matrix of left camera.
- Returns:
- KFbxXMatrix.
- Remarks:
- Use this method to reevaluate the global transformation of left camera.
- Examples:
- StereoCamera/main.cxx.
| KFbxXMatrix GetRightCameraLocalMatrix | ( | ) | const |
Get local matrix of right camera.
- Returns:
- KFbxXMatrix.
- Remarks:
- Use this method to reevaluate the local transformation of right camera.
- Examples:
- StereoCamera/main.cxx.
| KFbxXMatrix GetRightCameraGlobalMatrix | ( | ) | const |
Get global matrix of right camera.
- Returns:
- KFbxXMatrix.
- Remarks:
- Use this method to reevaluate the global transformation of right camera.
- Examples:
- StereoCamera/main.cxx.
| double ReevaluateLeftCameraFilmOffsetX | ( | ) | const |
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
- Examples:
- StereoCamera/main.cxx.
| double ReevaluateRightCameraFilmOffsetX | ( | ) | const |
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
- Examples:
- StereoCamera/main.cxx.
| bool ConnectProperties | ( | ) |
connect left and right camera property to stereo camera.
- Returns:
- true if it's successful, otherwise return false.
- Remarks:
- It's used to connect the left/right camera property [FocalLength, FarPlane, NearPlane, FilmWidth, FilmHeight, FilmSqueezeRatio] to stereo camera. During FBX SDK reevaluating, if ConnectProperties is called, to get the newest FocalLength property of left camera, please use lLeft_Camera->FocalLength.GetSrcProperty();
- Examples:
- StereoCamera/main.cxx.
| virtual bool ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
Reimplemented from KFbxCamera.
| virtual KStringList GetTypeFlags | ( | ) | const [protected, virtual] |
Used to retrieve the KProperty list from an attribute.
Reimplemented from KFbxCamera.
Friends And Related Function Documentation
friend class KFbxGlobalCameraSettings
[friend] |
Reimplemented from KFbxCamera.
Definition at line 260 of file kfbxcamerastereo.h.
friend class KFbxNode [friend] |
Reimplemented from KFbxCamera.
Definition at line 284 of file kfbxcamerastereo.h.
Member Data Documentation
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 eNONE.
Definition at line 165 of file kfbxcamerastereo.h.
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 174 of file kfbxcamerastereo.h.
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 183 of file kfbxcamerastereo.h.
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 193 of file kfbxcamerastereo.h.
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 202 of file kfbxcamerastereo.h.
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 211 of file kfbxcamerastereo.h.
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 220 of file kfbxcamerastereo.h.
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 229 of file kfbxcamerastereo.h.
This property handles the precomp file name.
To access this property do: PrecompFileName.Get(). To set this property do: PrecompFileName.Set(fbxString).
Default value is ""
Definition at line 249 of file kfbxcamerastereo.h.
This property handles the relative precomp file name.
To access this property do: RelativePrecompFileName.Get(). To set this property do: RelativePrecompFileName.Set(fbxString).
Default value is ""
Definition at line 258 of file kfbxcamerastereo.h.
The documentation for this class was generated from the following file:
- fbxfilesdk/kfbxplugins/kfbxcamerastereo.h
