ktime.h File Reference

#include <fbxfilesdk/fbxfilesdk_def.h>
#include <fbxfilesdk/fbxfilesdk_nsbegin.h>
#include <fbxfilesdk/fbxfilesdk_nsend.h>

Go to the source code of this file.

Classes

class   KTime
  Class to encapsulate time units. More...
class   KTimeSpan
  Class to encapsulate time intervals. More...
class   KTimeModeObject

Defines

#define  KTIME_INFINITE   KTime (K_LONGLONG( 0x7fffffffffffffff))
#define  KTIME_MINUS_INFINITE   KTime (K_LONGLONG(-0x7fffffffffffffff))
#define  KTIME_ZERO   KTime (0)
#define  KTIME_EPSILON   KTime (1)
#define  KTIME_ONE_SECOND   KTime (K_LONGLONG(46186158000))
#define  KTIME_ASSERT_EPSILON   0.5
#define  KTS_FORWARD   1
#define  KTS_BACKWARD   -1
#define  DEFAULT_MODE   KTime::eDEFAULT_MODE
#define  CINEMA   KTime::eCINEMA
#define  PAL   KTime::ePAL
#define  FRAMES30   KTime::eFRAMES30
#define  NTSC_DROP_FRAME   KTime::eNTSC_DROP_FRAME
#define  FRAMES50   KTime::eFRAMES50
#define  FRAMES60   KTime::eFRAMES60
#define  FRAMES100   KTime::eFRAMES100
#define  FRAMES120   KTime::eFRAMES120
#define  NTSC_FULL_FRAME   KTime::eNTSC_FULL_FRAME
#define  FRAMES30_DROP   KTime::eFRAMES30_DROP
#define  FRAMES1000   KTime::eFRAMES1000
#define  TIMEFORMAT_SMPTE   KTime::eSMPTE
#define  TIMEFORMAT_FRAME   KTime::eFRAME
#define  DEFAULT_FORMAT   KTime::eDEFAULT_PROTOCOL

Enumerations

enum   EOldTimeMode {
  eOLD_DEFAULT_MODE, eOLD_CINEMA, eOLD_PAL, eOLD_FRAMES30,
  eOLD_NTSC_DROP_FRAME, eOLD_FRAMES50, eOLD_FRAMES60, eOLD_FRAMES100,
  eOLD_FRAMES120, eOLD_NTSC_FULL_FRAME, eOLD_FRAMES30_DROP, eOLD_FRAMES1000,
  eOLD_TIME_MODE_COUNT
}
 

Keep compatibility with old fbx format

  • eOLD_DEFAULT_MODE Default mode set using KTime::SetGlobalTimeMode (ETimeMode pTimeMode)
  • eOLD_CINEMA 24 frameOLD_s/s
  • eOLD_PAL 25 frameOLD_s/s PAL/SECAM
  • eOLD_FRAMES30 30 frameOLD_s/s BLACK & WHITE NTSC
  • eOLD_NTSC_DROP_FRAME 29.97002617 frameOLD_s/s COLOR NTSC
  • eOLD_FRAMES50 50 frameOLD_s/s
  • eOLD_FRAMES60 60 frameOLD_s/s
  • eOLD_FRAMES100 100 frameOLD_s/s
  • eOLD_FRAMES120 120 frameOLD_s/s
  • eOLD_NTSC_FULL_FRAME 29.97002617 frameOLD_s/s COLOR NTSC
  • eOLD_FRAMES30_DROP 30 frameOLD_s/s
  • eOLD_FRAMES1000 1000 frameOLD_s/s
  • eOLD_TIME_MODE_COUNT.
More...

Functions

  KFBX_FORWARD (KTimeModeObject)
KFBX_DLL KTime::ETimeMode  KTime_GetGlobalTimeMode ()
KFBX_DLL HKTimeModeObject  KTime_GetGlobalTimeModeObject ()
KFBX_DLL KTime::ETimeProtocol  KTime_GetGlobalTimeFormat ()
KFBX_DLL void  KTime_SetGlobalTimeMode (KTime::ETimeMode pTimeMode, double pFrameRate)
KFBX_DLL void  KTime_SetGlobalTimeFormat (KTime::ETimeProtocol pTimeFormat)
KFBX_DLL int  KTime_GetOldTimeModeCorrespondance (KTime::ETimeMode pNewTimeMode)
KFBX_DLL int  KTime_GetTimeModeFromOldValue (int pOldTimeMode)
KFBX_DLL int  KTime_GetTimeModeFromFrameRate (char *pFrameRate)
KFBX_DLL void  KTime_GetControlStringList (char *pControlString, KTime::ETimeProtocol pTimeFormat)
KFBX_DLL char *  KTime_GetGlobalFrameRateString (KTime::ETimeMode pTimeMode)
KFBX_DLL char *  KTime_GetGlobalTimeModeString (KTime::ETimeMode pTimeMode)
KFBX_DLL double  KTime_GetFrameRate (KTime::ETimeMode pTimeMode)
KFBX_DLL int  KTime_SelectionToTimeFormat (int pSelection)
KFBX_DLL int  KTime_SelectionToTimeMode (int pSelection)
KFBX_DLL int  KTime_TimeToSelection (int pTimeMode=KTime::eDEFAULT_MODE, int pTimeFormat=KTime::eDEFAULT_PROTOCOL)
KFBX_DLL char *  KTime_GetTimeModeName (int pTimeMode)
KFBX_DLL int  KTime_GetFrameRateStringListIndex (KTime::ETimeMode pTimeMode)
KFBX_DLL bool  KTime_IsValidCustomFramerate (double pFramerate)
KFBX_DLL bool  KTime_GetNearestCustomFramerate (double pFramerate, double &pNearestRate)

Detailed Description

Definition in file ktime.h.


Define Documentation

#define KTIME_INFINITE   KTime (K_LONGLONG( 0x7fffffffffffffff))

Definition at line 53 of file ktime.h.

#define KTIME_MINUS_INFINITE   KTime (K_LONGLONG(-0x7fffffffffffffff))

Definition at line 54 of file ktime.h.

#define KTIME_ZERO   KTime (0)
#define KTIME_EPSILON   KTime (1)

Definition at line 56 of file ktime.h.

#define KTIME_ONE_SECOND   KTime (K_LONGLONG(46186158000))
Examples:
Animation/main.cxx.

Definition at line 57 of file ktime.h.

#define KTIME_ASSERT_EPSILON   0.5

Definition at line 59 of file ktime.h.

#define KTS_FORWARD   1

Definition at line 542 of file ktime.h.

#define KTS_BACKWARD   -1

Definition at line 543 of file ktime.h.

#define DEFAULT_MODE   KTime::eDEFAULT_MODE

Definition at line 727 of file ktime.h.

#define CINEMA   KTime::eCINEMA

Definition at line 728 of file ktime.h.

#define PAL   KTime::ePAL

Definition at line 729 of file ktime.h.

#define FRAMES30   KTime::eFRAMES30

Definition at line 730 of file ktime.h.

#define NTSC_DROP_FRAME   KTime::eNTSC_DROP_FRAME

Definition at line 731 of file ktime.h.

#define FRAMES50   KTime::eFRAMES50

Definition at line 732 of file ktime.h.

#define FRAMES60   KTime::eFRAMES60

Definition at line 733 of file ktime.h.

#define FRAMES100   KTime::eFRAMES100

Definition at line 734 of file ktime.h.

#define FRAMES120   KTime::eFRAMES120

Definition at line 735 of file ktime.h.

#define NTSC_FULL_FRAME   KTime::eNTSC_FULL_FRAME

Definition at line 736 of file ktime.h.

#define FRAMES30_DROP   KTime::eFRAMES30_DROP

Definition at line 737 of file ktime.h.

#define FRAMES1000   KTime::eFRAMES1000

Definition at line 738 of file ktime.h.

#define TIMEFORMAT_SMPTE   KTime::eSMPTE

Definition at line 739 of file ktime.h.

#define TIMEFORMAT_FRAME   KTime::eFRAME

Definition at line 740 of file ktime.h.

#define DEFAULT_FORMAT   KTime::eDEFAULT_PROTOCOL

Definition at line 741 of file ktime.h.


Enumeration Type Documentation

Keep compatibility with old fbx format

  • eOLD_DEFAULT_MODE Default mode set using KTime::SetGlobalTimeMode (ETimeMode pTimeMode)
  • eOLD_CINEMA 24 frameOLD_s/s
  • eOLD_PAL 25 frameOLD_s/s PAL/SECAM
  • eOLD_FRAMES30 30 frameOLD_s/s BLACK & WHITE NTSC
  • eOLD_NTSC_DROP_FRAME 29.97002617 frameOLD_s/s COLOR NTSC
  • eOLD_FRAMES50 50 frameOLD_s/s
  • eOLD_FRAMES60 60 frameOLD_s/s
  • eOLD_FRAMES100 100 frameOLD_s/s
  • eOLD_FRAMES120 120 frameOLD_s/s
  • eOLD_NTSC_FULL_FRAME 29.97002617 frameOLD_s/s COLOR NTSC
  • eOLD_FRAMES30_DROP 30 frameOLD_s/s
  • eOLD_FRAMES1000 1000 frameOLD_s/s
  • eOLD_TIME_MODE_COUNT.
Enumerator:
eOLD_DEFAULT_MODE 

Default mode set using KTime::SetGlobalTimeMode (ETimeMode pTimeMode)

eOLD_CINEMA 

24 frameOLD_s/s

eOLD_PAL 

25 frameOLD_s/s PAL/SECAM

eOLD_FRAMES30 

30 frameOLD_s/s BLACK & WHITE NTSC

eOLD_NTSC_DROP_FRAME 

29.97002617 frameOLD_s/s COLOR NTSC

eOLD_FRAMES50 

50 frameOLD_s/s

eOLD_FRAMES60 

60 frameOLD_s/s

eOLD_FRAMES100 

100 frameOLD_s/s

eOLD_FRAMES120 

120 frameOLD_s/s

eOLD_NTSC_FULL_FRAME 

29.97002617 frameOLD_s/s COLOR NTSC

eOLD_FRAMES30_DROP 

30 frameOLD_s/s

eOLD_FRAMES1000 

1000 frameOLD_s/s

eOLD_TIME_MODE_COUNT 

Definition at line 663 of file ktime.h.


Function Documentation

KFBX_DLL KTime::ETimeMode KTime_GetGlobalTimeMode ( )
KFBX_DLL HKTimeModeObject KTime_GetGlobalTimeModeObject ( )
KFBX_DLL KTime::ETimeProtocol KTime_GetGlobalTimeFormat ( )
KFBX_DLL void KTime_SetGlobalTimeMode ( KTime::ETimeMode  pTimeMode,
double  pFrameRate 
)
KFBX_DLL void KTime_SetGlobalTimeFormat ( KTime::ETimeProtocol  pTimeFormat )
KFBX_DLL int KTime_GetOldTimeModeCorrespondance ( KTime::ETimeMode  pNewTimeMode )
KFBX_DLL int KTime_GetTimeModeFromOldValue ( int  pOldTimeMode )
KFBX_DLL int KTime_GetTimeModeFromFrameRate ( char *  pFrameRate )
KFBX_DLL void KTime_GetControlStringList ( char *  pControlString,
KTime::ETimeProtocol  pTimeFormat 
)
KFBX_DLL char* KTime_GetGlobalFrameRateString ( KTime::ETimeMode  pTimeMode )
KFBX_DLL char* KTime_GetGlobalTimeModeString ( KTime::ETimeMode  pTimeMode )
KFBX_DLL double KTime_GetFrameRate ( KTime::ETimeMode  pTimeMode )
KFBX_DLL int KTime_SelectionToTimeFormat ( int  pSelection )
KFBX_DLL int KTime_SelectionToTimeMode ( int  pSelection )
KFBX_DLL int KTime_TimeToSelection ( int  pTimeMode = KTime::eDEFAULT_MODE,
int  pTimeFormat = KTime::eDEFAULT_PROTOCOL 
)
KFBX_DLL char* KTime_GetTimeModeName ( int  pTimeMode )
KFBX_DLL int KTime_GetFrameRateStringListIndex ( KTime::ETimeMode  pTimeMode )
KFBX_DLL bool KTime_IsValidCustomFramerate ( double  pFramerate )
KFBX_DLL bool KTime_GetNearestCustomFramerate ( double  pFramerate,
double &  pNearestRate 
)