KFbxCamera
#include<kfbxcamera.h>

Inheritance diagram for KFbxCamera:

Inheritance graph
[legend]

List of all members.

Detailed Description

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

A camera can be set to automatically point at and follow another node in the hierarchy. To do this, the focus source must be set to ECameraFocusSource::eCAMERA_INTEREST and the followed node associated with functionKFbxNode::SetTarget().

Definition at line76of filekfbxcamera.h.


Camera Position and Orientation Functions

enum ECameraProjectionType
 Camera projection types.More...
K_DEPRECATED void SetPosition(constKFbxVector4&pPosition)
 Set the default XYZ camera position.
K_DEPRECATEDKFbxVector4 GetPosition() const
 Get the default position of the camera.
K_DEPRECATED void SetUpVector(constKFbxVector4&pVector)
 Set the camera's Up vector.
K_DEPRECATEDKFbxVector4 GetUpVector() const
 Get the current Up vector.
K_DEPRECATED void SetDefaultCameraInterestPosition(constKFbxVector4&pPosition)
 Set the default point the camera is looking at.
K_DEPRECATEDKFbxVector4 GetDefaultCameraInterestPosition() const
 Return the camera interest to default coordinates.
K_DEPRECATED void SetRoll(double pRoll)
 Set the camera roll angle.
K_DEPRECATED double GetRoll() const
 Get the camera roll angle.
K_DEPRECATED void SetTurnTable(double pTurnTable)
 Set the camera turntable angle.
K_DEPRECATED double GetTurnTable() const
 Get the camera turntable angle.
K_DEPRECATED void SetProjectionType(ECameraProjectionTypepProjectionType)
 Set the camera projection type.
K_DEPRECATEDECameraProjectionType GetProjectionType() const
 Get the camera projection type.

Viewing Area Functions

enum ECameraFormat
 Camera formats.More...
enum ECameraAspectRatioMode
 Camera aspect ratio modes.More...
void SetFormat(ECameraFormatpFormat)
 Set the camera format.
ECameraFormat GetFormat() const
 Get the camera format.
void SetAspect(ECameraAspectRatioModepRatioMode, double pWidth, double pHeight)
 Set the camera aspect.
ECameraAspectRatioMode GetAspectRatioMode() const
 Get the camera aspect ratio mode.
K_DEPRECATED double GetAspectWidth() const
 Get the aspect width.
K_DEPRECATED double GetAspectHeight() const
 Get the aspect height.
void SetPixelRatio(double pRatio)
 Set the pixel ratio.
double GetPixelRatio() const
 Get the pixel ratio.
void SetNearPlane(double pDistance)
 Set the near plane distance from the camera.
double GetNearPlane() const
 Get the near plane distance from the camera.
void SetFarPlane(double pDistance)
 Set the far plane distance from camera.
double GetFarPlane() const
 Get the far plane distance from camera.
K_DEPRECATED void SetMouseLock(bool pMouseLock)
 Set interactive camera lock flag.
K_DEPRECATED bool GetMouseLock() const
 Get the camera lock flag.

Aperture and Film Functions

The aperture mode determines which values drive the camera aperture.

When the aperture mode iseHORIZONTAL_AND_VERTICAL,eHORIZONTALoreVERTICAL, the field of view is used. When the aperture mode iseFOCAL_LENGTH, the focal length is used.

It is possible to convert the aperture mode into field of view or vice versa using functions ComputeFieldOfView and ComputeFocalLength. These functions use the camera aperture width and height for their computation.

enum ECameraApertureFormat
 Camera aperture formats.More...
enum ECameraApertureMode
 Camera aperture modes.More...
enum ECameraGateFit
 Camera gate fit modes.More...
void SetApertureFormat(ECameraApertureFormatpFormat)
 Set the camera aperture format.
ECameraApertureFormat GetApertureFormat() const
 Get the camera aperture format.
void SetApertureMode(ECameraApertureModepMode)
 Set the camera aperture mode.
ECameraApertureMode GetApertureMode() const
 Get the camera aperture mode.
void SetApertureWidth(double pWidth)
 Set the camera aperture width in inches.
double GetApertureWidth() const
 Get the camera aperture width in inches.
void SetApertureHeight(double pHeight)
 Set the camera aperture height in inches.
double GetApertureHeight() const
 Get the camera aperture height in inches.
void SetSqueezeRatio(double pRatio)
 Set the squeeze ratio.
double GetSqueezeRatio() const
 Get the camera squeeze ratio.
K_DEPRECATED void SetOrthoZoom(const double&pOrthoZoom)
 Set the camera ortographic zoom.
K_DEPRECATED double GetOrthoZoom() const
 Get the camera ortographic zoom.
K_DEPRECATED void SetGateFit(constECameraGateFitpGateFit)
 Set the camera gate fit.
K_DEPRECATEDECameraGateFit GetGateFit() const
 Get the camera gate fit.
double ComputeFieldOfView(double pFocalLength) const
 Compute the angle of view based on the given focal length, the aperture width, and aperture height.
double ComputeFocalLength(double pAngleOfView)
 Compute the focal length based on the given angle of view, the aperture width, and aperture height.

Background Functions

enum ECameraBackgroundDisplayMode
 Background display modes.More...
enum ECameraBackgroundDrawingMode
 Background drawing modes.More...
enum ECameraBackgroundPlacementOptions
 Background placement options.More...
enum ECameraBackgroundDistanceMode
 ECamerabackgroundDistanceMode Background distance modes.More...
void SetBackgroundFileName(const char *pFileName)
 Set the associated background image file.
char const * GetBackgroundFileName() const
 Get the background image file name.
void SetBackgroundMediaName(const char *pFileName)
 Set the media name associated to the background image file.
char const * GetBackgroundMediaName() const
 Get the media name associated to the background image file.
K_DEPRECATED void SetBackgroundDisplayMode(ECameraBackgroundDisplayModepMode)
 Set the background display mode.
K_DEPRECATED
ECameraBackgroundDisplayMode 
GetBackgroundDisplayMode() const
 Get the background display mode.
K_DEPRECATED void SetBackgroundDrawingMode(ECameraBackgroundDrawingModepMode)
 Set the background drawing mode.
K_DEPRECATED
ECameraBackgroundDrawingMode 
GetBackgroundDrawingMode() const
 Get the background drawing mode.
K_DEPRECATED void SetForegroundMatteThresholdEnable(bool pEnable)
 Set the foreground matte threshold flag.
K_DEPRECATED bool GetForegroundMatteThresholdEnable() const
 Get the foreground matte threshold flag.
K_DEPRECATED void SetForegroundMatteThreshold(double pThreshold)
 Set foreground matte threshold.
K_DEPRECATED double GetForegroundMatteThreshold() const
 Get foreground matte threshold.
K_DEPRECATED void SetBackgroundPlacementOptions(kUInt pOptions)
 Set background placement options.
kUInt GetBackgroundPlacementOptions() const
 Get background placement options.
K_DEPRECATED void SetBackgroundDistanceMode(ECameraBackgroundDistanceModepMode)
 Set the background distance mode.
K_DEPRECATED
ECameraBackgroundDistanceMode 
GetBackgroundDistanceMode() const
 Get the background distance mode.
K_DEPRECATED void SetBackgroundDistance(double pDistance)
 Set the background distance.
K_DEPRECATED double GetBackgroundDistance() const
 Get the background distance.

Camera View Functions

It is the responsibility of the client application to perform the required tasks according to the state of the options that are either set or returned by these methods.

enum ECameraSafeAreaStyle
 Camera safe area display styles.More...
K_DEPRECATED void SetViewCameraInterest(bool pEnable)
 Change the camera interest visibility flag.
K_DEPRECATED bool GetViewCameraInterest() const
 Get current visibility state of the camera interest.
K_DEPRECATED void SetViewNearFarPlanes(bool pEnable)
 Change the camera near and far planes visibility flag.
K_DEPRECATED bool GetViewNearFarPlanes() const
 Get current visibility state of the camera near and far planes.
K_DEPRECATED void SetShowGrid(bool pEnable)
 Change the draw floor grid flag.
K_DEPRECATED bool GetShowGrid() const
 Get current floor grid draw state.
K_DEPRECATED void SetShowAxis(bool pEnable)
 Change the draw system axis flag.
K_DEPRECATED bool GetShowAxis() const
 Get current system axis draw state.
K_DEPRECATED void SetShowName(bool pEnable)
 Change the show camera name flag.
K_DEPRECATED bool GetShowName() const
 Get current camera name show state.
K_DEPRECATED void SetShowInfoOnMoving(bool pEnable)
 Change the show info on moving flag.
K_DEPRECATED bool GetShowInfoOnMoving() const
 Get current info on moving show state.
K_DEPRECATED void SetShowTimeCode(bool pEnable)
 Change the timecode show flag.
K_DEPRECATED bool GetShowTimeCode() const
 Get current timecode show state.
K_DEPRECATED void SetDisplaySafeArea(bool pEnable)
 Change the display camera safe area flag.
K_DEPRECATED bool GetDisplaySafeArea() const
 Get current safe area display state.
K_DEPRECATED void SetDisplaySafeAreaOnRender(bool pEnable)
 Change the display of the camera's safe area on render flag.
K_DEPRECATED bool GetDisplaySafeAreaOnRender() const
 Get current safe area on render display state.
K_DEPRECATED void SetSafeAreaStyle(ECameraSafeAreaStylepStyle)
 Set the safe area style.
K_DEPRECATEDECameraSafeAreaStyle GetSafeAreaStyle() const
 Get the currently set safe area style.
K_DEPRECATED void SetShowAudio(bool pEnable)
 Change the show audio flag.
K_DEPRECATED bool GetShowAudio() const
 Get current audio show state.
K_DEPRECATED void SetAudioColor(constKFbxColor&pColor)
 Set audio color.
K_DEPRECATEDKFbxColor GetAudioColor() const
 Get audio color.
K_DEPRECATED void SetUseFrameColor(bool pEnable)
 Change the use frame color flag.
K_DEPRECATED bool GetUseFrameColor() const
 Get the use frame color state.
K_DEPRECATED void SetFrameColor(constKFbxColor&pColor)
 Set frame color.
K_DEPRECATEDKFbxColor GetFrameColor() const
 Get frame color.

Render Functions

It is the responsibility of the client application to perform the required tasks according to the state of the options that are either set or returned by these methods.

enum ECameraRenderOptionsUsageTime
 Render options usage time.More...
enum ECameraAntialiasingMethod
 Antialiasing methods.More...
enum ECameraSamplingType
 Oversampling types.More...
enum ECameraFocusDistanceSource
 Camera focus sources.More...
K_DEPRECATED void SetRenderOptionsUsageTime(ECameraRenderOptionsUsageTimepUsageTime)
 Set the render options usage time.
K_DEPRECATED
ECameraRenderOptionsUsageTime 
GetRenderOptionsUsageTime() const
 Get the render options usage time.
K_DEPRECATED void SetUseAntialiasing(bool pEnable)
 Change the use antialiasing flag.
K_DEPRECATED bool GetUseAntialiasing() const
 Get the use antialiasing state.
K_DEPRECATED void SetAntialiasingIntensity(double pIntensity)
 Set antialiasing intensity.
K_DEPRECATED double GetAntialiasingIntensity() const
 Get the antialiasing intensity.
K_DEPRECATED void SetAntialiasingMethod(ECameraAntialiasingMethodpMethod)
 Set antialiasing method.
K_DEPRECATED
ECameraAntialiasingMethod 
GetAntialiasingMethod() const
 Get antialiasing method.
K_DEPRECATED void SetNumberOfSamples(int pNumberOfSamples)
 Set the number of samples used to process oversampling.
K_DEPRECATED int GetNumberOfSamples() const
 Get the number of samples used to process oversampling.
K_DEPRECATED void SetSamplingType(ECameraSamplingTypepType)
 Set sampling type.
K_DEPRECATEDECameraSamplingType GetSamplingType() const
 Get sampling type.
K_DEPRECATED void SetUseAccumulationBuffer(bool pUseAccumulationBuffer)
 Change the use accumulation buffer flag.
K_DEPRECATED bool GetUseAccumulationBuffer() const
 Get the state of the use accumulation buffer flag.
K_DEPRECATED void SetUseDepthOfField(bool pUseDepthOfField)
 Change use depth of field flag.
K_DEPRECATED bool GetUseDepthOfField() const
 Get use depth of field state.
K_DEPRECATED void SetFocusDistanceSource(ECameraFocusDistanceSourcepSource)
 Set source of camera focus distance.
K_DEPRECATED
ECameraFocusDistanceSource 
GetFocusDistanceSource() const
 Get source of camera focus distance.
K_DEPRECATED void SetSpecificDistance(double pDistance)
 Set the focus distance of the lens in millimiters.
K_DEPRECATED double GetSpecificDistance() const
 Get the focus distance of the lens in millimiters.
K_DEPRECATED void SetFocusAngle(double pAngle)
 Set the focus angle in degrees.
K_DEPRECATED double GetFocusAngle() const
 Get the focus angle in degrees.

Default Animation Values

These functions provide direct access to default animation values specific to a camera.

Since the default animation values are found in the default take node of the associated node, these functions only work if the camera has been associated with a node.

K_DEPRECATED void SetDefaultFieldOfView(double pFieldOfView)
 Set default field of view in degrees.
K_DEPRECATED double GetDefaultFieldOfView() const
 Get default field of view.
K_DEPRECATED void SetDefaultFieldOfViewX(double pFieldOfViewX)
 Set default field of view X.
K_DEPRECATED double GetDefaultFieldOfViewX() const
 Get default field of view X.
K_DEPRECATED void SetDefaultFieldOfViewY(double pFieldOfViewY)
 Set default field of view Y.
K_DEPRECATED double GetDefaultFieldOfViewY() const
 Get default field of view Y.
K_DEPRECATED void SetDefaultOpticalCenterX(double pOpticalCenterX)
 Set default optical center X, in pixels.
K_DEPRECATED double GetDefaultOpticalCenterX() const
 Get default optical center X, in pixels.
K_DEPRECATED void SetDefaultOpticalCenterY(double pOpticalCenterY)
 Set default optical center Y, in pixels.
K_DEPRECATED double GetDefaultOpticalCenterY() const
 Get default optical center Y, in pixels.
K_DEPRECATED void SetDefaultFocalLength(double pFocalLength)
 Set default focal length, in millimeters Use this function to set the default focal length when the camera aperture mode is set toeFOCAL_LENGTH.
K_DEPRECATED double GetDefaultFocalLength() const
 Get default focal length, in millimeters Use this function to get the default focal length when the camera aperture mode is set toeFOCAL_LENGTH.
K_DEPRECATED void SetDefaultRoll(double pRoll)
 Set default camera roll in degrees.
K_DEPRECATED double GetDefaultRoll() const
 Get default camera roll in degrees.
K_DEPRECATED void SetDefaultTurnTable(double pTurnTable)
 Set default turntable value in degrees.
K_DEPRECATED double GetDefaultTurnTable() const
 Get default turntable in degrees.
K_DEPRECATED void SetDefaultBackgroundColor(constKFbxColor&pColor)
 Set default background color.
K_DEPRECATEDKFbxColor GetDefaultBackgroundColor() const
 Get default background color.

Obsolete Functions

These functions are obsolete since animated background color, animated field of view, and animated focal length are now supported.

K_DEPRECATED void SetBackgroundColor(constKFbxColor&pColor)
 Set background color.
K_DEPRECATEDKFbxColor GetBackgroundColor() const
 Get background color.
K_DEPRECATED void SetAngleOfView(double pAngleOfView)
 Set the camera angle of view in degrees.
K_DEPRECATED double GetAngleOfView() const
 Get the camera angle of view in degrees.
K_DEPRECATED void SetFocalLength(double pFocalLength)
 Set the focal length of the camera in millimeters.
K_DEPRECATED double GetFocalLength() const
 Get the camera focal length in millimeters.

Utility Functions.

bool IsBoundingBoxInView(constKFbxMatrix&pWorldToScreen, constKFbxMatrix&pWorldToCamera, constKFbxVector4pPoints[8]) const
 Determine if the given bounding box is in the camera's view.
bool IsPointInView(constKFbxMatrix&pWorldToScreen, constKFbxMatrix&pWorldToCamera, constKFbxVector4&pPoint) const
 Determine if the given 3d point is in the camera's view.
KFbxMatrix ComputeWorldToScreen(int pPixelWidth, int pPixelHeight, constKFbxXMatrix&pWorldToCamera) const
 Compute world space to screen space transformation matrix.
KFbxMatrix ComputePerspective(int pPixelWidth, int pPixelHeight, bool pIncludePostPerspective) const
 Compute the perspective matrix for this camera.

Public Member Functions

virtual EAttributeType GetAttributeType() const
 Return the type of node attribute which is EAttributeType::eCAMERA.
void Reset()
 Reset the camera to default values.

Public Attributes

KFbxTypedProperty<fbxDouble3> Position
 This property handles the camera position (XYZ coordinates).
KFbxTypedProperty<fbxDouble3> UpVector
 This property handles the camera Up Vector (XYZ coordinates).
KFbxTypedProperty<fbxDouble3> InterestPosition
 This property handles the default point (XYZ coordinates) the camera is looking at.
KFbxTypedProperty<fbxDouble1> Roll
 This property handles the camera roll angle in degree(s).
KFbxTypedProperty<fbxDouble1> OpticalCenterX
 This property handles the camera optical center X, in pixels.
KFbxTypedProperty<fbxDouble1> OpticalCenterY
 This property handles the camera optical center Y, in pixels.
KFbxTypedProperty<fbxDouble3> BackgroundColor
 This property handles the camera RGB values of the background color.
KFbxTypedProperty<fbxDouble1> TurnTable
 This property handles the camera turn table angle in degree(s).
KFbxTypedProperty<fbxBool1> DisplayTurnTableIcon
 This property handles a flags that indicates if the camera displays the Turn Table icon or not.
KFbxTypedProperty<fbxBool1> UseMotionBlur
 This property handles a flags that indicates if the camera uses motion blur or not.
KFbxTypedProperty<fbxBool1> UseRealTimeMotionBlur
 This property handles a flags that indicates if the camera uses real time motion blur or not.
KFbxTypedProperty<fbxDouble1> MotionBlurIntensity
 This property handles the camera motion blur intensity (in pixels).
KFbxTypedProperty
<ECameraAspectRatioMode
AspectRatioMode
 This property handles the camera aspect ratio mode.
KFbxTypedProperty<fbxDouble1> AspectWidth
 This property handles the camera aspect width.
KFbxTypedProperty<fbxDouble1> AspectHeight
 This property handles the camera aspect height.
KFbxTypedProperty<fbxDouble1> PixelAspectRatio
 This property handles the pixel aspect ratio.
KFbxTypedProperty
<ECameraApertureMode
ApertureMode
 This property handles the aperture mode.
KFbxTypedProperty<ECameraGateFitGateFit
 This property handles the gate fit mode.
KFbxTypedProperty<fbxDouble1> FieldOfView
 This property handles the field of view in degrees.
KFbxTypedProperty<fbxDouble1> FieldOfViewX
 This property handles the X (horizontal) field of view in degrees.
KFbxTypedProperty<fbxDouble1> FieldOfViewY
 This property handles the Y (vertical) field of view in degrees.
KFbxTypedProperty<fbxDouble1> FocalLength
 This property handles the focal length (in millimeters).
KFbxTypedProperty<ECameraFormatCameraFormat
 This property handles the camera format.
KFbxTypedProperty<fbxBool1> UseFrameColor
 This property stores a flag that indicates to use or not a color for the frame.
KFbxTypedProperty<fbxDouble3> FrameColor
 This property handles the fame color.
KFbxTypedProperty<fbxBool1> ShowName
 This property handles the show name flag.
KFbxTypedProperty<fbxBool1> ShowInfoOnMoving
 This property handles the show info on moving flag.
KFbxTypedProperty<fbxBool1> ShowGrid
 This property handles the draw floor grid flag.
KFbxTypedProperty<fbxBool1> ShowOpticalCenter
 This property handles the show optical center flag.
KFbxTypedProperty<fbxBool1> ShowAzimut
 This property handles the show axis flag.
KFbxTypedProperty<fbxBool1> ShowTimeCode
 This property handles the show time code flag.
KFbxTypedProperty<fbxBool1> ShowAudio
 This property handles the show audio flag.
KFbxTypedProperty<fbxDouble3> AudioColor
 This property handles the show audio flag.
KFbxTypedProperty<fbxDouble1> NearPlane
 This property handles the near plane distance.
KFbxTypedProperty<fbxDouble1> FarPlane
 This property handles the far plane distance.
KFbxTypedProperty<fbxBool1> AutoComputeClipPlanes
 This property indicates that the clip planes should be automatically computed.
KFbxTypedProperty<fbxDouble1> FilmWidth
 This property handles the film aperture width (in inches).
KFbxTypedProperty<fbxDouble1> FilmHeight
 This property handles the film aperture height (in inches).
KFbxTypedProperty<fbxDouble1> FilmAspectRatio
 This property handles the film aperture aspect ratio.
KFbxTypedProperty<fbxDouble1> FilmSqueezeRatio
 This property handles the film aperture squeeze ratio.
KFbxTypedProperty
<ECameraApertureFormat
FilmFormat
 This property handles the film aperture format.
KFbxTypedProperty<fbxDouble2> FilmOffset
 This property handles the offset from the center of the film aperture, defined by the film height and film width.
KFbxTypedProperty<fbxBool1> ViewFrustum
 This property handles the view frustrum flag.
KFbxTypedProperty<fbxBool1> ViewFrustumNearFarPlane
 This property handles the view frustrum near and far plane flag.
KFbxTypedProperty
<ECameraBackgroundDisplayMode
ViewFrustumBackPlaneMode
 This property handles the view frustrum back plane mode.
KFbxTypedProperty<fbxDouble1> BackPlaneDistance
 This property handles the view frustrum back plane distance.
KFbxTypedProperty
<ECameraBackgroundDistanceMode
BackPlaneDistanceMode
 This property handles the view frustrum back plane distance mode.
KFbxTypedProperty<fbxBool1> ViewCameraToLookAt
 This property handles the view camera to look at flag.
KFbxTypedProperty<fbxBool1> LockMode
 This property handles the lock mode.
KFbxTypedProperty<fbxBool1> LockInterestNavigation
 This property handles the lock interest navigation flag.
KFbxTypedProperty<fbxBool1> FitImage
 This property handles the fit image flag.
KFbxTypedProperty<fbxBool1> Crop
 This property handles the crop flag.
KFbxTypedProperty<fbxBool1> Center
 This property handles the center flag.
KFbxTypedProperty<fbxBool1> KeepRatio
 This property handles the keep ratio flag.
KFbxTypedProperty
<ECameraBackgroundDrawingMode
BackgroundMode
 This property handles the background mode flag.
KFbxTypedProperty<fbxDouble1> BackgroundAlphaTreshold
 This property handles the background alpha threshold value.
KFbxTypedProperty<fbxBool1> FrontPlateFitImage
 This property handles the fit image for front plate flag.
KFbxTypedProperty<fbxBool1> FrontPlateCrop
 This property handles the front plane crop flag.
KFbxTypedProperty<fbxBool1> FrontPlateCenter
 This property handles the front plane center flag.
KFbxTypedProperty<fbxBool1> FrontPlateKeepRatio
 This property handles the front plane keep ratio flag.
KFbxTypedProperty<fbxBool1> ShowFrontPlate
 This property handles the front plane show flag.
KFbxTypedProperty
<ECameraBackgroundDisplayMode
ViewFrustumFrontPlaneMode
 This property handles the view frustrum front plane mode.
KFbxTypedProperty<fbxDouble1> FrontPlaneDistance
 This property handles the view frustrum front plane distance.
KFbxTypedProperty
<ECameraBackgroundDistanceMode
FrontPlaneDistanceMode
 This property handles the view frustrum front plane distance mode.
KFbxTypedProperty<fbxDouble1> ForegroundAlpha
 This property handles the foreground alpha value.
KFbxTypedProperty<fbxReference> ForegroundTexture
 This property has the foreground textures connected to it.
KFbxTypedProperty<fbxReference> BackgroundTexture
 This property has the background textures connected to it.
KFbxTypedProperty<fbxBool1> DisplaySafeArea
 This property handles the display safe area flag.
KFbxTypedProperty<fbxBool1> DisplaySafeAreaOnRender
 This property handles the display safe area on render flag.
KFbxTypedProperty
<ECameraSafeAreaStyle
SafeAreaDisplayStyle
 This property handles the display safe area display style.
KFbxTypedProperty<fbxDouble1> SafeAreaAspectRatio
 This property handles the display safe area aspect ratio.
KFbxTypedProperty<fbxBool1> Use2DMagnifierZoom
 This property handles the use 2d magnifier zoom flag.
KFbxTypedProperty<fbxDouble1> _2DMagnifierZoom
 This property handles the 2d magnifier zoom value.
KFbxTypedProperty<fbxDouble1> _2DMagnifierX
 This property handles the 2d magnifier X value.
KFbxTypedProperty<fbxDouble1> _2DMagnifierY
 This property handles the 2d magnifier Y value.
KFbxTypedProperty
<ECameraProjectionType
ProjectionType
 This property handles the projection type.
KFbxTypedProperty<fbxDouble1> OrthoZoom
 This property handles the otho zoom.
KFbxTypedProperty<fbxBool1> UseRealTimeDOFAndAA
 This property handles the use real time DOF and AA flag.
KFbxTypedProperty<fbxBool1> UseDepthOfField
 This property handles the use depth of field flag.
KFbxTypedProperty
<ECameraFocusDistanceSource
FocusSource
 This property handles the focus source.
KFbxTypedProperty<fbxDouble1> FocusAngle
 This property handles the focus angle (in degrees).
KFbxTypedProperty<fbxDouble1> FocusDistance
 This property handles the focus distance.
KFbxTypedProperty<fbxBool1> UseAntialiasing
 This property handles the use anti aliasing flag.
KFbxTypedProperty<fbxDouble1> AntialiasingIntensity
 This property handles the anti aliasing intensity.
KFbxTypedProperty
<ECameraAntialiasingMethod
AntialiasingMethod
 This property handles the anti aliasing method.
KFbxTypedProperty<fbxBool1> UseAccumulationBuffer
 This property handles the use accumulation buffer flag.
KFbxTypedProperty<fbxInteger1> FrameSamplingCount
 This property handles the frame sampling count.
KFbxTypedProperty
<ECameraSamplingType
FrameSamplingType
 This property handles the frame sampling type.

Member Enumeration Documentation

Camera projection types.

Camera projection types.

  • ePERSPECTIVE
  • eORTHOGONAL
    Remarks:
    By default, the camera projection type is set to ePERSPECTIVE. If the camera projection type is set to eORTHOGONAL, the following options are not relevant:
    • aperture format
    • aperture mode
    • aperture width and height
    • angle of view/focal length
    • squeeze ratio

Definition at line193of filekfbxcamera.h.

Camera formats.

  • eCUSTOM_FORMAT
  • eD1_NTSC
  • eNTSC
  • ePAL
  • eD1_PAL
  • eHD
  • e640x480
  • e320x200
  • e320x240
  • e128x128
  • eFULL_SCREEN

Definition at line235of filekfbxcamera.h.

Camera aspect ratio modes.

  • eWINDOW_SIZE
  • eFIXED_RATIO
  • eFIXED_RESOLUTION
  • eFIXED_WIDTH
  • eFIXED_HEIGHT

Definition at line270of filekfbxcamera.h.

Camera aperture formats.

  • eCUSTOM_APERTURE_FORMAT
  • e16MM_THEATRICAL
  • eSUPER_16MM
  • e35MM_ACADEMY
  • e35MM_TV_PROJECTION
  • e35MM_FULL_APERTURE
  • e35MM_185_PROJECTION
  • e35MM_ANAMORPHIC
  • e70MM_PROJECTION
  • eVISTAVISION
  • eDYNAVISION
  • eIMAX

Definition at line399of filekfbxcamera.h.

Camera aperture modes.

The aperture mode determines which values drive the camera aperture. If the aperture mode iseHORIZONTAL_AND_VERTICAL,eHORIZONTAL, oreVERTICAL, then the field of view is used. If the aperture mode iseFOCAL_LENGTH, then the focal length is used.

  • eHORIZONTAL_AND_VERTICAL
  • eHORIZONTAL
  • eVERTICAL
  • eFOCAL_LENGTH

Definition at line434of filekfbxcamera.h.

Camera gate fit modes.

  • eNO_FITNo resoluton gate fit.
  • eVERTICAL_FITFit the resolution gate vertically within the film gate.
  • eHORIZONTAL_FITFit the resolution gate horizontally within the film gate.
  • eFILL_FITFit the resolution gate within the film gate.
  • eOVERSCAN_FITFit the film gate within the resolution gate.
  • eSTRETCH_FITFit the resolution gate to the film gate.

Definition at line514of filekfbxcamera.h.

Background display modes.

  • eDISABLED
  • eALWAYS
  • eWHEN_MEDIA

Definition at line597of filekfbxcamera.h.

Background drawing modes.

  • eBACKGROUNDImage is drawn behind models.
  • eFOREGROUNDImage is drawn in front of models based on alpha channel.
  • eBACKGROUND_AND_FOREGROUNDImage is drawn behind and in front of models depending on alpha channel.

Definition at line625of filekfbxcamera.h.

Background placement options.

  • eFIT
  • eCENTER
  • eKEEP_RATIO
  • eCROP

Definition at line692of filekfbxcamera.h.

ECamerabackgroundDistanceMode Background distance modes.

  • eRELATIVE_TO_INTEREST
  • eABSOLUTE_FROM_CAMERA

Definition at line714of filekfbxcamera.h.

Camera safe area display styles.

  • eROUND
  • eSQUARE

Definition at line910of filekfbxcamera.h.

Render options usage time.

  • eINTERACTIVE
  • eAT_RENDER

Definition at line1009of filekfbxcamera.h.

Antialiasing methods.

  • eOVERSAMPLING_ANTIALIASING
  • eHARDWARE_ANTIALIASING

Definition at line1071of filekfbxcamera.h.

Oversampling types.

  • eUNIFORM
  • eSTOCHASTIC

Definition at line1115of filekfbxcamera.h.

Camera focus sources.

  • eCAMERA_INTEREST
  • eSPECIFIC_DISTANCE

Definition at line1175of filekfbxcamera.h.

Member Function Documentation

virtual EAttributeType GetAttributeType( ) const[virtual]

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

Reimplemented fromKFbxNodeAttribute.

void Reset( ) 

Reset the camera to default values.

K_DEPRECATED void SetPosition(constKFbxVector4pPosition ) 

Set the default XYZ camera position.

Parameters:
pPosition X, Y and Z values of the camera position, expressed as a vector.
Remarks:
If this attribute is not yet attached to a node, this method does nothing.

This function is deprecated. Use property Position.Set(pPosition) instead.

K_DEPRECATEDKFbxVector4GetPosition( ) const

Get the default position of the camera.

Returns:
The X, Y and Z values of the default position of the camera.
Remarks:
If this attribute is not attached to a node yet, this method will return 0,0,0.

This function is deprecated. Use property Position.Get() instead.

K_DEPRECATED void SetUpVector(constKFbxVector4pVector ) 

Set the camera's Up vector.

Parameters:
pVector The X, Y and Z values for the Up vector.
Remarks:
This function is deprecated. Use property UpVector.Set(pVector) instead.

K_DEPRECATEDKFbxVector4GetUpVector( ) const

Get the current Up vector.

Returns:
The X, Y and Z values of the currently set Up vector.
Remarks:
This function is deprecated. Use property UpVector.Get() instead.

K_DEPRECATED void SetDefaultCameraInterestPosition(constKFbxVector4pPosition ) 

Set the default point the camera is looking at.

Parameters:
pPosition X, Y and Z values of the camera interest point.
Remarks:
During the computations of the camera position and orientation, the default camera interest position is overridden by the position of a valid target in the parent node.

This function is deprecated. Use property InterestPosition.Set(pPosition) instead.

K_DEPRECATEDKFbxVector4GetDefaultCameraInterestPosition( ) const

Return the camera interest to default coordinates.

Returns:
The X,Y and Z values of the default interest point.
Remarks:
During the computations of the camera position and orientation, the default camera interest position is overridden by the position of a valid target in the parent node.

This function is deprecated. Use property InterestPosition.Get() instead.

K_DEPRECATED void SetRoll(double pRoll ) 

Set the camera roll angle.

Parameters:
pRoll The roll angle in degrees.
Remarks:
This function is deprecated. Use property Roll.Set(pRoll) instead.

K_DEPRECATED double GetRoll( ) const

Get the camera roll angle.

Returns:
The roll angle in degrees.
Remarks:
This function is deprecated. Use property Roll.Get() instead.

K_DEPRECATED void SetTurnTable(double pTurnTable ) 

Set the camera turntable angle.

Parameters:
pTurnTable The turntable angle in degrees.
Remarks:
This function is deprecated. Use property TurnTable.Set(pTurnTable) instead.

K_DEPRECATED double GetTurnTable( ) const

Get the camera turntable angle.

Returns:
The turntable angle in degrees.
Remarks:
This function is deprecated. Use property TurnTable.Get() instead.

K_DEPRECATED void SetProjectionType(ECameraProjectionType pProjectionType ) 

Set the camera projection type.

Parameters:
pProjectionType The camera projection identifier.
Remarks:
This function is deprecated. Use property ProjectionType.Set(pProjectionType) instead.

K_DEPRECATEDECameraProjectionTypeGetProjectionType( ) const

Get the camera projection type.

Returns:
The camera's current projection identifier.
Remarks:
This function is deprecated. Use property ProjectionType.Get() instead.

void SetFormat(ECameraFormat pFormat ) 

Set the camera format.

Parameters:
pFormat The camera format identifier.
Remarks:
Changing the camera format sets the camera aspect ratio mode to eFIXED_RESOLUTION and modifies the aspect width size, height size, and pixel ratio accordingly.

ECameraFormatGetFormat( ) const

Get the camera format.

Returns:
The current camera format identifier.

void SetAspect(ECameraAspectRatioMode pRatioMode,
double pWidth,
double pHeight 
)

Set the camera aspect.

Parameters:
pRatioMode Camera aspect ratio mode.
pWidth Camera aspect width, must be a positive value.
pHeight Camera aspect height, must be a positive value.
Remarks:
Changing the camera aspect sets the camera format to eCustom.
  • If the ratio mode is eWINDOW_SIZE, both width and height values aren't relevant.
  • If the ratio mode is eFIXED_RATIO, the height value is set to 1.0 and the width value is relative to the height value.
  • If the ratio mode is eFIXED_RESOLUTION, both width and height values are in pixels.
  • If the ratio mode is eFIXED_WIDTH, the width value is in pixels and the height value is relative to the width value.
  • If the ratio mode is eFIXED_HEIGHT, the height value is in pixels and the width value is relative to the height value.

ECameraAspectRatioModeGetAspectRatioMode( ) const

Get the camera aspect ratio mode.

Returns:
The current aspect ratio identifier.

K_DEPRECATED double GetAspectWidth( ) const

Get the aspect width.

Returns:
The aspect width value or an undefined value if aspect ratio mode is set to eWINDOW_SIZE.
Remarks:
This function is deprecated. Use property AspectWidth.Get() instead.

K_DEPRECATED double GetAspectHeight( ) const

Get the aspect height.

Returns:
The aspect height value or an undefined value if aspect ratio mode is set to eWINDOW_SIZE.
Remarks:
This function is deprecated. Use property AspectHeight.Get() instead.

void SetPixelRatio(double pRatio ) 

Set the pixel ratio.

Parameters:
pRatio The pixel ratio value.
Remarks:
The value must be a positive number. Comprised between 0.05 and 20.0. Values outside these limits will be clamped. Changing the pixel ratio sets the camera format to eCUSTOM_FORMAT.

double GetPixelRatio( ) const

Get the pixel ratio.

Returns:
The current camera's pixel ratio value.

void SetNearPlane(double pDistance ) 

Set the near plane distance from the camera.

The near plane is the minimum distance to render a scene on the camera display.

Parameters:
pDistance The near plane distance value.
Remarks:
The near plane value is limited to the range [0.001, 600000.0] and must be inferior to the far plane value.

double GetNearPlane( ) const

Get the near plane distance from the camera.

The near plane is the minimum distance to render a scene on the camera display.

Returns:
The near plane value.

void SetFarPlane(double pDistance ) 

Set the far plane distance from camera.

The far plane is the maximum distance to render a scene on the camera display.

Parameters:
pDistance The far plane distance value.
Remarks:
The far plane value is limited to the range [0.001, 600000.0] and must be superior to the near plane value.

double GetFarPlane( ) const

Get the far plane distance from camera.

The far plane is the maximum distance to render a scene on the camera display.

Returns:
The far plane value.

K_DEPRECATED void SetMouseLock(bool pMouseLock ) 

Set interactive camera lock flag.

Parameters:
pMouseLock Iftrue, disable modifications of the view area controls using mouse and keyboard commands.
Remarks:
It is the responsibility of the client application to perform the required tasks according to the state of this flag.

This function is deprecated. Use property LockMode.Set(pMouseLock) instead.

K_DEPRECATED bool GetMouseLock( ) const

Get the camera lock flag.

Returns:
trueIf modifications of the view area controls using mouse and keyboard commands are disabled.
Remarks:
It is the responsibility of the client application to perform the required tasks according to the state of this flag.

This function is deprecated. Use property LockMode.Get() instead.

void SetApertureFormat(ECameraApertureFormat pFormat ) 

Set the camera aperture format.

Parameters:
pFormat The camera aperture format identifier.
Remarks:
Changing the aperture format modifies the aperture width, height, and squeeze ratio accordingly.

ECameraApertureFormatGetApertureFormat( ) const

Get the camera aperture format.

Returns:
The camera's current aperture format identifier.

void SetApertureMode(ECameraApertureMode pMode ) 

Set the camera aperture mode.

Parameters:
pMode The camera aperture mode identifier.

ECameraApertureModeGetApertureMode( ) const

Get the camera aperture mode.

Returns:
The camera's current aperture mode identifier.

void SetApertureWidth(double pWidth ) 

Set the camera aperture width in inches.

Parameters:
pWidth The aperture width value.
Remarks:
Must be a positive value. The minimum accepted value is 0.0001. Changing the aperture width sets the camera aperture format to eCUSTOM_FORMAT.

double GetApertureWidth( ) const

Get the camera aperture width in inches.

Returns:
The camera's current aperture width value in inches.

void SetApertureHeight(double pHeight ) 

Set the camera aperture height in inches.

Parameters:
pHeight The aperture height value.
Remarks:
Must be a positive value. The minimum accepted value is 0.0001. Changing the aperture height sets the camera aperture format to eCUSTOM_FORMAT.

double GetApertureHeight( ) const

Get the camera aperture height in inches.

Returns:
The camera's current aperture height value in inches.

void SetSqueezeRatio(double pRatio ) 

Set the squeeze ratio.

Parameters:
pRatio The sqeeze ratio value.
Remarks:
Must be a positive value. The minimum accepted value is 0.0001. Changing the squeeze ratio sets the camera aperture format to eCUSTOM_FORMAT.

double GetSqueezeRatio( ) const

Get the camera squeeze ratio.

Returns:
The camera's current squeeze ratio value.

K_DEPRECATED void SetOrthoZoom(const double& pOrthoZoom ) 

Set the camera ortographic zoom.

Parameters:
pOrthoZoom This parameter's default value is 1.0.
Remarks:
This parameter is not used if the camera is not orthographic.

This function is deprecated. Use property OrthoZoom.Set(pOrthoZoom) instead.

K_DEPRECATED double GetOrthoZoom( ) const

Get the camera ortographic zoom.

Returns:
The camera's current orthographic zoom.
Remarks:
This function is deprecated. Use property OrthoZoom.Get() instead.

K_DEPRECATED void SetGateFit(constECameraGateFit pGateFit ) 

Set the camera gate fit.

Parameters:
pGateFit This parameter's default value is eNO_FIT.
Remarks:
This function is deprecated. Use property GateFit.Set(pGateFit) instead.

K_DEPRECATEDECameraGateFitGetGateFit( ) const

Get the camera gate fit.

Returns:
The camera's current gate fit.
Remarks:
This function is deprecated. Use property GateFit.Get() instead.

double ComputeFieldOfView(double pFocalLength ) const

Compute the angle of view based on the given focal length, the aperture width, and aperture height.

Parameters:
pFocalLength The focal length in millimeters
Returns:
The computed angle of view in degrees

double ComputeFocalLength(double pAngleOfView ) 

Compute the focal length based on the given angle of view, the aperture width, and aperture height.

Parameters:
pAngleOfView The angle of view in degrees
Returns:
The computed focal length in millimeters

void SetBackgroundFileName(const char * pFileName ) 

Set the associated background image file.

Parameters:
pFileName The path of the background image file.
Remarks:
The background image file name must be valid.

char const* GetBackgroundFileName( ) const

Get the background image file name.

Returns:
Pointer to the background filename string orNULLif not set.

void SetBackgroundMediaName(const char * pFileName ) 

Set the media name associated to the background image file.

Parameters:
pFileName The media name of the background image file.
Remarks:
The media name is a unique name used to identify the background image file.

char const* GetBackgroundMediaName( ) const

Get the media name associated to the background image file.

Returns:
Pointer to the media name string orNULLif not set.

K_DEPRECATED void SetBackgroundDisplayMode(ECameraBackgroundDisplayMode pMode ) 

Set the background display mode.

Parameters:
pMode The background display mode identifier.
Remarks:
This function is deprecated. Use property ViewFrustumBackPlaneMode.Set(pMode) instead.

K_DEPRECATEDECameraBackgroundDisplayModeGetBackgroundDisplayMode( ) const

Get the background display mode.

Returns:
The currently set background display mode identifier.
Remarks:
This function is deprecated. Use property ViewFrustumBackPlaneMode.Get() instead.

K_DEPRECATED void SetBackgroundDrawingMode(ECameraBackgroundDrawingMode pMode ) 

Set the background drawing mode.

Parameters:
pMode The background drawing mode identifier.
Remarks:
This function is deprecated. Use property BackgroundMode.Set(pMode) instead.

K_DEPRECATEDECameraBackgroundDrawingModeGetBackgroundDrawingMode( ) const

Get the background drawing mode.

Returns:
The currently set background drawing mode identifier.
Remarks:
This function is deprecated. Use property BackgroundMode.Get() instead.

K_DEPRECATED void SetForegroundMatteThresholdEnable(bool pEnable ) 

Set the foreground matte threshold flag.

Parameters:
pEnable Iftrueenable foreground matte threshold.
Remarks:
It is the responsibility of the client application to perform the required tasks according to the state of this flag.

This function is deprecated. Use property ForegroundTransparent.Set(pEnable) instead.

K_DEPRECATED bool GetForegroundMatteThresholdEnable( ) const

Get the foreground matte threshold flag.

Returns:
trueif foreground matte threshold is enabled, otherwisefalse.
Remarks:
It is the responsibility of the client application to perform the required tasks according to the state of this flag.

This function is deprecated. Use property ForegroundTransparent.Get() instead.

K_DEPRECATED void SetForegroundMatteThreshold(double pThreshold ) 

Set foreground matte threshold.

Parameters:
pThreshold Threshold value on a range from 0.0 to 1.0.
Remarks:
This option is only relevant if the background drawing mode is set to eFOREGROUND or eBACKGROUND_AND_FOREGROUND.

This function is deprecated. Use property BackgroundAlphaTreshold.Set(pThreshold) instead.

K_DEPRECATED double GetForegroundMatteThreshold( ) const

Get foreground matte threshold.

Returns:
Threshold value on a range from 0.0 to 1.0.
Remarks:
This option is only relevant if the background drawing mode is set to eFOREGROUND or eBACKGROUND_AND_FOREGROUND.

This function is deprecated. Use property BackgroundAlphaTreshold.Get() instead.

K_DEPRECATED void SetBackgroundPlacementOptions(kUInt pOptions ) 

Set background placement options.

Parameters:
pOptions Bitwise concatenation of one or more background placement options.

kUInt GetBackgroundPlacementOptions( ) const

Get background placement options.

Returns:
The bitwise concatenation of the currently set background placement options.

K_DEPRECATED void SetBackgroundDistanceMode(ECameraBackgroundDistanceMode pMode ) 

Set the background distance mode.

Parameters:
pMode The background distance mode identifier.
Remarks:
This function is deprecated. Use property BackPlaneDistanceMode.Set(pMode) instead.

K_DEPRECATEDECameraBackgroundDistanceModeGetBackgroundDistanceMode( ) const

Get the background distance mode.

Returns:
Return the background distance mode identifier.
Remarks:
This function is deprecated. Use property BackPlaneDistanceMode.Get() instead.

K_DEPRECATED void SetBackgroundDistance(double pDistance ) 

Set the background distance.

Parameters:
pDistance Distance of the background plane. This value can be either relative to the camera interest point or absolute from the camera position.
Remarks:
This function is deprecated. Use property BackPlaneDistance.Set(pDistance) instead.

K_DEPRECATED double GetBackgroundDistance( ) const

Get the background distance.

Returns:
The distance of the background plane.
Remarks:
This function is deprecated. Use property BackPlaneDistance.Get() instead.

K_DEPRECATED void SetViewCameraInterest(bool pEnable ) 

Change the camera interest visibility flag.

Parameters:
pEnable Set totrueif the camera interest is shown.
Remarks:
This function is deprecated. Use property ViewCameraToLookAt.Set(pEnable) instead.

K_DEPRECATED bool GetViewCameraInterest( ) const

Get current visibility state of the camera interest.

Returns:
trueif the camera interest is shown, orfalseif hidden.
Remarks:
This function is deprecated. Use property ViewCameraToLookAt.Get() instead.

K_DEPRECATED void SetViewNearFarPlanes(bool pEnable ) 

Change the camera near and far planes visibility flag.

Parameters:
pEnable Set totrueif the near and far planes are shown.
Remarks:
This function is deprecated. Use property ViewFrustumNearFarPlane.Set(pEnable) instead.

K_DEPRECATED bool GetViewNearFarPlanes( ) const

Get current visibility state of the camera near and far planes.

Returns:
trueif the near and far planes are shown.
Remarks:
This function is deprecated. Use property ViewFrustumNearFarPlane.Get() instead.

K_DEPRECATED void SetShowGrid(bool pEnable ) 

Change the draw floor grid flag.

Parameters:
pEnable Set totrueif the floor grid is shown.
Remarks:
This function is deprecated. Use property ShowGrid.Set(pEnable) instead.

K_DEPRECATED bool GetShowGrid( ) const

Get current floor grid draw state.

Returns:
trueif the floor grid is shown, orfalseif hidden.
Remarks:
This function is deprecated. Use property ShowGrid.Get() instead.

K_DEPRECATED void SetShowAxis(bool pEnable ) 

Change the draw system axis flag.

Parameters:
pEnable Set totrueif the system axis is shown.
Remarks:
This function is deprecated. Use property ShowAzimut.Set(pEnable) instead.

K_DEPRECATED bool GetShowAxis( ) const

Get current system axis draw state.

Returns:
trueif the system axis is shown, orfalseif hidden.
Remarks:
This function is deprecated. Use property ShowAzimut.Get() instead.

K_DEPRECATED void SetShowName(bool pEnable ) 

Change the show camera name flag.

Parameters:
pEnable Set totrueif the camera name is shown.
Remarks:
This function is deprecated. Use property ShowName.Set(pEnable) instead.

K_DEPRECATED bool GetShowName( ) const

Get current camera name show state.

Returns:
trueif the camera name is shown, orfalseif hidden.
Remarks:
This function is deprecated. Use property ShowName.Get() instead.

K_DEPRECATED void SetShowInfoOnMoving(bool pEnable ) 

Change the show info on moving flag.

Parameters:
pEnable Set totrueif info on moving is shown.
Remarks:
This function is deprecated. Use property ShowInfoOnMoving.Set(pEnable) instead.

K_DEPRECATED bool GetShowInfoOnMoving( ) const

Get current info on moving show state.

Returns:
trueif info on moving is shown, orfalseif hidden.
Remarks:
This function is deprecated. Use property ShowInfoOnMoving.Get() instead.

K_DEPRECATED void SetShowTimeCode(bool pEnable ) 

Change the timecode show flag.

Parameters:
pEnable Set totrueif the timecode is shown.
Remarks:
This function is deprecated. Use property ShowTimeCode.Set(pEnable) instead.

K_DEPRECATED bool GetShowTimeCode( ) const

Get current timecode show state.

Returns:
trueif the timecode is shown, orfalseif hidden.
Remarks:
This function is deprecated. Use property ShowTimeCode.Get() instead.

K_DEPRECATED void SetDisplaySafeArea(bool pEnable ) 

Change the display camera safe area flag.

Parameters:
pEnable Set totrueif the safe area is shown.
Remarks:
This function is deprecated. Use property DisplaySafeArea.Set(pEnable) instead.

K_DEPRECATED bool GetDisplaySafeArea( ) const

Get current safe area display state.

Returns:
trueif safe area is shown, orfalseif hidden.
Remarks:
This function is deprecated. Use property DisplaySafeArea.Get() instead.

K_DEPRECATED void SetDisplaySafeAreaOnRender(bool pEnable ) 

Change the display of the camera's safe area on render flag.

Parameters:
pEnable Set totrueif safe area is shown on render.
Remarks:
This function is deprecated. Use property DisplaySafeAreaOnRender.Set(pEnable) instead.

K_DEPRECATED bool GetDisplaySafeAreaOnRender( ) const

Get current safe area on render display state.

Returns:
trueif the safe area is shown on render, orfalseif it is hidden on render.
Remarks:
This function is deprecated. Use property DisplaySafeAreaOnRender.Get() instead.

K_DEPRECATED void SetSafeAreaStyle(ECameraSafeAreaStyle pStyle ) 

Set the safe area style.

Parameters:
pStyle Safe area style identifier.
Remarks:
This function is deprecated. Use property SafeAreaDisplayStyle.Set(pStyle) instead.

K_DEPRECATEDECameraSafeAreaStyleGetSafeAreaStyle( ) const

Get the currently set safe area style.

Returns:
Safe area style identifier.
Remarks:
This function is deprecated. Use property SafeAreaDisplayStyle.Get() instead.

K_DEPRECATED void SetShowAudio(bool pEnable ) 

Change the show audio flag.

Parameters:
pEnable Set totrueif audio waveform is shown.
Remarks:
This function is deprecated. Use property ShowAudio.Set(pEnable) instead.

K_DEPRECATED bool GetShowAudio( ) const

Get current audio show state.

Returns:
trueif audio is shown, orfalseif hidden.
Remarks:
This function is deprecated. Use property ShowAudio.Get() instead.

K_DEPRECATED void SetAudioColor(constKFbxColorpColor ) 

Set audio color.

Parameters:
pColor RGB values for the audio waveform color.
Remarks:
This function is deprecated. Use property AudioColor.Set(pColor) instead.

K_DEPRECATEDKFbxColorGetAudioColor( ) const

Get audio color.

Returns:
Currently set audio waveform color.
Remarks:
This function is deprecated. Use property AudioColor.Get() instead.

K_DEPRECATED void SetUseFrameColor(bool pEnable ) 

Change the use frame color flag.

Parameters:
pEnable Set totrueif the frame color is used.
Remarks:
This function is deprecated. Use property UseFrameColor.Set(pEnable) instead.

K_DEPRECATED bool GetUseFrameColor( ) const

Get the use frame color state.

Returns:
trueif the frame color is used, orfalseotherwise.
Remarks:
This function is deprecated. Use property UseFrameColor.Get() instead.

K_DEPRECATED void SetFrameColor(constKFbxColorpColor ) 

Set frame color.

Parameters:
pColor RGB values for the frame color.
Remarks:
This function is deprecated. Use property FrameColor.Set(pEnable) instead.

K_DEPRECATEDKFbxColorGetFrameColor( ) const

Get frame color.

Returns:
Currently set frame color.
Remarks:
This function is deprecated. Use property FrameColor.Set(pEnable) instead.

K_DEPRECATED void SetRenderOptionsUsageTime(ECameraRenderOptionsUsageTime pUsageTime ) 

Set the render options usage time.

Parameters:
pUsageTime The render options usage time identifier.
Remarks:
This function is deprecated. Use property UseRealTimeDOFAndAA.Set(pEnable) instead. pEnable == true<=>pUsageTime == eINTERACTIVE pEnable == false<=>pUsageTime == eAT_RENDER

K_DEPRECATEDECameraRenderOptionsUsageTimeGetRenderOptionsUsageTime( ) const

Get the render options usage time.

Returns:
Render options usage time identifier.
Remarks:
This function is deprecated. Use property UseRealTimeDOFAndAA.Get() instead. true<=>eINTERACTIVE false<=>eAT_RENDER

K_DEPRECATED void SetUseAntialiasing(bool pEnable ) 

Change the use antialiasing flag.

Parameters:
pEnable Set totrueif antialiasing is enabled.
Remarks:
This function is deprecated. Use property UseRealTimeDOFAndAA.Set(pEnable) instead.

K_DEPRECATED bool GetUseAntialiasing( ) const

Get the use antialiasing state.

Returns:
trueif antialiasing is enabled, orfalseif disabled.
Remarks:
This function is deprecated. Use property UseRealTimeDOFAndAA.Get() instead.

K_DEPRECATED void SetAntialiasingIntensity(double pIntensity ) 

Set antialiasing intensity.

Parameters:
pIntensity Antialiasing intensity value.
Remarks:
This function is deprecated. Use property AntialiasingIntensity.Set(pIntensity) instead.

K_DEPRECATED double GetAntialiasingIntensity( ) const

Get the antialiasing intensity.

Returns:
Return the current antialiasing intensity value.
Remarks:
This function is deprecated. Use property AntialiasingIntensity.Get() instead.

K_DEPRECATED void SetAntialiasingMethod(ECameraAntialiasingMethod pMethod ) 

Set antialiasing method.

Parameters:
pMethod The antialiasing method identifier.
Remarks:
This function is deprecated. Use property AntialiasingMethod.Set(pMethod) instead.

K_DEPRECATEDECameraAntialiasingMethodGetAntialiasingMethod( ) const

Get antialiasing method.

Returns:
The current antialiasing method identifier.
Remarks:
This function is deprecated. Use property AntialiasingMethod.Get() instead.

K_DEPRECATED void SetNumberOfSamples(int pNumberOfSamples ) 

Set the number of samples used to process oversampling.

Parameters:
pNumberOfSamples Number of samples used to process oversampling.
Remarks:
This option is only relevant if antialiasing method is set to eOVERSAMPLING_ANTIALIASING.

This function is deprecated. Use property FrameSamplingCount.Set(pNumberOfSamples) instead.

K_DEPRECATED int GetNumberOfSamples( ) const

Get the number of samples used to process oversampling.

Returns:
The current number of samples used to process oversampling.
Remarks:
This option is only relevant if antialiasing method is set to eOVERSAMPLING_ANTIALIASING.

This function is deprecated. Use property FrameSamplingCount.Get() instead.

K_DEPRECATED void SetSamplingType(ECameraSamplingType pType ) 

Set sampling type.

Parameters:
pType Sampling type identifier.
Remarks:
This option is only relevant if antialiasing type is set to eOVERSAMPLING_ANTIALIASING.

This function is deprecated. Use property FrameSamplingType.Set(pType) instead.

K_DEPRECATEDECameraSamplingTypeGetSamplingType( ) const

Get sampling type.

Returns:
The current sampling type identifier.
Remarks:
This option is only relevant if antialiasing type is set to eOVERSAMPLING_ANTIALIASING.

This function is deprecated. Use property FrameSamplingType.Get() instead.

K_DEPRECATED void SetUseAccumulationBuffer(bool pUseAccumulationBuffer ) 

Change the use accumulation buffer flag.

Parameters:
pUseAccumulationBuffer Set totrueto enable use of the accumulation buffer.
Remarks:
This function is deprecated. Use property UseAccumulationBuffer.Set(pUseAccumulationBuffer) instead.

K_DEPRECATED bool GetUseAccumulationBuffer( ) const

Get the state of the use accumulation buffer flag.

Returns:
trueif the use accumulation buffer flag is enabled,falseotherwise.
Remarks:
This function is deprecated. Use property UseAccumulationBuffer.Get() instead.

K_DEPRECATED void SetUseDepthOfField(bool pUseDepthOfField ) 

Change use depth of field flag.

Parameters:
pUseDepthOfField Set totrueif depth of field is used.
Remarks:
This function is deprecated. Use property UseDepthOfField.Set(pUseDepthOfField) instead.

K_DEPRECATED bool GetUseDepthOfField( ) const

Get use depth of field state.

Returns:
trueif depth of field is used,falseotherwise.
Remarks:
This function is deprecated. Use property UseDepthOfField.Get() instead.

K_DEPRECATED void SetFocusDistanceSource(ECameraFocusDistanceSource pSource ) 

Set source of camera focus distance.

Parameters:
pSource Focus distance source identifier.
Remarks:
This function is deprecated. Use property FocusSource.Set(pSource) instead.

K_DEPRECATEDECameraFocusDistanceSourceGetFocusDistanceSource( ) const

Get source of camera focus distance.

Returns:
Focus distance source identifier.
Remarks:
This function is deprecated. Use property FocusSource.Get() instead.

K_DEPRECATED void SetSpecificDistance(double pDistance ) 

Set the focus distance of the lens in millimiters.

Parameters:
pDistance Focus distance value.
Remarks:
This option is only relevant if focus distance source is set to eSPECIFIC_DISTANCE.

This function is deprecated. Use property FocusDistance.Set(pDistance) instead.

K_DEPRECATED double GetSpecificDistance( ) const

Get the focus distance of the lens in millimiters.

Returns:
Focus distance value.
Remarks:
This option is only relevant if focus distance source is set to eSPECIFIC_DISTANCE.

This function is deprecated. Use property FocusDistance.Get() instead.

K_DEPRECATED void SetFocusAngle(double pAngle ) 

Set the focus angle in degrees.

Parameters:
pAngle Focus angle value.
Remarks:
This function is deprecated. Use property FocusAngle.Set(pAngle) instead.

K_DEPRECATED double GetFocusAngle( ) const

Get the focus angle in degrees.

Returns:
Focus angle value.
Remarks:
This function is deprecated. Use property FocusAngle.Get() instead.

K_DEPRECATED void SetDefaultFieldOfView(double pFieldOfView ) 

Set default field of view in degrees.

Use this function to set the default field of view value when the camera aperture mode is set to eithereHORIZONTALoreVERTICAL. When the camera aperture mode is set toeHORIZONTAL, this function sets the horizontal field of view in degrees and the vertical field of view is adjusted accordingly. When the camera aperture mode is set toeVERTICAL, this function sets the vertical field of view in degrees and the horizontal field of view is adjusted accordingly.

Parameters:
pFieldOfView Field of view value.
Remarks:
This function has no effect when the camera aperture mode is set to eithereHORIZONTAL_AND_VERTICALoreFOCAL_LENGTH. The default field of view value is 25.115.

This function is deprecated. Use property FieldOfView.Set(pFieldOfView) instead.

K_DEPRECATED double GetDefaultFieldOfView( ) const

Get default field of view.

Use this function to get the default field of view value when the camera aperture mode is set to eithereHORIZONTALoreVERTICAL.

Returns:
If the camera aperture mode is set to eithereHORIZONTALoreVERTICAL, this function returns either the horizontal or vertical field of view value in degrees. If the camera aperture mode is set to eithereHORIZONTAL_AND_VERTICALoreFOCAL_LENGTH, this function has no effect and returns 0.
Remarks:
The default field of view value is 25.115.

This function is deprecated. Use property FieldOfView.Get() instead.

K_DEPRECATED void SetDefaultFieldOfViewX(double pFieldOfViewX ) 

Set default field of view X.

Use this function to set the default field of view horizontal value when the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL. This function sets the horizontal field of view in degrees.

Parameters:
pFieldOfViewX Field of view value.
Remarks:
This function has no effect if the camera aperture mode is set toeHORIZONTAL,eVERTICAL, oreFOCAL_LENGTH. The default field of view horizontal value is 40.

This function is deprecated. Use property FieldOfViewX.Set(pFieldOfViewX) instead.

K_DEPRECATED double GetDefaultFieldOfViewX( ) const

Get default field of view X.

Use this function to get the default field of view horizontal value when the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL.

Returns:
If the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL, return the current field of view horizontal value in degrees. If the camera aperture mode is set toeHORIZONTAL,eVERTICAL, oreFOCAL_LENGTH, this function has no effect and returns 0.
Remarks:
The default field of view X value is 40 degrees.

This function is deprecated. Use property FieldOfViewX.Get() instead.

K_DEPRECATED void SetDefaultFieldOfViewY(double pFieldOfViewY ) 

Set default field of view Y.

Use this function to set the default field of view vertical value when the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL.

Parameters:
pFieldOfViewY Field of view value.
Remarks:
This function has no effect if the camera aperture mode is set toeHORIZONTAL,eVERTICAL, oreFOCAL_LENGTH. The default field of view horizontal value is 40.

This function is deprecated. Use property FieldOfViewY.Set(pFieldOfViewY) instead.

K_DEPRECATED double GetDefaultFieldOfViewY( ) const

Get default field of view Y.

Use this function to get the default field of view vertical value when the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL.

Returns:
If the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL, return the current field of view vertical value in degrees. If the camera aperture mode is set toeHORIZONTAL,eVERTICAL, oreFOCAL_LENGTH, this function has no effect and returns 0.
Remarks:
The default field of view Y value is 40 degrees.

This function is deprecated. Use property FieldOfViewY.Get() instead.

K_DEPRECATED void SetDefaultOpticalCenterX(double pOpticalCenterX ) 

Set default optical center X, in pixels.

Use this function to set the default optical center horizontal value when the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL.

Parameters:
pOpticalCenterX Optical center offset.
Remarks:
This function has no effect if the camera aperture mode is set toeHORIZONTAL,eVERTICAL, oreFOCAL_LENGTH. The default optical center horizontal offset is 0.

This function is deprecated. Use property OpticalCenterX.Set(pOpticalCenterX) instead.

K_DEPRECATED double GetDefaultOpticalCenterX( ) const

Get default optical center X, in pixels.

Use this function to get the default optical center horizontal offset when the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL.

Returns:
If the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL, return the current optical center horizontal offset. If the camera aperture mode is set toeHORIZONTAL,eVERTICAL, oreFOCAL_LENGTH, this function has no effect and returns 0.
Remarks:
The default optical center X offset is 0.

This function is deprecated. Use property OpticalCenterX.Get() instead.

K_DEPRECATED void SetDefaultOpticalCenterY(double pOpticalCenterY ) 

Set default optical center Y, in pixels.

Use this function to set the default optical center vertical offset when the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL.

Parameters:
pOpticalCenterY Optical center offset.
Remarks:
This function has no effect if the camera aperture mode is set toeHORIZONTAL,eVERTICAL, oreFOCAL_LENGTH. The default optical center vertical offset is 0.

This function is deprecated. Use property OpticalCenterY.Set(pOpticalCenterY) instead.

K_DEPRECATED double GetDefaultOpticalCenterY( ) const

Get default optical center Y, in pixels.

Use this function to get the default optical center vertical offset when the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL.

Returns:
If the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL, return the current optical center vertical offset. If the camera aperture mode is set toeHORIZONTAL,eVERTICAL, oreFOCAL_LENGTH, this function has no effect and returns 0.
Remarks:
The default optical center X offset is 0.

This function is deprecated. Use property OpticalCenterY.Get() instead.

K_DEPRECATED void SetDefaultFocalLength(double pFocalLength ) 

Set default focal length, in millimeters Use this function to set the default focal length when the camera aperture mode is set toeFOCAL_LENGTH.

Parameters:
pFocalLength Focal length value.
Remarks:
This function has no effect if the camera aperture mode is set toeHORIZONTAL,eVERTICAL, oreHORIZONTAL_AND_VERTICAL. The default focal length is 0.

This function is deprecated. Use property FocalLength.Set(pFocalLength) instead.

K_DEPRECATED double GetDefaultFocalLength( ) const

Get default focal length, in millimeters Use this function to get the default focal length when the camera aperture mode is set toeFOCAL_LENGTH.

Returns:
If the camera aperture mode is set toeFOCAL_LENGTH, return the current default focal length. If the camera aperture mode is set toeHORIZONTAL,eVERTICAL, oreHORIZONTAL_AND_VERTICAL, this function has no effect and returns 0.
Remarks:
The default focal length is 0.

This function is deprecated. Use property FocalLength.Get() instead.

K_DEPRECATED void SetDefaultRoll(double pRoll ) 

Set default camera roll in degrees.

Parameters:
pRoll Roll value.
Remarks:
The default roll value is 0.

This function is deprecated. Use property Roll.Set(pRoll) instead.

K_DEPRECATED double GetDefaultRoll( ) const

Get default camera roll in degrees.

Returns:
Current roll value.
Remarks:
The default roll value is 0.

This function is deprecated. Use property Roll.Get() instead.

K_DEPRECATED void SetDefaultTurnTable(double pTurnTable ) 

Set default turntable value in degrees.

Parameters:
pTurnTable Turntable value.
Remarks:
The default turntable value is 0.

This function is deprecated. Use property TurnTable.Set(pTurnTable) instead.

K_DEPRECATED double GetDefaultTurnTable( ) const

Get default turntable in degrees.

Returns:
Current turntable value.
Remarks:
The default turntable value is 0.

This function is deprecated. Use property TurnTable.Get() instead.

K_DEPRECATED void SetDefaultBackgroundColor(constKFbxColorpColor ) 

Set default background color.

Parameters:
pColor RGB values of the background color.
Remarks:
The default background color is black.

This function is deprecated. Use property BackgroundColor.Set(pColor) instead.

K_DEPRECATEDKFbxColorGetDefaultBackgroundColor( ) const

Get default background color.

Returns:
Current background color.
Remarks:
The default background color is black.

This function is deprecated. Use property BackgroundColor.Get() instead.

K_DEPRECATED void SetBackgroundColor(constKFbxColorpColor ) 

Set background color.

This method is replaced by the SetDefaultBackgroundColor when setting a non-animated value. For animated values, the client application must access the BackgroundColor fcurves in the take.

Remarks:
This function is deprecated. Use property BackgroundColor.Set(pColor) instead.

K_DEPRECATEDKFbxColorGetBackgroundColor( ) const

Get background color.

This method is replaced by the GetDefaultBackgroundColor when getting a non-animated value. For animated values, the client application must access the BackgroundColor fcurves in the take.

Remarks:
This function is deprecated. Use property BackgroundColor.Get() instead.

K_DEPRECATED void SetAngleOfView(double pAngleOfView ) 

Set the camera angle of view in degrees.

Parameters:
pAngleOfView The camera angle of view value in degrees. This value is limited to the range [1.0, 179.0].
Warning:
Modifying the angle of view will automatically change the focal length.
Remarks:
This function is deprecated. Use SetDefaultFieldOfView(pAngleOfView), SetDefaultFieldOfViewX(pAngleOfView) or SetDefaultFieldOfViewY(pAngleOfView) instead.

K_DEPRECATED double GetAngleOfView( ) const

Get the camera angle of view in degrees.

Returns:
The camera's current angle of view value in degrees.
Remarks:
This function is deprecated. UseGetDefaultFieldOfView(),GetDefaultFieldOfViewX()orGetDefaultFieldOfViewY()instead.

K_DEPRECATED void SetFocalLength(double pFocalLength ) 

Set the focal length of the camera in millimeters.

Parameters:
pFocalLength The focal length in mm.
Warning:
Modifying the focal length will automatically change the angle of view.
Remarks:
This function is deprecated. Use SetDefaultFocalLength(pFocalLength) instead.

K_DEPRECATED double GetFocalLength( ) const

Get the camera focal length in millimeters.

Returns:
The camera's current focal length value.
Remarks:
This function is deprecated. UseGetDefaultFocalLength()instead.

bool IsBoundingBoxInView(constKFbxMatrixpWorldToScreen,
constKFbxMatrixpWorldToCamera,
constKFbxVector4 pPoints[8] 
)const

Determine if the given bounding box is in the camera's view.

The input points do not need to be ordered in any particular way.

Parameters:
pWorldToScreen The world to screen transformation. See ComputeWorldToScreen.
pWorldToCamera The world to camera transformation. Inverse matrix returned fromKFbxNode::GetGlobalFromCurrentTakeis suitable. SeeKFbxNodeAttribute::GetNode()andKFbxNode::GetGlobalFromCurrentTake().
pPoints 8 corners of the bounding box.
Returns:
true if any of the given points are in the camera's view, false otherwise.

bool IsPointInView(constKFbxMatrixpWorldToScreen,
constKFbxMatrixpWorldToCamera,
constKFbxVector4pPoint 
)const

Determine if the given 3d point is in the camera's view.

Parameters:
pWorldToScreen The world to screen transformation. See ComputeWorldToScreen.
pWorldToCamera The world to camera transformation. Inverse matrix returned fromKFbxNode::GetGlobalFromCurrentTakeis suitable. SeeKFbxNodeAttribute::GetNode()andKFbxNode::GetGlobalFromCurrentTake().
pPoint World-space point to test.
Returns:
true if the given point is in the camera's view, false otherwise.

KFbxMatrixComputeWorldToScreen(int pPixelWidth,
int pPixelHeight,
constKFbxXMatrixpWorldToCamera 
)const

Compute world space to screen space transformation matrix.

Parameters:
pPixelHeight The pixel height of the output image.
pPixelWidth The pixel height of the output image.
pWorldToCamera The world to camera affine transformation matrix.
Returns:
The world to screen space matrix, or the identity matrix on error.

KFbxMatrixComputePerspective(int pPixelWidth,
int pPixelHeight,
bool pIncludePostPerspective 
)const

Compute the perspective matrix for this camera.

Suitable for transforming camera space to normalized device coordinate space. Also suitable for use as an OpenGL projection matrix. Note this fails if the ProjectionType is not ePERSPECTIVE.

Parameters:
pPixelHeight The pixel height of the output image.
pPixelWidth The pixel height of the output image.
pIncludePostPerspective Indicate that post-projection transformations (offset, roll) be included in the output matrix.
Returns:
A perspective matrix, or the identity matrix on error.

Member Data Documentation

KFbxTypedProperty<fbxDouble3>Position

This property handles the camera position (XYZ coordinates).

To access this property do: Position.Get(). To set this property do: Position.Set(fbxDouble3).

Remarks:
Default Value is (0.0, 0.0, 0.0)

Definition at line1553of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble3>UpVector

This property handles the camera Up Vector (XYZ coordinates).

To access this property do: UpVector.Get(). To set this property do: UpVector.Set(fbxDouble3).

Remarks:
Default Value is (0.0, 1.0, 0.0)

Definition at line1562of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble3>InterestPosition

This property handles the default point (XYZ coordinates) the camera is looking at.

To access this property do: InterestPosition.Get(). To set this property do: InterestPosition.Set(fbxDouble3).

Remarks:
During the computations of the camera position and orientation, this property is overridden by the position of a valid target in the parent node.

Default Value is (0.0, 0.0, 0.0)

Definition at line1575of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>Roll

This property handles the camera roll angle in degree(s).

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

Default value is 0.

Definition at line1584of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>OpticalCenterX

This property handles the camera optical center X, in pixels.

It parameter sets the optical center horizontal offset when the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL. It has no effect otherwise.

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

Default value is 0.

Definition at line1596of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>OpticalCenterY

This property handles the camera optical center Y, in pixels.

It sets the optical center horizontal offset when the camera aperture mode is set toeHORIZONTAL_AND_VERTICAL. This parameter has no effect otherwise.

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

Default value is 0.

Definition at line1608of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble3>BackgroundColor

This property handles the camera RGB values of the background color.

To access this property do: BackgroundColor.Get(). To set this property do: BackgroundColor.Set(fbxDouble3).

Default value is black (0, 0, 0)

Definition at line1617of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>TurnTable

This property handles the camera turn table angle in degree(s).

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

Default value is 0.

Definition at line1626of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>DisplayTurnTableIcon

This property handles a flags that indicates if the camera displays the Turn Table icon or not.

To access this property do: DisplayTurnTableIcon.Get(). To set this property do: DisplayTurnTableIcon.Set(fbxBool1).

Default value is false (no display).

Definition at line1636of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>UseMotionBlur

This property handles a flags that indicates if the camera uses motion blur or not.

To access this property do: UseMotionBlur.Get(). To set this property do: UseMotionBlur.Set(fbxBool1).

Default value is false (do not use motion blur).

Definition at line1650of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>UseRealTimeMotionBlur

This property handles a flags that indicates if the camera uses real time motion blur or not.

To access this property do: UseRealTimeMotionBlur.Get(). To set this property do: UseRealTimeMotionBlur.Set(fbxBool1).

Default value is false (use real time motion blur).

Definition at line1660of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>MotionBlurIntensity

This property handles the camera motion blur intensity (in pixels).

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

Default value is 1.

Definition at line1669of filekfbxcamera.h.

This property handles the camera aspect ratio mode.

Remarks:
This Property is in a Read Only mode.

Please use functionSetAspect()if you want to change its value.

Default value is eWINDOW_SIZE.

Definition at line1683of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>AspectWidth

This property handles the camera aspect width.

Remarks:
This Property is in a Read Only mode.

Please use functionSetAspect()if you want to change its value.

Default value is 320.

Definition at line1692of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>AspectHeight

This property handles the camera aspect height.

Remarks:
This Property is in a Read Only mode.

Please use functionSetAspect()if you want to change its value.

Default value is 200.

Definition at line1701of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>PixelAspectRatio

This property handles the pixel aspect ratio.

Remarks:
This Property is in a Read Only mode.

Please use functionSetPixelRatio()if you want to change its value. Default value is 1.

Value range is [0.050, 20.0].

Definition at line1710of filekfbxcamera.h.

This property handles the aperture mode.

Default value is eVERTICAL.

Definition at line1716of filekfbxcamera.h.

KFbxTypedProperty<ECameraGateFit>GateFit

This property handles the gate fit mode.

To access this property do: GateFit.Get(). To set this property do: GateFit.Set(ECameraGateFit).

Default value is eNO_FIT.

Definition at line1725of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FieldOfView

This property handles the field of view in degrees.

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

Remarks:
This property has meaning only when property ApertureMode equals eHORIZONTAL or eVERTICAL.

Default vaule is 40.

Value range is [1.0, 179.0].

Definition at line1738of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FieldOfViewX

This property handles the X (horizontal) field of view in degrees.

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

Remarks:
This property has meaning only when property ApertureMode equals eHORIZONTAL or eVERTICAL.
Default value is 1.
Remarks:
Value range is [1.0, 179.0].

Definition at line1752of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FieldOfViewY

This property handles the Y (vertical) field of view in degrees.

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

Remarks:
This property has meaning only when property ApertureMode equals eHORIZONTAL or eVERTICAL.

Default vaule is 1.

Value range is [1.0, 179.0].

Definition at line1765of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FocalLength

This property handles the focal length (in millimeters).

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

Default value is the result of ComputeFocalLength(40.0).

Definition at line1774of filekfbxcamera.h.

KFbxTypedProperty<ECameraFormat>CameraFormat

This property handles the camera format.

To access this property do: CameraFormat.Get(). To set this property do: CameraFormat.Set(ECameraFormat).

Remarks:
This Property is in a Read Only mode.

Please use functionSetFormat()if you want to change its value. Default value is eCUSTOM_FORMAT.

Definition at line1785of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>UseFrameColor

This property stores a flag that indicates to use or not a color for the frame.

To access this property do: UseFrameColor.Get(). To set this property do: UseFrameColor.Set(fbxBool1).

Default value is false.

Definition at line1799of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble3>FrameColor

This property handles the fame color.

To access this property do: FrameColor.Get(). To set this property do: FrameColor.Set(fbxDouble3).

Default value is (0.3, 0.3, 0.3).

Definition at line1808of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ShowName

This property handles the show name flag.

To access this property do: ShowName.Get(). To set this property do: ShowName.Set(fbxBool1).

Default value is true.

Definition at line1821of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ShowInfoOnMoving

This property handles the show info on moving flag.

To access this property do: ShowInfoOnMoving.Get(). To set this property do: ShowInfoOnMoving.Set(fbxBool1).

Default value is true.

Definition at line1830of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ShowGrid

This property handles the draw floor grid flag.

To access this property do: ShowGrid.Get(). To set this property do: ShowGrid.Set(fbxBool1).

Default value is true.

Definition at line1839of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ShowOpticalCenter

This property handles the show optical center flag.

To access this property do: ShowOpticalCenter.Get(). To set this property do: ShowOpticalCenter.Set(fbxBool1).

Default value is false.

Definition at line1848of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ShowAzimut

This property handles the show axis flag.

To access this property do: ShowAzimut.Get(). To set this property do: ShowAzimut.Set(fbxBool1).

Default value is true.

Definition at line1857of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ShowTimeCode

This property handles the show time code flag.

To access this property do: ShowTimeCode.Get(). To set this property do: ShowTimeCode.Set(fbxBool1).

Default value is true.

Definition at line1866of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ShowAudio

This property handles the show audio flag.

To access this property do: ShowAudio.Get(). To set this property do: ShowAudio.Set(fbxBool1).

Default value is false.

Definition at line1875of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble3>AudioColor

This property handles the show audio flag.

To access this property do: AudioColor.Get(). To set this property do: AudioColor.Set(fbxDouble3).

Default value is (0.0, 1.0, 0.0)

Definition at line1884of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>NearPlane

This property handles the near plane distance.

Remarks:
This Property is in a Read Only mode.

Please use functionSetNearPlane()if you want to change its value. Default value is 10.

Value range is [0.001, 600000.0].

Definition at line1897of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FarPlane

This property handles the far plane distance.

Remarks:
This Property is in a Read Only mode

Please use functionSetPixelRatio()if you want to change its value Default value is 4000

Value range is [0.001, 600000.0]

Definition at line1906of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>AutoComputeClipPlanes

This property indicates that the clip planes should be automatically computed.

To access this property do: AutoComputeClipPlanes.Get(). To set this property do: AutoComputeClipPlanes.Set(fbxBool1).

When this property is set to true, the NearPlane and FarPlane values are ignored. Note that not all applications support this flag.

Definition at line1917of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FilmWidth

This property handles the film aperture width (in inches).

Remarks:
This Property is in a Read Only mode

Please use functionSetApertureWidth()orSetApertureFormat()if you want to change its value Default value is 0.8160

Value range is [0.0001, +inf[

Definition at line1932of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FilmHeight

This property handles the film aperture height (in inches).

Remarks:
This Property is in a Read Only mode

Please use functionSetApertureHeight()orSetApertureFormat()if you want to change its value Default value is 0.6120

Value range is [0.0001, +inf[

Definition at line1942of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FilmAspectRatio

This property handles the film aperture aspect ratio.

Remarks:
This Property is in a Read Only mode

Please use functionSetApertureFormat()if you want to change its value Default value is (FilmWidth / FilmHeight)

Value range is [0.0001, +inf[

Definition at line1951of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FilmSqueezeRatio

This property handles the film aperture squeeze ratio.

Remarks:
This Property is in a Read Only mode

Please use functionSetSqueezeRatio()orSetApertureFormat()if you want to change its value Default value is 1.0

Value range is [0.0001, +inf[

Definition at line1961of filekfbxcamera.h.

This property handles the film aperture format.

Remarks:
This Property is in a Read Only mode

Please use functionSetApertureFormat()if you want to change its value Default value is eCUSTOM_APERTURE_FORMAT

Definition at line1970of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble2>FilmOffset

This property handles the offset from the center of the film aperture, defined by the film height and film width.

The offset is measured in inches.

To access this property do: FilmOffset.Get(). To set this property do: FilmOffset.Set(fbxDouble2).

Definition at line1980of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ViewFrustum

This property handles the view frustrum flag.

To access this property do: ViewFrustum.Get(). To set this property do: ViewFrustum.Set(fbxBool1).

Default value is true

Definition at line1994of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ViewFrustumNearFarPlane

This property handles the view frustrum near and far plane flag.

To access this property do: ViewFrustumNearFarPlane.Get(). To set this property do: ViewFrustumNearFarPlane.Set(fbxBool1).

Default value is false

Definition at line2003of filekfbxcamera.h.

This property handles the view frustrum back plane mode.

To access this property do: ViewFrustumBackPlaneMode.Get(). To set this property do: ViewFrustumBackPlaneMode.Set(ECameraBackgroundDisplayMode).

Default value is eWHEN_MEDIA

Definition at line2012of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>BackPlaneDistance

This property handles the view frustrum back plane distance.

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

Default value is 100.0

Definition at line2021of filekfbxcamera.h.

This property handles the view frustrum back plane distance mode.

To access this property do: BackPlaneDistanceMode.Get(). To set this property do: BackPlaneDistanceMode.Set(ECameraBackgroundDistanceMode).

Default value is eRELATIVE_TO_INTEREST

Definition at line2030of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ViewCameraToLookAt

This property handles the view camera to look at flag.

To access this property do: ViewCameraToLookAt.Get(). To set this property do: ViewCameraToLookAt.Set(fbxBool1).

Default value is true

Definition at line2039of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>LockMode

This property handles the lock mode.

To access this property do: LockMode.Get(). To set this property do: LockMode.Set(fbxBool1).

Default value is false

Definition at line2052of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>LockInterestNavigation

This property handles the lock interest navigation flag.

To access this property do: LockInterestNavigation.Get(). To set this property do: LockInterestNavigation.Set(fbxBool1).

Default value is false

Definition at line2061of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>FitImage

This property handles the fit image flag.

To access this property do: FitImage.Get(). To set this property do: FitImage.Set(fbxBool1).

Default value is false.

Definition at line2074of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>Crop

This property handles the crop flag.

Default value is false.

Definition at line2080of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>Center

This property handles the center flag.

To access this property do: Center.Get(). To set this property do: Center.Set(fbxBool1).

Default value is true.

Definition at line2089of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>KeepRatio

This property handles the keep ratio flag.

To access this property do: KeepRatio.Get(). To set this property do: KeepRatio.Set(fbxBool1).

Default value is true.

Definition at line2098of filekfbxcamera.h.

This property handles the background mode flag.

To access this property do: BackgroundMode.Get(). To set this property do: BackgroundMode.Set(ECameraBackgroundDrawingMode).

Default value is eBACKGROUND.

Definition at line2107of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>BackgroundAlphaTreshold

This property handles the background alpha threshold value.

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

Default value is 0.5.

Definition at line2116of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>FrontPlateFitImage

This property handles the fit image for front plate flag.

To access this property do: FrontPlateFitImage.Get(). To set this property do: FrontPlateFitImage.Set(fbxBool1).

Default value is false.

Definition at line2129of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>FrontPlateCrop

This property handles the front plane crop flag.

To access this property do: FrontPlateCrop.Get(). To set this property do: FrontPlateCrop.Set(fbxBool1).

Default value is false.

Definition at line2138of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>FrontPlateCenter

This property handles the front plane center flag.

To access this property do: FrontPlateCenter.Get(). To set this property do: FrontPlateCenter.Set(fbxBool1).

Default value is true.

Definition at line2147of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>FrontPlateKeepRatio

This property handles the front plane keep ratio flag.

To access this property do: FrontPlateKeepRatio.Get(). To set this property do: FrontPlateKeepRatio.Set(fbxBool1).

Default value is true.

Definition at line2156of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>ShowFrontPlate

This property handles the front plane show flag.

To access this property do: ShowFrontPlate.Get(). To set this property do: ShowFrontPlate.Set(fbxBool1).

Default value is false.

Remarks:
this replaces ForegroundTransparent

Definition at line2167of filekfbxcamera.h.

This property handles the view frustrum front plane mode.

To access this property do: ViewFrustumFrontPlaneMode.Get(). To set this property do: ViewFrustumFrontPlaneMode.Set(ECameraBackgroundDisplayMode).

Default value is eWHEN_MEDIA

Definition at line2176of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FrontPlaneDistance

This property handles the view frustrum front plane distance.

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

Default value is 100.0

Definition at line2185of filekfbxcamera.h.

This property handles the view frustrum front plane distance mode.

To access this property do: FrontPlaneDistanceMode.Get(). To set this property do: FrontPlaneDistanceMode.Set(ECameraBackgroundDistanceMode).

Default value is eRELATIVE_TO_INTEREST

Definition at line2194of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>ForegroundAlpha

This property handles the foreground alpha value.

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

Default value is 0.5.

Definition at line2203of filekfbxcamera.h.

KFbxTypedProperty<fbxReference>ForegroundTexture

This property has the foreground textures connected to it.

To access this property do: ForegroundTexture.Get(). To set this property do: ForegroundTexture.Set(fbxReference).

Remarks:
they are connected as source objects

Definition at line2213of filekfbxcamera.h.

KFbxTypedProperty<fbxReference>BackgroundTexture

This property has the background textures connected to it.

To access this property do: BackgroundTexture.Get(). To set this property do: BackgroundTexture.Set(fbxReference).

Remarks:
they are connected as source objects

Definition at line2222of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>DisplaySafeArea

This property handles the display safe area flag.

To access this property do: DisplaySafeArea.Get(). To set this property do: DisplaySafeArea.Set(fbxBool1).

Default value is false

Definition at line2236of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>DisplaySafeAreaOnRender

This property handles the display safe area on render flag.

To access this property do: DisplaySafeAreaOnRender.Get(). To set this property do: DisplaySafeAreaOnRender.Set(fbxBool1).

Default value is false

Definition at line2245of filekfbxcamera.h.

This property handles the display safe area display style.

To access this property do: SafeAreaDisplayStyle.Get(). To set this property do: SafeAreaDisplayStyle.Set(ECameraSafeAreaStyle).

Default value is eSQUARE

Definition at line2254of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>SafeAreaAspectRatio

This property handles the display safe area aspect ratio.

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

Default value is 1.33333333333333

Definition at line2263of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>Use2DMagnifierZoom

This property handles the use 2d magnifier zoom flag.

To access this property do: Use2DMagnifierZoom.Get(). To set this property do: Use2DMagnifierZoom.Set(fbxBool1).

Default value is false

Definition at line2276of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>_2DMagnifierZoom

This property handles the 2d magnifier zoom value.

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

Default value is 100.0

Definition at line2285of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>_2DMagnifierX

This property handles the 2d magnifier X value.

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

Default value is 50.0

Definition at line2294of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>_2DMagnifierY

This property handles the 2d magnifier Y value.

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

Default value is 50.0

Definition at line2303of filekfbxcamera.h.

This property handles the projection type.

To access this property do: ProjectionType.Get(). To set this property do: ProjectionType.Set(ECameraProjectionType).

Default value is ePERSPECTIVE.

Definition at line2316of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>OrthoZoom

This property handles the otho zoom.

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

Default value is 1.0.

Definition at line2325of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>UseRealTimeDOFAndAA

This property handles the use real time DOF and AA flag.

To access this property do: UseRealTimeDOFAndAA.Get(). To set this property do: UseRealTimeDOFAndAA.Set(fbxBool1).

Default value is false.

Definition at line2338of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>UseDepthOfField

This property handles the use depth of field flag.

To access this property do: UseDepthOfField.Get(). To set this property do: UseDepthOfField.Set(fbxBool1).

Default value is false

Definition at line2347of filekfbxcamera.h.

This property handles the focus source.

To access this property do: FocusSource.Get(). To set this property do: FocusSource.Set(ECameraFocusDistanceSource).

Default value is eCAMERA_INTEREST

Definition at line2356of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FocusAngle

This property handles the focus angle (in degrees).

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

Default value is 3.5

Definition at line2365of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>FocusDistance

This property handles the focus distance.

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

Default value is 200.0

Definition at line2374of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>UseAntialiasing

This property handles the use anti aliasing flag.

To access this property do: UseAntialiasing.Get(). To set this property do: UseAntialiasing.Set(fbxBool1).

Default value is false

Definition at line2383of filekfbxcamera.h.

KFbxTypedProperty<fbxDouble1>AntialiasingIntensity

This property handles the anti aliasing intensity.

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

Default value is 0.77777

Definition at line2392of filekfbxcamera.h.

This property handles the anti aliasing method.

To access this property do: AntialiasingMethod.Get(). To set this property do: AntialiasingMethod.Set(ECameraAntialiasingMethod).

Default value is eOVERSAMPLING_ANTIALIASING

Definition at line2401of filekfbxcamera.h.

KFbxTypedProperty<fbxBool1>UseAccumulationBuffer

This property handles the use accumulation buffer flag.

To access this property do: UseAccumulationBuffer.Get(). To set this property do: UseAccumulationBuffer.Set(fbxBool1).

Default value is false

Definition at line2414of filekfbxcamera.h.

KFbxTypedProperty<fbxInteger1>FrameSamplingCount

This property handles the frame sampling count.

To access this property do: FrameSamplingCount.Get(). To set this property do: FrameSamplingCount.Set(fbxInteger1).

Default value is 7

Definition at line2423of filekfbxcamera.h.

This property handles the frame sampling type.

To access this property do: FrameSamplingType.Get(). To set this property do: FrameSamplingType.Set(ECameraSamplingType).

Default value is eSTOCHASTIC

Definition at line2432of filekfbxcamera.h.