KFbxGlobalTimeSettings Class Reference

#include <kfbxglobaltimesettings.h>

List of all members.

Detailed Description

This class contains functions for accessing global time settings.

Definition at line 65 of file kfbxglobaltimesettings.h.

Error Management

enum  EError
 Error identifiers. More...
KError & GetError ()
 Retrieve error object.
EError GetLastErrorID ()
 Get last error code.
char * GetLastErrorString ()
 Get last error string.

Timeline Time span

void SetTimelineDefautTimeSpan (const KTimeSpan &pTimeSpan)
 Set Timeline default time span.
void GetTimelineDefautTimeSpan (KTimeSpan &pTimeSpan) const
 Get Timeline default time span.

Time Markers

int GetTimeMarkerCount ()
 Get number of time markers.
bool SetCurrentTimeMarker (int pIndex)
 Set current time marker index.
int GetCurrentTimeMarker ()
 Get current time marker index.
KFbxTimeMarker * GetTimeMarker (int pIndex)
 Get time marker at given index.
void AddTimeMarker (KFbxTimeMarker pTimeMarker)
 Add a time marker.
void RemoveAllTimeMarkers ()
 Remove all time markers and set current time marker to -1.

Obsolete Functions

These functions still work but are no longer relevant.

void SetSnapOnFrame (bool pSnapOnFrame)
 Set snap on frame flag.
bool GetSnapOnFrame ()
 Get snap on frame flag.

Public Types

enum  ESnapOnFrameMode
 Snap on frame mode
  • eNO_SNAP
  • eSNAP_ON_FRAME
  • ePLAY_ON_FRAME
  • eSNAP_PLAY_ON_FRAME.
More...

Public Member Functions

void RestoreDefaultSettings ()
 Restore default settings.
void SetTimeMode (KTime::ETimeMode pTimeMode)
 Set time mode.
KTime::ETimeMode GetTimeMode ()
 Get time mode.
void SetTimeProtocol (KTime::ETimeProtocol pTimeProtocol)
 Set time protocol.
KTime::ETimeProtocol GetTimeProtocol ()
 Get time protocol.
void SetSnapOnFrameMode (ESnapOnFrameMode pSnapOnFrameMode)
 Set snap on frame mode.
ESnapOnFrameMode GetSnapOnFrameMode ()
 Get snap on frame mode.
const KFbxGlobalTimeSettings & operator= (const KFbxGlobalTimeSettings &pGlobalTimeSettings)
 Assignment operator.

Classes

struct  KFbxTimeMarker

Member Enumeration Documentation

enum ESnapOnFrameMode

Snap on frame mode

  • eNO_SNAP
  • eSNAP_ON_FRAME
  • ePLAY_ON_FRAME
  • eSNAP_PLAY_ON_FRAME.

Definition at line 99 of file kfbxglobaltimesettings.h.

enum EError

Error identifiers.

Most of these are only used internally.

  • eINDEX_OUT_OF_RANGE
  • eERROR_COUNT

Definition at line 202 of file kfbxglobaltimesettings.h.

Member Function Documentation

void RestoreDefaultSettings (  ) 

Restore default settings.

void SetTimeMode ( KTime::ETimeMode  pTimeMode  ) 

Set time mode.

Parameters:
pTimeMode One of the defined modes in class KTime.

KTime::ETimeMode GetTimeMode (  ) 

Get time mode.

Returns:
The currently set TimeMode.

void SetTimeProtocol ( KTime::ETimeProtocol  pTimeProtocol  ) 

Set time protocol.

Parameters:
pTimeProtocol One of the defined protocols in class KTime.

KTime::ETimeProtocol GetTimeProtocol (  ) 

Get time protocol.

Returns:
The currently set TimeProtocol.

void SetSnapOnFrameMode ( ESnapOnFrameMode  pSnapOnFrameMode  ) 

Set snap on frame mode.

Parameters:
pSnapOnFrameMode One of the following values: eNO_SNAP, eSNAP_ON_FRAME, ePLAY_ON_FRAME, or eSNAP_PLAY_ON_FRAME.

ESnapOnFrameMode GetSnapOnFrameMode (  ) 

Get snap on frame mode.

Returns:
The currently set FrameMode.

void SetTimelineDefautTimeSpan ( const KTimeSpan &  pTimeSpan  ) 

Set Timeline default time span.

Parameters:
pTimeSpan The time span of the time line.

void GetTimelineDefautTimeSpan ( KTimeSpan &  pTimeSpan  )  const

Get Timeline default time span.

Parameters:
pTimeSpan return the default time span for the time line.

int GetTimeMarkerCount (  ) 

Get number of time markers.

Returns:
The number of time markers.

bool SetCurrentTimeMarker ( int  pIndex  ) 

Set current time marker index.

Parameters:
pIndex Current time marker index.
Returns:
true if successful, or false if pIndex is invalid.
Remarks:
If pIndex is invalid, KFbxGlobalTimeSettings::GetLastErrorID() returns eINDEX_OUT_OF_RANGE.

int GetCurrentTimeMarker (  ) 

Get current time marker index.

Returns:
Current time marker index, or -1 if the current time marker has not been set.

KFbxTimeMarker* GetTimeMarker ( int  pIndex  ) 

Get time marker at given index.

Parameters:
pIndex Time marker index.
Returns:
Pointer to the time marker at pIndex, or NULL if the index is out of range.
Remarks:
If pIndex is out of range, KFbxGlobalTimeSettings::GetLastErrorID() returns eINDEX_OUT_OF_RANGE.

void AddTimeMarker ( KFbxTimeMarker  pTimeMarker  ) 

Add a time marker.

Parameters:
pTimeMarker New time marker.

void RemoveAllTimeMarkers (  ) 

Remove all time markers and set current time marker to -1.

const KFbxGlobalTimeSettings& operator= ( const KFbxGlobalTimeSettings &  pGlobalTimeSettings  ) 

Assignment operator.

KError& GetError (  ) 

Retrieve error object.

Returns:
Reference to error object.

EError GetLastErrorID (  ) 

Get last error code.

Returns:
Last error code.

char* GetLastErrorString (  ) 

Get last error string.

Returns:
Textual description of the last error.

void SetSnapOnFrame ( bool  pSnapOnFrame  ) 

Set snap on frame flag.

Parameters:
pSnapOnFrame If true, snap on frame mode is set to eSNAP_ON_FRAME. If false, snap on frame mode is set to eNO_SNAP.
Remarks:
This function is replaced by KFbxGlobalTimeSettings::SetSnapOnFrameMode().

bool GetSnapOnFrame (  ) 

Get snap on frame flag.

Returns:
true if snap on frame mode is set to either eSNAP_ON_FRAME or ePLAY_ON_FRAME. false if snap on frame mode is set to eNO_SNAP.
Remarks:
This function is replaced by KFbxGlobalTimeSettings::GetSnapOnFrameMode().