KFbxCamera Class Reference

This reference page is linked to from the following overview topics: Supported Scene Elements, Information and Technical Support, Connections, Nodes and the Scene Graph, FBX Nodes, FBX Node Attributes, Cameras, List of Python FBX classes.

---

Search for all occurrences

---

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 ECameraFocusDistanceSource::eCAMERA_INTEREST and the followed node associated with function KFbxNode::SetTarget().

See also:

KFbxCameraStereo KFbxCameraSwitcher

Examples:

ExportScene04/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayCamera.cxx, StereoCamera/main.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, ViewScene/DrawScene.cxx, ViewScene/main.cxx, ViewScene/SetCamera.cxx, and ViewScene/SetCamera.h.

Definition at line 66 of file kfbxcamera.h.

#include <kfbxcamera.h>

Inheritance diagram for KFbxCamera:

List of all members.

Public Types
enum	ECameraProjectionType { ePERSPECTIVE, eORTHOGONAL }
	Camera projection types. More...
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.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
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< ECameraGateFit >	GateFit
	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< ECameraFormat >	CameraFormat
	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 frame 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< fbxDouble1 >	FilmOffsetX
	This property handles the horizontal offset from the center of the film aperture, defined by the film height and film width.
KFbxTypedProperty< fbxDouble1 >	FilmOffsetY
	This property handles the vertical offset from the center of the film aperture, defined by the film height and film width.
KFbxTypedProperty< fbxDouble1 >	PreScale
	This property handles the pre-scale value.
KFbxTypedProperty< fbxDouble1 >	FilmTranslateX
	This property handles the horizontal film horizontal translation.
KFbxTypedProperty< fbxDouble1 >	FilmTranslateY
	This property handles the vertical film translation.
KFbxTypedProperty< fbxDouble1 >	FilmRollPivotX
	This property handles the horizontal pivot point used for rotating the film back.
KFbxTypedProperty< fbxDouble1 >	FilmRollPivotY
	This property handles the vertical pivot point used for rotating the film back.
KFbxTypedProperty< fbxDouble1 >	FilmRollValue
	This property handles the amount of rotation around the film back The roll value is specified in degrees.
KFbxTypedProperty < ECameraFilmRollOrder >	FilmRollOrder
	This property handles how the roll is applied with respect to the pivot value.
KFbxTypedProperty< fbxBool1 >	ViewCameraToLookAt
	This property handles the view camera to look at flag.
KFbxTypedProperty< fbxBool1 >	ViewFrustumNearFarPlane
	This property handles the view frustum near and far plane display state.
KFbxTypedProperty < ECameraFrontBackPlaneDisplayMode >	ViewFrustumBackPlaneMode
	This property handles the view frustum back plane mode.
KFbxTypedProperty< fbxDouble1 >	BackPlaneDistance
	This property handles the view frustum back plane distance.
KFbxTypedProperty < ECameraFrontBackPlaneDistanceMode >	BackPlaneDistanceMode
	This property handles the view frustum back plane distance mode.
KFbxTypedProperty < ECameraFrontBackPlaneDisplayMode >	ViewFrustumFrontPlaneMode
	This property handles the view frustum front plane mode.
KFbxTypedProperty< fbxDouble1 >	FrontPlaneDistance
	This property handles the view frustum front plane distance.
KFbxTypedProperty < ECameraFrontBackPlaneDistanceMode >	FrontPlaneDistanceMode
	This property handles the view frustum front plane distance mode.
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< fbxDouble1 >	BackgroundAlphaTreshold
	This property handles the background alpha threshold value.
KFbxTypedProperty< fbxDouble1 >	BackPlaneOffsetX
	This property handles the back plane offset X.
KFbxTypedProperty< fbxDouble1 >	BackPlaneOffsetY
	This property handles the back plane offset Y.
KFbxTypedProperty< fbxDouble1 >	BackPlaneRotation
	This property handles the back plane rotation.
KFbxTypedProperty< fbxDouble1 >	BackPlaneScaleX
	This property handles the back plane scaling X.
KFbxTypedProperty< fbxDouble1 >	BackPlaneScaleY
	This property handles the back plane scaling Y.
KFbxTypedProperty< fbxBool1 >	ShowBackplate
	This property handles the back plane show flag.
KFbxTypedProperty< fbxReference >	BackgroundTexture
	This property has the background textures connected to it.
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< fbxDouble1 >	FrontPlaneOffsetX
	This property handles the front plane offset X.
KFbxTypedProperty< fbxDouble1 >	FrontPlaneOffsetY
	This property handles the front plane offset Y.
KFbxTypedProperty< fbxDouble1 >	FrontPlaneRotation
	This property handles the front plane rotation.
KFbxTypedProperty< fbxDouble1 >	FrontPlaneScaleX
	This property handles the front plane scaling X.
KFbxTypedProperty< fbxDouble1 >	FrontPlaneScaleY
	This property handles the front plane scaling Y.
KFbxTypedProperty< fbxReference >	ForegroundTexture
	This property has the foreground textures connected to it.
KFbxTypedProperty< fbxDouble1 >	ForegroundOpacity
	This property handles the foreground image opacity value.
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 orthographic 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.
Protected Member Functions
	KFbxCamera (KFbxSdkManager &pManager, char const *pName)
virtual bool	ConstructProperties (bool pForceSet)
virtual KStringList	GetTypeFlags () const
	Used to retrieve the KProperty list from an attribute.
Friends
class	KFbxGlobalCameraSettings
class	KFbxNode
Viewing Area Functions
enum	ECameraFormat {   eCUSTOM_FORMAT, eD1_NTSC, eNTSC, ePAL,   eD1_PAL, eHD, e640x480, e320x200,   e320x240, e128x128, eFULL_SCREEN }
	Camera formats. More...
enum	ECameraAspectRatioMode {   eWINDOW_SIZE, eFIXED_RATIO, eFIXED_RESOLUTION, eFIXED_WIDTH,   eFIXED_HEIGHT }
	Camera aspect ratio modes. More...
void	SetFormat (ECameraFormat pFormat)
	Set the camera format.
ECameraFormat	GetFormat () const
	Get the camera format.
void	SetAspect (ECameraAspectRatioMode pRatioMode, double pWidth, double pHeight)
	Set the camera aspect.
ECameraAspectRatioMode	GetAspectRatioMode () const
	Get the camera aspect ratio mode.
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.
Aperture and Film Functions
The aperture mode determines which values drive the camera aperture.When the aperture mode is eHORIZONTAL_AND_VERTICAL, eHORIZONTAL or eVERTICAL, the field of view is used. When the aperture mode is eFOCAL_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 {   eCUSTOM_APERTURE_FORMAT = 0, e16MM_THEATRICAL, eSUPER_16MM, e35MM_ACADEMY,   e35MM_TV_PROJECTION, e35MM_FULL_APERTURE, e35MM_185_PROJECTION, e35MM_ANAMORPHIC,   e70MM_PROJECTION, eVISTAVISION, eDYNAVISION, eIMAX }
	Camera aperture formats. More...
enum	ECameraApertureMode { eHORIZONTAL_AND_VERTICAL, eHORIZONTAL, eVERTICAL, eFOCAL_LENGTH }
	Camera aperture modes. More...
enum	ECameraGateFit {   eNO_FIT, eVERTICAL_FIT, eHORIZONTAL_FIT, eFILL_FIT,   eOVERSCAN_FIT, eSTRETCH_FIT }
	Camera gate fit modes. More...
enum	ECameraFilmRollOrder { eROTATE_TRANSLATE, eTRANSLATE_ROTATE }
	Specifies how the roll is applied with respect to the pivot value. More...
void	SetApertureFormat (ECameraApertureFormat pFormat)
	Set the camera aperture format.
ECameraApertureFormat	GetApertureFormat () const
	Get the camera aperture format.
void	SetApertureMode (ECameraApertureMode pMode)
	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.
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) const
	Compute the focal length based on the given angle of view, the aperture width, and aperture height.
BackPlane/FrontPlane and Plate Functions
In the FbxSdk terminology, the Back/Front plane is the support of the plate.And the plate is the support of the texture used for backgrounds/foregrounds. Functions and properties identified by the "Plate" name are affecting the display of the texture on the plate. The functions and properties identified with the "Back/FrontPlane" are affecting the plate.Typically a client application would place the BackPlate a small distance in front of the FarPlane and the FrontPlate just behind the NearPlane to avoid them to be hidden by the clipping. Unless otherwise noted, there are no restrictions on the values stored by the camera object therefore it is the responsibility of the client application to process the information in a meaningful way and to maintain consistency between the different properties relationships.
enum	ECameraPlateDrawingMode { eBACKGROUND, eFOREGROUND, eBACKGROUND_AND_FOREGROUND }
	Image plate drawing modes. More...
enum	ECameraFrontBackPlaneDistanceMode { eRELATIVE_TO_INTEREST, eRELATIVE_TO_CAMERA }
	ECameraFrontBackPlaneDistanceMode Front and BackPlane distance modes. More...
enum	ECameraFrontBackPlaneDisplayMode { eDISABLED, eALWAYS, eWHEN_MEDIA }
	Front/Back Plane display 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.
void	SetForegroundFileName (const char *pFileName)
	Set the associated foreground image file.
char const *	GetForegroundFileName () const
	Get the foreground image file name.
void	SetForegroundMediaName (const char *pFileName)
	Set the media name associated to the foreground image file.
char const *	GetForegroundMediaName () const
	Get the media name associated to the foreground image file.
void	SetBackgroundAlphaTreshold (double pThreshold)
	Set back plate matte threshold.
double	GetBackgroundAlphaTreshold () const
	Get back plate matte threshold.
void	SetFitImage (bool pFitImage)
	Change the back plate fit image flag.
bool	GetFitImage () const
	Get the current back plate image flag.
void	SetCrop (bool pCrop)
	Change the back plate crop flag.
bool	GetCrop () const
	Get the current back plate crop flag.
void	SetCenter (bool pCenter)
	Change the back plate center flag.
bool	GetCenter () const
	Get the current back plate center flag.
void	SetKeepRatio (bool pKeepRatio)
	Change the back plate keep ratio flag.
bool	GetKeepRatio () const
	Get the current back plate keep ratio flag.
void	SetShowFrontPlate (bool pEnable)
	Enable or disable the display of the texture without the need to disconnect it from its plate.
bool	GetShowFrontPlate () const
	Get the current state of the flag.
void	SetFrontPlateFitImage (bool pFrontPlateFitImage)
	Change the front plate fit image flag.
bool	GetFrontPlateFitImage () const
	Get the current front plate fit image flag.
void	SetFrontPlateCrop (bool pFrontPlateCrop)
	Change the front plate crop flag.
bool	GetFrontPlateCrop () const
	Get the current front plate crop flag.
void	SetFrontPlateCenter (bool pFrontPlateCenter)
	Change the front plate center flag.
bool	GetFrontPlateCenter () const
	Get the current front plate center flag.
void	SetFrontPlateKeepRatio (bool pFrontPlateKeepRatio)
	Change the front plate keep ratio flag.
bool	GetFrontPlateKeepRatio () const
	Get the current front plate keep ratio flag.
void	SetForegroundOpacity (double pOpacity)
	Set the front plate opacity value.
double	GetForegroundOpacity () const
	Get the front plate opacity value.
void	SetForegroundTexture (KFbxTexture *pTexture)
	Attach the texture to the Front plate.
KFbxTexture *	GetForegroundTexture () const
	Get the texture connected to the Front plate.
void	SetBackPlaneDistanceMode (ECameraFrontBackPlaneDistanceMode pMode)
	Set the back plane distance mode flag.
ECameraFrontBackPlaneDistanceMode	GetBackPlaneDistanceMode () const
	Get the back plane distance mode.
void	SetFrontPlaneDistance (double pDistance)
	Set the front plane distance from the camera.
double	GetFrontPlaneDistance () const
	Get the front plane distance value.
void	SetFrontPlaneDistanceMode (ECameraFrontBackPlaneDistanceMode pMode)
	Set the front plane distance mode flag.
ECameraFrontBackPlaneDistanceMode	GetFrontPlaneDistanceMode () const
	Get the front plane distance mode flag.
void	SetViewFrustumFrontPlaneMode (ECameraFrontBackPlaneDisplayMode pMode)
	Set the front plane display mode.
ECameraFrontBackPlaneDisplayMode	GetViewFrustumFrontPlaneMode () const
	Get the front plane display mode.
void	SetViewFrustumBackPlaneMode (ECameraFrontBackPlaneDisplayMode pMode)
	Set the back plane display mode.
ECameraFrontBackPlaneDisplayMode	GetViewFrustumBackPlaneMode () const
	Get the back plane display mode.
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 { eROUND = 0, eSQUARE = 1 }
	Camera safe area display styles. More...
void	SetViewCameraInterest (bool pEnable)
	Change the camera interest visibility flag.
bool	GetViewCameraInterest () const
	Get current visibility state of the camera interest.
void	SetViewNearFarPlanes (bool pEnable)
	Change the camera near and far planes visibility flag.
bool	GetViewNearFarPlanes () const
	Get current visibility state of the camera near and far planes.
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 { eINTERACTIVE, eAT_RENDER }
	Render options usage time. More...
enum	ECameraAntialiasingMethod { eOVERSAMPLING_ANTIALIASING, eHARDWARE_ANTIALIASING }
	Antialiasing methods. More...
enum	ECameraSamplingType { eUNIFORM, eSTOCHASTIC }
	Oversampling types. More...
enum	ECameraFocusDistanceSource { eCAMERA_INTEREST, eSPECIFIC_DISTANCE }
	Camera focus sources. More...
Utility Functions.
bool	IsBoundingBoxInView (const KFbxMatrix &pWorldToScreen, const KFbxMatrix &pWorldToCamera, const KFbxVector4 pPoints[8]) const
	Determine if the given bounding box is in the camera's view.
bool	IsPointInView (const KFbxMatrix &pWorldToScreen, const KFbxMatrix &pWorldToCamera, const KFbxVector4 &pPoint) const
	Determine if the given 3d point is in the camera's view.
KFbxMatrix	ComputeWorldToScreen (int pPixelWidth, int pPixelHeight, const KFbxXMatrix &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.

---

Member Enumeration Documentation

enum ECameraProjectionType

Search for all occurrences

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

Enumerator:

ePERSPECTIVE	Search for all occurrences
eORTHOGONAL	Search for all occurrences

Definition at line 90 of file kfbxcamera.h.

    {
        ePERSPECTIVE,
        eORTHOGONAL
    } ECameraProjectionType;

enum ECameraFormat

Search for all occurrences

Camera formats.

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

Enumerator:

eCUSTOM_FORMAT	Search for all occurrences
eD1_NTSC	Search for all occurrences
eNTSC	Search for all occurrences
ePAL	Search for all occurrences
eD1_PAL	Search for all occurrences
eHD	Search for all occurrences
e640x480	Search for all occurrences
e320x200	Search for all occurrences
e320x240	Search for all occurrences
e128x128	Search for all occurrences
eFULL_SCREEN	Search for all occurrences

Definition at line 115 of file kfbxcamera.h.

        {
            eCUSTOM_FORMAT,
            eD1_NTSC,
            eNTSC,
            ePAL,
            eD1_PAL,
            eHD,
            e640x480,
            e320x200,
            e320x240,
            e128x128,
            eFULL_SCREEN
        } ECameraFormat;

enum ECameraAspectRatioMode

Search for all occurrences

Camera aspect ratio modes.

• eWINDOW_SIZE
• eFIXED_RATIO
• eFIXED_RESOLUTION
• eFIXED_WIDTH
• eFIXED_HEIGHT

Enumerator:

eWINDOW_SIZE	Search for all occurrences
eFIXED_RATIO	Search for all occurrences
eFIXED_RESOLUTION	Search for all occurrences
eFIXED_WIDTH	Search for all occurrences
eFIXED_HEIGHT	Search for all occurrences

Definition at line 150 of file kfbxcamera.h.

        {
            eWINDOW_SIZE,
            eFIXED_RATIO,
            eFIXED_RESOLUTION,
            eFIXED_WIDTH,
            eFIXED_HEIGHT
        } ECameraAspectRatioMode;

enum ECameraApertureFormat

Search for all occurrences

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

Enumerator:

eCUSTOM_APERTURE_FORMAT	Search for all occurrences
e16MM_THEATRICAL	Search for all occurrences
eSUPER_16MM	Search for all occurrences
e35MM_ACADEMY	Search for all occurrences
e35MM_TV_PROJECTION	Search for all occurrences
e35MM_FULL_APERTURE	Search for all occurrences
e35MM_185_PROJECTION	Search for all occurrences
e35MM_ANAMORPHIC	Search for all occurrences
e70MM_PROJECTION	Search for all occurrences
eVISTAVISION	Search for all occurrences
eDYNAVISION	Search for all occurrences
eIMAX	Search for all occurrences

Definition at line 247 of file kfbxcamera.h.

    {
        eCUSTOM_APERTURE_FORMAT = 0,
        e16MM_THEATRICAL,
        eSUPER_16MM,
        e35MM_ACADEMY,
        e35MM_TV_PROJECTION,
        e35MM_FULL_APERTURE,
        e35MM_185_PROJECTION,
        e35MM_ANAMORPHIC,
        e70MM_PROJECTION,
        eVISTAVISION,
        eDYNAVISION,
        eIMAX
    } ECameraApertureFormat;

enum ECameraApertureMode

Search for all occurrences

Camera aperture modes.

The aperture mode determines which values drive the camera aperture. If the aperture mode is eHORIZONTAL_AND_VERTICAL, eHORIZONTAL, or eVERTICAL, then the field of view is used. If the aperture mode is eFOCAL_LENGTH, then the focal length is used.

• eHORIZONTAL_AND_VERTICAL
• eHORIZONTAL
• eVERTICAL
• eFOCAL_LENGTH

Enumerator:

eHORIZONTAL_AND_VERTICAL	Search for all occurrences
eHORIZONTAL	Search for all occurrences
eVERTICAL	Search for all occurrences
eFOCAL_LENGTH	Search for all occurrences

Definition at line 282 of file kfbxcamera.h.

    {
        eHORIZONTAL_AND_VERTICAL,
        eHORIZONTAL,
        eVERTICAL,
        eFOCAL_LENGTH
    } ECameraApertureMode;

enum ECameraGateFit

Search for all occurrences

Camera gate fit modes.

• eNO_FIT No resolution gate fit.
• eVERTICAL_FIT Fit the resolution gate vertically within the film gate.
• eHORIZONTAL_FIT Fit the resolution gate horizontally within the film gate.
• eFILL_FIT Fit the resolution gate within the film gate.
• eOVERSCAN_FIT Fit the film gate within the resolution gate.
• eSTRETCH_FIT Fit the resolution gate to the film gate.

Enumerator:

eNO_FIT	Search for all occurrences
eVERTICAL_FIT	Search for all occurrences
eHORIZONTAL_FIT	Search for all occurrences
eFILL_FIT	Search for all occurrences
eOVERSCAN_FIT	Search for all occurrences
eSTRETCH_FIT	Search for all occurrences

Definition at line 345 of file kfbxcamera.h.

    {
        eNO_FIT,
        eVERTICAL_FIT,
        eHORIZONTAL_FIT,
        eFILL_FIT,
        eOVERSCAN_FIT,
        eSTRETCH_FIT
    } ECameraGateFit;

enum ECameraFilmRollOrder

Search for all occurrences

Specifies how the roll is applied with respect to the pivot value.

• eROTATE_TRANSLATE The film back is first rotated then translated by the pivot point value.
• eHORIZONTAL_AND_VERTICAL The film back is first translated then rotated by the film roll value.

Enumerator:

eROTATE_TRANSLATE	Search for all occurrences
eTRANSLATE_ROTATE	Search for all occurrences

Definition at line 372 of file kfbxcamera.h.

    {
        eROTATE_TRANSLATE,
        eTRANSLATE_ROTATE
    } ECameraFilmRollOrder;

enum ECameraPlateDrawingMode

Search for all occurrences

Image plate drawing modes.

• eBACKGROUND Image is drawn behind models.
• eFOREGROUND Image is drawn in front of models based on alpha channel.
• eBACKGROUND_AND_FOREGROUND Image is drawn behind and in front of models depending on alpha channel.

Enumerator:

eBACKGROUND	Search for all occurrences
eFOREGROUND	Search for all occurrences
eBACKGROUND_AND_FOREGROUND	Search for all occurrences

Definition at line 462 of file kfbxcamera.h.

    {
        eBACKGROUND,
        eFOREGROUND,
        eBACKGROUND_AND_FOREGROUND
    } ECameraPlateDrawingMode;

enum ECameraFrontBackPlaneDistanceMode

Search for all occurrences

ECameraFrontBackPlaneDistanceMode Front and BackPlane distance modes.

• eRELATIVE_TO_INTEREST
• eRELATIVE_TO_CAMERA

Enumerator:

eRELATIVE_TO_INTEREST	Search for all occurrences
eRELATIVE_TO_CAMERA	Search for all occurrences

Definition at line 604 of file kfbxcamera.h.

    {
        eRELATIVE_TO_INTEREST,
        eRELATIVE_TO_CAMERA
    } ECameraFrontBackPlaneDistanceMode;

enum ECameraFrontBackPlaneDisplayMode

Search for all occurrences

Front/Back Plane display modes.

• eDISABLED
• eALWAYS
• eWHEN_MEDIA

Enumerator:

eDISABLED	Search for all occurrences
eALWAYS	Search for all occurrences
eWHEN_MEDIA	Search for all occurrences

Definition at line 648 of file kfbxcamera.h.

    {
        eDISABLED,
        eALWAYS,
        eWHEN_MEDIA
    } ECameraFrontBackPlaneDisplayMode;

enum ECameraSafeAreaStyle

Search for all occurrences

Camera safe area display styles.

• eROUND
• eSQUARE

Enumerator:

eROUND	Search for all occurrences
eSQUARE	Search for all occurrences

Definition at line 712 of file kfbxcamera.h.

    {
        eROUND = 0,
        eSQUARE = 1
    } ECameraSafeAreaStyle;

enum ECameraRenderOptionsUsageTime

Search for all occurrences

Render options usage time.

• eINTERACTIVE
• eAT_RENDER

Enumerator:

eINTERACTIVE	Search for all occurrences
eAT_RENDER	Search for all occurrences

Definition at line 731 of file kfbxcamera.h.

    {
        eINTERACTIVE,
        eAT_RENDER
    } ECameraRenderOptionsUsageTime;

enum ECameraAntialiasingMethod

Search for all occurrences

Antialiasing methods.

• eOVERSAMPLING_ANTIALIASING
• eHARDWARE_ANTIALIASING

Enumerator:

eOVERSAMPLING_ANTIALIASING	Search for all occurrences
eHARDWARE_ANTIALIASING	Search for all occurrences

Definition at line 741 of file kfbxcamera.h.

    {
        eOVERSAMPLING_ANTIALIASING,
        eHARDWARE_ANTIALIASING
    } ECameraAntialiasingMethod;

enum ECameraSamplingType

Search for all occurrences

Oversampling types.

• eUNIFORM
• eSTOCHASTIC

Enumerator:

eUNIFORM	Search for all occurrences
eSTOCHASTIC	Search for all occurrences

Definition at line 751 of file kfbxcamera.h.

    {
        eUNIFORM,
        eSTOCHASTIC
    } ECameraSamplingType;

enum ECameraFocusDistanceSource

Search for all occurrences

Camera focus sources.

• eCAMERA_INTEREST
• eSPECIFIC_DISTANCE

Enumerator:

eCAMERA_INTEREST	Search for all occurrences
eSPECIFIC_DISTANCE	Search for all occurrences

Definition at line 761 of file kfbxcamera.h.

    {
        eCAMERA_INTEREST,
        eSPECIFIC_DISTANCE
    } ECameraFocusDistanceSource;

---

Constructor & Destructor Documentation

KFbxCamera	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		[protected]

---

Member Function Documentation

virtual EAttributeType GetAttributeType

(

)

const [virtual]

Search for all occurrences

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

Reimplemented from KFbxNodeAttribute.

Reimplemented in KFbxCameraStereo.

void Reset

(

)

Search for all occurrences

Reset the camera to default values.

Reimplemented in KFbxCameraStereo.

void SetFormat

(

ECameraFormat

pFormat

)

Search for all occurrences

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.

Examples:

UIExamples/CubeCreator/SDK_Utility.cxx.

ECameraFormat GetFormat

(

)

const

Search for all occurrences

Get the camera format.

Returns:

The current camera format identifier.

Examples:

ImportScene/DisplayCamera.cxx.

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

Search for all occurrences

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.

ECameraAspectRatioMode GetAspectRatioMode

(

)

const

Search for all occurrences

Get the camera aspect ratio mode.

Returns:

The current aspect ratio identifier.

Examples:

ImportScene/DisplayCamera.cxx.

void SetPixelRatio

(

double

pRatio

)

Search for all occurrences

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

Search for all occurrences

Get the pixel ratio.

Returns:

The current camera's pixel ratio value.

Examples:

ViewScene/SetCamera.cxx.

void SetNearPlane

(

double

pDistance

)

Search for all occurrences

Set the near plane distance from the camera.

The near plane is the minimum distance to render a scene on the camera display. A synonym for the near plane is "front clipping plane".

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

Search for all occurrences

Get the near plane distance from the camera.

The near plane is the minimum distance to render a scene on the camera display. A synonym for the near plane is "front clipping plane".

Returns:

The near plane value.

Examples:

ViewScene/SetCamera.cxx.

void SetFarPlane

(

double

pDistance

)

Search for all occurrences

Set the far plane distance from camera.

The far plane is the maximum distance to render a scene on the camera display. A synonym for the far plane is "back clipping plane".

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

Search for all occurrences

Get the far plane distance from camera.

The far plane is the maximum distance to render a scene on the camera display. A synonym for the far plane is "back clipping plane".

Returns:

The far plane value.

Examples:

ViewScene/SetCamera.cxx.

void SetApertureFormat

(

ECameraApertureFormat

pFormat

)

Search for all occurrences

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.

ECameraApertureFormat GetApertureFormat

(

)

const

Search for all occurrences

Get the camera aperture format.

Returns:

The camera's current aperture format identifier.

Examples:

ImportScene/DisplayCamera.cxx.

void SetApertureMode

(

ECameraApertureMode

pMode

)

Search for all occurrences

Set the camera aperture mode.

Parameters:

pMode

The camera aperture mode identifier.

Examples:

ExportScene04/main.cxx.

ECameraApertureMode GetApertureMode

(

)

const

Search for all occurrences

Get the camera aperture mode.

Returns:

The camera's current aperture mode identifier.

Examples:

ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

void SetApertureWidth

(

double

pWidth

)

Search for all occurrences

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.

Examples:

ExportScene04/main.cxx, and ViewScene/SetCamera.cxx.

double GetApertureWidth

(

)

const

Search for all occurrences

Get the camera aperture width in inches.

Returns:

The camera's current aperture width value in inches.

Examples:

ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

void SetApertureHeight

(

double

pHeight

)

Search for all occurrences

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.

Examples:

ExportScene04/main.cxx, and ViewScene/SetCamera.cxx.

double GetApertureHeight

(

)

const

Search for all occurrences

Get the camera aperture height in inches.

Returns:

The camera's current aperture height value in inches.

Examples:

ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

void SetSqueezeRatio

(

double

pRatio

)

Search for all occurrences

Set the squeeze ratio.

Parameters:

pRatio

The squeeze 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.

Examples:

ExportScene04/main.cxx, and ViewScene/SetCamera.cxx.

double GetSqueezeRatio

(

)

const

Search for all occurrences

Get the camera squeeze ratio.

Returns:

The camera's current squeeze ratio value.

Examples:

ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

double ComputeFieldOfView

(

double

pFocalLength

)

const

Search for all occurrences

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

Examples:

ViewScene/SetCamera.cxx.

double ComputeFocalLength

(

double

pAngleOfView

)

const

Search for all occurrences

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

Examples:

ViewScene/SetCamera.cxx.

void SetBackgroundFileName

(

const char *

pFileName

)

Search for all occurrences

Set the associated background image file.

Parameters:

pFileName

The path of the background image file.

Remarks:

The background image file name must be valid.

This method is still provided for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

char const* GetBackgroundFileName

(

)

const

Search for all occurrences

Get the background image file name.

Returns:

Pointer to the background filename string or NULL if not set.

Remarks:

This method is still provided for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

Examples:

ImportScene/DisplayCamera.cxx.

void SetBackgroundMediaName

(

const char *

pFileName

)

Search for all occurrences

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.

This method is still provided for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

char const* GetBackgroundMediaName

(

)

const

Search for all occurrences

Get the media name associated to the background image file.

Returns:

Pointer to the media name string or NULL if not set.

Remarks:

This method is still provided for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

void SetForegroundFileName

(

const char *

pFileName

)

Search for all occurrences

Set the associated foreground image file.

Parameters:

pFileName

The path of the foreground image file.

Remarks:

The foreground image file name must be valid.

This method is still provided for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

char const* GetForegroundFileName

(

)

const

Search for all occurrences

Get the foreground image file name.

Returns:

Pointer to the foreground filename string or NULL if not set.

Remarks:

This method is still provided for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

void SetForegroundMediaName

(

const char *

pFileName

)

Search for all occurrences

Set the media name associated to the foreground image file.

Parameters:

pFileName

The media name of the foreground image file.

Remarks:

The media name is a unique name used to identify the foreground image file.

This method is still provided for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

char const* GetForegroundMediaName

(

)

const

Search for all occurrences

Get the media name associated to the foreground image file.

Returns:

Pointer to the media name string or NULL if not set.

Remarks:

This method is still provided for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

void SetBackgroundAlphaTreshold

(

double

pThreshold

)

Search for all occurrences

Set back plate 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.

double GetBackgroundAlphaTreshold

(

)

const

Search for all occurrences

Get back plate 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.

void SetFitImage

(

bool

pFitImage

)

Search for all occurrences

Change the back plate fit image flag.

Parameters:

pFitImage

New value for the BackPlateFitImage property.

bool GetFitImage

(

)

const

Search for all occurrences

Get the current back plate image flag.

Returns:

The value of the BackPlateFitImage property.

Examples:

ImportScene/DisplayCamera.cxx.

void SetCrop

(

bool

pCrop

)

Search for all occurrences

Change the back plate crop flag.

Parameters:

pCrop

New value for the BackPlateCrop property.

bool GetCrop

(

)

const

Search for all occurrences

Get the current back plate crop flag.

Returns:

The value of the BackPlateCrop property.

Examples:

ImportScene/DisplayCamera.cxx.

void SetCenter

(

bool

pCenter

)

Search for all occurrences

Change the back plate center flag.

Parameters:

pCenter

New value for the BackPlateCenter property.

bool GetCenter

(

)

const

Search for all occurrences

Get the current back plate center flag.

Returns:

The value of the BackPlateCenter property.

Examples:

ImportScene/DisplayCamera.cxx.

void SetKeepRatio

(

bool

pKeepRatio

)

Search for all occurrences

Change the back plate keep ratio flag.

Parameters:

pKeepRatio

New value for the BackPlateKeepRatio property.

bool GetKeepRatio

(

)

const

Search for all occurrences

Get the current back plate keep ratio flag.

Returns:

The value of the BackPlateKeepRatio property.

Examples:

ImportScene/DisplayCamera.cxx.

void SetShowFrontPlate

(

bool

pEnable

)

Search for all occurrences

Enable or disable the display of the texture without the need to disconnect it from its plate.

Parameters:

pEnable

If true the texture is displayed.

Remarks:

It is the responsibility of the client application to perform the required tasks according to the state of this flag.

bool GetShowFrontPlate

(

)

const

Search for all occurrences

Get the current state of the flag.

Returns:

true if show front plate is enabled, otherwise false.

Remarks:

It is the responsibility of the client application to perform the required tasks according to the state of this flag.

void SetFrontPlateFitImage

(

bool

pFrontPlateFitImage

)

Search for all occurrences

Change the front plate fit image flag.

Parameters:

pFrontPlateFitImage

New value for the FrontPlateFitImage property.

bool GetFrontPlateFitImage

(

)

const

Search for all occurrences

Get the current front plate fit image flag.

Returns:

The value of the BackPlateFitImage property.

void SetFrontPlateCrop

(

bool

pFrontPlateCrop

)

Search for all occurrences

Change the front plate crop flag.

Parameters:

pFrontPlateCrop

New value for the FrontPlateCrop property.

bool GetFrontPlateCrop

(

)

const

Search for all occurrences

Get the current front plate crop flag.

Returns:

The value of the FrontPlateCrop property.

void SetFrontPlateCenter

(

bool

pFrontPlateCenter

)

Search for all occurrences

Change the front plate center flag.

Parameters:

pFrontPlateCenter

New value for the FrontPlateCenter property.

bool GetFrontPlateCenter

(

)

const

Search for all occurrences

Get the current front plate center flag.

Returns:

The value of the FrontPlateCenter property.

void SetFrontPlateKeepRatio

(

bool

pFrontPlateKeepRatio

)

Search for all occurrences

Change the front plate keep ratio flag.

Parameters:

pFrontPlateKeepRatio

New value for the FrontPlateKeepRatio property.

bool GetFrontPlateKeepRatio

(

)

const

Search for all occurrences

Get the current front plate keep ratio flag.

Returns:

The value of the FrontPlateKeepRatio property.

void SetForegroundOpacity

(

double

pOpacity

)

Search for all occurrences

Set the front plate opacity value.

Parameters:

pOpacity

New value for the ForegroundOpacity property.

double GetForegroundOpacity

(

)

const

Search for all occurrences

Get the front plate opacity value.

Returns:

The value of the ForegroundOpacity property.

void SetForegroundTexture

(

KFbxTexture *

pTexture

)

Search for all occurrences

Attach the texture to the Front plate.

Parameters:

pTexture

New texture handle.

KFbxTexture* GetForegroundTexture

(

)

const

Search for all occurrences

Get the texture connected to the Front plate.

Returns:

KFbxTexture* The texture handle.

void SetBackPlaneDistanceMode

(

ECameraFrontBackPlaneDistanceMode

pMode

)

Search for all occurrences

Set the back plane distance mode flag.

Parameters:

pMode

The back plane distance mode flag.

ECameraFrontBackPlaneDistanceMode GetBackPlaneDistanceMode

(

)

const

Search for all occurrences

Get the back plane distance mode.

Returns:

Return the back plane distance mode identifier.

void SetFrontPlaneDistance

(

double

pDistance

)

Search for all occurrences

Set the front plane distance from the camera.

The the absolute position of the plane must be calculated by taking into consideration the FrontPlaneDistanceMode.

Parameters:

pDistance

The front plane distance value.

Remarks:

It is the responsibility of the client application to ensure that this plane position is within the frustum boundaries.

double GetFrontPlaneDistance

(

)

const

Search for all occurrences

Get the front plane distance value.

Returns:

double The front plane distance value.

void SetFrontPlaneDistanceMode

(

ECameraFrontBackPlaneDistanceMode

pMode

)

Search for all occurrences

Set the front plane distance mode flag.

Parameters:

pMode

The front plane distance mode flag.

ECameraFrontBackPlaneDistanceMode GetFrontPlaneDistanceMode

(

)

const

Search for all occurrences

Get the front plane distance mode flag.

Returns:

ECameraFrontBackPlaneDistanceMode The front plane distance mode value.

void SetViewFrustumFrontPlaneMode

(

ECameraFrontBackPlaneDisplayMode

pMode

)

Search for all occurrences

Set the front plane display mode.

This mode can be used by the client application to decide under which circumstance the front plane should be drawn in the viewport.

Parameters:

pMode

The view frustum front plane display mode.

ECameraFrontBackPlaneDisplayMode GetViewFrustumFrontPlaneMode

(

)

const

Search for all occurrences

Get the front plane display mode.

Returns:

ECameraFrontBackPlaneDisplayMode The view frustum front plane display mode value.

void SetViewFrustumBackPlaneMode

(

ECameraFrontBackPlaneDisplayMode

pMode

)

Search for all occurrences

Set the back plane display mode.

This mode can be used by the client application to decide under which circumstance the back plane should be drawn in the viewport.

Parameters:

pMode

The view frustum back plane display mode.

ECameraFrontBackPlaneDisplayMode GetViewFrustumBackPlaneMode

(

)

const

Search for all occurrences

Get the back plane display mode.

Returns:

ECameraFrontBackPlaneDisplayMode The view frustum back plane display mode value.

void SetViewCameraInterest

(

bool

pEnable

)

Search for all occurrences

Change the camera interest visibility flag.

Parameters:

pEnable

Set to true if the camera interest is shown.

bool GetViewCameraInterest

(

)

const

Search for all occurrences

Get current visibility state of the camera interest.

Returns:

true if the camera interest is shown, or false if hidden.

void SetViewNearFarPlanes

(

bool

pEnable

)

Search for all occurrences

Change the camera near and far planes visibility flag.

Parameters:

pEnable

Set to true if the near and far planes are shown.

bool GetViewNearFarPlanes

(

)

const

Search for all occurrences

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

Returns:

true if the near and far planes are shown.

bool IsBoundingBoxInView	(	const KFbxMatrix &	pWorldToScreen,
		const KFbxMatrix &	pWorldToCamera,
		const KFbxVector4	pPoints[8]
	)		const

Search for all occurrences

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 from KFbxAnimEvaluator::GetNodeGlobalTransform or KFbxAnimEvaluator::GetNodeGlobalTransformFast is suitable. See KFbxScene::GetEvaluator and KFbxAnimEvaluator::GetNodeGlobalTransform or KFbxAnimEvaluator::GetNodeGlobalTransformFast.
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	(	const KFbxMatrix &	pWorldToScreen,
		const KFbxMatrix &	pWorldToCamera,
		const KFbxVector4 &	pPoint
	)		const

Search for all occurrences

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 from KFbxAnimEvaluator::GetNodeGlobalTransform or KFbxAnimEvaluator::GetNodeGlobalTransformFast is suitable. See KFbxScene::GetEvaluator and KFbxAnimEvaluator::GetNodeGlobalTransform or KFbxAnimEvaluator::GetNodeGlobalTransformFast.
pPoint	World-space point to test.

Returns:

true if the given point is in the camera's view, false otherwise.

KFbxMatrix ComputeWorldToScreen	(	int	pPixelWidth,
		int	pPixelHeight,
		const KFbxXMatrix &	pWorldToCamera
	)		const

Search for all occurrences

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.

KFbxMatrix ComputePerspective	(	int	pPixelWidth,
		int	pPixelHeight,
		bool	pIncludePostPerspective
	)		const

Search for all occurrences

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 width 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.

virtual KFbxObject& Copy

(

const KFbxObject &

pObject

)

[virtual]

Search for all occurrences

Copy an object content into this object.

Parameters:

pObject

The source object to copy data from.

Returns:

Returns the destination object being modified by the source.

Remarks:

This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.

Reimplemented from KFbxObject.

virtual bool ConstructProperties

(

bool

pForceSet

)

[protected, virtual]

Search for all occurrences

Reimplemented from KFbxNodeAttribute.

Reimplemented in KFbxCameraStereo.

virtual KStringList GetTypeFlags

(

)

const [protected, virtual]

Search for all occurrences

Used to retrieve the KProperty list from an attribute.

Reimplemented from KFbxObject.

Reimplemented in KFbxCameraStereo.

---

Friends And Related Function Documentation

friend class KFbxGlobalCameraSettings [friend]

Search for all occurrences

Reimplemented in KFbxCameraStereo.

Definition at line 1881 of file kfbxcamera.h.

friend class KFbxNode [friend]

Search for all occurrences

Reimplemented from KFbxNodeAttribute.

Reimplemented in KFbxCameraStereo.

Definition at line 1906 of file kfbxcamera.h.

---

Member Data Documentation

KFbxTypedProperty<fbxDouble3> Position

Search for all occurrences

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)

Examples:

ImportScene/DisplayCamera.cxx, ViewScene/main.cxx, and ViewScene/SetCamera.cxx.

Definition at line 836 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble3> UpVector

Search for all occurrences

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)

Examples:

ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 845 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble3> InterestPosition

Search for all occurrences

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)

Examples:

ImportScene/DisplayCamera.cxx, ViewScene/main.cxx, and ViewScene/SetCamera.cxx.

Definition at line 858 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> Roll

Search for all occurrences

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

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

Default value is 0.

Examples:

ExportScene04/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayCamera.cxx, ViewScene/DrawScene.cxx, ViewScene/main.cxx, and ViewScene/SetCamera.cxx.

Definition at line 867 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> OpticalCenterX

Search for all occurrences

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 to eHORIZONTAL_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.

Examples:

ImportScene/DisplayAnimation.cxx, and ImportScene/DisplayCamera.cxx.

Definition at line 879 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> OpticalCenterY

Search for all occurrences

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

It sets the optical center horizontal offset when the camera aperture mode is set to eHORIZONTAL_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.

Examples:

ImportScene/DisplayAnimation.cxx, and ImportScene/DisplayCamera.cxx.

Definition at line 891 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble3> BackgroundColor

Search for all occurrences

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)

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 900 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> TurnTable

Search for all occurrences

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 line 909 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> DisplayTurnTableIcon

Search for all occurrences

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 line 919 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> UseMotionBlur

Search for all occurrences

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 line 933 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> UseRealTimeMotionBlur

Search for all occurrences

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 line 943 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> MotionBlurIntensity

Search for all occurrences

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 line 952 of file kfbxcamera.h.

KFbxTypedProperty<ECameraAspectRatioMode> AspectRatioMode

Search for all occurrences

This property handles the camera aspect ratio mode.

Remarks:

This Property is in a Read Only mode.

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

Default value is eWINDOW_SIZE.

Definition at line 966 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> AspectWidth

Search for all occurrences

This property handles the camera aspect width.

Remarks:

This Property is in a Read Only mode.

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

Default value is 320.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 975 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> AspectHeight

Search for all occurrences

This property handles the camera aspect height.

Remarks:

This Property is in a Read Only mode.

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

Default value is 200.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 984 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> PixelAspectRatio

Search for all occurrences

This property handles the pixel aspect ratio.

Remarks:

This Property is in a Read Only mode.

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

Value range is [0.050, 20.0].

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 993 of file kfbxcamera.h.

KFbxTypedProperty<ECameraApertureMode> ApertureMode

Search for all occurrences

This property handles the aperture mode.

Default value is eVERTICAL.

Definition at line 999 of file kfbxcamera.h.

KFbxTypedProperty<ECameraGateFit> GateFit

Search for all occurrences

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 line 1008 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FieldOfView

Search for all occurrences

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 value is 40.

Value range is [1.0, 179.0].

Examples:

ImportScene/DisplayAnimation.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1021 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FieldOfViewX

Search for all occurrences

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_AND_VERTICAL.

Default value is 1.

Remarks:

Value range is [1.0, 179.0].

Examples:

ImportScene/DisplayAnimation.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1035 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FieldOfViewY

Search for all occurrences

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_AND_VERTICAL.

Default value is 1.

Value range is [1.0, 179.0].

Examples:

ImportScene/DisplayAnimation.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1048 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FocalLength

Search for all occurrences

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).

Examples:

ImportScene/DisplayCamera.cxx, StereoCamera/main.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1057 of file kfbxcamera.h.

KFbxTypedProperty<ECameraFormat> CameraFormat

Search for all occurrences

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 function SetFormat() if you want to change its value. Default value is eCUSTOM_FORMAT.

Definition at line 1068 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> UseFrameColor

Search for all occurrences

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.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1082 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble3> FrameColor

Search for all occurrences

This property handles the frame 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).

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1091 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ShowName

Search for all occurrences

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.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1104 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ShowInfoOnMoving

Search for all occurrences

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.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1113 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ShowGrid

Search for all occurrences

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.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1122 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ShowOpticalCenter

Search for all occurrences

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 line 1131 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ShowAzimut

Search for all occurrences

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.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1140 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ShowTimeCode

Search for all occurrences

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.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1149 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ShowAudio

Search for all occurrences

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.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1158 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble3> AudioColor

Search for all occurrences

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)

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1167 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> NearPlane

Search for all occurrences

This property handles the near plane distance.

Remarks:

This Property is in a Read Only mode.

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

Value range is [0.001, 600000.0].

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1180 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FarPlane

Search for all occurrences

This property handles the far plane distance.

Remarks:

This Property is in a Read Only mode

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

Value range is [0.001, 600000.0]

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1189 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> AutoComputeClipPlanes

Search for all occurrences

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 line 1200 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmWidth

Search for all occurrences

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

Remarks:

This Property is in a Read Only mode

Please use function SetApertureWidth() or SetApertureFormat() if you want to change its value Default value is 0.8160

Value range is [0.0001, +inf]

Definition at line 1215 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmHeight

Search for all occurrences

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

Remarks:

This Property is in a Read Only mode

Please use function SetApertureHeight() or SetApertureFormat() if you want to change its value Default value is 0.6120

Value range is [0.0001, +inf]

Definition at line 1225 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmAspectRatio

Search for all occurrences

This property handles the film aperture aspect ratio.

Remarks:

This Property is in a Read Only mode

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

Value range is [0.0001, +inf]

Definition at line 1234 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmSqueezeRatio

Search for all occurrences

This property handles the film aperture squeeze ratio.

Remarks:

This Property is in a Read Only mode

Please use function SetSqueezeRatio() or SetApertureFormat() if you want to change its value Default value is 1.0

Value range is [0.0001, +inf]

Definition at line 1244 of file kfbxcamera.h.

KFbxTypedProperty<ECameraApertureFormat> FilmFormat

Search for all occurrences

This property handles the film aperture format.

Remarks:

This Property is in a Read Only mode

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

Definition at line 1253 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmOffsetX

Search for all occurrences

This property handles the horizontal 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: FilmOffsetX.Get(). To set this property do: FilmOffsetX.Set(fbxDouble1).

Examples:

StereoCamera/main.cxx.

Definition at line 1263 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmOffsetY

Search for all occurrences

This property handles the vertical 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: FilmOffsetY.Get(). To set this property do: FilmOffsetY.Set(fbxDouble1).

Definition at line 1273 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> PreScale

Search for all occurrences

This property handles the pre-scale value.

The value is multiplied against the computed projection matrix. It is applied before the film roll. To access this property do: PreScale.Get(). To set this property do: PreScale.Set(fbxDouble1). Default value is 1.0

Definition at line 1282 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmTranslateX

Search for all occurrences

This property handles the horizontal film horizontal translation.

To access this property do: FilmTranslateX.Get(). To set this property do: FilmTranslateX.Set(fbxDouble1). Default value is 0.0

Definition at line 1289 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmTranslateY

Search for all occurrences

This property handles the vertical film translation.

To access this property do: FilmTranslateY.Get(). To set this property do: FilmTranslateY.Set(fbxDouble1). Default value is 0.0

Definition at line 1296 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmRollPivotX

Search for all occurrences

This property handles the horizontal pivot point used for rotating the film back.

To access this property do: FilmRollPivotX.Get(). To set this property do: FilmRollPivotX.Set(fbxDouble1). Default value is 0.0

Remarks:

FilmRollPivot value is used to compute the film roll matrix, which is a component of the post projection matrix.

Definition at line 1304 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmRollPivotY

Search for all occurrences

This property handles the vertical pivot point used for rotating the film back.

To access this property do: FilmRollPivotY.Get(). To set this property do: FilmRollPivotY.Set(fbxDouble1). Default value is 0.0

Remarks:

FilmRollPivot value is used to compute the film roll matrix, which is a component of the post projection matrix.

Definition at line 1312 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FilmRollValue

Search for all occurrences

This property handles the amount of rotation around the film back The roll value is specified in degrees.

To access this property do: FilmRollValue.Get(). To set this property do: FilmRollValue.Set(fbxDouble1). Default value is 0.0

Remarks:

The rotation occurs around the specified pivot point, this value is used to compute a film roll matrix, which is a component of the post-projection matrix.

Definition at line 1322 of file kfbxcamera.h.

KFbxTypedProperty<ECameraFilmRollOrder> FilmRollOrder

Search for all occurrences

This property handles how the roll is applied with respect to the pivot value.

eROTATE_TRANSLATE The film back is first rotated then translated by the pivot point value. eTRANSLATE_ROTATE The film back is first translated then rotated by the film roll value. To access this property do: FilmRollOrder.Get(). To set this property do: FilmRollOrder.Set(ECameraFilmRollOrder). Default value is eROTATE_TRANSLATE

Definition at line 1331 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ViewCameraToLookAt

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1344 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ViewFrustumNearFarPlane

Search for all occurrences

This property handles the view frustum near and far plane display state.

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

Default value is false

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1353 of file kfbxcamera.h.

KFbxTypedProperty<ECameraFrontBackPlaneDisplayMode> ViewFrustumBackPlaneMode

Search for all occurrences

This property handles the view frustum back plane mode.

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

Default value is eWHEN_MEDIA

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1362 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> BackPlaneDistance

Search for all occurrences

This property handles the view frustum back plane distance.

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

Default value is 100.0

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1371 of file kfbxcamera.h.

KFbxTypedProperty<ECameraFrontBackPlaneDistanceMode> BackPlaneDistanceMode

Search for all occurrences

This property handles the view frustum back plane distance mode.

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

Default value is eRELATIVE_TO_INTEREST

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1380 of file kfbxcamera.h.

KFbxTypedProperty<ECameraFrontBackPlaneDisplayMode> ViewFrustumFrontPlaneMode

Search for all occurrences

This property handles the view frustum front plane mode.

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

Default value is eWHEN_MEDIA

Definition at line 1389 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FrontPlaneDistance

Search for all occurrences

This property handles the view frustum 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 line 1398 of file kfbxcamera.h.

KFbxTypedProperty<ECameraFrontBackPlaneDistanceMode> FrontPlaneDistanceMode

Search for all occurrences

This property handles the view frustum front plane distance mode.

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

Default value is eRELATIVE_TO_INTEREST

Definition at line 1407 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> LockMode

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1420 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> LockInterestNavigation

Search for all occurrences

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 line 1429 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> FitImage

Search for all occurrences

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 line 1442 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> Crop

Search for all occurrences

This property handles the crop flag.

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

Default value is false.

Definition at line 1451 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> Center

Search for all occurrences

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 line 1460 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> KeepRatio

Search for all occurrences

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 line 1469 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> BackgroundAlphaTreshold

Search for all occurrences

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.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1478 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> BackPlaneOffsetX

Search for all occurrences

This property handles the back plane offset X.

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

Default value is 0.

Definition at line 1487 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> BackPlaneOffsetY

Search for all occurrences

This property handles the back plane offset Y.

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

Default value is 0.

Definition at line 1496 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> BackPlaneRotation

Search for all occurrences

This property handles the back plane rotation.

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

Default value is 0.

Definition at line 1505 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> BackPlaneScaleX

Search for all occurrences

This property handles the back plane scaling X.

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

Default value is 1.

Remarks:

The application manipulating the camera has to take into consideration the KeepRatio value too.

Definition at line 1516 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> BackPlaneScaleY

Search for all occurrences

This property handles the back plane scaling Y.

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

Default value is 1.

Remarks:

The application manipulating the camera has to take into consideration the KeepRatio value too.

Definition at line 1527 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ShowBackplate

Search for all occurrences

This property handles the back plane show flag.

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

Default value is false.

Remarks:

this replaces ForegroundTransparent

Definition at line 1537 of file kfbxcamera.h.

KFbxTypedProperty<fbxReference> BackgroundTexture

Search for all occurrences

This property has the background textures connected to it.

To access this property do: BackgroundTexture.GetSrcObject(). To set this property do: BackgroundTexture.ConnectSrcObject(KFbxObject*).

Remarks:

they are connected as source objects

Definition at line 1546 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> FrontPlateFitImage

Search for all occurrences

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 line 1560 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> FrontPlateCrop

Search for all occurrences

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 line 1569 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> FrontPlateCenter

Search for all occurrences

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 line 1578 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> FrontPlateKeepRatio

Search for all occurrences

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 line 1587 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> ShowFrontplate

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1598 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FrontPlaneOffsetX

Search for all occurrences

This property handles the front plane offset X.

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

Default value is 0.

Definition at line 1607 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FrontPlaneOffsetY

Search for all occurrences

This property handles the front plane offset Y.

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

Default value is 0.

Definition at line 1616 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FrontPlaneRotation

Search for all occurrences

This property handles the front plane rotation.

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

Default value is 0.

Definition at line 1625 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FrontPlaneScaleX

Search for all occurrences

This property handles the front plane scaling X.

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

Default value is 1.

Definition at line 1634 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FrontPlaneScaleY

Search for all occurrences

This property handles the front plane scaling Y.

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

Default value is 1.

Definition at line 1643 of file kfbxcamera.h.

KFbxTypedProperty<fbxReference> ForegroundTexture

Search for all occurrences

This property has the foreground textures connected to it.

To access this property do: ForegroundTexture.GetSrcObject(). To set this property do: ForegroundTexture.ConnectSrcObject(KFbxObject*).

Remarks:

they are connected as source objects

Definition at line 1652 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> ForegroundOpacity

Search for all occurrences

This property handles the foreground image opacity value.

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

Default value is 1.0.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1661 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> DisplaySafeArea

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1674 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> DisplaySafeAreaOnRender

Search for all occurrences

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 line 1683 of file kfbxcamera.h.

KFbxTypedProperty<ECameraSafeAreaStyle> SafeAreaDisplayStyle

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1692 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> SafeAreaAspectRatio

Search for all occurrences

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 line 1701 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> Use2DMagnifierZoom

Search for all occurrences

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 line 1714 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> _2DMagnifierZoom

Search for all occurrences

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 line 1723 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> _2DMagnifierX

Search for all occurrences

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 line 1732 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> _2DMagnifierY

Search for all occurrences

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 line 1741 of file kfbxcamera.h.

KFbxTypedProperty<ECameraProjectionType> ProjectionType

Search for all occurrences

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.

Examples:

ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1754 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> OrthoZoom

Search for all occurrences

This property handles the orthographic zoom.

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

Default value is 1.0.

Definition at line 1763 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> UseRealTimeDOFAndAA

Search for all occurrences

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.

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1776 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> UseDepthOfField

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1785 of file kfbxcamera.h.

KFbxTypedProperty<ECameraFocusDistanceSource> FocusSource

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1794 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FocusAngle

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1803 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> FocusDistance

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1812 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> UseAntialiasing

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1821 of file kfbxcamera.h.

KFbxTypedProperty<fbxDouble1> AntialiasingIntensity

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1830 of file kfbxcamera.h.

KFbxTypedProperty<ECameraAntialiasingMethod> AntialiasingMethod

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1839 of file kfbxcamera.h.

KFbxTypedProperty<fbxBool1> UseAccumulationBuffer

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1852 of file kfbxcamera.h.

KFbxTypedProperty<fbxInteger1> FrameSamplingCount

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1861 of file kfbxcamera.h.

KFbxTypedProperty<ECameraSamplingType> FrameSamplingType

Search for all occurrences

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

Examples:

ImportScene/DisplayCamera.cxx.

Definition at line 1870 of file kfbxcamera.h.

---

The documentation for this class was generated from the following file:

• fbxfilesdk/kfbxplugins/kfbxcamera.h