kfbxcamerastereo.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXCAMERASTEREO_H
#define FBXFILESDK_KFBXPLUGINS_KFBXCAMERASTEREO_H

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

Copyright (C) 2001 - 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 <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
#include <fbxfilesdk/components/kbaselib/kaydara.h>

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

#include <fbxfilesdk/kfbxmath/kfbxvector4.h>

#include <fbxfilesdk/components/kbaselib/klib/kstring.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFBX_DLL KFbxCameraStereo : public KFbxCamera
{
    KFBXOBJECT_DECLARE(KFbxCameraStereo, KFbxCamera);

public:

    virtual EAttributeType GetAttributeType() const;

    void Reset();


    typedef enum
    {
        eNONE,
        eCONVERGED,
        eOFF_AXIS,
        ePARALLEL
    } ECameraStereo;

    KFbxCamera* GetLeftCamera();

    KFbxCamera* GetRightCamera();

    bool SetLeftCamera(KFbxCamera* pCamera);

    bool SetRightCamera(KFbxCamera* pCamera);

    KFbxXMatrix GetLeftCameraLocalMatrix();

    KFbxXMatrix GetLeftCameraGlobalMatrix();

    KFbxXMatrix GetRightCameraLocalMatrix();

    KFbxXMatrix GetRightCameraGlobalMatrix();

    KFbxXMatrix GetStereoCameraLocalMatrix();

    KFbxXMatrix GetStereoCameraGlobalMatrix();

    double ReevaluateLeftCameraFilmOffsetX();

    double ReevaluateRightCameraFilmOffsetX();

    //
    // Properties
    //

    // -----------------------------------------------------------------------
    // Stereo and Stereo Adjustments
    // -----------------------------------------------------------------------

    KFbxTypedProperty<ECameraStereo>                    Stereo;

    KFbxTypedProperty<fbxDouble1>                       InteraxialSeparation;

    KFbxTypedProperty<fbxDouble1>                       ZeroParallax;

    KFbxTypedProperty<fbxDouble1>                       ToeInAdjust;

    KFbxTypedProperty<fbxDouble1>                       FilmOffsetRightCam;

    KFbxTypedProperty<fbxDouble1>                       FilmOffsetLeftCam;

    KFbxTypedProperty<fbxDouble1>                       ZeroOffset;

    KFbxTypedProperty<fbxReference>                     RightCamera;

    KFbxTypedProperty<fbxReference>                     LeftCamera;


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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    KFbxTypedProperty<fbxString>                        PrecompFileName;

    KFbxTypedProperty<fbxString>                        RelativePrecompFileName;

public:
    bool ConnectProperties();

    friend class KFbxGlobalCameraSettings;

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

protected:
    KFbxCameraStereo& operator=(KFbxCameraStereo const& pCameraStereo);

    KFbxCameraStereo(KFbxSdkManager& pManager, char const* pName);

    virtual bool ConstructProperties(bool pForceSet);

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

private:
    friend class KFbxNode;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

typedef KFbxCameraStereo* HKFbxCameraStereo;

inline EFbxType FbxTypeOf( KFbxCameraStereo::ECameraStereo const &pItem )         { return eENUM; }

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXCAMERASTEREO_H