fbcamera.h

Go to the documentation of this file.

#ifndef __FBCAMERA_H__
#define __FBCAMERA_H__
/**************************************************************************
 Copyright (c) 1994 - 2009 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 FBSDK_DLL 

    #define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbmodel.h>
#include <fbsdk/fbhud.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

FB_DEFINE_COMPONENT( FBSDK_DLL, Camera           );
FB_DEFINE_COMPONENT( FBSDK_DLL, CameraStereo     );

// FBCamera
__FB_FORWARD( FBCamera );

enum FBCameraFrameSizeMode { 
    kFBFrameSizeWindow,                    
    kFBFrameSizeFixedRatio,                
    kFBFrameSizeFixedResolution,        
    kFBFrameSizeFixedWidthResolution,    
    kFBFrameSizeFixedHeightResolution    
};


enum FBCameraResolutionMode { 
    kFBResolutionCustom,                
    kFBResolutionD1NTSC,                
    kFBResolutionNTSC,                    
    kFBResolutionPAL,                    
    kFBResolutionD1PAL,                    
    kFBResolutionHD,                    
    kFBResolution640x480,                
    kFBResolution320x200,                
    kFBResolution320x240,                
    kFBResolution128x128,                
    kFBResolutionFullScreen                
};


enum FBCameraApertureMode { 
    kFBApertureVertical,                
    kFBApertureHorizontal,                
    kFBApertureVertHoriz,                
    kFBApertureFocalLength                
};


enum FBCameraFilmBackType { 
    kFBFilmBackCustom,                    
    kFBFilmBack16mmTheatrical,            
    kFBFilmBackSuper16mm,                
    kFBFilmBack35mmAcademy,                
    kFBFilmBack35mmTVProjection,        
    kFBFilmBack35mmFullAperture,        
    kFBFilmBack35mm185Projection,        
    kFBFilmBack35mmAnamorphic,            
    kFBFilmBack70mmProjection,            
    kFBFilmBackVistaVision,                
    kFBFilmBackDynavision,                
    kFBFilmBackIMAX                        
};


enum FBCameraViewPlaneMode { 
    kFBViewPlaneDisabled,                
    kFBViewPlaneAlways,                    
    kFBViewPlaneWhenMedia                
};


enum FBCameraDistanceMode { 
    kFBDistModeRelativeToInterest,        
    kFBDistModeAbsoluteFromCamera        
};


enum FBCameraSafeAreaMode { 
    kFBSafeAreaSquare,                    
    kFBSafeAreaRound                    
};


enum FBCameraAntiAliasingMethod    { 
    kFBAntiAliasingSoftware,            
    kFBAntialiasingMultiSamplingOnyx    
};


enum FBCameraSamplingType { 
    kFBSamplingUniform,                    
    kFBSamplingStochastic                
};


enum FBCameraFocusDistanceSource { 
    kFBFocusDistanceCameraInterest,      
    kFBFocusDistanceSpecificDistance,    
    kFBFocusDistanceModel                
};


enum FBCameraType { 
    kFBCameraTypePerspective,            
    kFBCameraTypeOrthogonal                
};


enum FBCameraMatrixType { 
    kFBProjection,                      
    kFBModelView,                       
    kFBModelViewProj,                   
    kFBProjInverse                      
};

FB_DEFINE_ENUM( FBSDK_DLL, CameraType                    ); 
FB_DEFINE_ENUM( FBSDK_DLL, CameraApertureMode            ); 
FB_DEFINE_ENUM( FBSDK_DLL, CameraFilmBackType            ); 
FB_DEFINE_ENUM( FBSDK_DLL, CameraFrameSizeMode           ); 
FB_DEFINE_ENUM( FBSDK_DLL, CameraResolutionMode          ); 
FB_DEFINE_ENUM( FBSDK_DLL, CameraViewPlaneMode           ); 
FB_DEFINE_ENUM( FBSDK_DLL, CameraDistanceMode            ); 
FB_DEFINE_ENUM( FBSDK_DLL, CameraSafeAreaMode            ); 
FB_DEFINE_ENUM( FBSDK_DLL, CameraAntiAliasingMethod      ); 
FB_DEFINE_ENUM( FBSDK_DLL, CameraSamplingType            );
FB_DEFINE_ENUM( FBSDK_DLL, CameraFocusDistanceSource     ); 
FB_DEFINE_ENUM( FBSDK_DLL, CameraMatrixType              ); 

class FBSDK_DLL FBCamera : public FBModel {
    __FBClassDeclare( FBCamera,FBModel );
public:
    FBCamera(const char * pName, HIObject pObject=NULL);

    FBPropertyBool                        SystemCamera;           

    // Camera Format
    FBPropertyCameraFrameSizeMode        FrameSizeMode;          
    FBPropertyCameraResolutionMode        ResolutionMode;         
    FBPropertyDouble                    ResolutionWidth;        
    FBPropertyDouble                    ResolutionHeight;       
    FBPropertyDouble                    WindowWidth;            
    FBPropertyDouble                    WindowHeight;           
    FBPropertyDouble                    PixelAspectRatio;       
    FBPropertyDouble                    NearPlaneDistance;      
    FBPropertyDouble                    FarPlaneDistance;       
    FBPropertyBool                        MouseLockCamera;        
    FBPropertyCameraType                Type;                   
    FBPropertyCameraApertureMode        ApertureMode;           
    FBPropertyAnimatableDouble            FieldOfView;            

    FBPropertyAnimatableDouble            FieldOfViewX;           
    FBPropertyAnimatableDouble            FieldOfViewY;           
    FBPropertyAnimatableDouble            OpticalCenterX;         
    FBPropertyAnimatableDouble            OpticalCenterY;         
    FBPropertyAnimatableDouble            FocalLength;            

    FBPropertyCameraFilmBackType        FilmBackType;           
    FBPropertyDouble                    FilmSizeWidth;          
    FBPropertyDouble                    FilmSizeHeight;         
    FBPropertyDouble                    FilmAspectRatio;        
    FBPropertyDouble                    SqueezeRatio;           
    
    static const double OrthoFactor;    
    
    FBPropertyDouble OrthoZoom;
    

    // Camera Background options
    FBPropertyTexture                    BackGroundTexture;              
    FBPropertyVideo                      BackGroundMedia;                
    FBPropertyCameraViewPlaneMode        ViewBackGroundPlaneMode;        
    FBPropertyBool                       BackGroundImageCenter;          
    FBPropertyBool                       BackGroundImageFit;             
    FBPropertyBool                       BackGroundImageKeepRatio;       
    FBPropertyBool                       BackGroundImageCrop;            
    FBPropertyDouble                     BackGroundPlaneDistance;        
    FBPropertyCameraDistanceMode         BackGroundPlaneDistanceMode;    

    // Camera Foreground options
    FBPropertyAnimatableDouble           ForeGroundAlpha;                
    FBPropertyDouble                     ForeGroundMaterialThreshold;    
    FBPropertyBool                       ForeGroundTransparent;          
    FBPropertyTexture                    ForeGroundTexture;              
    FBPropertyVideo                      ForeGroundMedia;                
    FBPropertyCameraViewPlaneMode        ViewForeGroundPlaneMode;        
    FBPropertyBool                       ForeGroundImageCenter;          
    FBPropertyBool                       ForeGroundImageFit;             
    FBPropertyBool                       ForeGroundImageKeepRatio;       
    FBPropertyBool                       ForeGroundImageCrop;            
    FBPropertyDouble                     ForeGroundPlaneDistance;        
    FBPropertyCameraDistanceMode         ForeGroundPlaneDistanceMode;    

    // Camera View Options
    FBPropertyBool                       ViewCameraInterest;        
    FBPropertyBool                       ViewNearFarPlane;        
    FBPropertyBool                       ViewShowName;            
    FBPropertyBool                       ViewShowGrid;            
    FBPropertyBool                       ViewShowAxis;            
    FBPropertyBool                       ViewShowTimeCode;        
    FBPropertyBool                       ViewDisplaySafeArea;    
    FBPropertyBool                       ViewOpticalCenter;        
    FBPropertyCameraSafeAreaMode         SafeAreaMode;            

    FBPropertyAnimatableColor            BackGroundColor;        
    FBPropertyBool                       UseFrameColor;            
    FBPropertyColor                      FrameColor;                

    // Camera Render Options
        // Rendering Options
    FBPropertyBool                       UseAntiAliasing;        
    FBPropertyAnimatableBool             UseDepthOfField;        
    FBPropertyBool                       InteractiveMode;        

        // Anti-aliasing Options
    FBPropertyDouble                     AntiAliasingIntensity;    
    FBPropertyCameraAntiAliasingMethod   AntiAliasingMethod;        
    FBPropertyInt                        NumberOfSamples;        
    FBPropertyCameraSamplingType         SamplingType;            
    FBPropertyBool                       UseAccumulationBuffer;    
    
        // Depth of Field Options
    FBPropertyCameraFocusDistanceSource  FocusDistanceSource;      
    FBPropertyAnimatableDouble           FocusSpecificDistance;    
    FBPropertyModel                      FocusModel;               
    FBPropertyAnimatableDouble           FocusAngle;               

        // 2D Magnifier
    FBPropertyBool                       Use2DMagnifier;            
    FBPropertyBool                       Display2DMagnifierFrame;
    FBPropertyAnimatableDouble           MagnifierZoom;            
    FBPropertyAnimatableDouble           MagnifierPosX;            
    FBPropertyAnimatableDouble           MagnifierPosY;            

    // Other Attributes
    FBPropertyModel                      Interest;                
    FBPropertyAnimatableDouble           Roll;                    
    FBPropertyAnimatableDouble           TurnTable;                
    FBPropertyBool                       DisplayTurnTableIcon;    

    // MotionBlur
    FBPropertyAnimatableDouble           MotionBlurIntensity;    
    FBPropertyBool                       UseMotionBlur;            
    FBPropertyBool                       UseRealTimeMotionBlur;    

    // Viewport dimension (those property values are only updated & valid during custom renderer callback
    FBPropertyInt                        CameraViewportX;        
    FBPropertyInt                        CameraViewportY;        
    FBPropertyInt                        CameraViewportWidth;    
    FBPropertyInt                        CameraViewportHeight;   

#ifndef K_NO_HUD
    FBPropertyListHUD                    HUDs;                   
#endif

    K_DEPRECATED_2014 double*    GetMatrix( FBCameraMatrixType pType );

    void GetCameraMatrix( FBMatrix& pMatrix, FBCameraMatrixType pType, FBEvaluateInfo* pEvalInfo = NULL );

    FBVector4d InverseProjection( int pX, int pY, double pDistanceFromCamera, bool pRelativeToViewport = false );

/*
BACK-COMP implementation: 
The proper implementation is to change UseDepthOfField from 
FBPropertyBool to FBPropertyAnimatableBool. This breaks 
backward compatibility and should only be done for major releases
*/
    void GetAnimatableFarPlane(FBPropertyAnimatableDouble *pProp);
    void GetAnimatableNearPlane(FBPropertyAnimatableDouble *pProp);
};

// FBCameraStereo
__FB_FORWARD( FBCameraStereo );

/* Stereo Type */
enum FBCameraStereoType 
{ 
    kFBCameraStereoNone,
    kFBCameraStereoConverged,
    kFBCameraStereoOff_Axis,
    kFBCameraStereoParallel
}; 

FB_DEFINE_ENUM( FBSDK_DLL, CameraStereoType); 

class FBSDK_DLL FBCameraStereo : public FBCamera
{
    __FBClassDeclare(FBCameraStereo, FBCamera);
public:
    FBCameraStereo(const char * pName, HIObject pObject=NULL);

    FBPropertyCameraStereoType      Stereo;                         
    FBPropertyAnimatableDouble      InteraxialSeparation;           
    FBPropertyAnimatableDouble      ZeroParallax;                   
    FBPropertyAnimatableDouble      ToeInAdjust;                    
    FBPropertyAnimatableDouble      FilmOffsetRightCam;             
    FBPropertyAnimatableDouble      FilmOffsetLeftCam;              
   
    FBPropertyCamera                RightCamera;                    
    FBPropertyCamera                LeftCamera;                     
    FBPropertyCamera                CenterCamera;                   

    FBPropertyString                PrecompFileName;                
    FBPropertyString                RelativePrecompFileName;        

    FBPropertyBool                  DisplayZeroParallaxPlane;       
    FBPropertyDouble                ZeroParallaxPlaneTransparency;  
    FBPropertyColor                 ZeroParallaxPlaneColor;         
};

// FBPropertyListCamera
class FBSDK_DLL FBPropertyListCamera : public FBPropertyListComponent
{
public:
    FBPropertyListCamera();
    FBCamera* operator[](int pIndex);
};

// FBCameraSwitcher
__FB_FORWARD( FBCameraSwitcher );

class FBSDK_DLL FBCameraSwitcher : public FBModel
{
    __FBClassDeclare( FBCameraSwitcher, FBBox );
public:
    FBCameraSwitcher();

    FBPropertyCamera    CurrentCamera;        
    FBPropertyInt       CurrentCameraIndex; 

    bool PlotToCamera( FBCamera* pCamera );
};


#ifdef FBSDKUseNamespace
    }
#endif
#endif