fbplayercontrol.h

Go to the documentation of this file.

#ifndef __FBPLAYERCONTROL_H__
#define __FBPLAYERCONTROL_H__
/**************************************************************************
Copyright (c) 1994 - 2013 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

// Essential includes
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbcommand.h>

#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {;
#endif

enum FBTransportMode {  
    kFBTransportPlay,               kFBTransportPlayPrepare,        kFBTransportPlayReady,
    kFBTransportStop,               kFBTransportStopPost,           kFBTransportStopReady,
    kFBTransportShuttle,            kFBTransportShuttlePrepare,     kFBTransportShuttleReady,
    kFBTransportPlayReverse,        kFBTransportPlayReversePrepare, kFBTransportPlayReverseReady,
    kFBTransportJog,                kFBTransportJogPrepare,         kFBTransportJogReady,
    kFBTransportGoto,               kFBTransportGotoPrepare,        kFBTransportGotoReady,
    kFBTransportStepForward,        kFBTransportStepForwardPrepare, kFBTransportStepForwardReady,
    kFBTransportStepBackward,       kFBTransportStepBackwardPrepare,kFBTransportStepBackwardReady
};
FB_DEFINE_ENUM( FBSDK_DLL, TransportMode );

enum FBTransportTimeFormat
{
    kFBTimeFormatTimecode, 
    kFBTimeFormatFrame, 
};

FB_DEFINE_ENUM(FBSDK_DLL, TransportTimeFormat);


enum FBTransportPlaySpeed
{
    kFBSpeed_1_10x, 
    kFBSpeed_1_5x,  
    kFBSpeed_1_4x,  
    kFBSpeed_1_3x,  
    kFBSpeed_1_2x,  
    kFBSpeed_1x,    
    kFBSpeed_ALL_FR, 
    kFBSpeed_2x,    
    kFBSpeed_3x,    
    kFBSpeed_4x,    
    kFBSpeed_5x,    
    kFBSpeed_10x,    
    kFBSpeed_Custom 
};
FB_DEFINE_ENUM( FBSDK_DLL, TransportPlaySpeed);

enum FBTransportSnapMode
{
    kFBTransportSnapModeNoSnap,              
    kFBTransportSnapModeSnapOnFrames,        
    kFBTransportSnapModePlayOnFrames,        
    kFBTransportSnapModeSnapAndPlayOnFrames, 
};
FB_DEFINE_ENUM( FBSDK_DLL, TransportSnapMode );

enum FBPlayerControlChangeType {
    kFBPlayerControlNone,           
    kFBPlayerControlPlay,           
    kFBPlayerControlPlayReverse,    
    kFBPlayerControlStop,           
    kFBPlayerControlStepForward,    
    kFBPlayerControlStepBackward,   
    kFBPlayerControlGoto,           
    kFBPlayerControlRecordModeOn,   
    kFBPlayerControlRecordModeOff,  
};
FB_DEFINE_ENUM( FBSDK_DLL, PlayerControlChangeType );

// FBEventPlayerControlChange
__FB_FORWARD( FBEventPlayerControlChange );

class FBSDK_DLL FBEventPlayerControlChange: public FBEvent 
{
    public:
        FBEventPlayerControlChange( HKEventBase pEvent );       

        FBPropertyPlayerControlChangeType   Type;            
};


// FBPlayerControl
__FB_FORWARD( FBPlayerControl );

class FBSDK_DLL FBPlayerControl : public FBComponent {
    __FBClassDeclare( FBPlayerControl,FBComponent );
public:

    FBPlayerControl(HIObject pObject=NULL);

    bool Play(bool pUseMarkers = false);

    bool PlayReverse(bool pUseMarkers = false);

    void SetPlaySpeedMode (FBTransportPlaySpeed pPlaySpeedMode);

    void SetPlaySpeed(double pSpeed);

    FBTransportPlaySpeed GetPlaySpeedMode();

    double GetPlaySpeed();

    K_DEPRECATED_2016 void SetPlaySpeed (FBTransportPlaySpeed pPlaySpeed );
    
    bool Stop();

    bool GotoStart();

    bool GotoEnd();

    bool Goto( FBTime pTime );

    bool StepForward();

    bool StepBackward();

    bool Record( bool pOverrideTake=false,bool pCopyData=true );

    void LockTransport( bool pLock );

    bool IsLocked(); 

    FBTransportMode GetTransportMode();

    void       SetTransportFps ( FBTimeMode pTimeMode, double pCustom=0.0);

    FBTimeMode GetTransportFps ();

    double     GetTransportFpsValue ( FBTimeMode pTimeMode = kFBTimeModeDefault );

    void Key();

    void GotoNextKey();

    void GotoPreviousKey();

    void EvaluationPause();

    void EvaluationResume();

    FBPropertyBool  LoopActive;     
    FBPropertyTime  LoopStart;      
    FBPropertyTime  LoopStop;       

    FBPropertyTime  ZoomWindowStart;    
    FBPropertyTime  ZoomWindowStop;     

    FBPropertyTime  NextMarker;     
    FBPropertyTime  PreviousMarker; 

    FBPropertyBool  IsRecording;    
    FBPropertyBool  IsPlaying;      
    FBPropertyBool  IsPlotting;     

    FBPropertyTransportSnapMode SnapMode;   

    FBPropertyTransportTimeFormat TransportTimeFormat; 

    FBPropertyTime  RecordingSamplingPeriod;    
    FBPropertyTime  PlotSamplingPeriod;         

    FBPropertyEvent OnChange;                   

    static FBPlayerControl& TheOne();

    bool Goto( FBTime, FBTimeReferential );

    bool GotoStart( FBTimeReferential );

    bool GotoEnd( FBTimeReferential );

    bool StepForward( FBTimeReferential );

    bool StepBackward( FBTimeReferential );

    FBTimeReferential GetTimeReferential();

    void SetTimeReferential(FBTimeReferential pTimeReferential);

    FBTime GetEditCurrentTime();

    FBTime GetEditStart();

    void SetEditStart(FBTime pTime);

    FBTime GetEditStop();

    void SetEditStop(FBTime pTime);

    FBTime GetEditZoomStart();

    void SetEditZoomStart(FBTime pTime);

    FBTime GetEditZoomStop();

    void SetEditZoomStop(FBTime pTime);

    int AddGlobalTimeMark( FBTime pTime, const char* pName = NULL );

    bool DeleteGlobalTimeMark( int pIndex );

    void DeleteAllGlobalTimeMarks();

    int GetGlobalTimeMarkCount();

    FBTime GetGlobalTimeMarkTime( int pIndex );

    int SetGlobalTimeMarkTime( int pIndex, FBTime pTime );

    const char* GetGlobalTimeMarkName( int pIndex );

    bool SetGlobalTimeMarkName( int pIndex, const char* pName );

    FBTimeMarkAction GetGlobalTimeMarkAction( int pIndex );

    bool SetGlobalTimeMarkAction( int pIndex, FBTimeMarkAction pAction );

    FBColor GetGlobalTimeMarkColor( int pIndex );

    bool SetGlobalTimeMarkColor( int pIndex, FBColor pColor );

    int GetNextGlobalTimeMarkIndex();

    int GetPreviousGlobalTimeMarkIndex();
};

// FBReferenceTime
__FB_FORWARD( FBReferenceTime );

class FBSDK_DLL FBReferenceTime : public FBComponent {
    __FBClassDeclare( FBReferenceTime,FBComponent );
public:
    FBReferenceTime(HIObject pObject=NULL);

    int    Add( const char *pName );

    void   Remove( int pIndex );

    void   SetTime( int pIndex, FBTime pReferenceTime, FBTime pSystem );
    FBTime GetTime( int pIndex, FBTime pSystem );

    const char *operator[](int pIndex);

    FBPropertyInt               Count;          
    FBPropertyInt               ItemIndex;      
};

#ifdef FBSDKUseNamespace
} // namespace FBSDKNamespace
#endif

#endif