fbxvideo.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 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 _FBXSDK_SCENE_VIDEO_H_
#define _FBXSDK_SCENE_VIDEO_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxobject.h>
#include <fbxsdk/core/base/fbxerror.h>
#include <fbxsdk/core/math/fbxvector2.h>

#include <fbxsdk/scene/fbxgroupname.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FBXSDK_DLL FbxVideo : public FbxObject
{
    FBXSDK_OBJECT_DECLARE(FbxVideo, FbxObject);

public:

        void Reset();

        void ImageTextureSetMipMap(bool pUseMipMap);

        bool ImageTextureGetMipMap() const;

        bool SetFileName(char const* pName);

        FbxString 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(FbxTime pTime);

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

        void SetFreeRunning(bool pState);

        bool GetFreeRunning() const;


        void SetLoop(bool pLoop);

        bool GetLoop() const;


        enum EInterlaceMode
        {
            eNone,           
            eFields,         
            eHalfEven,       
            eHalfOdd,        
            eFullEven,       
            eFullOdd,        
            eFullEvenOdd,    
            eFullOddEven     
        };

        void SetInterlaceMode(EInterlaceMode pInterlaceMode);

        EInterlaceMode GetInterlaceMode() const;


        enum EAccessMode
        {
            eDisk,
            eMemory,
            eDiskAsync
        };

        void SetAccessMode(EAccessMode pAccessMode);

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

        enum EErrorCode
        {
            eTakeNodeError,
            eErrorCount        
        };

        EErrorCode GetLastErrorID() const;

        const char* GetLastErrorString() const;

#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
    FbxVideo(FbxManager& pManager, char const* pName);

    virtual void Construct(const FbxVideo* pFrom);
    virtual bool ConstructProperties(bool pForceSet);
    virtual bool ConnecNotify(FbxConnectEvent const &pEvent);

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

    virtual FbxStringList GetTypeFlags() const;

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

    FbxPropertyT<FbxBool>   ImageSequence;
    FbxPropertyT<FbxInt> ImageSequenceOffset;
    FbxPropertyT<FbxDouble> FrameRate;
    FbxPropertyT<FbxInt> LastFrame;
    FbxPropertyT<FbxInt> Width;
    FbxPropertyT<FbxInt> Height;
    FbxPropertyT<FbxString> Path;
    FbxPropertyT<FbxInt> StartFrame;
    FbxPropertyT<FbxInt> StopFrame;
    FbxPropertyT<FbxDouble> PlaySpeed;
    FbxPropertyT<FbxTime> Offset;
    FbxPropertyT<EInterlaceMode> InterlaceMode;
    FbxPropertyT<FbxBool> FreeRunning;
    FbxPropertyT<FbxBool> Loop;
    FbxPropertyT<EAccessMode> AccessMode;

protected:
    void Init();

    static FbxError smError;

    bool                   mUseMipMap;
    bool                   mOriginalFormat;
    FbxString                mOriginalFilename;

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

inline EFbxType FbxTypeOf(const FbxVideo::EInterlaceMode&){ return eFbxEnum; }
inline EFbxType FbxTypeOf(const FbxVideo::EAccessMode&){ return eFbxEnum; }

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_SCENE_VIDEO_H_ */