kfbxcamera.h

Go to the documentation of this file.

#ifndef _FBXSDK_CAMERA_H_
#define _FBXSDK_CAMERA_H_

/**************************************************************************************

 Copyright © 2001 - 2007 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.

 The coded instructions, statements, computer programs, and/or related material
 (collectively the "Data") in these files contain unpublished information
 proprietary to Autodesk, Inc. and/or its licensors, which is protected by
 Canada and United States of America federal copyright law and by international
 treaties.

 The Data may not be disclosed or distributed to third parties, in whole or in
 part, without the prior written consent of Autodesk, Inc. ("Autodesk").

 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
 BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE,
 NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE.
 WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
 OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE.

 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
 OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
 SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
 OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
 HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
 FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
 ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
 WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
 OR DAMAGE.

**************************************************************************************/

#include <kaydaradef.h>
#ifndef KFBX_DLL 
    #define KFBX_DLL K_DLLIMPORT
#endif

#include <kaydara.h>

#include <kfbxplugins/kfbxnodeattribute.h>
#include <kfbxplugins/kfbxcolor.h>

#include <kfbxmath/kfbxvector4.h>

#include <klib/kstring.h>

#ifdef KARCH_DEV_MACOSX_CFM
    #include <CFURL.h>
    #include <Files.h>
#endif

#include <fbxfilesdk_nsbegin.h>

class KFbxTexture;
class KFbxSdkManager;
class KFbxCamera_internal;

class KFBX_DLL KFbxCamera : public KFbxNodeAttribute
{
    KFBXOBJECT_DECLARE(KFbxCamera);
    
public:
    virtual EAttributeType GetAttributeType() const;

    void Reset();


    void SetPosition(const KFbxVector4& pPosition);
    
    KFbxVector4 GetPosition() const;

    void SetUpVector(const KFbxVector4& pVector);

    KFbxVector4 GetUpVector() const;

    void SetDefaultCameraInterestPosition(const KFbxVector4& pPosition);

    KFbxVector4 GetDefaultCameraInterestPosition() const;

    void SetRoll(double pRoll);

    double GetRoll() const;

    void SetTurnTable(double pTurnTable);

    double GetTurnTable() const;

    typedef enum 
    { 
        ePERSPECTIVE, 
        eORTHOGONAL 
    } ECameraProjectionType;

    void SetProjectionType(ECameraProjectionType pProjectionType);

    ECameraProjectionType GetProjectionType() const;



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

    void SetFormat(ECameraFormat pFormat);

    ECameraFormat GetFormat() const;

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

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

    ECameraAspectRatioMode GetAspectRatioMode() const;

    double GetAspectWidth() const;

    double GetAspectHeight() const;

    void SetPixelRatio(double pRatio);

    double GetPixelRatio() const;

    void SetNearPlane(double pDistance);

    double GetNearPlane() const;

    void SetFarPlane(double pDistance);
    
    double GetFarPlane() const;

    void SetMouseLock(bool pMouseLock);

    bool GetMouseLock() const;



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

    void SetApertureFormat(ECameraApertureFormat pFormat);

    ECameraApertureFormat GetApertureFormat() const;

    typedef enum 
    { 
        eHORIZONTAL_AND_VERTICAL,
        eHORIZONTAL,
        eVERTICAL,
        eFOCAL_LENGTH
    } ECameraApertureMode;

    void SetApertureMode(ECameraApertureMode pMode);

    ECameraApertureMode GetApertureMode() const;

    void SetApertureWidth(double pWidth);
    
    double GetApertureWidth() const;

    void SetApertureHeight(double pHeight);

    double GetApertureHeight() const;

    void SetSqueezeRatio(double pRatio);

    double GetSqueezeRatio() const;

    void SetOrthoZoom(const double& pOrthoZoom);

    double GetOrthoZoom() const;

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

    void SetGateFit(const ECameraGateFit pGateFit);

    ECameraGateFit GetGateFit() const;

    double ComputeFieldOfView(double pFocalLength) const;

    double ComputeFocalLength(double pAngleOfView);


    void SetBackgroundFileName(char* pFileName);

#ifdef KARCH_DEV_MACOSX_CFM
    bool SetBackgroundFile(const FSSpec &pMacFileSpec);
    bool SetBackgroundFile(const FSRef &pMacFileRef);
    bool SetBackgroundFile(const CFURLRef &pMacURL);
#endif

    char const* GetBackgroundFileName() const;

#ifdef KARCH_DEV_MACOSX_CFM
    bool GetBackgroundFile(FSSpec &pMacFileSpec) const;
    bool GetBackgroundFile(FSRef &pMacFileRef) const;
    bool GetBackgroundFile(CFURLRef &pMacURL) const;
#endif

    void SetBackgroundMediaName(char* pFileName);

    char const* GetBackgroundMediaName() const;

    typedef enum 
    {
        eDISABLED,
        eALWAYS,  
        eWHEN_MEDIA
    } ECameraBackgroundDisplayMode;

    void SetBackgroundDisplayMode(ECameraBackgroundDisplayMode pMode);

    ECameraBackgroundDisplayMode GetBackgroundDisplayMode() const;

    typedef enum 
    {
        eBACKGROUND,
        eFOREGROUND,
        eBACKGROUND_AND_FOREGROUND
    } ECameraBackgroundDrawingMode;

    void SetBackgroundDrawingMode(ECameraBackgroundDrawingMode pMode);

    ECameraBackgroundDrawingMode GetBackgroundDrawingMode() const;

    void SetForegroundMatteThresholdEnable(bool pEnable);
    
    bool GetForegroundMatteThresholdEnable() const;

    void SetForegroundMatteThreshold(double pThreshold);
    
    double GetForegroundMatteThreshold() const;

    typedef enum 
    {
        eFIT = 1<<0,
        eCENTER = 1<<1,
        eKEEP_RATIO = 1<<2,
        eCROP = 1<<3
    } ECameraBackgroundPlacementOptions;
    
    void SetBackgroundPlacementOptions(kUInt pOptions);

    kUInt GetBackgroundPlacementOptions() const;

    typedef enum 
    {
        eRELATIVE_TO_INTEREST,
        eABSOLUTE_FROM_CAMERA
    } ECameraBackgroundDistanceMode;

    void SetBackgroundDistanceMode(ECameraBackgroundDistanceMode pMode);

    ECameraBackgroundDistanceMode GetBackgroundDistanceMode() const;

    void SetBackgroundDistance(double pDistance);

    double GetBackgroundDistance() const;



    void SetViewCameraInterest(bool pEnable);

    bool GetViewCameraInterest() const;

    void SetViewNearFarPlanes(bool pEnable);

    bool GetViewNearFarPlanes() const;
    
    void SetShowGrid(bool pEnable);
    
    bool GetShowGrid() const;

    void SetShowAxis(bool pEnable);

    bool GetShowAxis() const;

    void SetShowName(bool pEnable);

    bool GetShowName() const;

    void SetShowInfoOnMoving(bool pEnable);

    bool GetShowInfoOnMoving() const;

    void SetShowTimeCode(bool pEnable);
    
    bool GetShowTimeCode() const;

    void SetDisplaySafeArea(bool pEnable);

    bool GetDisplaySafeArea() const;

    void SetDisplaySafeAreaOnRender(bool pEnable);

    bool GetDisplaySafeAreaOnRender() const;

    typedef enum 
    { 
        eROUND = 0, 
        eSQUARE = 1 
    } ECameraSafeAreaStyle;

    void SetSafeAreaStyle(ECameraSafeAreaStyle pStyle);

    ECameraSafeAreaStyle GetSafeAreaStyle() const;

    void SetShowAudio(bool pEnable);

    bool GetShowAudio() const;

    void SetAudioColor(const KFbxColor& pColor);

    KFbxColor GetAudioColor() const;

    void SetUseFrameColor(bool pEnable);

    bool GetUseFrameColor() const;

    void SetFrameColor(const KFbxColor& pColor);

    KFbxColor GetFrameColor() const;



    typedef enum 
    {
        eINTERACTIVE,
        eAT_RENDER
    } ECameraRenderOptionsUsageTime;

    void SetRenderOptionsUsageTime(ECameraRenderOptionsUsageTime pUsageTime);

    ECameraRenderOptionsUsageTime GetRenderOptionsUsageTime() const;

    void SetUseAntialiasing(bool pEnable);

    bool GetUseAntialiasing() const;

    void SetAntialiasingIntensity(double pIntensity);

    double GetAntialiasingIntensity() const;

    typedef enum 
    {
        eOVERSAMPLING_ANTIALIASING, 
        eHARDWARE_ANTIALIASING
    } ECameraAntialiasingMethod;

    void SetAntialiasingMethod(ECameraAntialiasingMethod pMethod);

    ECameraAntialiasingMethod GetAntialiasingMethod() const;

    void SetNumberOfSamples(int pNumberOfSamples);

    int GetNumberOfSamples() const;

    typedef enum 
    {
        eUNIFORM,
        eSTOCHASTIC
    } ECameraSamplingType;

    void SetSamplingType(ECameraSamplingType pType);

    ECameraSamplingType GetSamplingType() const;

    void SetUseAccumulationBuffer(bool pUseAccumulationBuffer);

    bool GetUseAccumulationBuffer() const;

    void SetUseDepthOfField(bool pUseDepthOfField);

    bool GetUseDepthOfField() const;

    typedef enum 
    {
        eCAMERA_INTEREST, 
        eSPECIFIC_DISTANCE
    } ECameraFocusDistanceSource;

    void SetFocusDistanceSource(ECameraFocusDistanceSource pSource);

    ECameraFocusDistanceSource GetFocusDistanceSource() const;

    void SetSpecificDistance(double pDistance);

    double GetSpecificDistance() const;

    void SetFocusAngle(double pAngle);
    
    double GetFocusAngle() const;



    void SetDefaultFieldOfView(double pFieldOfView);

    double GetDefaultFieldOfView() const;

    void SetDefaultFieldOfViewX(double pFieldOfViewX);

    double GetDefaultFieldOfViewX() const;

    void SetDefaultFieldOfViewY(double pFieldOfViewY);

    double GetDefaultFieldOfViewY() const;

    void SetDefaultOpticalCenterX(double pOpticalCenterX);

    double GetDefaultOpticalCenterX() const;

    void SetDefaultOpticalCenterY(double pOpticalCenterY);

    double GetDefaultOpticalCenterY() const;

    void SetDefaultFocalLength(double pFocalLength);

    double GetDefaultFocalLength() const;

    void SetDefaultRoll(double pRoll);

    double GetDefaultRoll() const;

    void SetDefaultTurnTable(double pTurnTable);

    double GetDefaultTurnTable() const;

    void SetDefaultBackgroundColor(const KFbxColor& pColor);

    KFbxColor GetDefaultBackgroundColor() const;



    K_DEPRECATED void SetBackgroundColor(const KFbxColor& pColor);

    K_DEPRECATED KFbxColor GetBackgroundColor() const;

    K_DEPRECATED void SetAngleOfView(double pAngleOfView);

    K_DEPRECATED double GetAngleOfView() const;

    K_DEPRECATED void SetFocalLength(double pFocalLength);

    K_DEPRECATED double GetFocalLength() const;



    void SetBackgroundTexture(KFbxTexture* pTexture);

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    friend class KFbxGlobalCameraSettings;
    
public:

    virtual KObject* GetFbxObject_internal();
    virtual KObject const*  GetFbxObject_internal() const;

    // Clone
    virtual KFbxObject* Clone(KFbxObject::ECloneType pCloneType) const;

protected:
    static char const* GetNamePrefix() { return 0; }

    KFbxCamera& operator=(KFbxCamera const& pCamera);

    KFbxCamera(KFbxSdkManager& pManager, char const* pName);
    virtual ~KFbxCamera ();

    virtual void Destruct(bool pRecursive, bool pDependents);

    virtual void AddChannels(KFbxTakeNode *pTakeNode);

    virtual void RemoveChannels(KFbxTakeNode *pTakeNode);

    KFbxCamera_internal* mPH;

    virtual KString     GetTypeName() const;
    virtual KStringList GetTypeFlags() const;

private:

    double ComputePixelRatio(kUInt pWidth, kUInt pHeight, double pScreenRatio = 1.3333333333);

    // Camera Position and Orientation
    KFbxVector4 mUpVector;
    KFbxVector4 mDefaultCameraInterestPosition;

    // Background Properties
    KString mBackgroundMediaName;
    KString mBackgroundFileName;

    // Camera Ortho Zoom
    double mOrthoZoom;

    // Camera View Options
    bool mShowInfoOnMoving;
    bool mDisplaySafeAreaOnRender;
    bool mShowAudio;
    KFbxColor mAudioColor;

    // Render Options
    ECameraAntialiasingMethod mAntialiasingMethod;
    ECameraSamplingType mSamplingType;

    friend class KFbxNode;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

typedef KFbxCamera* HKFbxCamera;

#include <fbxfilesdk_nsend.h>

#endif // #ifndef _FBXSDK_CAMERA_H_