orxFX.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008- 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 _orxFX_H_
#define _orxFX_H_
 
 
#include "orxInclude.h"
#include "math/orxVector.h"
#include "object/orxObject.h"
 

#define orxFX_SLOT_KU32_FLAG_ABSOLUTE           0x00010000  
#define orxFX_SLOT_KU32_FLAG_STAGGER            0x00020000  
#define orxFX_SLOT_KU32_FLAG_USE_ROTATION       0x00040000  
#define orxFX_SLOT_KU32_FLAG_USE_SCALE          0x00080000  
 

typedef enum __orxFX_TYPE_t
{
  orxFX_TYPE_ALPHA = 0,
  orxFX_TYPE_RGB,
  orxFX_TYPE_HSL,
  orxFX_TYPE_HSV,
  orxFX_TYPE_POSITION,
  orxFX_TYPE_ROTATION,
  orxFX_TYPE_SCALE,
  orxFX_TYPE_SPEED,
  orxFX_TYPE_VOLUME,
  orxFX_TYPE_PITCH,
  orxFX_TYPE_SIZE,
  orxFX_TYPE_ORIGIN,
 
  orxFX_TYPE_FLOAT_ADD,
  orxFX_TYPE_FLOAT_MULTIPLY,
  orxFX_TYPE_VECTOR_ADD,
  orxFX_TYPE_VECTOR_MULTIPLY,
 
  orxFX_TYPE_NUMBER,
 
  orxFX_TYPE_MAX_NUMBER = 16,
 
  orxFX_TYPE_NONE = orxENUM_NONE
 
} orxFX_TYPE;
 

typedef enum __orxFX_CURVE_t
{
  orxFX_CURVE_SINE = 0,
  orxFX_CURVE_SQUARE,
  orxFX_CURVE_TRIANGLE,
 
  orxFX_CURVE_SYMMETRIC_NUMBER,
 
  /* Below this point all curves are non-symmetrical */
 
  orxFX_CURVE_BEZIER = orxFX_CURVE_SYMMETRIC_NUMBER,
  orxFX_CURVE_LINEAR,
  orxFX_CURVE_SMOOTH,
  orxFX_CURVE_SMOOTHER,
 
  orxFX_CURVE_EASE_IN_SINE,
  orxFX_CURVE_EASE_OUT_SINE,
  orxFX_CURVE_EASE_IN_OUT_SINE,
  orxFX_CURVE_EASE_IN_QUAD,
  orxFX_CURVE_EASE_OUT_QUAD,
  orxFX_CURVE_EASE_IN_OUT_QUAD,
  orxFX_CURVE_EASE_IN_CUBIC,
  orxFX_CURVE_EASE_OUT_CUBIC,
  orxFX_CURVE_EASE_IN_OUT_CUBIC,
  orxFX_CURVE_EASE_IN_QUART,
  orxFX_CURVE_EASE_OUT_QUART,
  orxFX_CURVE_EASE_IN_OUT_QUART,
  orxFX_CURVE_EASE_IN_QUINT,
  orxFX_CURVE_EASE_OUT_QUINT,
  orxFX_CURVE_EASE_IN_OUT_QUINT,
  orxFX_CURVE_EASE_IN_EXPO,
  orxFX_CURVE_EASE_OUT_EXPO,
  orxFX_CURVE_EASE_IN_OUT_EXPO,
  orxFX_CURVE_EASE_IN_CIRC,
  orxFX_CURVE_EASE_OUT_CIRC,
  orxFX_CURVE_EASE_IN_OUT_CIRC,
  orxFX_CURVE_EASE_IN_BACK,
  orxFX_CURVE_EASE_OUT_BACK,
  orxFX_CURVE_EASE_IN_OUT_BACK,
  orxFX_CURVE_EASE_IN_ELASTIC,
  orxFX_CURVE_EASE_OUT_ELASTIC,
  orxFX_CURVE_EASE_IN_OUT_ELASTIC,
  orxFX_CURVE_EASE_IN_BOUNCE,
  orxFX_CURVE_EASE_OUT_BOUNCE,
  orxFX_CURVE_EASE_IN_OUT_BOUNCE,
 
  orxFX_CURVE_NUMBER,
 
  orxFX_CURVE_NONE = orxENUM_NONE
 
} orxFX_CURVE;
 

typedef struct __orxFX_CURVE_PARAM_t
{
  union
  {
    struct
    {
      orxFLOAT          fStartValue;
      orxFLOAT          fEndValue;
    };
 
    struct
    {
      orxVECTOR         vStartValue;
      orxVECTOR         vEndValue;
    };
  };
 
  orxVECTOR             vCurvePoint1;           
  orxVECTOR             vCurvePoint2;           
 
  orxFLOAT              fStartTime;
  orxFLOAT              fEndTime;
  orxFLOAT              fPeriod;
  orxFLOAT              fPhase;
  orxFLOAT              fAmplification;
  orxFLOAT              fAcceleration;
  orxFLOAT              fPow;
 
} orxFX_CURVE_PARAM;
 

typedef struct __orxFX_t                        orxFX;
 

typedef enum __orxFX_EVENT_t
{
  orxFX_EVENT_START = 0,                        
  orxFX_EVENT_STOP,                             
  orxFX_EVENT_ADD,                              
  orxFX_EVENT_REMOVE,                           
  orxFX_EVENT_LOOP,                             
 
  orxFX_EVENT_NUMBER,
 
  orxFX_EVENT_NONE = orxENUM_NONE
 
} orxFX_EVENT;

typedef struct __orxFX_EVENT_PAYLOAD_t
{
  orxFX          *pstFX;                        
  const orxSTRING zFXName;                      
 
} orxFX_EVENT_PAYLOAD;
 

extern orxDLLAPI void orxFASTCALL               orxFX_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL          orxFX_Init();

extern orxDLLAPI void orxFASTCALL               orxFX_Exit();

extern orxDLLAPI orxFX *orxFASTCALL             orxFX_Create();

extern orxDLLAPI orxFX *orxFASTCALL             orxFX_CreateFromConfig(const orxSTRING _zConfigID);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxFX_Delete(orxFX *_pstFX);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxFX_ClearCache();

extern orxDLLAPI orxSTATUS orxFASTCALL          orxFX_Apply(const orxFX *_pstFX, orxOBJECT *_pstObject, orxFLOAT _fPreviousTime, orxFLOAT _fTime);

extern orxDLLAPI orxFLOAT orxFASTCALL           orxFX_GetFloat(const orxFX *_pstFX, orxFLOAT _fPreviousTime, orxFLOAT _fTime);

extern orxDLLAPI orxVECTOR *orxFASTCALL         orxFX_GetVector(const orxFX *_pstFX, orxFLOAT _fPreviousTime, orxFLOAT _fTime, orxVECTOR *_pvVector);

extern orxDLLAPI void orxFASTCALL               orxFX_Enable(orxFX *_pstFX, orxBOOL _bEnable);

extern orxDLLAPI orxBOOL orxFASTCALL            orxFX_IsEnabled(const orxFX *_pstFX);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxFX_AddSlot(orxFX *_pstFX, orxFX_TYPE _eType, orxFX_CURVE _eCurve, const orxFX_CURVE_PARAM *_pstCurveParam, orxU32 _u32Flags);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxFX_AddSlotFromConfig(orxFX *_pstFX, const orxSTRING _zSlotID);

extern orxDLLAPI orxFLOAT orxFASTCALL           orxFX_GetDuration(const orxFX *_pstFX);

extern orxDLLAPI orxFX *orxFASTCALL             orxFX_Get(const orxSTRING _zName);

extern orxDLLAPI const orxSTRING orxFASTCALL    orxFX_GetName(const orxFX *_pstFX);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxFX_Loop(orxFX *_pstFX, orxBOOL _bLoop);

extern orxDLLAPI orxBOOL orxFASTCALL            orxFX_IsLooping(const orxFX *_pstFX);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxFX_SetStagger(orxFX *_pstFX, orxBOOL _bStagger, orxFLOAT _fOffset);

extern orxDLLAPI orxBOOL orxFASTCALL            orxFX_GetStagger(const orxFX *_pstFX, orxFLOAT *_pfOffset);
 
#endif /* _orxFX_H_ */