FBX C++ API Reference
FbxCamera Class Reference

#include <fbxcamera.h>

Class 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 EFocusDistanceSource::eFocusSrcCameraInterest and the followed node associated with function FbxNode::SetTarget().

See also
FbxCameraStereo and FbxCameraSwitcher.
Examples:
Camera/main.cxx, ExportScene04/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayCamera.cxx, ImportScene/DisplayCamera.h, StereoCamera/main.cxx, ViewScene/DrawScene.cxx, ViewScene/SceneContext.cxx, ViewScene/SetCamera.cxx, and ViewScene/SetCamera.h.

Definition at line 34 of file fbxcamera.h.

+ Inheritance diagram for FbxCamera:

Public Types

enum  EProjectionType { ePerspective, eOrthogonal }
 Camera projection types. More...
 
typedef FbxNodeAttribute ParentClass
 
- Public Types inherited from FbxNodeAttribute
enum  EType {
  eUnknown, eNull, eMarker, eSkeleton,
  eMesh, eNurbs, ePatch, eCamera,
  eCameraStereo, eCameraSwitcher, eLight, eOpticalReference,
  eOpticalMarker, eNurbsCurve, eTrimNurbsSurface, eBoundary,
  eNurbsSurface, eShape, eLODGroup, eSubDiv,
  eCachedEffect, eLine
}
 Node attribute types. More...
 
typedef FbxObject ParentClass
 
- Public Types inherited from FbxObject
typedef FbxEmitter ParentClass
 
enum  EObjectFlag {
  eNone = 0, eInitialized = 1 << 0, eSystem = 1 << 1, eSavable = 1 << 2,
  eSelected = 1 << 3, eHidden = 1 << 4, eContentLoaded = 1 << 5, eDontLocalize = 1 << 6,
  eCopyCalledByClone = 1 << 16
}
 Flags available to control objects. More...
 
enum  ECloneType { eDeepClone, eReferenceClone }
 Types of clones that can be created for FbxObject. More...
 

Public Member Functions

virtual FbxClassId GetClassId () const
 
virtual FbxNodeAttribute::EType GetAttributeType () const
 Return the type of node attribute which is EType::eCamera. More...
 
void Reset ()
 Reset the camera to default values. More...
 
- Public Member Functions inherited from FbxNodeAttribute
int GetNodeCount () const
 Return the node count using this attribute. More...
 
FbxNodeGetNode (int pIndex=0) const
 Return the node this attribute is set to. More...
 
- Public Member Functions inherited from FbxObject
virtual void Compact ()
 Compact the memory used by this object. More...
 
template<class T >
bool Is () const
 Templated test if this class is a hierarchical children of the specified class type. More...
 
FbxManagerGetFbxManager () const
 Retrieve the FbxManager this object belongs to. More...
 
FbxDocumentGetDocument () const
 Returns a const pointer to the document that contains this object. More...
 
FbxDocumentGetRootDocument () const
 Returns a const pointer to the root document that contains this object. More...
 
FbxSceneGetScene () const
 Returns a const pointer to the scene that contains this object. More...
 
void Destroy (bool pRecursive=false)
 Unregister and delete this object from memory. More...
 
void ResetProperties ()
 Reset all the properties of this object to their default values. More...
 
virtual bool GetSelected ()
 Returns if this object is currently in a selected state. More...
 
virtual void SetSelected (bool pSelected)
 Sets whether this object is currently selected. More...
 
void SetUserDataPtr (const FbxUInt64 &pUserID, void *pUserData)
 Sets the data pointer for an user data record whose ID is pUserID. More...
 
void * GetUserDataPtr (const FbxUInt64 &pUserID) const
 Returns the data pointer of an user data record whose ID is pUserID. More...
 
void SetUserDataPtr (void *pUserData)
 Sets the data pointer for the user data record whose ID is the object ID. More...
 
void * GetUserDataPtr () const
 Returns the data pointer of the user data record whose ID is the object ID. More...
 
bool ConnectSrcObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone)
 Connects this object to a source object. More...
 
bool IsConnectedSrcObject (const FbxObject *pObject) const
 Judges whether this object connects with the source object. More...
 
bool DisconnectSrcObject (FbxObject *pObject)
 Disconnects this object from a source object. More...
 
bool DisconnectAllSrcObject ()
 Disconnects this object from all source objects. More...
 
bool DisconnectAllSrcObject (const FbxCriteria &pCriteria)
 Disconnects this object from all source objects that satisfy a given criteria. More...
 
int GetSrcObjectCount () const
 Returns the number of source objects with which this object connects. More...
 
int GetSrcObjectCount (const FbxCriteria &pCriteria) const
 Returns the number of source objects that satisfy the given criteria with which this object connects. More...
 
FbxObjectGetSrcObject (int pIndex=0) const
 Returns the source object with which this object connects at the specified index. More...
 
FbxObjectGetSrcObject (const FbxCriteria &pCriteria, int pIndex=0) const
 Returns the source object that satisfies the criteria at the specified index with which this object connects. More...
 
FbxObjectFindSrcObject (const char *pName, int pStartIndex=0) const
 Searches the source object with the specified name, starting at the specified index. More...
 
FbxObjectFindSrcObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const
 Searches the source object with the specified name which satisfies the given criteria, starting at the specified index. More...
 
template<class T >
bool DisconnectAllSrcObject ()
 Disconnects this object from all source objects of the specified class type. More...
 
template<class T >
bool DisconnectAllSrcObject (const FbxCriteria &pCriteria)
 Disconnects this object from all source objects that are of the specified class type and that satisfy the given criteria. More...
 
template<class T >
int GetSrcObjectCount () const
 Returns the number of source objects of a specific class type with which this object connects. More...
 
template<class T >
int GetSrcObjectCount (const FbxCriteria &pCriteria) const
 Returns the number of source objects with which this object connects that are the specified class type and that satisfy the given criteria. More...
 
template<class T >
T * GetSrcObject (int pIndex=0) const
 Returns the source object of the specified class type at the specified index. More...
 
template<class T >
T * GetSrcObject (const FbxCriteria &pCriteria, int pIndex=0) const
 Returns the source object that is the specified class type and that satisfies the given criteria at the specified index. More...
 
template<class T >
T * FindSrcObject (const char *pName, int pStartIndex=0) const
 Searches the source object with the specified name that is the specified class type, starting at the specified index. More...
 
template<class T >
T * FindSrcObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const
 Searches the source object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index. More...
 
bool ConnectDstObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone)
 Connects this object to one destination object. More...
 
bool IsConnectedDstObject (const FbxObject *pObject) const
 Judges whether this object connects with the destination object. More...
 
bool DisconnectDstObject (FbxObject *pObject)
 Disconnects this object from the destination object. More...
 
bool DisconnectAllDstObject ()
 Disconnects this object from all destination objects. More...
 
bool DisconnectAllDstObject (const FbxCriteria &pCriteria)
 Disconnects this object from all destination objects that satisfy given criteria. More...
 
int GetDstObjectCount () const
 Returns the number of destination objects with which this object connects. More...
 
int GetDstObjectCount (const FbxCriteria &pCriteria) const
 Returns the number of destination objects with which this object connects that satisfy the given criteria. More...
 
FbxObjectGetDstObject (int pIndex=0) const
 Returns the destination object at the specified index with which this object connects. More...
 
FbxObjectGetDstObject (const FbxCriteria &pCriteria, int pIndex=0) const
 Returns the destination object with which this object connects that satisfies the given criteria at the specified index. More...
 
FbxObjectFindDstObject (const char *pName, int pStartIndex=0) const
 Searches the destination object with the specified name, starting at the specified index. More...
 
FbxObjectFindDstObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const
 Searches the destination object with the specified name which satisfies the given criteria, starting at the specified index. More...
 
template<class T >
bool DisconnectAllDstObject ()
 Disconnects this object from all destination objects of the specified class type. More...
 
template<class T >
bool DisconnectAllDstObject (const FbxCriteria &pCriteria)
 Disconnects this object from all destination objects that are the specified class type and that satisfy the given criteria. More...
 
template<class T >
int GetDstObjectCount () const
 Returns the number of destination objects of the specified class type with which this object connects. More...
 
template<class T >
int GetDstObjectCount (const FbxCriteria &pCriteria) const
 Returns the number of destination objects with which this object connects that are the specified class type and that satisfy the given criteria. More...
 
template<class T >
T * GetDstObject (int pIndex=0) const
 Returns the destination object with which this object connects that is the specified class type at the specified index. More...
 
template<class T >
T * GetDstObject (const FbxCriteria &pCriteria, int pIndex=0) const
 Returns the destination object with which this object connects that is the specified class type and that satisfies the given criteria at the specified index. More...
 
template<class T >
T * FindDstObject (const char *pName, int pStartIndex=0) const
 Searches the destination object with the specified name which is of the specified class type, starting at the specified index. More...
 
template<class T >
T * FindDstObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const
 Searches the destination object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index. More...
 
FbxProperty GetFirstProperty () const
 Returns the first property of this object. More...
 
FbxProperty GetNextProperty (const FbxProperty &pProperty) const
 Returns the next property of this object that follows the specified property. More...
 
FbxProperty FindProperty (const char *pName, bool pCaseSensitive=true) const
 Searches a property by name. More...
 
FbxProperty FindProperty (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const
 Searches a property by name and data type. More...
 
FbxProperty FindPropertyHierarchical (const char *pName, bool pCaseSensitive=true) const
 Searches a property by full name. More...
 
FbxProperty FindPropertyHierarchical (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const
 Searches a property by full name and data type. More...
 
FbxProperty GetClassRootProperty ()
 Returns the class root property. More...
 
bool ConnectSrcProperty (const FbxProperty &pProperty)
 Connects this object to a source property. More...
 
bool IsConnectedSrcProperty (const FbxProperty &pProperty)
 Determines whether this object connects with the specified source property. More...
 
bool DisconnectSrcProperty (const FbxProperty &pProperty)
 Disconnects this object from the specified source property. More...
 
int GetSrcPropertyCount () const
 Returns the number of source properties with which this object connects. More...
 
FbxProperty GetSrcProperty (int pIndex=0) const
 Returns the source property at the specified index with which this object connects. More...
 
FbxProperty FindSrcProperty (const char *pName, int pStartIndex=0) const
 Searches a source property with which this object connects that has a specific name, starting at the specified index. More...
 
bool ConnectDstProperty (const FbxProperty &pProperty)
 Connects this object to a destination property. More...
 
bool IsConnectedDstProperty (const FbxProperty &pProperty)
 Determines if this object connects with the specified destination property. More...
 
bool DisconnectDstProperty (const FbxProperty &pProperty)
 Disconnects this object from the specified destination property. More...
 
int GetDstPropertyCount () const
 Returns the number of destination properties with which this object connects. More...
 
FbxProperty GetDstProperty (int pIndex=0) const
 Returns the destination property at the specified index with which this object connects. More...
 
FbxProperty FindDstProperty (const char *pName, int pStartIndex=0) const
 Searches a destination property with which this object connects that has a specific name, starting at the specified index. More...
 
int ContentUnload ()
 Unloads this object's content using the offload peripheral that is currently set in the document then flushes it from memory. More...
 
int ContentLoad ()
 Loads this object's content using the offload peripheral that is currently set in the document. More...
 
bool ContentIsLoaded () const
 Judges if this object's content is loaded. More...
 
void ContentDecrementLockCount ()
 Decreases the content lock count of an object. More...
 
void ContentIncrementLockCount ()
 Increases the content lock count of an object. More...
 
bool ContentIsLocked () const
 Judges if this object's content is locked. More...
 
virtual bool ContentWriteTo (FbxStream &pStream) const
 Writes the content of the object to the given stream. More...
 
virtual bool ContentReadFrom (const FbxStream &pStream)
 Reads the content of the object from the given stream. More...
 
void EmitMessage (FbxMessage *pMessage) const
 Emits a message in all available message emitters in the document or SDK manager. More...
 
virtual const char * Localize (const char *pID, const char *pDefault=((void *) 0)) const
 Localization helper function, it calls the implementation of FBX SDK manager. More...
 
FbxLibraryGetParentLibrary () const
 Returns a handle on the parent library of this object. More...
 
bool AddImplementation (FbxImplementation *pImplementation)
 Adds an implementation. More...
 
bool RemoveImplementation (FbxImplementation *pImplementation)
 Removes an implementation. More...
 
bool HasDefaultImplementation (void) const
 Determines if this shading node has a default implementation. More...
 
FbxImplementationGetDefaultImplementation (void) const
 Returns the default implementation of this shading node. More...
 
bool SetDefaultImplementation (FbxImplementation *pImplementation)
 Sets the default implementation of this shading node. More...
 
int GetImplementationCount (const FbxImplementationFilter *pCriteria=((void *) 0)) const
 Returns the number of implementations that satisfy a given criteria. More...
 
FbxImplementationGetImplementation (int pIndex, const FbxImplementationFilter *pCriteria=((void *) 0)) const
 Returns the implementation at the specified index that satisfies the given criteria. More...
 
virtual FbxString GetUrl () const
 Returns the URL of this object. More...
 
virtual bool SetUrl (char *pUrl)
 Sets the URL of this object. More...
 
void SetRuntimeClassId (const FbxClassId &pClassId)
 Set the run-time ClassId for this class. More...
 
FbxClassId GetRuntimeClassId () const
 Retrieve the run-time ClassId for this object. More...
 
bool IsRuntime (const FbxClassId &pClassId) const
 Test if this class is a hierarchical children of the specified class type. More...
 
bool IsRuntimePlug () const
 Find out if the ClassId was registered during run-time rather than at compile time. More...
 
void SetObjectFlags (EObjectFlag pFlags, bool pValue)
 Set the state of object flags. More...
 
bool GetObjectFlags (EObjectFlag pFlags) const
 Get the state of object flags. More...
 
void SetAllObjectFlags (FbxUInt pFlags)
 Override all object flags at once. More...
 
FbxUInt GetAllObjectFlags () const
 Get all object flags at once. More...
 
virtual FbxObjectCopy (const FbxObject &pObject)
 Copy an object content into this object. More...
 
virtual FbxObjectClone (FbxObject::ECloneType pCloneType=eDeepClone, FbxObject *pContainer=((void *) 0), void *pSet=((void *) 0)) const
 Creates a clone of this object. More...
 
bool IsAReferenceTo () const
 Checks if this object is a reference clone of another object. More...
 
FbxObjectGetReferenceTo () const
 If this object is a reference clone, returns the original object (from which the clone originates). More...
 
bool IsReferencedBy () const
 Checks if any objects are reference cloned from this object. More...
 
int GetReferencedByCount () const
 Returns the number of objects that are reference clones of this object. More...
 
FbxObjectGetReferencedBy (int pIndex) const
 Returns a reference clone of this object at the specified index. More...
 
void SetName (const char *pName)
 Sets the name of this object. More...
 
const char * GetName () const
 Returns the full name of this object. More...
 
FbxString GetNameWithoutNameSpacePrefix () const
 Returns the name of the object without the namespace qualifier. More...
 
FbxString GetNameWithNameSpacePrefix () const
 Returns the name of the object with the namespace qualifier. More...
 
void SetInitialName (const char *pName)
 Sets the initial name of the object. More...
 
const char * GetInitialName () const
 Returns the initial name of the object. More...
 
FbxString GetNameSpaceOnly ()
 Returns the namespace of the object. More...
 
void SetNameSpace (FbxString pNameSpace)
 Sets the namespace of the object. More...
 
FbxArray< FbxString * > GetNameSpaceArray (char identifier)
 Returns an array of all the namespaces for this object. More...
 
FbxString GetNameOnly () const
 Returns only the name (no namespace or prefix) of the object. More...
 
FbxString GetNameSpacePrefix () const
 Returns the namespace qualifier. More...
 
const FbxUInt64GetUniqueID () const
 Returns the unique ID of this object. More...
 
- Public Member Functions inherited from FbxEmitter
void AddListener (FbxEventHandler &pHandler)
 Add the specified event handler to current emitter list. More...
 
void RemoveListener (FbxEventHandler &pHandler)
 Remove the specified event handler from current emitter list. More...
 
template<typename EventType >
void Emit (const EventType &pEvent) const
 Emit an event with the specified the event type. More...
 

Static Public Member Functions

static FbxCameraCreate (FbxManager *pManager, const char *pName)
 
static FbxCameraCreate (FbxObject *pContainer, const char *pName)
 
- Static Public Member Functions inherited from FbxNodeAttribute
static FbxNodeAttributeCreate (FbxManager *pManager, const char *pName)
 
static FbxNodeAttributeCreate (FbxObject *pContainer, const char *pName)
 
- Static Public Member Functions inherited from FbxObject
static FbxObjectCreate (FbxManager *pManager, const char *pName)
 
static FbxObjectCreate (FbxObject *pContainer, const char *pName)
 
static FbxString RemovePrefix (char *pName)
 Removes the prefix of pName. More...
 
static FbxString StripPrefix (FbxString &lName)
 Strips the prefix of pName. More...
 
static FbxString StripPrefix (const char *pName)
 Strips the prefix of pName. More...
 

Public Attributes

FbxPropertyT< FbxDouble3Position
 This property handles the camera's position (XYZ coordinates). More...
 
FbxPropertyT< FbxDouble3UpVector
 This property handles the camera's Up Vector (XYZ coordinates). More...
 
FbxPropertyT< FbxDouble3InterestPosition
 This property handles the default point (XYZ coordinates) the camera is looking at. More...
 
FbxPropertyT< FbxDoubleRoll
 This property handles the camera roll angle in degrees. More...
 
FbxPropertyT< FbxDoubleOpticalCenterX
 This property handles the camera optical center X, in pixels. More...
 
FbxPropertyT< FbxDoubleOpticalCenterY
 This property handles the camera optical center Y, in pixels. More...
 
FbxPropertyT< FbxDouble3BackgroundColor
 This property handles the RGB values of the camera's background color. More...
 
FbxPropertyT< FbxDoubleTurnTable
 When modeling 3D objects, you often need to review or evaluate your models during the creation process. More...
 
FbxPropertyT< FbxBoolDisplayTurnTableIcon
 This property handles a flag that indicates if the camera displays the Turn Table icon or not. More...
 
FbxPropertyT< FbxBoolUseMotionBlur
 This property handles a flag that indicates if the camera uses motion blur or not. More...
 
FbxPropertyT< FbxBoolUseRealTimeMotionBlur
 This property handles a flag that indicates if the camera uses real time motion blur or not. More...
 
FbxPropertyT< FbxDoubleMotionBlurIntensity
 This property handles the camera's motion blur intensity (in pixels). More...
 
FbxPropertyT< EAspectRatioModeAspectRatioMode
 This property handles the camera's aspect ratio mode. More...
 
FbxPropertyT< FbxDoubleAspectWidth
 This property handles the camera's aspect width. More...
 
FbxPropertyT< FbxDoubleAspectHeight
 This property handles the camera's aspect height. More...
 
FbxPropertyT< FbxDoublePixelAspectRatio
 This property handles the pixel aspect ratio. More...
 
FbxPropertyT< EApertureModeApertureMode
 This property handles the aperture mode. More...
 
FbxPropertyT< EGateFitGateFit
 This property handles the gate fit mode. More...
 
FbxPropertyT< FbxDoubleFieldOfView
 This property handles the field of view in degrees. More...
 
FbxPropertyT< FbxDoubleFieldOfViewX
 This property handles the X (horizontal) field of view in degrees. More...
 
FbxPropertyT< FbxDoubleFieldOfViewY
 This property handles the Y (vertical) field of view in degrees. More...
 
FbxPropertyT< FbxDoubleFocalLength
 This property handles the focal length (in millimeters). More...
 
FbxPropertyT< EFormatCameraFormat
 This property handles the camera's format. More...
 
FbxPropertyT< FbxBoolUseFrameColor
 This property stores a flag that indicates to draw a border with color around the camera's viewable area or not. More...
 
FbxPropertyT< FbxDouble3FrameColor
 This property is used to define the color of the border around the camera view. More...
 
FbxPropertyT< FbxBoolShowName
 This property handles the flag to show the camera's name or not. More...
 
FbxPropertyT< FbxBoolShowInfoOnMoving
 This property handles the flag to show info on moving or not. More...
 
FbxPropertyT< FbxBoolShowGrid
 This property handles the flag to draw floor grid or not. More...
 
FbxPropertyT< FbxBoolShowOpticalCenter
 This property handles the flag to show optical center or not. More...
 
FbxPropertyT< FbxBoolShowAzimut
 This property handles the flag to show the camera's sight line or not. More...
 
FbxPropertyT< FbxBoolShowTimeCode
 This property handles the flag to show time code or not. More...
 
FbxPropertyT< FbxBoolShowAudio
 This property handles the flag to show audio or not. More...
 
FbxPropertyT< FbxDouble3AudioColor
 This property handles audio color. More...
 
FbxPropertyT< FbxDoubleNearPlane
 This property handles the near plane distance. More...
 
FbxPropertyT< FbxDoubleFarPlane
 This property handles the far plane distance. More...
 
FbxPropertyT< FbxBoolAutoComputeClipPlanes
 This property indicates that the clip planes should be automatically computed or not. More...
 
FbxPropertyT< FbxDoubleFilmWidth
 This property handles the film aperture width (in inches). More...
 
FbxPropertyT< FbxDoubleFilmHeight
 This property handles the film aperture height (in inches). More...
 
FbxPropertyT< FbxDoubleFilmAspectRatio
 This property handles the film aperture aspect ratio. More...
 
FbxPropertyT< FbxDoubleFilmSqueezeRatio
 This property handles the film aperture squeeze ratio. More...
 
FbxPropertyT< EApertureFormatFilmFormat
 This property handles the film aperture format. More...
 
FbxPropertyT< FbxDoubleFilmOffsetX
 This property handles the horizontal offset from the center of the film aperture, defined by the film height and film width. More...
 
FbxPropertyT< FbxDoubleFilmOffsetY
 This property handles the vertical offset from the center of the film aperture, defined by the film height and film width. More...
 
FbxPropertyT< FbxDoublePreScale
 This property handles the pre-scale value. More...
 
FbxPropertyT< FbxDoubleFilmTranslateX
 This property handles the horizontal film horizontal translation. More...
 
FbxPropertyT< FbxDoubleFilmTranslateY
 This property handles the vertical film translation. More...
 
FbxPropertyT< FbxDoubleFilmRollPivotX
 This property handles the horizontal pivot point used for rotating the film back. More...
 
FbxPropertyT< FbxDoubleFilmRollPivotY
 This property handles the vertical pivot point used for rotating the film back. More...
 
FbxPropertyT< FbxDoubleFilmRollValue
 This property handles the amount of rotation around the film back. More...
 
FbxPropertyT< EFilmRollOrderFilmRollOrder
 This property handles how the roll is applied with respect to the pivot value. More...
 
FbxPropertyT< FbxBoolViewCameraToLookAt
 This property handles the camera's look-at flag. More...
 
FbxPropertyT< FbxBoolViewFrustumNearFarPlane
 This property handles to display the near and far plane or not. More...
 
FbxPropertyT< EFrontBackPlaneDisplayModeViewFrustumBackPlaneMode
 This property handles the back plane display mode. More...
 
FbxPropertyT< FbxDoubleBackPlaneDistance
 This property handles the back plane distance. More...
 
FbxPropertyT< EFrontBackPlaneDistanceModeBackPlaneDistanceMode
 This property handles the back plane distance mode. More...
 
FbxPropertyT< EFrontBackPlaneDisplayModeViewFrustumFrontPlaneMode
 This property handles the front plane mode. More...
 
FbxPropertyT< FbxDoubleFrontPlaneDistance
 This property handles the front plane distance. More...
 
FbxPropertyT< EFrontBackPlaneDistanceModeFrontPlaneDistanceMode
 This property handles the front plane distance mode. More...
 
FbxPropertyT< FbxBoolLockMode
 This property handles the flag to lock the camera's navigation. More...
 
FbxPropertyT< FbxBoolLockInterestNavigation
 This property handles the flag to lock the camera interest's navigation. More...
 
FbxPropertyT< FbxBoolBackPlateFitImage
 This property handles the fit image flag of back plane. More...
 
FbxPropertyT< FbxBoolBackPlateCrop
 This property handles the crop flag of back plane. More...
 
FbxPropertyT< FbxBoolBackPlateCenter
 This property handles the center flag of back plane. More...
 
FbxPropertyT< FbxBoolBackPlateKeepRatio
 This property handles the keep ratio flag of back plane. More...
 
FbxPropertyT< FbxDoubleBackgroundAlphaTreshold
 This property handles the background alpha threshold value. More...
 
FbxPropertyT< FbxDoubleBackPlaneOffsetX
 This property handles the back plane offset X. More...
 
FbxPropertyT< FbxDoubleBackPlaneOffsetY
 This property handles the back plane offset Y. More...
 
FbxPropertyT< FbxDoubleBackPlaneRotation
 This property handles the back plane rotation. More...
 
FbxPropertyT< FbxDoubleBackPlaneScaleX
 This property handles the back plane scaling X. More...
 
FbxPropertyT< FbxDoubleBackPlaneScaleY
 This property handles the back plane scaling Y. More...
 
FbxPropertyT< FbxBoolShowBackplate
 This property handles the flag to show back plane or not. More...
 
FbxPropertyT< FbxReferenceBackgroundTexture
 This property has the background texture connected to it. More...
 
FbxPropertyT< FbxBoolFrontPlateFitImage
 This property handles the fit image flag of front plate. More...
 
FbxPropertyT< FbxBoolFrontPlateCrop
 This property handles the crop flag of front plane. More...
 
FbxPropertyT< FbxBoolFrontPlateCenter
 This property handles the center flag of front plane. More...
 
FbxPropertyT< FbxBoolFrontPlateKeepRatio
 This property handles the keep ratio flag of front plane. More...
 
FbxPropertyT< FbxBoolShowFrontplate
 This property handles the flag to show front plane or not. More...
 
FbxPropertyT< FbxDoubleFrontPlaneOffsetX
 This property handles the front plane offset X. More...
 
FbxPropertyT< FbxDoubleFrontPlaneOffsetY
 This property handles the front plane offset Y. More...
 
FbxPropertyT< FbxDoubleFrontPlaneRotation
 This property handles the front plane rotation. More...
 
FbxPropertyT< FbxDoubleFrontPlaneScaleX
 This property handles the front plane scaling X. More...
 
FbxPropertyT< FbxDoubleFrontPlaneScaleY
 This property handles the front plane scaling Y. More...
 
FbxPropertyT< FbxReferenceForegroundTexture
 This property has the foreground texture connected to it. More...
 
FbxPropertyT< FbxDoubleForegroundOpacity
 This property handles the foreground image opacity value. More...
 
FbxPropertyT< FbxBoolDisplaySafeArea
 This property handles the flag to display safe area or not. More...
 
FbxPropertyT< FbxBoolDisplaySafeAreaOnRender
 This property handles the flag display safe area on render or not. More...
 
FbxPropertyT< ESafeAreaStyleSafeAreaDisplayStyle
 This property handles the style to display safe area. More...
 
FbxPropertyT< FbxDoubleSafeAreaAspectRatio
 This property handles the display aspect ratio of safe area. More...
 
FbxPropertyT< FbxBoolUse2DMagnifierZoom
 This property handles the flag to use 2d magnifier zoom or not. More...
 
FbxPropertyT< FbxDouble_2DMagnifierZoom
 This property handles the 2d magnifier zoom value. More...
 
FbxPropertyT< FbxDouble_2DMagnifierX
 This property handles the 2d magnifier X value. More...
 
FbxPropertyT< FbxDouble_2DMagnifierY
 This property handles the 2d magnifier Y value. More...
 
FbxPropertyT< EProjectionTypeProjectionType
 This property handles the projection type. More...
 
FbxPropertyT< FbxDoubleOrthoZoom
 This property handles the orthographic zoom value. More...
 
FbxPropertyT< FbxBoolUseRealTimeDOFAndAA
 This property handles the flag to use real time Depth of Field and Anti-Aliasing or not. More...
 
FbxPropertyT< FbxBoolUseDepthOfField
 This property handles the flag to use depth of field or not. More...
 
FbxPropertyT< EFocusDistanceSourceFocusSource
 This property handles the focus source. More...
 
FbxPropertyT< FbxDoubleFocusAngle
 This property handles the focus angle (in degrees). More...
 
FbxPropertyT< FbxDoubleFocusDistance
 This property handles the focus distance. More...
 
FbxPropertyT< FbxBoolUseAntialiasing
 This property handles the flag to use anti aliasing or not. More...
 
FbxPropertyT< FbxDoubleAntialiasingIntensity
 This property handles the anti aliasing intensity. More...
 
FbxPropertyT< EAntialiasingMethodAntialiasingMethod
 This property handles the anti aliasing method. More...
 
FbxPropertyT< FbxBoolUseAccumulationBuffer
 This property handles the flag to use accumulation buffer or not. More...
 
FbxPropertyT< FbxIntFrameSamplingCount
 This property handles the frame sampling count. More...
 
FbxPropertyT< ESamplingTypeFrameSamplingType
 This property handles the frame sampling type. More...
 
- Public Attributes inherited from FbxNodeAttribute
FbxPropertyT< FbxDouble3Color
 This property handles the color. More...
 
- Public Attributes inherited from FbxObject
FbxProperty RootProperty
 The root property that holds all children property for this object. More...
 

Static Public Attributes

static FbxClassId ClassId
 
- Static Public Attributes inherited from FbxNodeAttribute
static FbxClassId ClassId
 
static const char * sColor
 Property Names. More...
 
static const FbxDouble3 sDefaultColor
 Property Default Values. More...
 
- Static Public Attributes inherited from FbxObject
static FbxClassId ClassId
 

Protected Member Functions

virtual ~ FbxCamera ()
 
 FbxCamera (FbxManager &pManager, const char *pName)
 
- Protected Member Functions inherited from FbxNodeAttribute
virtual ~ FbxNodeAttribute ()
 
 FbxNodeAttribute (FbxManager &pManager, const char *pName)
 
- Protected Member Functions inherited from FbxObject
virtual ~ FbxObject ()
 
virtual void Construct (const FbxObject *pFrom)
 Optional constructor override, automatically called by default constructor. More...
 
virtual void ConstructProperties (bool pForceSet)
 Optional property constructor override, automatically called by default constructor. More...
 
virtual void Destruct (bool pRecursive)
 Optional destructor override, automatically called by default destructor. More...
 
virtual void ContentClear ()
 Clears this object's content from memory. More...
 
virtual FbxPeripheralGetPeripheral ()
 Retrieves the peripheral of that object. More...
 

Static Protected Member Functions

static FbxCameraAllocate (FbxManager *pManager, const char *pName, const FbxCamera *pFrom)
 
- Static Protected Member Functions inherited from FbxNodeAttribute
static FbxNodeAttributeAllocate (FbxManager *pManager, const char *pName, const FbxNodeAttribute *pFrom)
 
- Static Protected Member Functions inherited from FbxObject
static FbxObjectAllocate (FbxManager *pManager, const char *pName, const FbxObject *pFrom)
 

Friends

class fbxsdk ::FbxManager
 
template<typename T >
T * fbxsdk ::FbxNew ()
 
template<typename T , typename T1 >
T * fbxsdk ::FbxNew (T1 &p1)
 
template<typename T , typename T1 >
T * fbxsdk ::FbxNew (const T1 &p1)
 
template<typename T , typename T1 , typename T2 >
T * fbxsdk ::FbxNew (T1 &p1, T2 &p2)
 
template<typename T , typename T1 , typename T2 >
T * fbxsdk ::FbxNew (T1 &p1, const T2 &p2)
 
template<typename T , typename T1 , typename T2 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2)
 
template<typename T , typename T1 , typename T2 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2)
 
template<typename T , typename T1 , typename T2 , typename T3 >
T * fbxsdk ::FbxNew (T1 &p1, T2 &p2, T3 &p3)
 
template<typename T , typename T1 , typename T2 , typename T3 >
T * fbxsdk ::FbxNew (T1 &p1, T2 &p2, const T3 &p3)
 
template<typename T , typename T1 , typename T2 , typename T3 >
T * fbxsdk ::FbxNew (T1 &p1, const T2 &p2, T3 &p3)
 
template<typename T , typename T1 , typename T2 , typename T3 >
T * fbxsdk ::FbxNew (T1 &p1, const T2 &p2, const T3 &p3)
 
template<typename T , typename T1 , typename T2 , typename T3 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3)
 
template<typename T , typename T1 , typename T2 , typename T3 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2, const T3 &p3)
 
template<typename T , typename T1 , typename T2 , typename T3 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3)
 
template<typename T , typename T1 , typename T2 , typename T3 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (T1 &p1, T2 &p2, T3 &p3, T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (T1 &p1, T2 &p2, T3 &p3, const T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (T1 &p1, T2 &p2, const T3 &p3, T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (T1 &p1, T2 &p2, const T3 &p3, const T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (T1 &p1, const T2 &p2, T3 &p3, T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (T1 &p1, const T2 &p2, T3 &p3, const T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (T1 &p1, const T2 &p2, const T3 &p3, T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3, T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3, const T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2, const T3 &p3, T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2, const T3 &p3, const T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3, T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3, const T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (T1 &p1, T2 &p2, T3 &p3, T4 &p4, T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3, T4 &p4, T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3, T4 &p4, T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2, const T3 &p3, T4 &p4, T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3, const T4 &p4, T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, T2 &p2, T3 &p3, T4 &p4, const T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, T4 &p4, T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3, const T4 &p4, T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, T3 &p3, T4 &p4, const T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, T4 &p4, const T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, const T5 &p5)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, const T5 &p5, const T6 &p6)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, const T5 &p5, const T6 &p6, const T7 &p7)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 , typename T8 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, const T5 &p5, const T6 &p6, const T7 &p7, const T8 &p8)
 
template<typename T , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 , typename T8 , typename T9 >
T * fbxsdk ::FbxNew (const T1 &p1, const T2 &p2, const T3 &p3, const T4 &p4, const T5 &p5, const T6 &p6, const T7 &p7, const T8 &p8, const T9 &p9)
 
template<typename T >
void fbxsdk ::FbxDelete (T *p)
 
template<typename T >
void fbxsdk ::FbxDelete (const T *p)
 
template<typename T >
T * fbxsdk ::FbxNewArray (const int n)
 
template<typename T >
void fbxsdk ::FbxDeleteArray (T *p)
 

Functions to handle the viewing area.

enum  EFormat {
  eCustomFormat, eD1NTSC, eNTSC, ePAL,
  eD1PAL, eHD, e640x480, e320x200,
  e320x240, e128x128, eFullscreen
}
 Camera formats identifiers. More...
 
enum  EAspectRatioMode {
  eWindowSize, eFixedRatio, eFixedResolution, eFixedWidth,
  eFixedHeight
}
 Camera's aspect ratio modes. More...
 
void SetFormat (EFormat pFormat)
 Set the camera format. More...
 
EFormat GetFormat () const
 Get the camera format. More...
 
void SetAspect (EAspectRatioMode pRatioMode, double pWidth, double pHeight)
 Set the camera's aspect ratio mode. More...
 
EAspectRatioMode GetAspectRatioMode () const
 Get the camera aspect ratio mode. More...
 
void SetPixelRatio (double pRatio)
 Set the pixel ratio. More...
 
double GetPixelRatio () const
 Get the pixel ratio. More...
 
void SetNearPlane (double pDistance)
 Set the near plane distance from the camera. More...
 
double GetNearPlane () const
 Get the near plane distance from the camera. More...
 
void SetFarPlane (double pDistance)
 Set the far plane distance from camera. More...
 
double GetFarPlane () const
 Get the far plane distance from camera. More...
 

Aperture and Film Functions.

In photography, the aperture is the size of hole allowing light from the lens to get through to the film.

The aperture mode determines which values drive the camera aperture. When the aperture mode is eHorizAndVert, eHorizontal or eVertical, the field of view is used. When the aperture mode is eFocalLength, 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  EApertureFormat {
  eCustomAperture, e16mmTheatrical, eSuper16mm, e35mmAcademy,
  e35mmTVProjection, e35mmFullAperture, e35mm185Projection, e35mmAnamorphic,
  e70mmProjection, eVistaVision, eDynaVision, eIMAX
}
 Camera's aperture formats. More...
 
enum  EApertureMode { eHorizAndVert, eHorizontal, eVertical, eFocalLength }
 Camera aperture modes. More...
 
enum  EGateFit {
  eFitNone, eFitVertical, eFitHorizontal, eFitFill,
  eFitOverscan, eFitStretch
}
 Camera's gate fit modes. More...
 
enum  EFilmRollOrder { eRotateFirst, eTranslateFirst }
 Specifies how the roll is applied with respect to the pivot value. More...
 
void SetApertureFormat (EApertureFormat pFormat)
 Set the camera aperture format. More...
 
EApertureFormat GetApertureFormat () const
 Get the camera aperture format. More...
 
void SetApertureMode (EApertureMode pMode)
 Set the camera aperture mode. More...
 
EApertureMode GetApertureMode () const
 Get the camera aperture mode. More...
 
void SetApertureWidth (double pWidth)
 Set the camera aperture width in inches. More...
 
double GetApertureWidth () const
 Get the camera aperture width in inches. More...
 
void SetApertureHeight (double pHeight)
 Set the camera aperture height in inches. More...
 
double GetApertureHeight () const
 Get the camera aperture height in inches. More...
 
void SetSqueezeRatio (double pRatio)
 Set the squeeze ratio. More...
 
double GetSqueezeRatio () const
 Get the camera squeeze ratio. More...
 
double ComputeFieldOfView (double pFocalLength) const
 Compute the angle of view based on the given focal length, the aperture width, and aperture height. More...
 
double ComputeFocalLength (double pAngleOfView) const
 Compute the focal length based on the given angle of view, the aperture width, and aperture height. More...
 

Functions to handle BackPlane/FrontPlane and Plate.

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  EPlateDrawingMode { ePlateBackground, ePlateForeground, ePlateBackAndFront }
 Image plate drawing modes. More...
 
enum  EFrontBackPlaneDistanceMode { eRelativeToInterest, eRelativeToCamera }
 Front and BackPlane distance modes. More...
 
enum  EFrontBackPlaneDisplayMode { ePlanesDisabled, ePlanesAlways, ePlanesWhenMedia }
 Front/back plane display modes. More...
 
void SetBackgroundFileName (const char *pFileName)
 Set the associated background image file. More...
 
const char * GetBackgroundFileName () const
 Get the background image file name. More...
 
void SetBackgroundMediaName (const char *pFileName)
 Set the media name associated to the background image file. More...
 
const char * GetBackgroundMediaName () const
 Get the media name associated to the background image file. More...
 
void SetForegroundFileName (const char *pFileName)
 Set the associated foreground image file. More...
 
const char * GetForegroundFileName () const
 Get the foreground image file name. More...
 
void SetForegroundMediaName (const char *pFileName)
 Set the media name associated to the foreground image file. More...
 
const char * GetForegroundMediaName () const
 Get the media name associated to the foreground image file. More...
 
void SetBackgroundAlphaTreshold (double pThreshold)
 Set front plate matte threshold. More...
 
double GetBackgroundAlphaTreshold () const
 Get front plate matte threshold. More...
 
void SetBackPlateFitImage (bool pFitImage)
 Change the back plate fit image flag. More...
 
bool GetBackPlateFitImage () const
 Get the current back plate image flag. More...
 
void SetBackPlateCrop (bool pCrop)
 Change the back plate crop flag. More...
 
bool GetBackPlateCrop () const
 Get the current back plate crop flag. More...
 
void SetBackPlateCenter (bool pCenter)
 Change the back plate center flag. More...
 
bool GetBackPlateCenter () const
 Get the current back plate center flag. More...
 
void SetBackPlateKeepRatio (bool pKeepRatio)
 Change the back plate keep ratio flag. More...
 
bool GetBackPlateKeepRatio () const
 Get the current back plate keep ratio flag. More...
 
void SetShowFrontPlate (bool pEnable)
 Enable or disable the display of the texture without the need to disconnect it from its plate. More...
 
bool GetShowFrontPlate () const
 Get the current state of the flag to display the front plate or not. More...
 
void SetFrontPlateFitImage (bool pFrontPlateFitImage)
 Change the front plate fit image flag. More...
 
bool GetFrontPlateFitImage () const
 Get the current front plate fit image flag. More...
 
void SetFrontPlateCrop (bool pFrontPlateCrop)
 Change the front plate crop flag. More...
 
bool GetFrontPlateCrop () const
 Get the current front plate crop flag. More...
 
void SetFrontPlateCenter (bool pFrontPlateCenter)
 Change the front plate center flag. More...
 
bool GetFrontPlateCenter () const
 Get the current front plate center flag. More...
 
void SetFrontPlateKeepRatio (bool pFrontPlateKeepRatio)
 Change the front plate keep ratio flag. More...
 
bool GetFrontPlateKeepRatio () const
 Get the current front plate keep ratio flag. More...
 
void SetForegroundOpacity (double pOpacity)
 Set the front plate opacity value. More...
 
double GetForegroundOpacity () const
 Get the front plate opacity value. More...
 
void SetForegroundTexture (FbxTexture *pTexture)
 Attach the texture to the front plate. More...
 
FbxTextureGetForegroundTexture () const
 Get the texture connected to the front plate. More...
 
void SetBackPlaneDistanceMode (EFrontBackPlaneDistanceMode pMode)
 Set the back plane distance mode. More...
 
EFrontBackPlaneDistanceMode GetBackPlaneDistanceMode () const
 Get the back plane distance mode. More...
 
void SetFrontPlaneDistance (double pDistance)
 Set the front plane distance from the camera. More...
 
double GetFrontPlaneDistance () const
 Get the front plane distance value. More...
 
void SetFrontPlaneDistanceMode (EFrontBackPlaneDistanceMode pMode)
 Set the front plane distance mode. More...
 
EFrontBackPlaneDistanceMode GetFrontPlaneDistanceMode () const
 Get the front plane distance mode flag. More...
 
void SetViewFrustumFrontPlaneMode (EFrontBackPlaneDisplayMode pMode)
 Set the front plane display mode. More...
 
EFrontBackPlaneDisplayMode GetViewFrustumFrontPlaneMode () const
 Get the front plane display mode. More...
 
void SetViewFrustumBackPlaneMode (EFrontBackPlaneDisplayMode pMode)
 Set the back plane display mode. More...
 
EFrontBackPlaneDisplayMode GetViewFrustumBackPlaneMode () const
 Get the back plane display mode. More...
 

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  ESafeAreaStyle { eSafeAreaRound, eSafeAreaSquare }
 Camera safe area display styles. More...
 
void SetViewCameraInterest (bool pEnable)
 Change the camera interest visibility flag. More...
 
bool GetViewCameraInterest () const
 Get current visibility state of the camera interest. More...
 
void SetViewNearFarPlanes (bool pEnable)
 Change the camera near and far planes visibility flag. More...
 
bool GetViewNearFarPlanes () const
 Get current visibility state of the camera near and far planes. More...
 

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  ERenderOptionsUsageTime { eInteractive, eOnDemand }
 Render options usage time. More...
 
enum  EAntialiasingMethod { eAAOversampling, eAAHardware }
 Anti-aliasing methods. More...
 
enum  ESamplingType { eSamplingUniform, eSamplingStochastic }
 Oversampling types for anti-aliasing. More...
 
enum  EFocusDistanceSource { eFocusSrcCameraInterest, eFocusSpecificDistance }
 Camera focus sources, that is the focal point for the depth of field. More...
 

Utility Functions.

FbxVector4 EvaluatePosition (const FbxTime &pTime=FbxTime((0LL))) const
 Evaluate the camera position (eye). More...
 
FbxVector4 EvaluateLookAtPosition (const FbxTime &pTime=FbxTime((0LL))) const
 Evaluate the camera target position (look at). More...
 
FbxVector4 EvaluateUpDirection (const FbxVector4 &pCameraPosition, const FbxVector4 &pLookAtPosition, const FbxTime &pTime=FbxTime((0LL))) const
 Evaluate the camera up direction, taking target up objects into consideration. More...
 
FbxMatrix ComputeProjectionMatrix (const int pWidth, const int pHeight, const bool pVerticalFOV=true) const
 Compute the camera projection matrix. More...
 
bool IsBoundingBoxInView (const FbxMatrix &pWorldToScreen, const FbxMatrix &pWorldToCamera, const FbxVector4 pPoints[8]) const
 Determine if the given bounding box is in the camera's view. More...
 
bool IsPointInView (const FbxMatrix &pWorldToScreen, const FbxMatrix &pWorldToCamera, const FbxVector4 &pPoint) const
 Determine if the given 3d point is in the camera's view. More...
 
FbxMatrix ComputeWorldToScreen (int pPixelWidth, int pPixelHeight, const FbxAMatrix &pWorldToCamera) const
 Compute world space to screen space transformation matrix. More...
 
FbxVector4 ComputeScreenToWorld (float pX, float pY, float pWidth, float pHeight, const FbxTime &pTime=FbxTime((0x7fffffffffffffffLL))) const
 Compute screen space to world space ray direction. More...
 

Member Typedef Documentation

◆ ParentClass

Definition at line 36 of file fbxcamera.h.

Member Enumeration Documentation

◆ EProjectionType

Camera projection types.

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 

Perspective projection.

eOrthogonal 

Orthogonal projection.

Definition at line 55 of file fbxcamera.h.

56  {
57  ePerspective,
59  };
Perspective projection.
Definition: fbxcamera.h:57
Orthogonal projection.
Definition: fbxcamera.h:58

◆ EFormat

enum EFormat

Camera formats identifiers.

Remarks
This is designed as the same as in MotionBuilder.
See also
SetFormat, GetFormat and CameraFormat.
Enumerator
eCustomFormat 

The format's width, height, or pixel ratio has been user-specified, and matches none of the other picture formats.

eD1NTSC 

Standard format for D1 NTSC (720 by 486).

eNTSC 

NTSC standard for North American television broadcast (640 by 480).

ePAL 

PAL standard for European television broadcast (570 by 486).

eD1PAL 

Standard format for D1 PAL (720 by 576).

eHD 

HD format(1920 by 1080).

e640x480 

Recommended computer screen format (640 by 480).

e320x200 

Recommended format for World Wide Web production(320 by 200).

e320x240 

Alternate World Wide Web format(320 by 240).

e128x128 

Format(128 by 128)

eFullscreen 

Full computer screen format (1280 by 1024 pixels).

Definition at line 69 of file fbxcamera.h.

70  {
72  eD1NTSC,
73  eNTSC,
74  ePAL,
75  eD1PAL,
76  eHD,
77  e640x480,
78  e320x200,
79  e320x240,
80  e128x128,
82  };
HD format(1920 by 1080).
Definition: fbxcamera.h:76
Recommended computer screen format (640 by 480).
Definition: fbxcamera.h:77
Full computer screen format (1280 by 1024 pixels).
Definition: fbxcamera.h:81
Format(128 by 128)
Definition: fbxcamera.h:80
Standard format for D1 PAL (720 by 576).
Definition: fbxcamera.h:75
Recommended format for World Wide Web production(320 by 200).
Definition: fbxcamera.h:78
Alternate World Wide Web format(320 by 240).
Definition: fbxcamera.h:79
PAL standard for European television broadcast (570 by 486).
Definition: fbxcamera.h:74
Standard format for D1 NTSC (720 by 486).
Definition: fbxcamera.h:72
NTSC standard for North American television broadcast (640 by 480).
Definition: fbxcamera.h:73
The format&#39;s width, height, or pixel ratio has been user-specified, and matches none of the other pic...
Definition: fbxcamera.h:71

◆ EAspectRatioMode

Camera's aspect ratio modes.

See also
SetAspect, GetAspectRatioMode, AspectWidth, AspectHeight and AspectRatioMode.
Enumerator
eWindowSize 

Both width and height values aren't relevant.

eFixedRatio 

The height value is set to 1.0 and the width value is relative to the height value.

eFixedResolution 

Both width and height values are in pixels.

eFixedWidth 

The width value is in pixels and the height value is relative to the width value.

eFixedHeight 

The height value is in pixels and the width value is relative to the height value.

Definition at line 100 of file fbxcamera.h.

101  {
102  eWindowSize,
103  eFixedRatio,
105  eFixedWidth,
106  eFixedHeight
107  };
Both width and height values are in pixels.
Definition: fbxcamera.h:104
Both width and height values aren&#39;t relevant.
Definition: fbxcamera.h:102
The height value is in pixels and the width value is relative to the height value.
Definition: fbxcamera.h:106
The width value is in pixels and the height value is relative to the width value. ...
Definition: fbxcamera.h:105
The height value is set to 1.0 and the width value is relative to the height value.
Definition: fbxcamera.h:103

◆ EApertureFormat

Camera's aperture formats.

Remarks
This is designed as the same as in MotionBuilder.
See also
SetApertureFormat, GetApertureFormat, FilmFormat, FilmWidth, FilmHeight, FilmSqueezeRatio and FilmAspectRatio.
Enumerator
eCustomAperture 

The film size, squeeze ratio and aspect ratio has been user-specified, and matches none of the other aperture formats.

e16mmTheatrical 

Film Size: 0.404, 0.295 inches.

Film Squeeze Ratio: 1.0. Film Aspect Ratio: 1.369.

eSuper16mm 

Film Size: 0.493, 0.292 inches.

Film Squeeze Ratio: 1.0. Film Aspect Ratio: 1.688.

e35mmAcademy 

Film Size: 0.864, 0.630 inches.

Film Squeeze Ratio: 1.0. Film Aspect Ratio: 1.371.

e35mmTVProjection 

Film Size: 0.816, 0.612 inches.

Film Squeeze Ratio: 1.0. Film Aspect Ratio: 1.333.

e35mmFullAperture 

Film Size: 0.980, 0.735 inches.

Film Squeeze Ratio: 1.0. Film Aspect Ratio: 1.333.

e35mm185Projection 

Film Size: 0.825, 0.446 inches.

Film Squeeze Ratio: 1.0. Film Aspect Ratio: 1.850.

e35mmAnamorphic 

Film Size: 0.864, 0.732 inches.

Film Squeeze Ratio: 2.0. Film Aspect Ratio:1.180.

e70mmProjection 

Film Size: 2.066, 0.906 inches.

Film Squeeze Ratio: 1.0. Film Aspect Ratio: 2.280.

eVistaVision 

Film Size: 1.485, 0.991 inches.

Film Squeeze Ratio: 1.0. Film Aspect Ratio: 1.498.

eDynaVision 

Film Size: 2.080, 1.480 inches.

Film Squeeze Ratio: 1.0. Film Aspect Ratio: 1.405.

eIMAX 

Film Size: 2.772, 2.072 inches.

Film Squeeze Ratio: 1.0. Film Aspect Ratio: 1.338.

Definition at line 184 of file fbxcamera.h.

185  {
188  eSuper16mm,
189  e35mmAcademy,
195  eVistaVision,
196  eDynaVision,
197  eIMAX
198  };
Film Size: 0.825, 0.446 inches.
Definition: fbxcamera.h:192
Film Size: 0.980, 0.735 inches.
Definition: fbxcamera.h:191
Film Size: 2.772, 2.072 inches.
Definition: fbxcamera.h:197
Film Size: 2.080, 1.480 inches.
Definition: fbxcamera.h:196
Film Size: 0.493, 0.292 inches.
Definition: fbxcamera.h:188
Film Size: 0.816, 0.612 inches.
Definition: fbxcamera.h:190
Film Size: 0.864, 0.732 inches.
Definition: fbxcamera.h:193
The film size, squeeze ratio and aspect ratio has been user-specified, and matches none of the other ...
Definition: fbxcamera.h:186
Film Size: 2.066, 0.906 inches.
Definition: fbxcamera.h:194
Film Size: 1.485, 0.991 inches.
Definition: fbxcamera.h:195
Film Size: 0.404, 0.295 inches.
Definition: fbxcamera.h:187
Film Size: 0.864, 0.630 inches.
Definition: fbxcamera.h:189

◆ EApertureMode

Camera aperture modes.

The aperture mode determines which values drive the camera aperture. If the aperture mode is eHorizAndVert, eHorizontal, or eVertical, then the field of view is used. If the aperture mode is eFocalLength, then the focal length is used.

Enumerator
eHorizAndVert 

Set the angle values for both the horizontal and vertical settings.

eHorizontal 

Set only the horizontal angle.

eVertical 

Set only the vertical angle.

eFocalLength 

Use focal length directly.

Definition at line 216 of file fbxcamera.h.

217  {
218  eHorizAndVert,
219  eHorizontal,
220  eVertical,
221  eFocalLength
222  };
Set only the horizontal angle.
Definition: fbxcamera.h:219
Set only the vertical angle.
Definition: fbxcamera.h:220
Set the angle values for both the horizontal and vertical settings.
Definition: fbxcamera.h:218
Use focal length directly.
Definition: fbxcamera.h:221

◆ EGateFit

enum EGateFit

Camera's gate fit modes.

There are two gates for a camera, film gate and resolution gate. Film gate is a border indicating the area of the camera's view as a real-world camera records on film. The dimensions of the film gate represent the dimensions of the camera aperture. But the film gate does not represent the render region. It is the resolution gate that represents the rendering resolution. The gate fit mode controls the size of the resolution gate relative to the film gate.

Enumerator
eFitNone 

No resolution gate fit.

eFitVertical 

Fit the resolution gate vertically within the film gate.

eFitHorizontal 

Fit the resolution gate horizontally within the film gate.

eFitFill 

Fit the resolution gate within the film gate.

eFitOverscan 

Fit the film gate within the resolution gate.

eFitStretch 

Fit the resolution gate to the film gate.

Definition at line 278 of file fbxcamera.h.

279  {
280  eFitNone,
281  eFitVertical,
283  eFitFill,
284  eFitOverscan,
285  eFitStretch
286  };
No resolution gate fit.
Definition: fbxcamera.h:280
Fit the resolution gate to the film gate.
Definition: fbxcamera.h:285
Fit the resolution gate horizontally within the film gate.
Definition: fbxcamera.h:282
Fit the resolution gate within the film gate.
Definition: fbxcamera.h:283
Fit the resolution gate vertically within the film gate.
Definition: fbxcamera.h:281
Fit the film gate within the resolution gate.
Definition: fbxcamera.h:284

◆ EFilmRollOrder

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

Enumerator
eRotateFirst 

The film back is first rotated then translated by the pivot point value.

eTranslateFirst 

The film back is first translated then rotated by the film roll value.

Definition at line 304 of file fbxcamera.h.

305  {
306  eRotateFirst,
308  };
The film back is first translated then rotated by the film roll value.
Definition: fbxcamera.h:307
The film back is first rotated then translated by the pivot point value.
Definition: fbxcamera.h:306

◆ EPlateDrawingMode

Image plate drawing modes.

Enumerator
ePlateBackground 

Image is drawn behind models.

ePlateForeground 

Image is drawn in front of models based on alpha channel.

ePlateBackAndFront 

Image is drawn behind and in front of models depending on alpha channel.

Definition at line 391 of file fbxcamera.h.

392  {
396  };
Image is drawn behind and in front of models depending on alpha channel.
Definition: fbxcamera.h:395
Image is drawn behind models.
Definition: fbxcamera.h:393
Image is drawn in front of models based on alpha channel.
Definition: fbxcamera.h:394

◆ EFrontBackPlaneDistanceMode

Front and BackPlane distance modes.

See also
SetBackPlaneDistanceMode and GetBackPlaneDistanceMode.
Enumerator
eRelativeToInterest 

The back plane distance is measured in relation to the camera interest.

eRelativeToCamera 

The back plane distance is measured in relation to the camera.

Definition at line 551 of file fbxcamera.h.

552  {
555  };
The back plane distance is measured in relation to the camera.
Definition: fbxcamera.h:554
The back plane distance is measured in relation to the camera interest.
Definition: fbxcamera.h:553

◆ EFrontBackPlaneDisplayMode

Front/back plane display modes.

Enumerator
ePlanesDisabled 

Disables the front/back plane whether a texture is being projected or not.

ePlanesAlways 

Always shows the front/back plane, even if no texture has been added.

ePlanesWhenMedia 

Shows the front/back plane only if a texture has been added.

Definition at line 592 of file fbxcamera.h.

593  {
595  ePlanesAlways,
597  };
Always shows the front/back plane, even if no texture has been added.
Definition: fbxcamera.h:595
Disables the front/back plane whether a texture is being projected or not.
Definition: fbxcamera.h:594
Shows the front/back plane only if a texture has been added.
Definition: fbxcamera.h:596

◆ ESafeAreaStyle

Camera safe area display styles.

Enumerator
eSafeAreaRound 

Rounded safe area.

eSafeAreaSquare 

Square safe area.

Definition at line 652 of file fbxcamera.h.

653  {
656  };
Rounded safe area.
Definition: fbxcamera.h:654
Square safe area.
Definition: fbxcamera.h:655

◆ ERenderOptionsUsageTime

Render options usage time.

Enumerator
eInteractive 

To render in real time.

eOnDemand 

Only render when it is asked.

Definition at line 669 of file fbxcamera.h.

670  {
671  eInteractive,
672  eOnDemand
673  };
Only render when it is asked.
Definition: fbxcamera.h:672
To render in real time.
Definition: fbxcamera.h:671

◆ EAntialiasingMethod

Anti-aliasing methods.

Enumerator
eAAOversampling 

To do anti-aliasing by oversampling.

eAAHardware 

To do anti-aliasing by hardware.

Definition at line 677 of file fbxcamera.h.

678  {
680  eAAHardware
681  };
To do anti-aliasing by hardware.
Definition: fbxcamera.h:680
To do anti-aliasing by oversampling.
Definition: fbxcamera.h:679

◆ ESamplingType

Oversampling types for anti-aliasing.

Enumerator
eSamplingUniform 

The Uniform method samples each pixel at the same location.

The pixel is divided into equal parts, and each part is sampled. The number of samples determines the number of times the pixel is divided.

eSamplingStochastic 

The Stochastic method randomly samples each pixel.

This produces an accurate color using a small number of samples.

Definition at line 685 of file fbxcamera.h.

686  {
692  };
The Stochastic method randomly samples each pixel.
Definition: fbxcamera.h:690
The Uniform method samples each pixel at the same location.
Definition: fbxcamera.h:687

◆ EFocusDistanceSource

Camera focus sources, that is the focal point for the depth of field.

See also
FocusDistance.
Enumerator
eFocusSrcCameraInterest 

Base the depth of field on the camera interest.

Models at the camera interest are in focus. As you move toward or away from the camera interest, models become increasingly blurred.

eFocusSpecificDistance 

Base the depth of field on a point defined by a specific distance from the camera interest.

Definition at line 697 of file fbxcamera.h.

698  {
702  };
Base the depth of field on a point defined by a specific distance from the camera interest...
Definition: fbxcamera.h:701
Base the depth of field on the camera interest.
Definition: fbxcamera.h:699

Constructor & Destructor Documentation

◆ ~ FbxCamera()

virtual ~ FbxCamera ( )
inlineprotectedvirtual

Definition at line 36 of file fbxcamera.h.

38 :

◆ FbxCamera()

FbxCamera ( FbxManager pManager,
const char *  pName 
)
inlineprotected

Definition at line 36 of file fbxcamera.h.

38 :

Member Function Documentation

◆ GetClassId()

virtual FbxClassId GetClassId ( ) const
inlinevirtual

Reimplemented from FbxNodeAttribute.

Reimplemented in FbxCameraStereo.

Definition at line 36 of file fbxcamera.h.

38 :

◆ Create() [1/2]

static FbxCamera* Create ( FbxManager pManager,
const char *  pName 
)
static

◆ Create() [2/2]

static FbxCamera* Create ( FbxObject pContainer,
const char *  pName 
)
static

◆ Allocate()

static FbxCamera* Allocate ( FbxManager pManager,
const char *  pName,
const FbxCamera pFrom 
)
staticprotected

◆ GetAttributeType()

virtual FbxNodeAttribute::EType GetAttributeType ( ) const
virtual

Return the type of node attribute which is EType::eCamera.

Reimplemented from FbxNodeAttribute.

Reimplemented in FbxCameraStereo.

◆ Reset()

void Reset ( )

Reset the camera to default values.

◆ SetFormat()

void SetFormat ( EFormat  pFormat)

Set the camera format.

Parameters
pFormatThe camera format identifier.
Remarks
Changing the camera format sets the camera aspect ratio mode to eFixedResolution and modifies the aspect width size, height size, and pixel ratio accordingly.
Examples:
Camera/main.cxx.

◆ GetFormat()

EFormat GetFormat ( ) const

Get the camera format.

Returns
The current camera format identifier.
Examples:
Camera/main.cxx, and ImportScene/DisplayCamera.cxx.

◆ SetAspect()

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

Set the camera's aspect ratio mode.

Parameters
pRatioModeCamera's aspect ratio mode.
pWidthCamera's aspect width, must be a positive value.
pHeightCamera's aspect height, must be a positive value.
Remarks
Changing the camera aspect sets the camera format to eCustomFormat.
See also
EAspectRatioMode.
Examples:
Camera/main.cxx.

◆ GetAspectRatioMode()

EAspectRatioMode GetAspectRatioMode ( ) const

Get the camera aspect ratio mode.

Returns
The current aspect ratio mode.
Examples:
Camera/main.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

◆ SetPixelRatio()

void SetPixelRatio ( double  pRatio)

Set the pixel ratio.

Parameters
pRatioThe 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 eCustomFormat.

◆ GetPixelRatio()

double GetPixelRatio ( ) const

Get the pixel ratio.

Returns
The current camera's pixel ratio value.
Examples:
Camera/main.cxx, and ViewScene/SetCamera.cxx.

◆ SetNearPlane()

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

Parameters
pDistanceThe 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.

◆ GetNearPlane()

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

Returns
The near plane value.
Examples:
ViewScene/SetCamera.cxx.

◆ SetFarPlane()

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

Parameters
pDistanceThe 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.

◆ GetFarPlane()

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

Returns
The far plane value.
Examples:
ViewScene/SetCamera.cxx.

◆ SetApertureFormat()

void SetApertureFormat ( EApertureFormat  pFormat)

Set the camera aperture format.

Parameters
pFormatThe camera aperture format identifier.
Remarks
Changing the aperture format modifies the aperture width, height, and squeeze ratio accordingly.
Examples:
Camera/main.cxx.

◆ GetApertureFormat()

EApertureFormat GetApertureFormat ( ) const

Get the camera aperture format.

Returns
The camera's current aperture format identifier.
Examples:
Camera/main.cxx, and ImportScene/DisplayCamera.cxx.

◆ SetApertureMode()

void SetApertureMode ( EApertureMode  pMode)

Set the camera aperture mode.

Parameters
pModeThe camera aperture mode identifier.
Examples:
Camera/main.cxx, and ExportScene04/main.cxx.

◆ GetApertureMode()

EApertureMode GetApertureMode ( ) const

Get the camera aperture mode.

Returns
The camera's current aperture mode identifier.
Examples:
Camera/main.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

◆ SetApertureWidth()

void SetApertureWidth ( double  pWidth)

Set the camera aperture width in inches.

Parameters
pWidthThe 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 eCustomFormat.
Examples:
ExportScene04/main.cxx, and ViewScene/SetCamera.cxx.

◆ GetApertureWidth()

double GetApertureWidth ( ) const

Get the camera aperture width in inches.

Returns
The camera's current aperture width value in inches.
Examples:
Camera/main.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

◆ SetApertureHeight()

void SetApertureHeight ( double  pHeight)

Set the camera aperture height in inches.

Parameters
pHeightThe 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 eCustomFormat.
Examples:
ExportScene04/main.cxx, and ViewScene/SetCamera.cxx.

◆ GetApertureHeight()

double GetApertureHeight ( ) const

Get the camera aperture height in inches.

Returns
The camera's current aperture height value in inches.
Examples:
Camera/main.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

◆ SetSqueezeRatio()

void SetSqueezeRatio ( double  pRatio)

Set the squeeze ratio.

Parameters
pRatioThe 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 eCustomFormat.
Examples:
ExportScene04/main.cxx.

◆ GetSqueezeRatio()

double GetSqueezeRatio ( ) const

Get the camera squeeze ratio.

Returns
The camera's current squeeze ratio value.
Examples:
Camera/main.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

◆ ComputeFieldOfView()

double ComputeFieldOfView ( double  pFocalLength) const

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

Parameters
pFocalLengthThe focal length in millimeters.
Returns
The computed angle of view in degrees.
Remarks
If aperture mode is not vertical, horizontal is assumed.
Examples:
Camera/main.cxx, and ViewScene/SetCamera.cxx.

◆ ComputeFocalLength()

double ComputeFocalLength ( double  pAngleOfView) const

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

Parameters
pAngleOfViewThe angle of view in degrees.
Returns
The computed focal length in millimeters.
Remarks
If aperture mode is not vertical, horizontal is assumed.
Examples:
Camera/main.cxx, and ViewScene/SetCamera.cxx.

◆ SetBackgroundFileName()

void SetBackgroundFileName ( const char *  pFileName)

Set the associated background image file.

Parameters
pFileNameThe path of the background image file.
Remarks
The background image file name must be valid.
This method is still provided just for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

◆ GetBackgroundFileName()

const char* GetBackgroundFileName ( ) const

Get the background image file name.

Returns
Pointer to the background filename string or NULL if not set.
Remarks
This method is still provided just for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.
Examples:
ImportScene/DisplayCamera.cxx.

◆ SetBackgroundMediaName()

void SetBackgroundMediaName ( const char *  pFileName)

Set the media name associated to the background image file.

Parameters
pFileNameThe 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 just for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

◆ GetBackgroundMediaName()

const char* GetBackgroundMediaName ( ) const

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 just for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

◆ SetForegroundFileName()

void SetForegroundFileName ( const char *  pFileName)

Set the associated foreground image file.

Parameters
pFileNameThe path of the foreground image file.
Remarks
The foreground image file name must be valid.
This method is still provided just for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

◆ GetForegroundFileName()

const char* GetForegroundFileName ( ) const

Get the foreground image file name.

Returns
Pointer to the foreground filename string or NULL if not set.
Remarks
This method is still provided just for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

◆ SetForegroundMediaName()

void SetForegroundMediaName ( const char *  pFileName)

Set the media name associated to the foreground image file.

Parameters
pFileNameThe 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 just for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

◆ GetForegroundMediaName()

const char* GetForegroundMediaName ( ) const

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 just for legacy files (Fbx version 5.0 and earlier) and must not be used in any other cases.

◆ SetBackgroundAlphaTreshold()

void SetBackgroundAlphaTreshold ( double  pThreshold)

Set front plate matte threshold.

Parameters
pThresholdThreshold value on a range from 0.0 to 1.0.
Remarks
This option is only relevant if the image plate drawing mode is set to ePlateForeground or ePlateBackAndFront.

◆ GetBackgroundAlphaTreshold()

double GetBackgroundAlphaTreshold ( ) const

Get front plate matte threshold.

Returns
Threshold value on a range from 0.0 to 1.0.
Remarks
This option is only relevant if the image plate drawing mode is set to ePlateForeground or ePlateBackAndFront.

◆ SetBackPlateFitImage()

void SetBackPlateFitImage ( bool  pFitImage)

Change the back plate fit image flag.

If this flag is on, scale the back plate image to fit on the back plane.

Parameters
pFitImageNew value for the BackPlateFitImage property.

◆ GetBackPlateFitImage()

bool GetBackPlateFitImage ( ) const

Get the current back plate image flag.

If this flag is on, scale the back plate image to fit on the back plane.

Returns
The value of the BackPlateFitImage property.
Examples:
ImportScene/DisplayCamera.cxx.

◆ SetBackPlateCrop()

void SetBackPlateCrop ( bool  pCrop)

Change the back plate crop flag.

If this flag is on, crop the back plate image to fit on the back plane. If the image is smaller than the plane, this flag has no effect.

Parameters
pCropNew value for the BackPlateCrop property.

◆ GetBackPlateCrop()

bool GetBackPlateCrop ( ) const

Get the current back plate crop flag.

If this flag is on, crop the back plate image to fit on the back plane. If the image is smaller than the plane, this flag has no effect.

Returns
The value of the BackPlateCrop property.
Examples:
ImportScene/DisplayCamera.cxx.

◆ SetBackPlateCenter()

void SetBackPlateCenter ( bool  pCenter)

Change the back plate center flag.

If this flag is on, center the back plate image on the back plane.

Parameters
pCenterNew value for the BackPlateCenter property.

◆ GetBackPlateCenter()

bool GetBackPlateCenter ( ) const

Get the current back plate center flag.

If this flag is on, center the back plate image on the back plane.

Returns
The value of the BackPlateCenter property.
Examples:
ImportScene/DisplayCamera.cxx.

◆ SetBackPlateKeepRatio()

void SetBackPlateKeepRatio ( bool  pKeepRatio)

Change the back plate keep ratio flag.

If this flag is on, keep the aspect ratio of the back plate image. Turn on both the keep ration flag and the fit image flag to scale the back plate image proportionately.

Parameters
pKeepRatioNew value for the BackPlateKeepRatio property.

◆ GetBackPlateKeepRatio()

bool GetBackPlateKeepRatio ( ) const

Get the current back plate keep ratio flag.

If this flag is on, keep the aspect ratio of the back plate image. Turn on both the keep ration flag and the fit image flag to scale the back plate image proportionately.

Returns
The value of the BackPlateKeepRatio property.
Examples:
ImportScene/DisplayCamera.cxx.

◆ SetShowFrontPlate()

void SetShowFrontPlate ( bool  pEnable)

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

Parameters
pEnableIf true the texture is displayed, false otherwise.
Remarks
It is the responsibility of the client application to perform the required tasks according to the state of this flag.

◆ GetShowFrontPlate()

bool GetShowFrontPlate ( ) const

Get the current state of the flag to display the front plate or not.

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.

◆ SetFrontPlateFitImage()

void SetFrontPlateFitImage ( bool  pFrontPlateFitImage)

Change the front plate fit image flag.

If this flag is on, scale the front plate image to fit on the front plane.

Parameters
pFrontPlateFitImageNew value for the FrontPlateFitImage property.

◆ GetFrontPlateFitImage()

bool GetFrontPlateFitImage ( ) const

Get the current front plate fit image flag.

If this flag is on, scale the front plate image to fit on the front plane.

Returns
The value of the BackPlateFitImage property.

◆ SetFrontPlateCrop()

void SetFrontPlateCrop ( bool  pFrontPlateCrop)

Change the front plate crop flag.

If this flag is on, crop the front plate image to fit on the front plane. If the image is smaller than the plane, this flag has no effect.

Parameters
pFrontPlateCropNew value for the FrontPlateCrop property.

◆ GetFrontPlateCrop()

bool GetFrontPlateCrop ( ) const

Get the current front plate crop flag.

If this flag is on, crop the front plate image to fit on the front plane. If the image is smaller than the plane, this flag has no effect.

Returns
The value of the FrontPlateCrop property.

◆ SetFrontPlateCenter()

void SetFrontPlateCenter ( bool  pFrontPlateCenter)

Change the front plate center flag.

If this flag is on, center the front plate image on the front plane.

Parameters
pFrontPlateCenterNew value for the FrontPlateCenter property.

◆ GetFrontPlateCenter()

bool GetFrontPlateCenter ( ) const

Get the current front plate center flag.

If this flag is on, center the front plate image on the front plane.

Returns
The value of the FrontPlateCenter property.

◆ SetFrontPlateKeepRatio()

void SetFrontPlateKeepRatio ( bool  pFrontPlateKeepRatio)

Change the front plate keep ratio flag.

If this flag is on, keep the aspect ratio of the front plate image. Turn on both the keep ration flag and the fit image flag to scale the front plate image proportionately.

Parameters
pFrontPlateKeepRatioNew value for the FrontPlateKeepRatio property.

◆ GetFrontPlateKeepRatio()

bool GetFrontPlateKeepRatio ( ) const

Get the current front plate keep ratio flag.

If this flag is on, keep the aspect ratio of the front plate image. Turn on both the keep ration flag and the fit image flag to scale the front plate image proportionately.

Returns
The value of the FrontPlateKeepRatio property.

◆ SetForegroundOpacity()

void SetForegroundOpacity ( double  pOpacity)

Set the front plate opacity value.

Parameters
pOpacityNew value for the ForegroundOpacity property.

◆ GetForegroundOpacity()

double GetForegroundOpacity ( ) const

Get the front plate opacity value.

Returns
The value of the ForegroundOpacity property.

◆ SetForegroundTexture()

void SetForegroundTexture ( FbxTexture pTexture)

Attach the texture to the front plate.

Parameters
pTextureThe pointer to the texture to attach.

◆ GetForegroundTexture()

FbxTexture* GetForegroundTexture ( ) const

Get the texture connected to the front plate.

Returns
A pointer to the texture attached to front plate.

◆ SetBackPlaneDistanceMode()

void SetBackPlaneDistanceMode ( EFrontBackPlaneDistanceMode  pMode)

Set the back plane distance mode.

Parameters
pModeThe back plane distance mode to set.

◆ GetBackPlaneDistanceMode()

EFrontBackPlaneDistanceMode GetBackPlaneDistanceMode ( ) const

Get the back plane distance mode.

Returns
Return the back plane distance mode.

◆ SetFrontPlaneDistance()

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 of the FrontPlaneDistanceMode.

Parameters
pDistanceThe front plane distance value.
Remarks
It is the responsibility of the client application to ensure that this plane position is within the frustum boundaries.

◆ GetFrontPlaneDistance()

double GetFrontPlaneDistance ( ) const

Get the front plane distance value.

Returns
double The front plane distance value.

◆ SetFrontPlaneDistanceMode()

void SetFrontPlaneDistanceMode ( EFrontBackPlaneDistanceMode  pMode)

Set the front plane distance mode.

Parameters
pModeThe front plane distance mode to set.

◆ GetFrontPlaneDistanceMode()

EFrontBackPlaneDistanceMode GetFrontPlaneDistanceMode ( ) const

Get the front plane distance mode flag.

Returns
The front plane distance mode.

◆ SetViewFrustumFrontPlaneMode()

void SetViewFrustumFrontPlaneMode ( EFrontBackPlaneDisplayMode  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.

Parameters
pModeThe front/back plane display mode.

◆ GetViewFrustumFrontPlaneMode()

EFrontBackPlaneDisplayMode GetViewFrustumFrontPlaneMode ( ) const

Get the front plane display mode.

Returns
The front/back plane display mode.

◆ SetViewFrustumBackPlaneMode()

void SetViewFrustumBackPlaneMode ( EFrontBackPlaneDisplayMode  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.

Parameters
pModeThe front/back plane display mode.

◆ GetViewFrustumBackPlaneMode()

EFrontBackPlaneDisplayMode GetViewFrustumBackPlaneMode ( ) const

Get the back plane display mode.

Returns
The front/back plane display mode.

◆ SetViewCameraInterest()

void SetViewCameraInterest ( bool  pEnable)

Change the camera interest visibility flag.

Parameters
pEnableSet to true if the camera interest is shown, false otherwise.

◆ GetViewCameraInterest()

bool GetViewCameraInterest ( ) const

Get current visibility state of the camera interest.

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

◆ SetViewNearFarPlanes()

void SetViewNearFarPlanes ( bool  pEnable)

Change the camera near and far planes visibility flag.

Parameters
pEnableSet to true if the near and far planes are shown, false otherwise.

◆ GetViewNearFarPlanes()

bool GetViewNearFarPlanes ( ) const

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

Returns
true if the near and far planes are shown, false otherwise.

◆ EvaluatePosition()

FbxVector4 EvaluatePosition ( const FbxTime pTime = FbxTime((0LL))) const

Evaluate the camera position (eye).

Parameters
pTimeThe time at which the camera should be evaluated.
Returns
The camera position evaluated from property value and animation.

◆ EvaluateLookAtPosition()

FbxVector4 EvaluateLookAtPosition ( const FbxTime pTime = FbxTime((0LL))) const

Evaluate the camera target position (look at).

Parameters
pTimeThe time at which the camera should be evaluated.
Returns
The camera target position evaluated from property value and animation.

◆ EvaluateUpDirection()

FbxVector4 EvaluateUpDirection ( const FbxVector4 pCameraPosition,
const FbxVector4 pLookAtPosition,
const FbxTime pTime = FbxTime((0LL)) 
) const

Evaluate the camera up direction, taking target up objects into consideration.

Parameters
pCameraPositionThe camera current position. You can retrieve this with FbxCamera::EvaluatePosition().
pLookAtPositionThe camera target position. you can retrieve this with FbxCamera::EvaluateLookAtPosition().
pTimeThe time at which the camera should be evaluated.
Returns
The camera up direction vector based on provided information.

◆ ComputeProjectionMatrix()

FbxMatrix ComputeProjectionMatrix ( const int  pWidth,
const int  pHeight,
const bool  pVerticalFOV = true 
) const

Compute the camera projection matrix.

Parameters
pWidthThe width of the output frame.
pHeightThe height of the output frame.
pVerticalFOVCalculate FOV vertically (based on height) if true or horizontally (based on width) if false (Note: Only applicable in perspective proj).
Returns
The camera projection matrix, or the default identity matrix in case of wrong camera parameters.

◆ IsBoundingBoxInView()

bool IsBoundingBoxInView ( const FbxMatrix pWorldToScreen,
const FbxMatrix pWorldToCamera,
const FbxVector4  pPoints[8] 
) const

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

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

Parameters
pWorldToScreenThe world to screen transformation. Please refer to FbxCamera::ComputeWorldToScreen.
pWorldToCameraThe world to camera transformation. Inverse of the matrix returned from FbxAnimEvaluator::GetNodeGlobalTransform is suitable. Please refer to FbxScene::GetEvaluator and FbxAnimEvaluator::GetNodeGlobalTransform.
pPoints8 corners of the bounding box.
Returns
true if any of the given points are in the camera's view, false otherwise.

◆ IsPointInView()

bool IsPointInView ( const FbxMatrix pWorldToScreen,
const FbxMatrix pWorldToCamera,
const FbxVector4 pPoint 
) const

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

Parameters
pWorldToScreenThe world to screen transformation. Please refer to FbxCamera::ComputeWorldToScreen.
pWorldToCameraThe world to camera transformation. Inverse of the matrix returned from FbxAnimEvaluator::GetNodeGlobalTransform is suitable. Please refer to FbxScene::GetEvaluator and FbxAnimEvaluator::GetNodeGlobalTransform.
pPointWorld-space point to test.
Returns
true if the given point is in the camera's view, false otherwise.

◆ ComputeWorldToScreen()

FbxMatrix ComputeWorldToScreen ( int  pPixelWidth,
int  pPixelHeight,
const FbxAMatrix pWorldToCamera 
) const

Compute world space to screen space transformation matrix.

Parameters
pPixelHeightThe pixel height of the output image.
pPixelWidthThe pixel height of the output image.
pWorldToCameraThe world to camera affine transformation matrix.
Returns
The world to screen space matrix, or the identity matrix on error.

◆ ComputeScreenToWorld()

FbxVector4 ComputeScreenToWorld ( float  pX,
float  pY,
float  pWidth,
float  pHeight,
const FbxTime pTime = FbxTime((0x7fffffffffffffffLL)) 
) const

Compute screen space to world space ray direction.

Parameters
pXThe horizontal screen coordinate.
pYThe vertical screen coordinate.
pWidthThe width of the viewport in pixels.
pHeightThe height of the viewport in pixels.
pTimeThe time to use to evaluate the camera's view matrix.
Returns
a normalized vector corresponding to the ray direction.

Friends And Related Function Documentation

◆ fbxsdk ::FbxManager

friend class fbxsdk ::FbxManager
friend

Definition at line 36 of file fbxcamera.h.

◆ fbxsdk ::FbxNew [1/47]

T* fbxsdk ::FbxNew ( )
friend

◆ fbxsdk ::FbxNew [2/47]

T* fbxsdk ::FbxNew ( T1 &  p1)
friend

◆ fbxsdk ::FbxNew [3/47]

T* fbxsdk ::FbxNew ( const T1 &  p1)
friend

◆ fbxsdk ::FbxNew [4/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
T2 &  p2 
)
friend

◆ fbxsdk ::FbxNew [5/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
const T2 &  p2 
)
friend

◆ fbxsdk ::FbxNew [6/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2 
)
friend

◆ fbxsdk ::FbxNew [7/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2 
)
friend

◆ fbxsdk ::FbxNew [8/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
T2 &  p2,
T3 &  p3 
)
friend

◆ fbxsdk ::FbxNew [9/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
T2 &  p2,
const T3 &  p3 
)
friend

◆ fbxsdk ::FbxNew [10/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
const T2 &  p2,
T3 &  p3 
)
friend

◆ fbxsdk ::FbxNew [11/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
const T2 &  p2,
const T3 &  p3 
)
friend

◆ fbxsdk ::FbxNew [12/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2,
T3 &  p3 
)
friend

◆ fbxsdk ::FbxNew [13/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2,
const T3 &  p3 
)
friend

◆ fbxsdk ::FbxNew [14/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
T3 &  p3 
)
friend

◆ fbxsdk ::FbxNew [15/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3 
)
friend

◆ fbxsdk ::FbxNew [16/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
T2 &  p2,
T3 &  p3,
T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [17/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
T2 &  p2,
T3 &  p3,
const T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [18/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
T2 &  p2,
const T3 &  p3,
T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [19/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
T2 &  p2,
const T3 &  p3,
const T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [20/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
const T2 &  p2,
T3 &  p3,
T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [21/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
const T2 &  p2,
T3 &  p3,
const T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [22/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
const T2 &  p2,
const T3 &  p3,
T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [23/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
const T2 &  p2,
const T3 &  p3,
const T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [24/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2,
T3 &  p3,
T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [25/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2,
T3 &  p3,
const T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [26/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2,
const T3 &  p3,
T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [27/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2,
const T3 &  p3,
const T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [28/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
T3 &  p3,
T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [29/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
T3 &  p3,
const T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [30/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3,
T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [31/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3,
const T4 &  p4 
)
friend

◆ fbxsdk ::FbxNew [32/47]

T* fbxsdk ::FbxNew ( T1 &  p1,
T2 &  p2,
T3 &  p3,
T4 &  p4,
T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [33/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2,
T3 &  p3,
T4 &  p4,
T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [34/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
T3 &  p3,
T4 &  p4,
T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [35/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2,
const T3 &  p3,
T4 &  p4,
T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [36/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2,
T3 &  p3,
const T4 &  p4,
T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [37/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
T2 &  p2,
T3 &  p3,
T4 &  p4,
const T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [38/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3,
T4 &  p4,
T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [39/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
T3 &  p3,
const T4 &  p4,
T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [40/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
T3 &  p3,
T4 &  p4,
const T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [41/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3,
const T4 &  p4,
T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [42/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3,
T4 &  p4,
const T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [43/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3,
const T4 &  p4,
const T5 &  p5 
)
friend

◆ fbxsdk ::FbxNew [44/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3,
const T4 &  p4,
const T5 &  p5,
const T6 &  p6 
)
friend

◆ fbxsdk ::FbxNew [45/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3,
const T4 &  p4,
const T5 &  p5,
const T6 &  p6,
const T7 &  p7 
)
friend

◆ fbxsdk ::FbxNew [46/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3,
const T4 &  p4,
const T5 &  p5,
const T6 &  p6,
const T7 &  p7,
const T8 &  p8 
)
friend

◆ fbxsdk ::FbxNew [47/47]

T* fbxsdk ::FbxNew ( const T1 &  p1,
const T2 &  p2,
const T3 &  p3,
const T4 &  p4,
const T5 &  p5,
const T6 &  p6,
const T7 &  p7,
const T8 &  p8,
const T9 &  p9 
)
friend

◆ fbxsdk ::FbxDelete [1/2]

void fbxsdk ::FbxDelete ( T *  p)
friend

◆ fbxsdk ::FbxDelete [2/2]

void fbxsdk ::FbxDelete ( const T *  p)
friend

◆ fbxsdk ::FbxNewArray

T* fbxsdk ::FbxNewArray ( const int  n)
friend

◆ fbxsdk ::FbxDeleteArray

void fbxsdk ::FbxDeleteArray ( T *  p)
friend

Member Data Documentation

◆ ClassId

FbxClassId ClassId
static

Definition at line 36 of file fbxcamera.h.

◆ Position

This property handles the camera's 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/SceneContext.cxx, and ViewScene/SetCamera.cxx.

Definition at line 782 of file fbxcamera.h.

◆ UpVector

This property handles the camera's 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 791 of file fbxcamera.h.

◆ InterestPosition

FbxPropertyT<FbxDouble3> InterestPosition

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

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

Remarks
During the computations of the camera position and orientation, this property is overridden by the position of a valid target in the parent node.
Default Value is (0.0, 0.0, 0.0).
Examples:
ImportScene/DisplayCamera.cxx, ViewScene/SceneContext.cxx, and ViewScene/SetCamera.cxx.

Definition at line 804 of file fbxcamera.h.

◆ Roll

This property handles the camera roll angle in degrees.

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

Default value is 0.0.

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

Definition at line 813 of file fbxcamera.h.

◆ OpticalCenterX

FbxPropertyT<FbxDouble> OpticalCenterX

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

It sets horizontal offset of the optical center. When the camera's aperture mode is set to eVertical, this property has no effect.

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

Default value is 0.0.

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

Definition at line 824 of file fbxcamera.h.

◆ OpticalCenterY

FbxPropertyT<FbxDouble> OpticalCenterY

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

It sets the vertical offset of the optical center. When the camera's aperture mode is set to eHorizontal, this property has no effect.

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

Default value is 0.0.

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

Definition at line 835 of file fbxcamera.h.

◆ BackgroundColor

FbxPropertyT<FbxDouble3> BackgroundColor

This property handles the RGB values of the camera's 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 844 of file fbxcamera.h.

◆ TurnTable

FbxPropertyT<FbxDouble> TurnTable

When modeling 3D objects, you often need to review or evaluate your models during the creation process.

You may create a camera with turn table animation to view your models in 360 or certain degrees. This property handles the camera's turn table angle in degrees.

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

Default value is 0.

Definition at line 855 of file fbxcamera.h.

◆ DisplayTurnTableIcon

FbxPropertyT<FbxBool> DisplayTurnTableIcon

This property handles a flag 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(FbxBool).

Default value is false (no display).

Definition at line 865 of file fbxcamera.h.

◆ UseMotionBlur

FbxPropertyT<FbxBool> UseMotionBlur

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

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

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

Definition at line 879 of file fbxcamera.h.

◆ UseRealTimeMotionBlur

FbxPropertyT<FbxBool> UseRealTimeMotionBlur

This property handles a flag 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(FbxBool).

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

Definition at line 889 of file fbxcamera.h.

◆ MotionBlurIntensity

FbxPropertyT<FbxDouble> MotionBlurIntensity

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

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

Default value is 1.0.

Definition at line 898 of file fbxcamera.h.

◆ AspectRatioMode

FbxPropertyT<EAspectRatioMode> AspectRatioMode

This property handles the camera's aspect ratio mode.

Remarks
This property is read-only.
Please use function SetAspect() if you want to change its value.

Default value is eWindowSize.

Definition at line 912 of file fbxcamera.h.

◆ AspectWidth

FbxPropertyT<FbxDouble> AspectWidth

This property handles the camera's aspect width.

Remarks
This property is read-only.
Please use function SetAspect() if you want to change its value.

Default value is 320.

Examples:
Camera/main.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 921 of file fbxcamera.h.

◆ AspectHeight

FbxPropertyT<FbxDouble> AspectHeight

This property handles the camera's aspect height.

Remarks
This property is read-only.
Please use function SetAspect() if you want to change its value.

Default value is 200.

Examples:
Camera/main.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 930 of file fbxcamera.h.

◆ PixelAspectRatio

FbxPropertyT<FbxDouble> PixelAspectRatio

This property handles the pixel aspect ratio.

Remarks
This property is read-only.
Please use function SetPixelRatio() if you want to change its value.

Default value is 1.

Remarks
Value range is [0.050, 20.0].
Examples:
Camera/main.cxx, and ImportScene/DisplayCamera.cxx.

Definition at line 940 of file fbxcamera.h.

◆ ApertureMode

FbxPropertyT<EApertureMode> ApertureMode

This property handles the aperture mode.

To access this property do: ApertureMode.Get(). To set this property do: ApertureMode.Set(EApertureMode).

Default value is eVertical.

Definition at line 949 of file fbxcamera.h.

◆ GateFit

This property handles the gate fit mode.

To control the size of the resolution gate relative to the film gate. If the resolution gate and the film gate have the same aspect ratio, then the property has no effect.

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

Default value is eFitNone.

Examples:
ViewScene/SetCamera.cxx.

Definition at line 960 of file fbxcamera.h.

◆ FieldOfView

FbxPropertyT<FbxDouble> FieldOfView

This property handles the field of view in degrees.

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

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:
Camera/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 973 of file fbxcamera.h.

◆ FieldOfViewX

FbxPropertyT<FbxDouble> 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(FbxDouble).

Remarks
This property has meaning only when property ApertureMode equals eHorizAndVert.

Default value is 1.

Remarks
Value range is [1.0, 179.0].
Examples:
Camera/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 986 of file fbxcamera.h.

◆ FieldOfViewY

FbxPropertyT<FbxDouble> 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(FbxDouble).

Remarks
This property has meaning only when property ApertureMode equals eHorizAndVert.
Default value is 1.
Value range is [1.0, 179.0].
Examples:
Camera/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayCamera.cxx, and ViewScene/SetCamera.cxx.

Definition at line 999 of file fbxcamera.h.

◆ FocalLength

FbxPropertyT<FbxDouble> FocalLength

This property handles the focal length (in millimeters).

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

Default value is the result of ComputeFocalLength(40.0).

Examples:
Camera/main.cxx, ImportScene/DisplayCamera.cxx, StereoCamera/main.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1008 of file fbxcamera.h.

◆ CameraFormat

FbxPropertyT<EFormat> CameraFormat

This property handles the camera's format.

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

Remarks
This property is read-only.
Please use function SetFormat() if you want to change its value.

Default value is eCustomFormat.

Definition at line 1020 of file fbxcamera.h.

◆ UseFrameColor

FbxPropertyT<FbxBool> UseFrameColor

This property stores a flag that indicates to draw a border with color around the camera's viewable area or not.

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

Default value is false.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1032 of file fbxcamera.h.

◆ FrameColor

FbxPropertyT<FbxDouble3> FrameColor

This property is used to define the color of the border around the camera view.

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 1041 of file fbxcamera.h.

◆ ShowName

FbxPropertyT<FbxBool> ShowName

This property handles the flag to show the camera's name or not.

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

Default value is true.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1054 of file fbxcamera.h.

◆ ShowInfoOnMoving

FbxPropertyT<FbxBool> ShowInfoOnMoving

This property handles the flag to show info on moving or not.

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

Default value is true.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1063 of file fbxcamera.h.

◆ ShowGrid

FbxPropertyT<FbxBool> ShowGrid

This property handles the flag to draw floor grid or not.

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

Default value is true.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1072 of file fbxcamera.h.

◆ ShowOpticalCenter

FbxPropertyT<FbxBool> ShowOpticalCenter

This property handles the flag to show optical center or not.

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

Default value is false.

Definition at line 1081 of file fbxcamera.h.

◆ ShowAzimut

FbxPropertyT<FbxBool> ShowAzimut

This property handles the flag to show the camera's sight line or not.

When the camera is revolved about the center of interest in the perspective view, the angle of a camera's sight line relative to a plane perpendicular to the ground plane is referred to as its azimuth; and the angle of a camera's sight line relative to the ground plane is referred to as its elevation;

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

Default value is true.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1093 of file fbxcamera.h.

◆ ShowTimeCode

FbxPropertyT<FbxBool> ShowTimeCode

This property handles the flag to show time code or not.

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

Default value is true.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1102 of file fbxcamera.h.

◆ ShowAudio

FbxPropertyT<FbxBool> ShowAudio

This property handles the flag to show audio or not.

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

Default value is false.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1111 of file fbxcamera.h.

◆ AudioColor

FbxPropertyT<FbxDouble3> AudioColor

This property handles audio color.

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 1120 of file fbxcamera.h.

◆ NearPlane

FbxPropertyT<FbxDouble> NearPlane

This property handles the near plane distance.

Remarks
This property is read-only.
Please use function SetNearPlane() if you want to change its value.

Default value is 10.

Remarks
Value range is [0.001, 600000.0].
Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1134 of file fbxcamera.h.

◆ FarPlane

This property handles the far plane distance.

Remarks
This property is read-only.
Please use function SetFarPlane() if you want to change its value.

Default value is 4000.

Remarks
Value range is [0.001, 600000.0].
Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1144 of file fbxcamera.h.

◆ AutoComputeClipPlanes

FbxPropertyT<FbxBool> AutoComputeClipPlanes

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

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

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 1154 of file fbxcamera.h.

◆ FilmWidth

FbxPropertyT<FbxDouble> FilmWidth

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

Remarks
This property is read-only.
Please use function SetApertureWidth() or SetApertureFormat() if you want to change its value.

Default value is 0.8160.

Remarks
Value range is [0.0001, +inf).
Examples:
Camera/main.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1170 of file fbxcamera.h.

◆ FilmHeight

FbxPropertyT<FbxDouble> FilmHeight

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

Remarks
This property is read-only.
Please use function SetApertureHeight() or SetApertureFormat() if you want to change its value.

Default value is 0.6120.

Remarks
Value range is [0.0001, +inf).
Examples:
Camera/main.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1181 of file fbxcamera.h.

◆ FilmAspectRatio

FbxPropertyT<FbxDouble> FilmAspectRatio

This property handles the film aperture aspect ratio.

Remarks
This property is read-only.
Please use function SetApertureFormat() if you want to change its value.

Default value is (FilmWidth / FilmHeight).

Remarks
Value range is [0.0001, +inf).
Examples:
Camera/main.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1191 of file fbxcamera.h.

◆ FilmSqueezeRatio

FbxPropertyT<FbxDouble> FilmSqueezeRatio

This property handles the film aperture squeeze ratio.

Remarks
This property is read-only.
Please use function SetSqueezeRatio() or SetApertureFormat() if you want to change its value.

Default value is 1.0.

Remarks
Value range is [0.0001, +inf).

Definition at line 1202 of file fbxcamera.h.

◆ FilmFormat

This property handles the film aperture format.

Remarks
This property is read-only.
Please use function SetApertureFormat() if you want to change its value.

Default value is eCustomAperture.

Definition at line 1212 of file fbxcamera.h.

◆ FilmOffsetX

FbxPropertyT<FbxDouble> FilmOffsetX

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

Default value is 0.0.

Examples:
StereoCamera/main.cxx, and ViewScene/SetCamera.cxx.

Definition at line 1222 of file fbxcamera.h.

◆ FilmOffsetY

FbxPropertyT<FbxDouble> 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(FbxDouble).

Default value is 0.0.

Examples:
ViewScene/SetCamera.cxx.

Definition at line 1233 of file fbxcamera.h.

◆ 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(FbxDouble).

Default value is 1.0.

Definition at line 1244 of file fbxcamera.h.

◆ FilmTranslateX

FbxPropertyT<FbxDouble> FilmTranslateX

This property handles the horizontal film horizontal translation.

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

Definition at line 1251 of file fbxcamera.h.

◆ FilmTranslateY

FbxPropertyT<FbxDouble> FilmTranslateY

This property handles the vertical film translation.

To access this property do: FilmTranslateY.Get(). To set this property do: FilmTranslateY.Set(FbxDouble).

Default value is 0.0.

Definition at line 1260 of file fbxcamera.h.

◆ FilmRollPivotX

FbxPropertyT<FbxDouble> 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(FbxDouble).

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 1270 of file fbxcamera.h.

◆ FilmRollPivotY

FbxPropertyT<FbxDouble> 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(FbxDouble).

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 1280 of file fbxcamera.h.

◆ FilmRollValue

FbxPropertyT<FbxDouble> 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(FbxDouble).

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 1292 of file fbxcamera.h.

◆ FilmRollOrder

FbxPropertyT<EFilmRollOrder> FilmRollOrder

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

eRotateFirst The film back is first rotated then translated by the pivot point value. eTranslateFirst 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(EFilmRollOrder).

Default value is eRotateFirst.

Definition at line 1303 of file fbxcamera.h.

◆ ViewCameraToLookAt

FbxPropertyT<FbxBool> ViewCameraToLookAt

This property handles the camera's look-at flag.

If this flag is on, the camera will look at the camera interest.

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

Default value is true.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1317 of file fbxcamera.h.

◆ ViewFrustumNearFarPlane

FbxPropertyT<FbxBool> ViewFrustumNearFarPlane

This property handles to display the near and far plane or not.

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

Default value is false.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1326 of file fbxcamera.h.

◆ ViewFrustumBackPlaneMode

FbxPropertyT<EFrontBackPlaneDisplayMode> ViewFrustumBackPlaneMode

This property handles the back plane display mode.

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

Default value is ePlanesWhenMedia.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1335 of file fbxcamera.h.

◆ BackPlaneDistance

FbxPropertyT<FbxDouble> BackPlaneDistance

This property handles the back plane distance.

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

Default value is 100.0.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1344 of file fbxcamera.h.

◆ BackPlaneDistanceMode

FbxPropertyT<EFrontBackPlaneDistanceMode> BackPlaneDistanceMode

This property handles the back plane distance mode.

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

Default value is eRelativeToInterest.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1353 of file fbxcamera.h.

◆ ViewFrustumFrontPlaneMode

FbxPropertyT<EFrontBackPlaneDisplayMode> ViewFrustumFrontPlaneMode

This property handles the front plane mode.

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

Default value is ePlanesWhenMedia.

Definition at line 1362 of file fbxcamera.h.

◆ FrontPlaneDistance

FbxPropertyT<FbxDouble> FrontPlaneDistance

This property handles the front plane distance.

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

Default value is 100.0.

Definition at line 1371 of file fbxcamera.h.

◆ FrontPlaneDistanceMode

FbxPropertyT<EFrontBackPlaneDistanceMode> FrontPlaneDistanceMode

This property handles the front plane distance mode.

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

Default value is eRelativeToInterest.

Definition at line 1380 of file fbxcamera.h.

◆ LockMode

FbxPropertyT<FbxBool> LockMode

This property handles the flag to lock the camera's navigation.

When this flag is on, the camera's view can not be changed anymore. To access this property do: LockMode.Get(). To set this property do: LockMode.Set(FbxBool).

Default value is false.

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

Definition at line 1393 of file fbxcamera.h.

◆ LockInterestNavigation

FbxPropertyT<FbxBool> LockInterestNavigation

This property handles the flag to lock the camera interest's navigation.

When this flag is one, the position of the camera interest is locked. To access this property do: LockInterestNavigation.Get(). To set this property do: LockInterestNavigation.Set(FbxBool).

Default value is false.

Definition at line 1402 of file fbxcamera.h.

◆ BackPlateFitImage

FbxPropertyT<FbxBool> BackPlateFitImage

This property handles the fit image flag of back plane.

To access this property do: BackPlateFitImage.Get(). To set this property do: BackPlateFitImage.Set(FbxBool).

Default value is false.

See also
SetFitImage and GetFitImage.

Definition at line 1416 of file fbxcamera.h.

◆ BackPlateCrop

FbxPropertyT<FbxBool> BackPlateCrop

This property handles the crop flag of back plane.

To access this property do: BackPlateCrop.Get(). To set this property do: BackPlateCrop.Set(FbxBool).

Default value is false.

See also
SetCrop and GetCrop.

Definition at line 1426 of file fbxcamera.h.

◆ BackPlateCenter

FbxPropertyT<FbxBool> BackPlateCenter

This property handles the center flag of back plane.

To access this property do: BackPlateCenter.Get(). To set this property do: BackPlateCenter.Set(FbxBool).

Default value is true. see SetCenter and GetCenter.

Definition at line 1436 of file fbxcamera.h.

◆ BackPlateKeepRatio

FbxPropertyT<FbxBool> BackPlateKeepRatio

This property handles the keep ratio flag of back plane.

To access this property do: BackPlateKeepRatio.Get(). To set this property do: BackPlateKeepRatio.Set(FbxBool).

Default value is true.

See also
SetKeepRatio and GetKeepRatio.

Definition at line 1446 of file fbxcamera.h.

◆ BackgroundAlphaTreshold

FbxPropertyT<FbxDouble> BackgroundAlphaTreshold

This property handles the background alpha threshold value.

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

Default value is 0.5.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1455 of file fbxcamera.h.

◆ BackPlaneOffsetX

FbxPropertyT<FbxDouble> BackPlaneOffsetX

This property handles the back plane offset X.

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

Default value is 0.0.

Definition at line 1464 of file fbxcamera.h.

◆ BackPlaneOffsetY

FbxPropertyT<FbxDouble> BackPlaneOffsetY

This property handles the back plane offset Y.

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

Default value is 0.0.

Definition at line 1473 of file fbxcamera.h.

◆ BackPlaneRotation

FbxPropertyT<FbxDouble> BackPlaneRotation

This property handles the back plane rotation.

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

Default value is 0.0.

Definition at line 1482 of file fbxcamera.h.

◆ BackPlaneScaleX

FbxPropertyT<FbxDouble> BackPlaneScaleX

This property handles the back plane scaling X.

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

Default value is 1.0.

Remarks
The application manipulating the camera has to take into consideration of the BackPlateKeepRatio value too.

Definition at line 1493 of file fbxcamera.h.

◆ BackPlaneScaleY

FbxPropertyT<FbxDouble> BackPlaneScaleY

This property handles the back plane scaling Y.

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

Default value is 1.0.

Remarks
The application manipulating the camera has to take into consideration of the BackPlateKeepRatio value too.

Definition at line 1504 of file fbxcamera.h.

◆ ShowBackplate

FbxPropertyT<FbxBool> ShowBackplate

This property handles the flag to show back plane or not.

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

Default value is false.

Remarks
This replaces ForegroundTransparent.

Definition at line 1514 of file fbxcamera.h.

◆ BackgroundTexture

FbxPropertyT<FbxReference> BackgroundTexture

This property has the background texture connected to it.

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

Remarks
The background texture is connected as source object.

Definition at line 1523 of file fbxcamera.h.

◆ FrontPlateFitImage

FbxPropertyT<FbxBool> FrontPlateFitImage

This property handles the fit image flag of front plate.

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

Default value is false.

Definition at line 1537 of file fbxcamera.h.

◆ FrontPlateCrop

FbxPropertyT<FbxBool> FrontPlateCrop

This property handles the crop flag of front plane.

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

Default value is false.

Definition at line 1546 of file fbxcamera.h.

◆ FrontPlateCenter

FbxPropertyT<FbxBool> FrontPlateCenter

This property handles the center flag of front plane.

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

Default value is true.

Definition at line 1555 of file fbxcamera.h.

◆ FrontPlateKeepRatio

FbxPropertyT<FbxBool> FrontPlateKeepRatio

This property handles the keep ratio flag of front plane.

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

Default value is true.

Definition at line 1564 of file fbxcamera.h.

◆ ShowFrontplate

FbxPropertyT<FbxBool> ShowFrontplate

This property handles the flag to show front plane or not.

To access this property do: ShowFrontplate.Get(). To set this property do: ShowFrontplate.Set(FbxBool).

Default value is false.

Remarks
This replaces ForegroundTransparent.
Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1575 of file fbxcamera.h.

◆ FrontPlaneOffsetX

FbxPropertyT<FbxDouble> FrontPlaneOffsetX

This property handles the front plane offset X.

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

Default value is 0.0.

Definition at line 1584 of file fbxcamera.h.

◆ FrontPlaneOffsetY

FbxPropertyT<FbxDouble> FrontPlaneOffsetY

This property handles the front plane offset Y.

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

Default value is 0.0.

Definition at line 1593 of file fbxcamera.h.

◆ FrontPlaneRotation

FbxPropertyT<FbxDouble> FrontPlaneRotation

This property handles the front plane rotation.

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

Default value is 0.0.

Definition at line 1602 of file fbxcamera.h.

◆ FrontPlaneScaleX

FbxPropertyT<FbxDouble> FrontPlaneScaleX

This property handles the front plane scaling X.

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

Default value is 1.0.

Definition at line 1611 of file fbxcamera.h.

◆ FrontPlaneScaleY

FbxPropertyT<FbxDouble> FrontPlaneScaleY

This property handles the front plane scaling Y.

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

Default value is 1.0.

Definition at line 1620 of file fbxcamera.h.

◆ ForegroundTexture

FbxPropertyT<FbxReference> ForegroundTexture

This property has the foreground texture connected to it.

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

Remarks
The foreground texture is connected as source object.

Definition at line 1629 of file fbxcamera.h.

◆ ForegroundOpacity

FbxPropertyT<FbxDouble> ForegroundOpacity

This property handles the foreground image opacity value.

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

Default value is 1.0.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1638 of file fbxcamera.h.

◆ DisplaySafeArea

FbxPropertyT<FbxBool> DisplaySafeArea

This property handles the flag to display safe area or not.

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

Default value is false.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1651 of file fbxcamera.h.

◆ DisplaySafeAreaOnRender

FbxPropertyT<FbxBool> DisplaySafeAreaOnRender

This property handles the flag display safe area on render or not.

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

Default value is false.

Definition at line 1660 of file fbxcamera.h.

◆ SafeAreaDisplayStyle

FbxPropertyT<ESafeAreaStyle> SafeAreaDisplayStyle

This property handles the style to display safe area.

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

Default value is eSafeAreaSquare.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1669 of file fbxcamera.h.

◆ SafeAreaAspectRatio

FbxPropertyT<FbxDouble> SafeAreaAspectRatio

This property handles the display aspect ratio of safe area.

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

Default value is 1.33333333333333.

Definition at line 1678 of file fbxcamera.h.

◆ Use2DMagnifierZoom

FbxPropertyT<FbxBool> Use2DMagnifierZoom

This property handles the flag to use 2d magnifier zoom or not.

The 2D Magnifier lets you perform a 2D enlargement of the scene using the current camera without changing any camera settings.

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

Default value is false.

Definition at line 1693 of file fbxcamera.h.

◆ _2DMagnifierZoom

FbxPropertyT<FbxDouble> _2DMagnifierZoom

This property handles the 2d magnifier zoom value.

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

Default value is 100.0.

Definition at line 1702 of file fbxcamera.h.

◆ _2DMagnifierX

FbxPropertyT<FbxDouble> _2DMagnifierX

This property handles the 2d magnifier X value.

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

Default value is 50.0.

Definition at line 1711 of file fbxcamera.h.

◆ _2DMagnifierY

FbxPropertyT<FbxDouble> _2DMagnifierY

This property handles the 2d magnifier Y value.

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

Default value is 50.0.

Definition at line 1720 of file fbxcamera.h.

◆ ProjectionType

FbxPropertyT<EProjectionType> ProjectionType

This property handles the projection type.

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

Default value is ePerspective.

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

Definition at line 1733 of file fbxcamera.h.

◆ OrthoZoom

FbxPropertyT<FbxDouble> OrthoZoom

This property handles the orthographic zoom value.

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

Default value is 1.0.

Definition at line 1742 of file fbxcamera.h.

◆ UseRealTimeDOFAndAA

FbxPropertyT<FbxBool> UseRealTimeDOFAndAA

This property handles the flag to use real time Depth of Field and Anti-Aliasing or not.

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

Default value is false.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1755 of file fbxcamera.h.

◆ UseDepthOfField

FbxPropertyT<FbxBool> UseDepthOfField

This property handles the flag to use depth of field or not.

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

Default value is false.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1764 of file fbxcamera.h.

◆ FocusSource

This property handles the focus source.

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

Default value is eFocusSrcCameraInterest.

See also
FocusDistance.
Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1774 of file fbxcamera.h.

◆ FocusAngle

FbxPropertyT<FbxDouble> FocusAngle

This property handles the focus angle (in degrees).

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

Default value is 3.5.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1783 of file fbxcamera.h.

◆ FocusDistance

FbxPropertyT<FbxDouble> FocusDistance

This property handles the focus distance.

Focus distance is the distance between the camera and the object on which the camera is focused. There are two possible sources for this distance.

See also
EFocusDistanceSource

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

Default value is 200.0.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1795 of file fbxcamera.h.

◆ UseAntialiasing

FbxPropertyT<FbxBool> UseAntialiasing

This property handles the flag to use anti aliasing or not.

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

Default value is false.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1804 of file fbxcamera.h.

◆ AntialiasingIntensity

FbxPropertyT<FbxDouble> AntialiasingIntensity

This property handles the anti aliasing intensity.

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

Default value is 0.77777.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1813 of file fbxcamera.h.

◆ AntialiasingMethod

FbxPropertyT<EAntialiasingMethod> AntialiasingMethod

This property handles the anti aliasing method.

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

Default value is eAAOversampling.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1822 of file fbxcamera.h.

◆ UseAccumulationBuffer

FbxPropertyT<FbxBool> UseAccumulationBuffer

This property handles the flag to use accumulation buffer or not.

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

Default value is false.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1835 of file fbxcamera.h.

◆ FrameSamplingCount

FbxPropertyT<FbxInt> FrameSamplingCount

This property handles the frame sampling count.

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

Default value is 7.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1844 of file fbxcamera.h.

◆ FrameSamplingType

FbxPropertyT<ESamplingType> FrameSamplingType

This property handles the frame sampling type.

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

Default value is eSamplingStochastic.

Examples:
ImportScene/DisplayCamera.cxx.

Definition at line 1853 of file fbxcamera.h.


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