fbxmediaclip.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2017 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_MEDIACLIP_H_
#define _FBXSDK_SCENE_MEDIACLIP_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxobject.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FBXSDK_DLL FbxMediaClip : public FbxObject
{
    FBXSDK_ABSTRACT_OBJECT_DECLARE(FbxMediaClip, FbxObject);

public:
        virtual void Reset();

        virtual bool SetFileName(const char* pName);

        FbxString GetFileName () const;

        virtual bool SetRelativeFileName(const char* pName);

        FbxString GetRelativeFileName() const;

        void SetColor(FbxColor pColor);

        FbxColor GetColor() const;

        void SetPlaySpeed(double pPlaySpeed);

        double GetPlaySpeed() const;

        void SetClipIn(FbxTime pTime);

        FbxTime GetClipIn() const;

        void SetClipOut(FbxTime pTime);

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

        void SetMute(bool pMute);

        bool GetMute() const;

        enum EAccessMode
        {
            eDisk,
            eMemory,
            eDiskAsync
        };

        void SetAccessMode(EAccessMode pAccessMode);

        EAccessMode GetAccessMode() const;
    
/*****************************************************************************************************************************
** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
*****************************************************************************************************************************/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
    virtual void Construct(const FbxObject* pFrom);
    virtual void ConstructProperties(bool pForceSet);

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<FbxDouble3>    Color;
    FbxPropertyT<FbxTime>       ClipIn;
    FbxPropertyT<FbxTime>       ClipOut;
    FbxPropertyT<FbxTime>       Offset;
    FbxPropertyT<FbxDouble>     PlaySpeed;
    FbxPropertyT<FbxBool>       FreeRunning;
    FbxPropertyT<FbxBool>       Loop;
    FbxPropertyT<FbxBool>       Mute;
    FbxPropertyT<EAccessMode>   AccessMode;

protected:
    void Init();
    FbxPropertyT<FbxString>     Path;
    FbxPropertyT<FbxString>     RelPath;

    bool        mOriginalFormat;
    FbxString   mOriginalFilename;

#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

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

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_SCENE_MEDIACLIP_H_ */