FBCamera Class Reference

FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera FBCamera
Inheritance diagram for FBCamera:
Inheritance graph
[legend]

List of all members.


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.

See samples: NewCamera.py, RenderLayers.py, CameraSwitcher.py, SetAllCamerasBackgroundColor.py, SetAllCamerasBackgroundColorFromCurrentCamera.py, SetAllCamerasBackgroundColorFromFirstSelectedCamera.py, FBCamera.py.


Public Member Functions

  FBCamera (str pName)
  Constructor.

Public Attributes

float  AntiAliasingIntensity
  Read Write Property: Anti-aliasing intensity.
FBCameraAntiAliasingMethod  AntiAliasingMethod
  Read Write Property: Anti-aliasing method.
FBCameraApertureMode  ApertureMode
  Read Write Property: Aperture mode.
FBAnimatableColor  BackGroundColor
  Read Write Property: Background color for camera.
bool  BackGroundImageCenter
  Read Write Property: Center the background image
bool  BackGroundImageCrop
  Read Write Property: Crop the background image
bool  BackGroundImageFit
  Read Write Property: Fit the background image
bool  BackGroundImageKeepRatio
  Read Write Property: Keep the background image's ratio
FBVideo  BackGroundMedia
  Read Write Property: BackGround Image
float  BackGroundPlaneDistance
  Read Write Property: Set the distance for the background plane.
FBCameraDistanceMode  BackGroundPlaneDistanceMode
  Read Write Property: Select mode for the background plane's distance.
bool  Display2DMagnifierFrame
  Read Write Property: Enable/Disable the drawing of the 2D Magnifier frame box.
bool  DisplayTurnTableIcon
  Read Write Property: Enable/Disable the drawing of the Turn Table icon.
float  FarPlaneDistance
  Read Write Property: Far plane distance.
FBAnimatableDouble  FieldOfView
  Read Write Property: Field of View (used when in horizontal or vertical aperture modes).
FBAnimatableDouble  FieldOfViewX
  Read Write Property: Field of View X angle (used in horizontal and vertical aperture mode).
FBAnimatableDouble  FieldOfViewY
  Read Write Property: Field of View Y angle (used in horizontal and vertical aperture mode).
float  FilmAspectRatio
  Read Write Property: Film aspect ratio.
FBCameraFilmBackType  FilmBackType
  Read Write Property: Film back standard type.
float  FilmSizeHeight
  Read Write Property: Height of the film.
float  FilmSizeWidth
  Read Write Property: Width of the film.
FBAnimatableDouble  FocalLength
  Read Write Property: Focal Length.
float  FocusAngle
  Read Write Property: Focus Angle (rendering dof).
FBCameraFocusDistanceSource  FocusDistanceSource
  Read Write Property: Select source for focusing.
float  FocusSpecificDistance
  Read Write Property: Specfic distance for focusing.
FBAnimatableDouble  ForeGroundAlpha
  Read Write Property: Opacity of foreground.
bool  ForeGroundImageCenter
  Read Write Property: Center the foreground image
bool  ForeGroundImageCrop
  Read Write Property: Crop the foreground image
bool  ForeGroundImageFit
  Read Write Property: Fit the foreground image
bool  ForeGroundImageKeepRatio
  Read Write Property: Keep the foreground image's ratio?
float  ForeGroundMaterialThreshold
  Read Write Property: Material threshold for a transparent foreground.
FBVideo  ForeGroundMedia
  Read Write Property: ForeGround Image
float  ForeGroundPlaneDistance
  Read Write Property: Set the distance for the foreground plane.
FBCameraDistanceMode  ForeGroundPlaneDistanceMode
  Read Write Property: Select mode for the foreground plane's distance.
bool  ForeGroundTransparent
  Read Write Property: Is the foreground transparent?
FBColor  FrameColor
  Read Write Property: Frame color for camera.
FBCameraFrameSizeMode  FrameSizeMode
  Read Write Property: Frame size standard mode.
bool  InteractiveMode
  Read Write Property: Interactive mode?
FBModel  Interest
  Read Write Property: Direct camera's interest.
FBAnimatableDouble  MagnifierPosX
  Read Write Property: 2D Magnifier X Position.
FBAnimatableDouble  MagnifierPosY
  Read Write Property: 2D Magnifier Y Position.
FBAnimatableDouble  MagnifierZoom
  Read Write Property: 2D Magnifier Zoom value.
bool  MouseLockCamera
  Read Write Property: Mouse lock for camera?
float  NearPlaneDistance
  Read Write Property: Near plane distance.
int  NumberOfSamples
  Read Write Property: Number of samples to oversample with.
FBAnimatableDouble  OpticalCenterX
  Read Write Property: Optical Center X (mm).
FBAnimatableDouble  OpticalCenterY
  Read Write Property: Optical Center Y (mm).
float  OrthogonalVerticalSize
  Read Write Property: Near plane distance.
float  PixelAspectRatio
  Read Write Property: Pixel aspect ratio.
float  ResolutionHeight
  Read Write Property: Resolution height.
FBCameraResolutionMode  ResolutionMode
  Read Write Property: Resolution standard mode.
float  ResolutionWidth
  Read Write Property: Resolution width.
FBAnimatableDouble  Roll
  Read Write Property: Camera's roll on it's Z axis.
FBCameraSafeAreaMode  SafeAreaMode
  Read Write Property: Select mode for safe area.
FBCameraSamplingType  SamplingType
  Read Write Property: Type of over sampling.
float  SqueezeRatio
  Read Write Property: Squeeze ratio.
bool  SystemCamera
  Read Only Property: Indicate if this a producer (default or system) camera or a custom (user-created) camera.
FBAnimatableDouble  TurnTable
  Read Write Property: Camera's rotation around its interest.
FBCameraType  Type
  Read Write Property: Type of camera
bool  Use2DMagnifier
  Read Write Property: Enable/Disable the 2D Magnifier.
bool  UseAccumulationBuffer
  Read Write Property: Use accumulation buffer?
bool  UseAntiAliasing
  Read Write Property: Use anti-aliasing?
bool  UseDepthOfField
  Read Write Property: Use depth of field calculations?
bool  UseFrameColor
  Read Write Property: Use frame color?
FBCameraViewPlaneMode  ViewBackGroundPlaneMode
  Read Write Property: Background plane view mode
bool  ViewCameraInterest
  Read Write Property: Show the camera interest?
bool  ViewDisplaySafeArea
  Read Write Property: Display safe area?
FBCameraViewPlaneMode  ViewForeGroundPlaneMode
  Read Write Property: Foreground plane view mode
bool  ViewNearFarPlane
  Read Write Property: Show near/far planes?
bool  ViewOpticalCenter
  Read Write Property: View optical center?
bool  ViewShowAxis
  Read Write Property: Show axis?
bool  ViewShowGrid
  Read Write Property: Show grid?
bool  ViewShowTimeCode
  Read Write Property: Show time code?
float  WindowHeight
  Read Only Property: Window height.

Constructor & Destructor Documentation

FBCamera ( str  pName  ) 

Constructor.

Parameters:
pName  Name of camera.

Member Data Documentation

float AntiAliasingIntensity

Read Write Property: Anti-aliasing intensity.

FBCameraAntiAliasingMethod AntiAliasingMethod

Read Write Property: Anti-aliasing method.

FBCameraApertureMode ApertureMode

Read Write Property: Aperture mode.

FBAnimatableColor BackGroundColor

Read Write Property: Background color for camera.

bool BackGroundImageCenter

Read Write Property: Center the background image

bool BackGroundImageCrop

Read Write Property: Crop the background image

bool BackGroundImageFit

Read Write Property: Fit the background image

bool BackGroundImageKeepRatio

Read Write Property: Keep the background image's ratio

FBVideo BackGroundMedia

Read Write Property: BackGround Image

float BackGroundPlaneDistance

Read Write Property: Set the distance for the background plane.

FBCameraDistanceMode BackGroundPlaneDistanceMode

Read Write Property: Select mode for the background plane's distance.

bool Display2DMagnifierFrame

Read Write Property: Enable/Disable the drawing of the 2D Magnifier frame box.

bool DisplayTurnTableIcon

Read Write Property: Enable/Disable the drawing of the Turn Table icon.

float FarPlaneDistance

Read Write Property: Far plane distance.

FBAnimatableDouble FieldOfView

Read Write Property: Field of View (used when in horizontal or vertical aperture modes).

FBAnimatableDouble FieldOfViewX

Read Write Property: Field of View X angle (used in horizontal and vertical aperture mode).

FBAnimatableDouble FieldOfViewY

Read Write Property: Field of View Y angle (used in horizontal and vertical aperture mode).

float FilmAspectRatio

Read Write Property: Film aspect ratio.

FBCameraFilmBackType FilmBackType

Read Write Property: Film back standard type.

float FilmSizeHeight

Read Write Property: Height of the film.

float FilmSizeWidth

Read Write Property: Width of the film.

FBAnimatableDouble FocalLength

Read Write Property: Focal Length.

float FocusAngle

Read Write Property: Focus Angle (rendering dof).

FBCameraFocusDistanceSource FocusDistanceSource

Read Write Property: Select source for focusing.

float FocusSpecificDistance

Read Write Property: Specfic distance for focusing.

FBAnimatableDouble ForeGroundAlpha

Read Write Property: Opacity of foreground.

bool ForeGroundImageCenter

Read Write Property: Center the foreground image

bool ForeGroundImageCrop

Read Write Property: Crop the foreground image

bool ForeGroundImageFit

Read Write Property: Fit the foreground image

bool ForeGroundImageKeepRatio

Read Write Property: Keep the foreground image's ratio?

float ForeGroundMaterialThreshold

Read Write Property: Material threshold for a transparent foreground.

FBVideo ForeGroundMedia

Read Write Property: ForeGround Image

float ForeGroundPlaneDistance

Read Write Property: Set the distance for the foreground plane.

FBCameraDistanceMode ForeGroundPlaneDistanceMode

Read Write Property: Select mode for the foreground plane's distance.

bool ForeGroundTransparent

Read Write Property: Is the foreground transparent?

FBColor FrameColor

Read Write Property: Frame color for camera.

FBCameraFrameSizeMode FrameSizeMode

Read Write Property: Frame size standard mode.

bool InteractiveMode

Read Write Property: Interactive mode?

FBModel Interest

Read Write Property: Direct camera's interest.

FBAnimatableDouble MagnifierPosX

Read Write Property: 2D Magnifier X Position.

FBAnimatableDouble MagnifierPosY

Read Write Property: 2D Magnifier Y Position.

FBAnimatableDouble MagnifierZoom

Read Write Property: 2D Magnifier Zoom value.

bool MouseLockCamera

Read Write Property: Mouse lock for camera?

float NearPlaneDistance

Read Write Property: Near plane distance.

int NumberOfSamples

Read Write Property: Number of samples to oversample with.

FBAnimatableDouble OpticalCenterX

Read Write Property: Optical Center X (mm).

FBAnimatableDouble OpticalCenterY

Read Write Property: Optical Center Y (mm).

float OrthogonalVerticalSize

Read Write Property: Near plane distance.

float PixelAspectRatio

Read Write Property: Pixel aspect ratio.

float ResolutionHeight

Read Write Property: Resolution height.

FBCameraResolutionMode ResolutionMode

Read Write Property: Resolution standard mode.

float ResolutionWidth

Read Write Property: Resolution width.

FBAnimatableDouble Roll

Read Write Property: Camera's roll on it's Z axis.

FBCameraSafeAreaMode SafeAreaMode

Read Write Property: Select mode for safe area.

FBCameraSamplingType SamplingType

Read Write Property: Type of over sampling.

float SqueezeRatio

Read Write Property: Squeeze ratio.

bool SystemCamera

Read Only Property: Indicate if this a producer (default or system) camera or a custom (user-created) camera.

FBAnimatableDouble TurnTable

Read Write Property: Camera's rotation around its interest.

FBCameraType Type

Read Write Property: Type of camera

bool Use2DMagnifier

Read Write Property: Enable/Disable the 2D Magnifier.

bool UseAccumulationBuffer

Read Write Property: Use accumulation buffer?

bool UseAntiAliasing

Read Write Property: Use anti-aliasing?

bool UseDepthOfField

Read Write Property: Use depth of field calculations?

bool UseFrameColor

Read Write Property: Use frame color?

FBCameraViewPlaneMode ViewBackGroundPlaneMode

Read Write Property: Background plane view mode

bool ViewCameraInterest

Read Write Property: Show the camera interest?

bool ViewDisplaySafeArea

Read Write Property: Display safe area?

FBCameraViewPlaneMode ViewForeGroundPlaneMode

Read Write Property: Foreground plane view mode

bool ViewNearFarPlane

Read Write Property: Show near/far planes?

bool ViewOpticalCenter

Read Write Property: View optical center?

bool ViewShowAxis

Read Write Property: Show axis?

bool ViewShowGrid

Read Write Property: Show grid?

bool ViewShowTimeCode

Read Write Property: Show time code?

float WindowHeight

Read Only Property: Window height.


Generated on Tue Feb 9 19:34:12 2010 for Python Reference Guide by  doxygen 1.5.3