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.

#include <kfbxglobaltimesettings.h>

Classes
struct	KFbxTimeMarker
	This is a struct to define time markers. More...
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.
Friends
class	KFbxScene
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.
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.
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.

Member Enumeration Documentation

enum ESnapOnFrameMode

Search for all occurrences

Snap on frame mode.

eNO_SNAP
eSNAP_ON_FRAME
ePLAY_ON_FRAME
eSNAP_PLAY_ON_FRAME

Enumerator:

eNO_SNAP	Search for all occurrences
eSNAP_ON_FRAME	Search for all occurrences
ePLAY_ON_FRAME	Search for all occurrences
eSNAP_PLAY_ON_FRAME	Search for all occurrences

Definition at line 93 of file kfbxglobaltimesettings.h.

    {
        eNO_SNAP,
        eSNAP_ON_FRAME,
        ePLAY_ON_FRAME,
        eSNAP_PLAY_ON_FRAME
    } ESnapOnFrameMode;

enum EError

Search for all occurrences

Error identifiers, most of these are only used internally.

eINDEX_OUT_OF_RANGE
eERROR_COUNT

Enumerator:

eINDEX_OUT_OF_RANGE	Search for all occurrences
eERROR_COUNT	Search for all occurrences

Definition at line 213 of file kfbxglobaltimesettings.h.

    {
        eINDEX_OUT_OF_RANGE,
        eERROR_COUNT
    } EError;

Member Function Documentation

KFBXNEW_DECLARE_FRIEND void RestoreDefaultSettings ( )

Search for all occurrences

Restores the default settings.

void SetTimeMode ( KTime::ETimeMode pTimeMode )

Search for all occurrences

Sets the time mode.

Parameters:

pTimeMode One of the defined modes in KTime class.

KTime::ETimeMode GetTimeMode ( ) const

Search for all occurrences

Returns the time mode.

Returns:: The currently set time mode.

void SetTimeProtocol ( KTime::ETimeProtocol pTimeProtocol )

Search for all occurrences

Sets the time protocol.

Parameters:

pTimeProtocol One of the defined protocols in KTime class.

KTime::ETimeProtocol GetTimeProtocol ( ) const

Search for all occurrences

Returns the time protocol.

Returns:: The currently set time protocol.

void SetSnapOnFrameMode ( ESnapOnFrameMode pSnapOnFrameMode )

Search for all occurrences

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

Search for all occurrences

Returns the snap on frame mode.

Returns:: The currently set snap on frame mode.

void SetTimelineDefautTimeSpan ( const KTimeSpan & pTimeSpan )

Search for all occurrences

Sets the default time span of time line.

Parameters:

pTimeSpan The time span of time line.

void GetTimelineDefautTimeSpan ( KTimeSpan & pTimeSpan ) const

Search for all occurrences

Returns the default time span of time line.

Parameters:

pTimeSpan Holds the default time span of time line.

int GetTimeMarkerCount ( ) const

Search for all occurrences

Returns the number of time markers.

Returns:: The number of time markers.

bool SetCurrentTimeMarker ( int pIndex )

Search for all occurrences

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

Search for all occurrences

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

Search for all occurrences

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 )

Search for all occurrences

Adds a time marker.

Parameters:

pTimeMarker The new time marker to be added.

void RemoveAllTimeMarkers ( )

Search for all occurrences

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 ( )

Search for all occurrences

Retrieves the error object.

Returns:: Reference to the error object.

EError GetLastErrorID ( ) const

Search for all occurrences

Returns the last error code.

Returns:: The last error code.

const char* GetLastErrorString ( ) const

Search for all occurrences

Returns the last error string.

Returns:: Text description of the last error.

void SetSnapOnFrame ( bool pSnapOnFrame )

Search for all occurrences

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

Search for all occurrences

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.