kfbxvideo.h

Go to the documentation of this file.

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

   Copyright (C) 2011 Autodesk, Inc.
   All rights reserved.

   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.

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

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXVIDEO_H
#define FBXFILESDK_KFBXPLUGINS_KFBXVIDEO_H


#include <fbxfilesdk/fbxfilesdk_def.h>

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

#include <fbxfilesdk/kfbxmath/kfbxvector2.h>
#include <fbxfilesdk/kfbxplugins/kfbxgroupname.h>
#include <fbxfilesdk/kfbxplugins/kfbxobject.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFBX_DLL KFbxVideo : public KFbxObject
{
    KFBXOBJECT_DECLARE(KFbxVideo, KFbxObject);

public:

        void Reset();

        void ImageTextureSetMipMap(bool pUseMipMap);

        bool ImageTextureGetMipMap() const;

        bool SetFileName(char const* pName);

        KString GetFileName () const;

        bool SetRelativeFileName(char const* pName);

        const char* GetRelativeFileName() const;

        void SetImageSequence(bool pImageSequence);

        bool GetImageSequence() const;

        void SetImageSequenceOffset(int pOffset);

        int GetImageSequenceOffset() const;

        double GetFrameRate() const;

        int GetLastFrame() const;

        int GetWidth() const;

        int GetHeight() const;

        void SetStartFrame(int pStartFrame);

        int GetStartFrame() const;

        void SetStopFrame(int pStopFrame);

        int GetStopFrame() const;

        void SetPlaySpeed(double pPlaySpeed);

        double GetPlaySpeed() const;

        void SetOffset(KTime pTime);

        /* Retrieve the time offset.
         * \return     The current time shift.
         */
        KTime GetOffset() const;

        void SetFreeRunning(bool pState);

        bool GetFreeRunning() const;


        void SetLoop(bool pLoop);

        bool GetLoop() const;


        typedef enum
        {
            None,           
            Fields,         
            HalfEven,       
            HalfOdd,        
            FullEven,       
            FullOdd,        
            FullEvenOdd,    
            FullOddEven     
        } EInterlaceMode;

        void SetInterlaceMode(EInterlaceMode pInterlaceMode);

        EInterlaceMode GetInterlaceMode() const;


        typedef enum
        {
            Disk,
            Memory,
            DiskAsync
        } EAccessMode;

        void SetAccessMode(EAccessMode pAccessMode);

        EAccessMode GetAccessMode() const;
    
        KError& GetError();

        typedef enum
        {
            eTAKE_NODE_ERROR,
            eERROR_COUNT        
        } EError;

        EError GetLastErrorID() const;

        const char* GetLastErrorString() const;

#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
    KFbxVideo(KFbxSdkManager& pManager, char const* pName);

    virtual void Construct(const KFbxVideo* pFrom);
    virtual bool ConstructProperties(bool pForceSet);
    virtual bool ConnecNotify(KFbxConnectEvent const &pEvent);

public:
    virtual KFbxObject& Copy(const KFbxObject& pObject);

    virtual KStringList GetTypeFlags() const;

    void SetOriginalFormat(bool pState);
    bool GetOriginalFormat() const;
    void SetOriginalFilename(const char* pOriginalFilename);
    const char* GetOriginalFilename() const;

protected:
    void Init();

    static KError smError;

    KFbxTypedProperty<fbxBool1>   ImageSequence;
    KFbxTypedProperty<fbxInteger1> ImageSequenceOffset;
    KFbxTypedProperty<fbxDouble1> FrameRate;
    KFbxTypedProperty<fbxInteger1> LastFrame;
    KFbxTypedProperty<fbxInteger1> Width;
    KFbxTypedProperty<fbxInteger1> Height;
    KFbxTypedProperty<fbxString> Path;
    KFbxTypedProperty<fbxInteger1> StartFrame;
    KFbxTypedProperty<fbxInteger1> StopFrame;
    KFbxTypedProperty<fbxDouble1> PlaySpeed;
    KFbxTypedProperty<fbxTime> Offset;
    KFbxTypedProperty<EInterlaceMode> InterlaceMode;
    KFbxTypedProperty<fbxBool1> FreeRunning;
    KFbxTypedProperty<fbxBool1> Loop;
    KFbxTypedProperty<EAccessMode> AccessMode;

    bool                   mUseMipMap;
    bool                   mOriginalFormat;
    KString                mOriginalFilename;

    // Temporary values
    KString                mRelativeFilename;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

typedef KFbxVideo* HKFbxVideo;

inline EFbxType FbxTypeOf( KFbxVideo::EInterlaceMode const &pItem ) { return eENUM; }
inline EFbxType FbxTypeOf( KFbxVideo::EAccessMode const &pItem ) { return eENUM; }

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXVIDEO_H