KFbxGlobalTimeSettings Class Reference

#include <kfbxglobaltimesettings.h>

List of all members.


Detailed Description

This class contains functions for accessing global time settings.
Remarks:
This class exists for FBX version 6.x and earlier. The new FBX v7.x file format that is now the default no longer uses it. The relevant data (a subset of this class) has been moved to the KFbxGlobalSettings object and should be used instead.

Definition at line 58 of file kfbxglobaltimesettings.h.


Error Management

enum   EError {
   eINDEX_OUT_OF_RANGE,
   eERROR_COUNT
}
  Error identifiers, most of these are only used internally. More...
KError GetError ()
  Retrieves the error object.
EError  GetLastErrorID () const
  Returns the last error code.
const char *  GetLastErrorString () const
  Returns the last error string.

Time span of time line

void  SetTimelineDefautTimeSpan (const KTimeSpan &pTimeSpan)
  Sets the default time span of time line.
void  GetTimelineDefautTimeSpan (KTimeSpan &pTimeSpan) const
  Returns the default time span of time line.

Time Markers

int  GetTimeMarkerCount () const
  Returns the number of time markers.
bool  SetCurrentTimeMarker (int pIndex)
  Sets the index of the current time marker.
int  GetCurrentTimeMarker () const
  Returns the current time marker index.
KFbxTimeMarker GetTimeMarker (int pIndex) const
  Returns the time marker at the given index.
void  AddTimeMarker (KFbxTimeMarker pTimeMarker)
  Adds a time marker.
void  RemoveAllTimeMarkers ()
  Removes all time markers and sets the current time marker index to -1.

Obsolete Functions

These functions still work but are no longer relevant.

void  SetSnapOnFrame (bool pSnapOnFrame)
  Sets the snap on frame mode flag.
bool  GetSnapOnFrame () const
  Returns the snap on frame mode flag.

Public Types

enum   ESnapOnFrameMode {
   eNO_SNAP,
   eSNAP_ON_FRAME,
   ePLAY_ON_FRAME,
   eSNAP_PLAY_ON_FRAME
}
  Snap on frame mode. More...

Public Member Functions

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

Classes

struct   KFbxTimeMarker
  This is a struct to define time markers. More...

Member Enumeration Documentation

Snap on frame mode.

  • eNO_SNAP
  • eSNAP_ON_FRAME
  • ePLAY_ON_FRAME
  • eSNAP_PLAY_ON_FRAME
Enumerator:
eNO_SNAP 
eSNAP_ON_FRAME 
ePLAY_ON_FRAME 
eSNAP_PLAY_ON_FRAME 

Definition at line 93 of file kfbxglobaltimesettings.h.

enum EError

Error identifiers, most of these are only used internally.

  • eINDEX_OUT_OF_RANGE
  • eERROR_COUNT
Enumerator:
eINDEX_OUT_OF_RANGE 
eERROR_COUNT 

Definition at line 213 of file kfbxglobaltimesettings.h.


Member Function Documentation

KFBXNEW_DECLARE_FRIEND void RestoreDefaultSettings (  ) 

Restores the default settings.

void SetTimeMode ( KTime::ETimeMode  pTimeMode  ) 

Sets the time mode.

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

KTime::ETimeMode GetTimeMode (  )  const

Returns the time mode.

Returns:
The currently set time mode.

void SetTimeProtocol ( KTime::ETimeProtocol  pTimeProtocol  ) 

Sets the time protocol.

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

KTime::ETimeProtocol GetTimeProtocol (  )  const

Returns the time protocol.

Returns:
The currently set time protocol.

void SetSnapOnFrameMode ( ESnapOnFrameMode  pSnapOnFrameMode  ) 

Sets the 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 (  )  const

Returns the snap on frame mode.

Returns:
The currently set snap on frame mode.

void SetTimelineDefautTimeSpan ( const KTimeSpan pTimeSpan  ) 

Sets the default time span of time line.

Parameters:
pTimeSpan  The time span of time line.

void GetTimelineDefautTimeSpan ( KTimeSpan pTimeSpan  )  const

Returns the default time span of time line.

Parameters:
pTimeSpan  Holds the default time span of time line.

int GetTimeMarkerCount (  )  const

Returns the number of time markers.

Returns:
The number of time markers.

bool SetCurrentTimeMarker ( int  pIndex  ) 

Sets the index of the current time marker.

Parameters:
pIndex  The current time marker index.
Returns:
True if successful, or returns false if the index is not valid.
Remarks:
If the index is not valid, KFbxGlobalTimeSettings::GetLastErrorID() returns eINDEX_OUT_OF_RANGE.

int GetCurrentTimeMarker (  )  const

Returns the current time marker index.

Returns:
The current time marker index, or -1 if no current time marker has been set.

KFbxTimeMarker* GetTimeMarker ( int  pIndex  )  const

Returns the time marker at the given index.

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

void AddTimeMarker ( KFbxTimeMarker  pTimeMarker  ) 

Adds a time marker.

Parameters:
pTimeMarker  The new time marker to be added.

void RemoveAllTimeMarkers (  ) 

Removes all time markers and sets the current time marker index to -1.

const KFbxGlobalTimeSettings& operator= ( const KFbxGlobalTimeSettings pGlobalTimeSettings  ) 

Assignment operator.

Parameters:
pGlobalTimeSettings  KFbxGlobalTimeSettings object assigned to this one.

KError& GetError (  ) 

Retrieves the error object.

Returns:
Reference to the error object.

EError GetLastErrorID (  )  const

Returns the last error code.

Returns:
The last error code.

const char* GetLastErrorString (  )  const

Returns the last error string.

Returns:
Text description of the last error.

void SetSnapOnFrame ( bool  pSnapOnFrame  ) 

Sets the snap on frame mode 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 (  )  const

Returns the snap on frame mode flag.

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