This reference page is linked to from the following overview topics: Scene Elements, FBModel - Transformation Data and the Scene Graph, FBCamera - Cameras.
Detailed Description
Creates custom cameras and manages system cameras.
When you look at a scene in the MotionBuilder Viewer, you are using a camera view.
There are two types of cameras:
- Producer cameras. By default one of the producer cameras is used. These are always present. They can be configured but not destroyed.
- Custom cameras, created by the user.
The SystemCamera property indicates whether a given camera is a producer or a custom camera.
When you create a camera you should make it visible with the show property (inherited from FBModel).
Use FBCameraSwitcher to get and set the current camera. For usage, see the Python sample CameraSwitcher.py.
To see how to create a camera with a marker as an interest, see the Python sample code in FBCamera.py. For usage in C++, see the manipcamera sample.
#include <fbmodel.h>
Public Member Functions |
|
| FBCamera (const char *pName, HIObject pObject=NULL) | |
| Constructor. |
|
| double * | GetMatrix (FBCameraMatrixType pType) |
| Obtain the camera's transformation matrix
(either Model or Projection View). |
|
Public Attributes |
|
| FBPropertyBool | SystemCamera |
| Read Only Property: Indicate if this
a producer (default or system) camera or a custom (user-created)
camera. |
|
| FBPropertyCameraFrameSizeMode | FrameSizeMode |
| Read Write Property: Frame size
standard mode. |
|
| FBPropertyCameraResolutionMode | ResolutionMode |
| Read Write Property: Resolution
standard mode. |
|
| FBPropertyDouble | ResolutionWidth |
| Read Write Property: Resolution
width. |
|
| FBPropertyDouble | ResolutionHeight |
| Read Write Property: Resolution
height. |
|
| FBPropertyDouble | WindowHeight |
| Read Only Property: Window height.
|
|
| FBPropertyDouble | PixelAspectRatio |
| Read Write Property: Pixel aspect
ratio. |
|
| FBPropertyDouble | NearPlaneDistance |
| Read Write Property: Near plane
distance. |
|
| FBPropertyDouble | FarPlaneDistance |
| Read Write Property: Far plane
distance. |
|
| FBPropertyBool | MouseLockCamera |
| Read Write Property: Mouse lock for
camera? |
|
| FBPropertyCameraType | Type |
| Read Write Property: Type of camera
|
|
| FBPropertyCameraApertureMode | ApertureMode |
| Read Write Property: Aperture mode.
|
|
| FBPropertyAnimatableDouble | FieldOfView |
| Read Write Property: Field of View
(used when in horizontal or vertical aperture modes). |
|
| FBPropertyAnimatableDouble | FieldOfViewX |
| Read Write Property: Field of View X
angle (used in horizontal and vertical aperture mode). |
|
| FBPropertyAnimatableDouble | FieldOfViewY |
| Read Write Property: Field of View Y
angle (used in horizontal and vertical aperture mode). |
|
| FBPropertyAnimatableDouble | OpticalCenterX |
| Read Write Property: Optical Center X
(mm). |
|
| FBPropertyAnimatableDouble | OpticalCenterY |
| Read Write Property: Optical Center Y
(mm). |
|
| FBPropertyAnimatableDouble | FocalLength |
| Read Write Property: Focal Length.
|
|
| FBPropertyCameraFilmBackType | FilmBackType |
| Read Write Property: Film back
standard type. |
|
| FBPropertyDouble | FilmSizeWidth |
| Read Write Property: Width of the
film. |
|
| FBPropertyDouble | FilmSizeHeight |
| Read Write Property: Height of the
film. |
|
| FBPropertyDouble | FilmAspectRatio |
| Read Write Property: Film aspect
ratio. |
|
| FBPropertyDouble | SqueezeRatio |
| Read Write Property: Squeeze ratio.
|
|
| FBPropertyDouble | OrthoZoom |
| Read Write Property: Zoom factor of
an orthographic camera. |
|
| FBPropertyVideo | BackGroundMedia |
| Read Write Property: BackGround Image
|
|
| FBPropertyCameraViewPlaneMode | ViewBackGroundPlaneMode |
| Read Write Property: Background plane
view mode |
|
| FBPropertyBool | BackGroundImageCenter |
| Read Write Property: Center the
background image |
|
| FBPropertyBool | BackGroundImageFit |
| Read Write Property: Fit the
background image |
|
| FBPropertyBool | BackGroundImageKeepRatio |
| Read Write Property: Keep the
background image's ratio |
|
| FBPropertyBool | BackGroundImageCrop |
| Read Write Property: Crop the
background image |
|
| FBPropertyDouble | BackGroundPlaneDistance |
| Read Write Property: Set the distance
for the background plane. |
|
| FBPropertyCameraDistanceMode | BackGroundPlaneDistanceMode |
| Read Write Property: Select mode for
the background plane's distance. |
|
| FBPropertyAnimatableDouble | ForeGroundAlpha |
| Read Write Property: Opacity of
foreground. |
|
| FBPropertyDouble | ForeGroundMaterialThreshold |
| Read Write Property: Material
threshold for a transparent foreground. |
|
| FBPropertyBool | ForeGroundTransparent |
| Read Write Property: Is the
foreground transparent? |
|
| FBPropertyVideo | ForeGroundMedia |
| Read Write Property: ForeGround Image
|
|
| FBPropertyCameraViewPlaneMode | ViewForeGroundPlaneMode |
| Read Write Property: Foreground plane
view mode |
|
| FBPropertyBool | ForeGroundImageCenter |
| Read Write Property: Center the
foreground image |
|
| FBPropertyBool | ForeGroundImageFit |
| Read Write Property: Fit the
foreground image |
|
| FBPropertyBool | ForeGroundImageKeepRatio |
| Read Write Property: Keep the
foreground image's ratio? |
|
| FBPropertyBool | ForeGroundImageCrop |
| Read Write Property: Crop the
foreground image |
|
| FBPropertyDouble | ForeGroundPlaneDistance |
| Read Write Property: Set the distance
for the foreground plane. |
|
| FBPropertyCameraDistanceMode | ForeGroundPlaneDistanceMode |
| Read Write Property: Select mode for
the foreground plane's distance. |
|
| FBPropertyBool | ViewCameraInterest |
| Read Write Property: Show the camera
interest? |
|
| FBPropertyBool | ViewNearFarPlane |
| Read Write Property: Show near/far
planes? |
|
| FBPropertyBool | ViewShowGrid |
| Read Write Property: Show grid?
|
|
| FBPropertyBool | ViewShowAxis |
| Read Write Property: Show axis?
|
|
| FBPropertyBool | ViewShowTimeCode |
| Read Write Property: Show time code?
|
|
| FBPropertyBool | ViewDisplaySafeArea |
| Read Write Property: Display safe
area? |
|
| FBPropertyBool | ViewOpticalCenter |
| Read Write Property: View optical
center? |
|
| FBPropertyCameraSafeAreaMode | SafeAreaMode |
| Read Write Property: Select mode for
safe area. |
|
| FBPropertyAnimatableColor | BackGroundColor |
| Read Write Property: Background color
for camera. |
|
| FBPropertyBool | UseFrameColor |
| Read Write Property: Use frame color?
|
|
| FBPropertyColor | FrameColor |
| Read Write Property: Frame color for
camera. |
|
| FBPropertyBool | UseAntiAliasing |
| Read Write Property: Use
anti-aliasing? |
|
| FBPropertyBool | UseDepthOfField |
| Read Write Property: Use depth of
field calculations? |
|
| FBPropertyBool | InteractiveMode |
| Read Write Property: Interactive
mode? |
|
| FBPropertyDouble | AntiAliasingIntensity |
| Read Write Property: Anti-aliasing
intensity. |
|
| FBPropertyCameraAntiAliasingMethod | AntiAliasingMethod |
| Read Write Property: Anti-aliasing
method. |
|
| FBPropertyInt | NumberOfSamples |
| Read Write Property: Number of
samples to oversample with. |
|
| FBPropertyCameraSamplingType | SamplingType |
| Read Write Property: Type of over
sampling. |
|
| FBPropertyBool | UseAccumulationBuffer |
| Read Write Property: Use accumulation
buffer? |
|
| FBPropertyCameraFocusDistanceSource | FocusDistanceSource |
| Read Write Property: Select source
for focusing. |
|
| FBPropertyDouble | FocusSpecificDistance |
| Read Write Property: Specfic distance
for focusing. |
|
| FBPropertyDouble | FocusAngle |
| Read Write Property: Focus Angle
(rendering dof). |
|
| FBPropertyBool | Use2DMagnifier |
| Read Write Property: Enable/Disable
the 2D Magnifier. |
|
| FBPropertyBool | Display2DMagnifierFrame |
| Read Write Property: Enable/Disable
the drawing of the 2D Magnifier frame box. |
|
| FBPropertyAnimatableDouble | MagnifierZoom |
| Read Write Property: 2D Magnifier
Zoom value. |
|
| FBPropertyAnimatableDouble | MagnifierPosX |
| Read Write Property: 2D Magnifier X
Position. |
|
| FBPropertyAnimatableDouble | MagnifierPosY |
| Read Write Property: 2D Magnifier Y
Position. |
|
| FBPropertyModel | Interest |
| Read Write Property: Direct camera's
interest. |
|
| FBPropertyAnimatableDouble | Roll |
| Read Write Property: Camera's roll on
it's Z axis. |
|
| FBPropertyAnimatableDouble | TurnTable |
| Read Write Property: Camera's
rotation around its interest. |
|
| FBPropertyBool | DisplayTurnTableIcon |
| Read Write Property: Enable/Disable
the drawing of the Turn Table icon. |
|
| FBPropertyAnimatableDouble | MotionBlurIntensity |
| Read Write Property: Motion Blur
Intensity. |
|
| FBPropertyBool | UseMotionBlur |
| Read Write Property: Enable Motion
Blur. |
|
| FBPropertyBool | UseRealTimeMotionBlur |
| Read Write Property: Enable Real-time
Motion Blur. |
|
| FBPropertyInt | CameraViewportX |
| Read Only Property: Camera Viewport
start position's X value |
|
| FBPropertyInt | CameraViewportY |
| Read Only Property: Camera Viewport
start position's Y value |
|
| FBPropertyInt | CameraViewportWidth |
| Read Only Property: Camera Viewport
width |
|
| FBPropertyInt | CameraViewportHeight |
| Read Only Property: Camera Viewport
height |
|
| FBPropertyListHUD | HUDs |
| List : HUDs present in this camera
|
|
Static Public Attributes |
|
| static const double | OrthoFactor |
| Constant scale factor to be used with
OrthoZoom
for orthographic cameras. |
|
Constructor & Destructor Documentation
| FBCamera | ( | const char * | pName, |
| HIObject | pObject =
NULL |
||
| ) |
Constructor.
- Parameters:
-
pName Name of camera. pObject For internal use only(default=NULL).
Member Function Documentation
| double* GetMatrix | ( | FBCameraMatrixType | pType | ) |
Obtain the camera's transformation matrix (either Model or Projection View).
- Parameters:
-
pType Matrix type to obtain.
- Returns:
- Matrix of doubles (the camera's matrix in question).
Member Data Documentation
Read Only Property: Indicate if this a producer (default or system) camera or a custom (user-created) camera.
| FBPropertyCameraFrameSizeMode FrameSizeMode |
Read Write Property: Frame size standard mode.
| FBPropertyCameraResolutionMode ResolutionMode |
Read Write Property: Resolution standard mode.
Read Write Property: Resolution width.
Read Write Property: Resolution height.
Read Only Property: Window height.
Read Write Property: Pixel aspect ratio.
Read Write Property: Near plane distance.
Read Write Property: Far plane distance.
Read Write Property: Mouse lock for camera?
| FBPropertyCameraType Type |
Read Write Property: Type of camera
| FBPropertyCameraApertureMode ApertureMode |
Read Write Property: Aperture mode.
Read Write Property: Field of View (used when in horizontal or vertical aperture modes).
Read Write Property: Field of View X angle (used in horizontal and vertical aperture mode).
Read Write Property: Field of View Y angle (used in horizontal and vertical aperture mode).
Read Write Property: Optical Center X (mm).
Read Write Property: Optical Center Y (mm).
Read Write Property: Focal Length.
| FBPropertyCameraFilmBackType FilmBackType |
Read Write Property: Film back standard type.
Read Write Property: Width of the film.
Read Write Property: Height of the film.
Read Write Property: Film aspect ratio.
Read Write Property: Squeeze ratio.
const double OrthoFactor
[static] |
Constant scale factor to be used with OrthoZoom for orthographic cameras.
Read Write Property: Zoom factor of an orthographic camera.
OrthoZoom is only applicable if the camera has orthographic
projection (i.e., Type ==
FBCameraType::kFBCameraTypeOrthogonal).
This value changes when the orthographic camera is zoomed in or
out.
Refer to the following code if you wish to compute the left, right,
top, and bottom view planes of the camera.
double lW = mCam.CameraViewportWidth;
double lH = mCam.CameraViewportHeight;
double lPixelRatio = mCam.PixelAspectRatio;
const double lFactor = mCam.OrthoZoom * FBCamera::OrthoFactor;
if( lW < lH )
{
mLeftPlane = -lFactor * lPixelRatio;
mRightPlane = lFactor * lPixelRatio;
mBottomPlane = -(lFactor * lH) / lW;
mTopPlane = (lFactor * lH) / lW;
}
else
{
lW *= lPixelRatio;
mLeftPlane = -(lFactor * lW) / lH;
mRightPlane = (lFactor * lW) / lH;
mBottomPlane = -lFactor;
mTopPlane = lFactor;
}
| FBPropertyVideo BackGroundMedia |
Read Write Property: BackGround Image
| FBPropertyCameraViewPlaneMode ViewBackGroundPlaneMode |
Read Write Property: Background plane view mode
Read Write Property: Center the background image
Read Write Property: Fit the background image
Read Write Property: Keep the background image's ratio
Read Write Property: Crop the background image
Read Write Property: Set the distance for the background plane.
| FBPropertyCameraDistanceMode BackGroundPlaneDistanceMode |
Read Write Property: Select mode for the background plane's distance.
Read Write Property: Opacity of foreground.
Read Write Property: Material threshold for a transparent foreground.
Read Write Property: Is the foreground transparent?
| FBPropertyVideo ForeGroundMedia |
Read Write Property: ForeGround Image
| FBPropertyCameraViewPlaneMode ViewForeGroundPlaneMode |
Read Write Property: Foreground plane view mode
Read Write Property: Center the foreground image
Read Write Property: Fit the foreground image
Read Write Property: Keep the foreground image's ratio?
Read Write Property: Crop the foreground image
Read Write Property: Set the distance for the foreground plane.
| FBPropertyCameraDistanceMode ForeGroundPlaneDistanceMode |
Read Write Property: Select mode for the foreground plane's distance.
Read Write Property: Show the camera interest?
Read Write Property: Show near/far planes?
Read Write Property: Show grid?
Read Write Property: Show axis?
Read Write Property: Show time code?
Read Write Property: Display safe area?
Read Write Property: View optical center?
| FBPropertyCameraSafeAreaMode SafeAreaMode |
Read Write Property: Select mode for safe area.
Read Write Property: Background color for camera.
Read Write Property: Use frame color?
Read Write Property: Frame color for camera.
Read Write Property: Use anti-aliasing?
Read Write Property: Use depth of field calculations?
Read Write Property: Interactive mode?
Read Write Property: Anti-aliasing intensity.
| FBPropertyCameraAntiAliasingMethod AntiAliasingMethod |
Read Write Property: Anti-aliasing method.
Read Write Property: Number of samples to oversample with.
| FBPropertyCameraSamplingType SamplingType |
Read Write Property: Type of over sampling.
Read Write Property: Use accumulation buffer?
| FBPropertyCameraFocusDistanceSource FocusDistanceSource |
Read Write Property: Select source for focusing.
Read Write Property: Specfic distance for focusing.
Read Write Property: Focus Angle (rendering dof).
Read Write Property: Enable/Disable the 2D Magnifier.
Read Write Property: Enable/Disable the drawing of the 2D Magnifier frame box.
Read Write Property: 2D Magnifier Zoom value.
Read Write Property: 2D Magnifier X Position.
Read Write Property: 2D Magnifier Y Position.
| FBPropertyModel Interest |
Read Write Property: Direct camera's interest.
Read Write Property: Camera's roll on it's Z axis.
Read Write Property: Camera's rotation around its interest.
Read Write Property: Enable/Disable the drawing of the Turn Table icon.
Read Write Property: Motion Blur Intensity.
Read Write Property: Enable Motion Blur.
Read Write Property: Enable Real-time Motion Blur.
Read Only Property: Camera Viewport start position's X value
Read Only Property: Camera Viewport start position's Y value
Read Only Property: Camera Viewport width
Read Only Property: Camera Viewport height
List : HUDs present in this camera
The documentation for this class was generated from the following file:
- fbsdk/fbmodel.h
