orxAnim.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 _orxANIM_H_
#define _orxANIM_H_


#include "orxInclude.h"

#include "object/orxStructure.h"


#define orxANIM_KU32_FLAG_NONE                0x00000000  
#define orxANIM_KU32_FLAG_2D                  0x00000001  
#define orxANIM_KU32_MASK_USER_ALL            0x0000000F  
#define orxANIM_KU32_MASK_ALL                 0xFFFFFFFF  
#define orxANIM_KU32_KEY_MAX_NUMBER           65535       
#define orxANIM_KU32_EVENT_MAX_NUMBER         65535       
typedef struct __orxANIM_t                    orxANIM;


typedef enum __orxANIM_EVENT_t
{
  orxANIM_EVENT_START = 0,                    
  orxANIM_EVENT_STOP,                         
  orxANIM_EVENT_CUT,                          
  orxANIM_EVENT_LOOP,                         
  orxANIM_EVENT_UPDATE,                       
  orxANIM_EVENT_CUSTOM_EVENT,                 
  orxANIM_EVENT_NUMBER,

  orxANIM_EVENT_NONE = orxENUM_NONE

} orxANIM_EVENT;

typedef struct __orxANIM_EVENT_PAYLOAD_t
{
  orxANIM            *pstAnim;                
  const orxSTRING     zAnimName;              
  union
  {
    /* Loop event */
    struct
    {
      orxU32          u32Count;               
    } stLoop;

    /* Cut event */
    struct
    {
      orxFLOAT        fTime;                  
    } stCut;

    /* Custom event */
    struct
    {
      const orxSTRING zName;                  
      orxFLOAT        fValue;                 
      orxFLOAT        fTime;                  
    } stCustom;
  };

} orxANIM_EVENT_PAYLOAD;

typedef struct __orxANIM_CUSTOM_EVENT_t
{
  const orxSTRING zName;                      
  orxFLOAT        fValue;                     
  orxFLOAT        fTimeStamp;                 
} orxANIM_CUSTOM_EVENT;


extern orxDLLAPI void orxFASTCALL             orxAnim_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL        orxAnim_Init();

extern orxDLLAPI void orxFASTCALL             orxAnim_Exit();


extern orxDLLAPI orxANIM *orxFASTCALL         orxAnim_Create(orxU32 _u32Flags, orxU32 _u32KeyNumber, orxU32 _u32EventNumber);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxAnim_Delete(orxANIM *_pstAnim);


extern orxDLLAPI orxSTATUS orxFASTCALL        orxAnim_AddKey(orxANIM *_pstAnim, orxSTRUCTURE *_pstData, orxFLOAT _fTimeStamp);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxAnim_RemoveLastKey(orxANIM *_pstAnim);

extern orxDLLAPI void orxFASTCALL             orxAnim_RemoveAllKeys(orxANIM *_pstAnim);


extern orxDLLAPI orxSTATUS orxFASTCALL        orxAnim_AddEvent(orxANIM *_pstAnim, const orxSTRING _zEventName, orxFLOAT _fTimeStamp, orxFLOAT _fValue);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxAnim_RemoveLastEvent(orxANIM *_pstAnim);

extern orxDLLAPI void orxFASTCALL             orxAnim_RemoveAllEvents(orxANIM *_pstAnim);

extern orxDLLAPI const orxANIM_CUSTOM_EVENT *orxFASTCALL orxAnim_GetNextEvent(const orxANIM *_pstAnim, const orxANIM_CUSTOM_EVENT *_pstEvent);

extern orxDLLAPI const orxANIM_CUSTOM_EVENT *orxFASTCALL orxAnim_GetEventAfter(const orxANIM *_pstAnim, orxFLOAT _fTimeStamp);


extern orxDLLAPI orxU32 orxFASTCALL           orxAnim_GetKey(const orxANIM *_pstAnim, orxFLOAT _fTimeStamp);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL    orxAnim_GetKeyData(const orxANIM *_pstAnim, orxU32 _u32Index);


extern orxDLLAPI orxU32 orxFASTCALL           orxAnim_GetKeyStorageSize(const orxANIM *_pstAnim);

extern orxDLLAPI orxU32 orxFASTCALL           orxAnim_GetKeyCount(const orxANIM *_pstAnim);


extern orxDLLAPI orxU32 orxFASTCALL           orxAnim_GetEventStorageSize(const orxANIM *_pstAnim);

extern orxDLLAPI orxU32 orxFASTCALL           orxAnim_GetEventCount(const orxANIM *_pstAnim);


extern orxDLLAPI orxFLOAT orxFASTCALL         orxAnim_GetLength(const orxANIM *_pstAnim);

extern orxDLLAPI const orxSTRING orxFASTCALL  orxAnim_GetName(const orxANIM *_pstAnim);

#endif /* _orxANIM_H_ */