#include
<kfbxcamera.h>
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().
Definition at line 72 of file kfbxcamera.h.
Viewing Area Functions |
|
enum | ECameraFormat |
Camera formats. More... |
|
enum | ECameraAspectRatioMode |
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 |
Camera aperture formats. More... |
|
enum | ECameraApertureMode |
Camera aperture modes. More... |
|
enum | ECameraGateFit |
Camera gate fit modes. More... |
|
enum | ECameraFilmRollOrder |
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 responsability of the client
application to process the information in a meaningful way and to
maintain consistency between the different properties
relationships. |
|
enum | ECameraPlateDrawingMode |
Image plate drawing modes. More... |
|
enum | ECameraFrontBackPlaneDistanceMode |
ECameraFrontBackPlaneDistanceMode Front and
BackPlane distance modes. More... |
|
enum | ECameraFrontBackPlaneDisplayMode |
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 | SetShowBackPlate (bool pEnable) |
Enable or disable the display of the texture
without the need to disconnect it from its plate. |
|
bool | GetShowBackPlate () const |
Get the current state of the flag. |
|
void | SetBackgroundAlphaTreshold (double pThreshold) |
Set back plate matte threshold. |
|
double | GetBackgroundAlphaTreshold () const |
Get back plate matte threshold. |
|
void | SetBackgroundTexture (KFbxTexture *pTexture) |
Attach the texture to the Back plate.
|
|
KFbxTexture * | GetBackgroundTexture () const |
Get the texture connected to the Back plate.
|
|
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 | SetBackPlaneDistance (double pDistance) |
Set the back plane distance from the camera.
|
|
double | GetBackPlaneDistance () const |
Get the back plane distance value. |
|
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 |
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 |
Render options usage time. More... |
|
enum | ECameraAntialiasingMethod |
Antialiasing methods. More... |
|
enum | ECameraSamplingType |
Oversampling types. More... |
|
enum | ECameraFocusDistanceSource |
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. |
|
Public Types |
|
enum | ECameraProjectionType |
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. |
|
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 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 frustrum near
and far plane display state. |
|
KFbxTypedProperty < ECameraFrontBackPlaneDisplayMode > |
ViewFrustumBackPlaneMode |
This property handles the view frustrum back
plane mode. |
|
KFbxTypedProperty< fbxDouble1 > | BackPlaneDistance |
This property handles the view frustrum back
plane distance. |
|
KFbxTypedProperty < ECameraFrontBackPlaneDistanceMode > |
BackPlaneDistanceMode |
This property handles the view frustrum back
plane distance mode. |
|
KFbxTypedProperty < ECameraFrontBackPlaneDisplayMode > |
ViewFrustumFrontPlaneMode |
This property handles the view frustrum
front plane mode. |
|
KFbxTypedProperty< fbxDouble1 > | FrontPlaneDistance |
This property handles the view frustrum
front plane distance. |
|
KFbxTypedProperty < ECameraFrontBackPlaneDistanceMode > |
FrontPlaneDistanceMode |
This property handles the view frustrum
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< fbxDouble2 > | BackPlaneOffset |
This property handles the back plane offset.
|
|
KFbxTypedProperty< fbxDouble1 > | BackPlaneRotation |
This property handles the back plane
rotation. |
|
KFbxTypedProperty< fbxDouble2 > | BackPlaneScale |
This property handles the back plane
scaling. |
|
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< fbxDouble2 > | FrontPlaneOffset |
This property handles the front plane
offset. |
|
KFbxTypedProperty< fbxDouble1 > | FrontPlaneRotation |
This property handles the front plane
rotation. |
|
KFbxTypedProperty< fbxDouble2 > | FrontPlaneScale |
This property handles the front plane
scaling. |
|
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. |
Camera projection types.
Camera projection types.
Definition at line 96 of file kfbxcamera.h.
enum ECameraFormat |
Camera formats.
Definition at line 121 of file kfbxcamera.h.
Camera aspect ratio modes.
Definition at line 156 of file kfbxcamera.h.
Camera aperture formats.
Definition at line 253 of file kfbxcamera.h.
enum ECameraApertureMode |
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.
Definition at line 288 of file kfbxcamera.h.
enum ECameraGateFit |
Camera gate fit modes.
Definition at line 351 of file kfbxcamera.h.
enum ECameraFilmRollOrder |
Specifies how the roll is applied with respect to the pivot value.
Definition at line 378 of file kfbxcamera.h.
Image plate drawing modes.
Definition at line 438 of file kfbxcamera.h.
ECameraFrontBackPlaneDistanceMode Front and BackPlane distance modes.
Definition at line 603 of file kfbxcamera.h.
Front/Back Plane display modes.
Definition at line 660 of file kfbxcamera.h.
enum ECameraSafeAreaStyle |
Antialiasing methods.
Definition at line 753 of file kfbxcamera.h.
enum ECameraSamplingType |
Camera focus sources.
Definition at line 773 of file kfbxcamera.h.
virtual EAttributeType GetAttributeType | ( | ) | const [virtual] |
Return the type of node attribute which is EAttributeType::eCAMERA.
Reimplemented from KFbxNodeAttribute.
Reimplemented in KFbxCameraStereo.
void Reset | ( | ) |
Reset the camera to default values.
Reimplemented in KFbxCameraStereo.
void SetFormat | ( | ECameraFormat | pFormat | ) |
Set the camera format.
pFormat | The camera format identifier. |
ECameraFormat GetFormat | ( | ) | const |
Get the camera format.
void SetAspect | ( | ECameraAspectRatioMode | pRatioMode, | |
double | pWidth, | |||
double | pHeight | |||
) |
Set the camera aspect.
pRatioMode | Camera aspect ratio mode. | |
pWidth | Camera aspect width, must be a positive value. | |
pHeight | Camera aspect height, must be a positive value. |
ECameraAspectRatioMode GetAspectRatioMode | ( | ) | const |
Get the camera aspect ratio mode.
void SetPixelRatio | ( | double | pRatio | ) |
Set the pixel ratio.
pRatio | The pixel ratio value. |
double GetPixelRatio | ( | ) | const |
Get the pixel ratio.
void SetNearPlane | ( | double | pDistance | ) |
Set the near plane distance from the camera.
The near plane is the minimum distance to render a scene on the camera display. A synonym for the near plane is "front clipping plane".
pDistance | The near plane distance value. |
double GetNearPlane | ( | ) | const |
Get the near plane distance from the camera.
The near plane is the minimum distance to render a scene on the camera display. A synonym for the near plane is "front clipping plane".
void SetFarPlane | ( | double | pDistance | ) |
Set the far plane distance from camera.
The far plane is the maximum distance to render a scene on the camera display. A synonym for the far plane is "back clipping plane".
pDistance | The far plane distance value. |
double GetFarPlane | ( | ) | const |
Get the far plane distance from camera.
The far plane is the maximum distance to render a scene on the camera display. A synonym for the far plane is "back clipping plane".
void SetApertureFormat | ( | ECameraApertureFormat | pFormat | ) |
Set the camera aperture format.
pFormat | The camera aperture format identifier. |
ECameraApertureFormat GetApertureFormat | ( | ) | const |
Get the camera aperture format.
void SetApertureMode | ( | ECameraApertureMode | pMode | ) |
Set the camera aperture mode.
pMode | The camera aperture mode identifier. |
ECameraApertureMode GetApertureMode | ( | ) | const |
Get the camera aperture mode.
void SetApertureWidth | ( | double | pWidth | ) |
Set the camera aperture width in inches.
pWidth | The aperture width value. |
double GetApertureWidth | ( | ) | const |
Get the camera aperture width in inches.
void SetApertureHeight | ( | double | pHeight | ) |
Set the camera aperture height in inches.
pHeight | The aperture height value. |
double GetApertureHeight | ( | ) | const |
Get the camera aperture height in inches.
void SetSqueezeRatio | ( | double | pRatio | ) |
Set the squeeze ratio.
pRatio | The sqeeze ratio value. |
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.
pFocalLength | The focal length in millimeters |
double ComputeFocalLength | ( | double | pAngleOfView | ) | const |
Compute the focal length based on the given angle of view, the aperture width, and aperture height.
pAngleOfView | The angle of view in degrees |
void SetBackgroundFileName | ( | const char * | pFileName | ) |
Set the associated background image file.
pFileName | The path of 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* GetBackgroundFileName | ( | ) | const |
Get the background image file name.
NULL
if not set.void SetBackgroundMediaName | ( | const char * | pFileName | ) |
Set the media name associated to the background image file.
pFileName | The media name of 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 |
Get the media name associated to the background image file.
NULL
if not
set.void SetShowBackPlate | ( | bool | pEnable | ) |
Enable or disable the display of the texture without the need to disconnect it from its plate.
pEnable | If true the texture is displayed. |
bool GetShowBackPlate | ( | ) | const |
Get the current state of the flag.
true
if show back plate is enabled, otherwise
false
.void SetBackgroundAlphaTreshold | ( | double | pThreshold | ) |
Set back plate matte threshold.
pThreshold | Threshold value on a range from 0.0 to 1.0. |
double GetBackgroundAlphaTreshold | ( | ) | const |
Get back plate matte threshold.
void SetBackgroundTexture | ( | KFbxTexture * | pTexture | ) |
Attach the texture to the Back plate.
pTexture | New texture handle. |
KFbxTexture* GetBackgroundTexture | ( | ) | const |
Get the texture connected to the Back plate.
void SetFitImage | ( | bool | pFitImage | ) |
Change the back plate fit image flag.
pFitImage | New value for the BackPlateFitImage property. |
bool GetFitImage | ( | ) | const |
Get the current back plate image flag.
void SetCrop | ( | bool | pCrop | ) |
Change the back plate crop flag.
pCrop | New value for the BackPlateCrop property. |
bool GetCrop | ( | ) | const |
Get the current back plate crop flag.
void SetCenter | ( | bool | pCenter | ) |
Change the back plate center flag.
pCenter | New value for the BackPlateCenter property. |
bool GetCenter | ( | ) | const |
Get the current back plate center flag.
void SetKeepRatio | ( | bool | pKeepRatio | ) |
Change the back plate keep ratio flag.
pKeepRatio | New value for the BackPlateKeepRatio property. |
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.
pEnable | If true the texture is displayed. |
bool GetShowFrontPlate | ( | ) | const |
Get the current state of the flag.
true
if show front plate is enabled, otherwise
false
.void SetFrontPlateFitImage | ( | bool | pFrontPlateFitImage | ) |
Change the front plate fit image flag.
pFrontPlateFitImage | New value for the FrontPlateFitImage property. |
bool GetFrontPlateFitImage | ( | ) | const |
Get the current front plate fit image flag.
void SetFrontPlateCrop | ( | bool | pFrontPlateCrop | ) |
Change the front plate crop flag.
pFrontPlateCrop | New value for the FrontPlateCrop property. |
bool GetFrontPlateCrop | ( | ) | const |
Get the current front plate crop flag.
void SetFrontPlateCenter | ( | bool | pFrontPlateCenter | ) |
Change the front plate center flag.
pFrontPlateCenter | New value for the FrontPlateCenter property. |
bool GetFrontPlateCenter | ( | ) | const |
Get the current front plate center flag.
void SetFrontPlateKeepRatio | ( | bool | pFrontPlateKeepRatio | ) |
Change the front plate keep ratio flag.
pFrontPlateKeepRatio | New value for the FrontPlateKeepRatio property. |
bool GetFrontPlateKeepRatio | ( | ) | const |
Get the current front plate keep ratio flag.
void SetForegroundOpacity | ( | double | pOpacity | ) |
Set the front plate opacity value.
pOpacity | New value for the ForegroundOpacity property. |
double GetForegroundOpacity | ( | ) | const |
Get the front plate opacity value.
void SetForegroundTexture | ( | KFbxTexture * | pTexture | ) |
Attach the texture to the Front plate.
pTexture | New texture handle. |
KFbxTexture* GetForegroundTexture | ( | ) | const |
Get the texture connected to the Front plate.
void SetBackPlaneDistance | ( | double | pDistance | ) |
Set the back plane distance from the camera.
The the absolute position of the plane must be calculated by taking into consideration the BackPlaneDistanceMode.
pDistance | The back plane distance value. |
double GetBackPlaneDistance | ( | ) | const |
Get the back plane distance value.
void SetBackPlaneDistanceMode | ( | ECameraFrontBackPlaneDistanceMode | pMode | ) |
Set the back plane distance mode flag.
pMode | 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.
The the absolute position of the plane must be calculated by taking into consideration the FrontPlaneDistanceMode.
pDistance | The front plane distance value. |
double GetFrontPlaneDistance | ( | ) | const |
Get the front plane distance value.
void SetFrontPlaneDistanceMode | ( | ECameraFrontBackPlaneDistanceMode | pMode | ) |
Set the front plane distance mode flag.
pMode | 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.
This mode can be used by the client application to decide under which circumstance the front plane should be drawn in the viewport.
pMode | The view frustum front plane display mode. |
ECameraFrontBackPlaneDisplayMode GetViewFrustumFrontPlaneMode | ( | ) | const |
Get the front plane display mode.
void SetViewFrustumBackPlaneMode | ( | ECameraFrontBackPlaneDisplayMode | pMode | ) |
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.
pMode | The view frustum back plane display mode. |
ECameraFrontBackPlaneDisplayMode GetViewFrustumBackPlaneMode | ( | ) | const |
Get the back plane display mode.
void SetViewCameraInterest | ( | bool | pEnable | ) |
Change the camera interest visibility flag.
pEnable | Set to true if the camera interest is shown. |
bool GetViewCameraInterest | ( | ) | const |
Get current visibility state of the camera interest.
true
if the camera interest is shown, or
false
if hidden.void SetViewNearFarPlanes | ( | bool | pEnable | ) |
Change the camera near and far planes visibility flag.
pEnable | Set to true if the near and far planes are
shown. |
bool GetViewNearFarPlanes | ( | ) | const |
Get current visibility state of the camera near and far planes.
true
if the near and far planes are shown.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.
The input points do not need to be ordered in any particular way.
pWorldToScreen | The world to screen transformation. See ComputeWorldToScreen. | |
pWorldToCamera | The world to camera transformation. Inverse matrix returned from KFbxNode::GetGlobalFromCurrentTake is suitable. See KFbxNodeAttribute::GetNode() and KFbxNode::GetGlobalFromCurrentTake(). | |
pPoints | 8 corners of the bounding box. |
bool IsPointInView | ( | const KFbxMatrix & | pWorldToScreen, | |
const KFbxMatrix & | pWorldToCamera, | |||
const KFbxVector4 & | pPoint | |||
) | const |
Determine if the given 3d point is in the camera's view.
pWorldToScreen | The world to screen transformation. See ComputeWorldToScreen. | |
pWorldToCamera | The world to camera transformation. Inverse matrix returned from KFbxNode::GetGlobalFromCurrentTake is suitable. See KFbxNodeAttribute::GetNode() and KFbxNode::GetGlobalFromCurrentTake(). | |
pPoint | World-space point to test. |
KFbxMatrix ComputeWorldToScreen | ( | int | pPixelWidth, | |
int | pPixelHeight, | |||
const KFbxXMatrix & | pWorldToCamera | |||
) | const |
Compute world space to screen space transformation matrix.
pPixelHeight | The pixel height of the output image. | |
pPixelWidth | The pixel height of the output image. | |
pWorldToCamera | The world to camera affine transformation matrix. |
KFbxMatrix ComputePerspective | ( | int | pPixelWidth, | |
int | pPixelHeight, | |||
bool | pIncludePostPerspective | |||
) | const |
Compute the perspective matrix for this camera.
Suitable for transforming camera space to normalized device coordinate space. Also suitable for use as an OpenGL projection matrix. Note this fails if the ProjectionType is not ePERSPECTIVE.
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. |
KFbxTypedProperty<fbxDouble3> Position |
This property handles the camera position (XYZ coordinates).
To access this property do: Position.Get(). To set this property do: Position.Set(fbxDouble3).
Definition at line 848 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble3> UpVector |
This property handles the camera Up Vector (XYZ coordinates).
To access this property do: UpVector.Get(). To set this property do: UpVector.Set(fbxDouble3).
Definition at line 857 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble3> InterestPosition |
This property handles the default point (XYZ coordinates) the camera is looking at.
To access this property do: InterestPosition.Get(). To set this property do: InterestPosition.Set(fbxDouble3).
Default Value is (0.0, 0.0, 0.0)
Definition at line 870 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> Roll |
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.
Definition at line 879 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> OpticalCenterX |
This property handles the camera optical center X, in pixels.
It parameter sets the optical center horizontal offset when the camera aperture mode is set 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.
Definition at line 891 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> OpticalCenterY |
This property handles the camera optical center Y, in pixels.
It sets the optical center horizontal offset when the camera aperture mode is set 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.
Definition at line 903 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble3> BackgroundColor |
This property handles the camera RGB values of the background color.
To access this property do: BackgroundColor.Get(). To set this property do: BackgroundColor.Set(fbxDouble3).
Default value is black (0, 0, 0)
Definition at line 912 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> TurnTable |
This property handles the camera turn table angle in degree(s).
To access this property do: TurnTable.Get(). To set this property do: TurnTable.Set(fbxDouble1).
Default value is 0.
Definition at line 921 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> DisplayTurnTableIcon |
This property handles a flags that indicates if the camera displays the Turn Table icon or not.
To access this property do: DisplayTurnTableIcon.Get(). To set this property do: DisplayTurnTableIcon.Set(fbxBool1).
Default value is false (no display).
Definition at line 931 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> UseMotionBlur |
This property handles a flags that indicates if the camera uses motion blur or not.
To access this property do: UseMotionBlur.Get(). To set this property do: UseMotionBlur.Set(fbxBool1).
Default value is false (do not use motion blur).
Definition at line 945 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> UseRealTimeMotionBlur |
This property handles a flags that indicates if the camera uses real time motion blur or not.
To access this property do: UseRealTimeMotionBlur.Get(). To set this property do: UseRealTimeMotionBlur.Set(fbxBool1).
Default value is false (use real time motion blur).
Definition at line 955 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> MotionBlurIntensity |
This property handles the camera motion blur intensity (in pixels).
To access this property do: MotionBlurIntensity.Get(). To set this property do: MotionBlurIntensity.Set(fbxDouble1).
Default value is 1.
Definition at line 964 of file kfbxcamera.h.
This property handles the camera aspect ratio mode.
Please use function SetAspect() if you want to change its value.
Definition at line 978 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> AspectWidth |
This property handles the camera aspect width.
Please use function SetAspect() if you want to change its value.
Definition at line 987 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> AspectHeight |
This property handles the camera aspect height.
Please use function SetAspect() if you want to change its value.
Definition at line 996 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> PixelAspectRatio |
This property handles the pixel aspect ratio.
Please use function SetPixelRatio() if you want to change its value. Default value is 1.
Value range is [0.050, 20.0].
Definition at line 1005 of file kfbxcamera.h.
This property handles the aperture mode.
Default value is eVERTICAL.
Definition at line 1011 of file kfbxcamera.h.
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 1020 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FieldOfView |
This property handles the field of view in degrees.
To access this property do: FieldOfView.Get(). To set this property do: FieldOfView.Set(fbxDouble1).
Default value is 40.
Value range is [1.0, 179.0].
Definition at line 1033 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FieldOfViewX |
This property handles the X (horizontal) field of view in degrees.
To access this property do: FieldOfViewX.Get(). To set this property do: FieldOfViewX.Set(fbxDouble1).
Definition at line 1047 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FieldOfViewY |
This property handles the Y (vertical) field of view in degrees.
To access this property do: FieldOfViewY.Get(). To set this property do: FieldOfViewY.Set(fbxDouble1).
Default value is 1.
Value range is [1.0, 179.0].
Definition at line 1060 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FocalLength |
This property handles the focal length (in millimeters).
To access this property do: FocalLength.Get(). To set this property do: FocalLength.Set(fbxDouble1).
Default value is the result of ComputeFocalLength(40.0).
Definition at line 1069 of file kfbxcamera.h.
This property handles the camera format.
To access this property do: CameraFormat.Get(). To set this property do: CameraFormat.Set(ECameraFormat).
Please use function SetFormat() if you want to change its value. Default value is eCUSTOM_FORMAT.
Definition at line 1080 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> UseFrameColor |
This property stores a flag that indicates to use or not a color for the frame.
To access this property do: UseFrameColor.Get(). To set this property do: UseFrameColor.Set(fbxBool1).
Default value is false.
Definition at line 1094 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble3> FrameColor |
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).
Definition at line 1103 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ShowName |
This property handles the show name flag.
To access this property do: ShowName.Get(). To set this property do: ShowName.Set(fbxBool1).
Default value is true.
Definition at line 1116 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ShowInfoOnMoving |
This property handles the show info on moving flag.
To access this property do: ShowInfoOnMoving.Get(). To set this property do: ShowInfoOnMoving.Set(fbxBool1).
Default value is true.
Definition at line 1125 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ShowGrid |
This property handles the draw floor grid flag.
To access this property do: ShowGrid.Get(). To set this property do: ShowGrid.Set(fbxBool1).
Default value is true.
Definition at line 1134 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ShowOpticalCenter |
This property handles the show optical center flag.
To access this property do: ShowOpticalCenter.Get(). To set this property do: ShowOpticalCenter.Set(fbxBool1).
Default value is false.
Definition at line 1143 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ShowAzimut |
This property handles the show axis flag.
To access this property do: ShowAzimut.Get(). To set this property do: ShowAzimut.Set(fbxBool1).
Default value is true.
Definition at line 1152 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ShowTimeCode |
This property handles the show time code flag.
To access this property do: ShowTimeCode.Get(). To set this property do: ShowTimeCode.Set(fbxBool1).
Default value is true.
Definition at line 1161 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ShowAudio |
This property handles the show audio flag.
To access this property do: ShowAudio.Get(). To set this property do: ShowAudio.Set(fbxBool1).
Default value is false.
Definition at line 1170 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble3> AudioColor |
This property handles the show audio flag.
To access this property do: AudioColor.Get(). To set this property do: AudioColor.Set(fbxDouble3).
Default value is (0.0, 1.0, 0.0)
Definition at line 1179 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> NearPlane |
This property handles the near plane distance.
Please use function SetNearPlane() if you want to change its value. Default value is 10.
Value range is [0.001, 600000.0].
Definition at line 1192 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FarPlane |
This property handles the far plane distance.
Please use function SetFarPlane() if you want to change its value Default value is 4000
Value range is [0.001, 600000.0]
Definition at line 1201 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> AutoComputeClipPlanes |
This property indicates that the clip planes should be automatically computed.
To access this property do: AutoComputeClipPlanes.Get(). To set this property do: AutoComputeClipPlanes.Set(fbxBool1).
When this property is set to true, the NearPlane and FarPlane values are ignored. Note that not all applications support this flag.
Definition at line 1212 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmWidth |
This property handles the film aperture width (in inches).
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 1227 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmHeight |
This property handles the film aperture height (in inches).
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 1237 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmAspectRatio |
This property handles the film aperture aspect ratio.
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 1246 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmSqueezeRatio |
This property handles the film aperture squeeze ratio.
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 1256 of file kfbxcamera.h.
This property handles the film aperture format.
Please use function SetApertureFormat() if you want to change its value Default value is eCUSTOM_APERTURE_FORMAT
Definition at line 1265 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmOffsetX |
This property handles the offset from the center of the film aperture, defined by the film height and film width.
The offset is measured in inches.
To access this property do: FilmOffset.Get(). To set this property do: FilmOffset.Set(fbxDouble2). 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).
Definition at line 1285 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmOffsetY |
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 1295 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> PreScale |
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 1304 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmTranslateX |
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 1311 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmTranslateY |
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 1318 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmRollPivotX |
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
Definition at line 1326 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmRollPivotY |
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
Definition at line 1334 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FilmRollValue |
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
Definition at line 1344 of file kfbxcamera.h.
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 1353 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ViewCameraToLookAt |
This property handles the view camera to look at flag.
To access this property do: ViewCameraToLookAt.Get(). To set this property do: ViewCameraToLookAt.Set(fbxBool1).
Default value is true
Definition at line 1366 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ViewFrustumNearFarPlane |
This property handles the view frustrum 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
Definition at line 1375 of file kfbxcamera.h.
This property handles the view frustrum back plane mode.
To access this property do: ViewFrustumBackPlaneMode.Get(). To set this property do: ViewFrustumBackPlaneMode.Set(ECameraFrontBackPlaneDisplayMode).
Default value is eWHEN_MEDIA
Definition at line 1384 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> BackPlaneDistance |
This property handles the view frustrum back plane distance.
To access this property do: BackPlaneDistance.Get(). To set this property do: BackPlaneDistance.Set(fbxDouble1).
Default value is 100.0
Definition at line 1393 of file kfbxcamera.h.
This property handles the view frustrum back plane distance mode.
To access this property do: BackPlaneDistanceMode.Get(). To set this property do: BackPlaneDistanceMode.Set(ECameraFrontBackPlaneDistanceMode).
Default value is eRELATIVE_TO_INTEREST
Definition at line 1402 of file kfbxcamera.h.
This property handles the view frustrum 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 1411 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FrontPlaneDistance |
This property handles the view frustrum front plane distance.
To access this property do: FrontPlaneDistance.Get(). To set this property do: FrontPlaneDistance.Set(fbxDouble1).
Default value is 100.0
Definition at line 1420 of file kfbxcamera.h.
This property handles the view frustrum front plane distance mode.
To access this property do: FrontPlaneDistanceMode.Get(). To set this property do: FrontPlaneDistanceMode.Set(ECameraFrontBackPlaneDistanceMode).
Default value is eRELATIVE_TO_INTEREST
Definition at line 1429 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> LockMode |
This property handles the lock mode.
To access this property do: LockMode.Get(). To set this property do: LockMode.Set(fbxBool1).
Default value is false
Definition at line 1442 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> LockInterestNavigation |
This property handles the lock interest navigation flag.
To access this property do: LockInterestNavigation.Get(). To set this property do: LockInterestNavigation.Set(fbxBool1).
Default value is false
Definition at line 1451 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> FitImage |
This property handles the fit image flag.
To access this property do: FitImage.Get(). To set this property do: FitImage.Set(fbxBool1).
Default value is false.
Definition at line 1464 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> Crop |
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 1473 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> Center |
This property handles the center flag.
To access this property do: Center.Get(). To set this property do: Center.Set(fbxBool1).
Default value is true.
Definition at line 1482 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> KeepRatio |
This property handles the keep ratio flag.
To access this property do: KeepRatio.Get(). To set this property do: KeepRatio.Set(fbxBool1).
Default value is true.
Definition at line 1491 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> BackgroundAlphaTreshold |
This property handles the background alpha threshold value.
To access this property do: BackgroundAlphaTreshold.Get(). To set this property do: BackgroundAlphaTreshold.Set(fbxDouble1).
Default value is 0.5.
Definition at line 1500 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble2> BackPlaneOffset |
This property handles the back plane offset.
To access this property do: BackPlaneOffset.Get() To set this property do: BackPlaneOffset.Set(fbxDouble2).
Default value is (0., 0.).
Definition at line 1509 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> BackPlaneRotation |
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 1518 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble2> BackPlaneScale |
This property handles the back plane scaling.
To access this property do: BackPlaneOffset.Get() To set this property do: BackPlaneScale.Set(fbxDouble2).
Default value is (1., 1.).
Definition at line 1529 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ShowBackplate |
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.
Definition at line 1539 of file kfbxcamera.h.
KFbxTypedProperty<fbxReference> BackgroundTexture |
This property has the background textures connected to it.
To access this property do: BackgroundTexture.GetSrcObject(). To set this property do: BackgroundTexture.ConnectSrcObject(KFbxObject*).
Definition at line 1548 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> FrontPlateFitImage |
This property handles the fit image for front plate flag.
To access this property do: FrontPlateFitImage.Get(). To set this property do: FrontPlateFitImage.Set(fbxBool1).
Default value is false.
Definition at line 1562 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> FrontPlateCrop |
This property handles the front plane crop flag.
To access this property do: FrontPlateCrop.Get(). To set this property do: FrontPlateCrop.Set(fbxBool1).
Default value is false.
Definition at line 1571 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> FrontPlateCenter |
This property handles the front plane center flag.
To access this property do: FrontPlateCenter.Get(). To set this property do: FrontPlateCenter.Set(fbxBool1).
Default value is true.
Definition at line 1580 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> FrontPlateKeepRatio |
This property handles the front plane keep ratio flag.
To access this property do: FrontPlateKeepRatio.Get(). To set this property do: FrontPlateKeepRatio.Set(fbxBool1).
Default value is true.
Definition at line 1589 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> ShowFrontplate |
This property handles the front plane show flag.
To access this property do: ShowFrontplate.Get(). To set this property do: ShowFrontplate.Set(fbxBool1).
Default value is false.
Definition at line 1600 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble2> FrontPlaneOffset |
This property handles the front plane offset.
To access this property do: FrontPlaneOffset.Get() To set this property do: FrontPlaneOffset.Set(fbxDouble2).
Default value is (0., 0.).
Definition at line 1610 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FrontPlaneRotation |
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 1619 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble2> FrontPlaneScale |
This property handles the front plane scaling.
To access this property do: FrontPlaneOffset.Get() To set this property do: FrontPlaneScale.Set(fbxDouble3).
Default value is (1., 1.).
Definition at line 1628 of file kfbxcamera.h.
KFbxTypedProperty<fbxReference> ForegroundTexture |
This property has the foreground textures connected to it.
To access this property do: ForegroundTexture.GetSrcObject(). To set this property do: ForegroundTexture.ConnectSrcObject(KFbxObject*).
Definition at line 1637 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> ForegroundOpacity |
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.
Definition at line 1646 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> DisplaySafeArea |
This property handles the display safe area flag.
To access this property do: DisplaySafeArea.Get(). To set this property do: DisplaySafeArea.Set(fbxBool1).
Default value is false
Definition at line 1659 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> DisplaySafeAreaOnRender |
This property handles the display safe area on render flag.
To access this property do: DisplaySafeAreaOnRender.Get(). To set this property do: DisplaySafeAreaOnRender.Set(fbxBool1).
Default value is false
Definition at line 1668 of file kfbxcamera.h.
This property handles the display safe area display style.
To access this property do: SafeAreaDisplayStyle.Get(). To set this property do: SafeAreaDisplayStyle.Set(ECameraSafeAreaStyle).
Default value is eSQUARE
Definition at line 1677 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> SafeAreaAspectRatio |
This property handles the display safe area aspect ratio.
To access this property do: SafeAreaDisplayStyle.Get(). To set this property do: SafeAreaAspectRatio.Set(fbxDouble1).
Default value is 1.33333333333333
Definition at line 1686 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> Use2DMagnifierZoom |
This property handles the use 2d magnifier zoom flag.
To access this property do: Use2DMagnifierZoom.Get(). To set this property do: Use2DMagnifierZoom.Set(fbxBool1).
Default value is false
Definition at line 1699 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> _2DMagnifierZoom |
This property handles the 2d magnifier zoom value.
To access this property do: _2DMagnifierZoom.Get(). To set this property do: _2DMagnifierZoom.Set(fbxDouble1).
Default value is 100.0
Definition at line 1708 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> _2DMagnifierX |
This property handles the 2d magnifier X value.
To access this property do: _2DMagnifierX.Get(). To set this property do: _2DMagnifierX.Set(fbxDouble1).
Default value is 50.0
Definition at line 1717 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> _2DMagnifierY |
This property handles the 2d magnifier Y value.
To access this property do: _2DMagnifierY.Get(). To set this property do: _2DMagnifierY.Set(fbxDouble1).
Default value is 50.0
Definition at line 1726 of file kfbxcamera.h.
This property handles the projection type.
To access this property do: ProjectionType.Get(). To set this property do: ProjectionType.Set(ECameraProjectionType).
Default value is ePERSPECTIVE.
Definition at line 1739 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> OrthoZoom |
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 1748 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> UseRealTimeDOFAndAA |
This property handles the use real time DOF and AA flag.
To access this property do: UseRealTimeDOFAndAA.Get(). To set this property do: UseRealTimeDOFAndAA.Set(fbxBool1).
Default value is false.
Definition at line 1761 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> UseDepthOfField |
This property handles the use depth of field flag.
To access this property do: UseDepthOfField.Get(). To set this property do: UseDepthOfField.Set(fbxBool1).
Default value is false
Definition at line 1770 of file kfbxcamera.h.
This property handles the focus source.
To access this property do: FocusSource.Get(). To set this property do: FocusSource.Set(ECameraFocusDistanceSource).
Default value is eCAMERA_INTEREST
Definition at line 1779 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FocusAngle |
This property handles the focus angle (in degrees).
To access this property do: FocusAngle.Get(). To set this property do: FocusAngle.Set(fbxDouble1).
Default value is 3.5
Definition at line 1788 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> FocusDistance |
This property handles the focus distance.
To access this property do: FocusDistance.Get(). To set this property do: FocusDistance.Set(fbxDouble1).
Default value is 200.0
Definition at line 1797 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> UseAntialiasing |
This property handles the use anti aliasing flag.
To access this property do: UseAntialiasing.Get(). To set this property do: UseAntialiasing.Set(fbxBool1).
Default value is false
Definition at line 1806 of file kfbxcamera.h.
KFbxTypedProperty<fbxDouble1> AntialiasingIntensity |
This property handles the anti aliasing intensity.
To access this property do: AntialiasingIntensity.Get(). To set this property do: AntialiasingIntensity.Set(fbxDouble1).
Default value is 0.77777
Definition at line 1815 of file kfbxcamera.h.
This property handles the anti aliasing method.
To access this property do: AntialiasingMethod.Get(). To set this property do: AntialiasingMethod.Set(ECameraAntialiasingMethod).
Default value is eOVERSAMPLING_ANTIALIASING
Definition at line 1824 of file kfbxcamera.h.
KFbxTypedProperty<fbxBool1> UseAccumulationBuffer |
This property handles the use accumulation buffer flag.
To access this property do: UseAccumulationBuffer.Get(). To set this property do: UseAccumulationBuffer.Set(fbxBool1).
Default value is false
Definition at line 1837 of file kfbxcamera.h.
KFbxTypedProperty<fbxInteger1> FrameSamplingCount |
This property handles the frame sampling count.
To access this property do: FrameSamplingCount.Get(). To set this property do: FrameSamplingCount.Set(fbxInteger1).
Default value is 7
Definition at line 1846 of file kfbxcamera.h.
This property handles the frame sampling type.
To access this property do: FrameSamplingType.Get(). To set this property do: FrameSamplingType.Set(ECameraSamplingType).
Default value is eSTOCHASTIC
Definition at line 1855 of file kfbxcamera.h.