orxTimeLine.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2022 Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */

#ifndef _orxTIMELINE_H_
#define _orxTIMELINE_H_


#include "orxInclude.h"
#include "object/orxStructure.h"


typedef struct __orxTIMELINE_t                  orxTIMELINE;


typedef enum __orxTIMELINE_EVENT_t
{
  orxTIMELINE_EVENT_TRACK_START = 0,            
  orxTIMELINE_EVENT_TRACK_STOP,                 
  orxTIMELINE_EVENT_TRACK_ADD,                  
  orxTIMELINE_EVENT_TRACK_REMOVE,               
  orxTIMELINE_EVENT_LOOP,                       
  orxTIMELINE_EVENT_TRIGGER,                    
  orxTIMELINE_EVENT_NUMBER,

  orxTIMELINE_EVENT_NONE = orxENUM_NONE

} orxTIMELINE_EVENT;

typedef struct __orxTIMELINE_EVENT_PAYLOAD_t
{
  orxTIMELINE    *pstTimeLine;                  
  const orxSTRING zTrackName;                   
  const orxSTRING zEvent;                       
  orxFLOAT        fTimeStamp;                   
} orxTIMELINE_EVENT_PAYLOAD;


extern orxDLLAPI void orxFASTCALL               orxTimeLine_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTimeLine_Init();

extern orxDLLAPI void orxFASTCALL               orxTimeLine_Exit();

extern orxDLLAPI orxTIMELINE *orxFASTCALL       orxTimeLine_Create();

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTimeLine_Delete(orxTIMELINE *_pstTimeLine);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTimeLine_ClearCache();

extern orxDLLAPI void orxFASTCALL               orxTimeLine_Enable(orxTIMELINE *_pstTimeLine, orxBOOL _bEnable);

extern orxDLLAPI orxBOOL orxFASTCALL            orxTimeLine_IsEnabled(const orxTIMELINE *_pstTimeLine);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTimeLine_AddTrackFromConfig(orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTimeLine_RemoveTrackFromConfig(orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID);

extern orxDLLAPI orxU32 orxFASTCALL             orxTimeLine_GetCount(const orxTIMELINE *_pstTimeLine);

extern orxDLLAPI orxFLOAT orxFASTCALL           orxTimeLine_GetTrackDuration(const orxSTRING _zTrackID);

#endif /* _orxTIMELINE_H_ */