orxFrame.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 _orxFRAME_H_
#define _orxFRAME_H_

#include "orxInclude.h"

#include "math/orxVector.h"


#define orxFRAME_KU32_FLAG_NONE                       0x00000000  
#define orxFRAME_KU32_FLAG_SCROLL_X                   0x00000001  
#define orxFRAME_KU32_FLAG_SCROLL_Y                   0x00000002  
#define orxFRAME_KU32_MASK_SCROLL_BOTH                0x00000003  
#define orxFRAME_KU32_FLAG_DEPTH_SCALE                0x00000004  
#define orxFRAME_KU32_FLAG_FLIP_X                     0x00000010  
#define orxFRAME_KU32_FLAG_FLIP_Y                     0x00000020  
#define orxFRAME_KU32_MASK_FLIP_BOTH                  0x00000030  
#define orxFRAME_KU32_FLAG_IGNORE_NONE                0x00000000  
#define orxFRAME_KU32_FLAG_IGNORE_ROTATION            0x00000100  
#define orxFRAME_KU32_FLAG_IGNORE_SCALE_X             0x00000200  
#define orxFRAME_KU32_FLAG_IGNORE_SCALE_Y             0x00000400  
#define orxFRAME_KU32_FLAG_IGNORE_SCALE_Z             0x00000800  
#define orxFRAME_KU32_MASK_IGNORE_SCALE               0x00000E00  
#define orxFRAME_KU32_FLAG_IGNORE_POSITION_ROTATION   0x00001000  
#define orxFRAME_KU32_FLAG_IGNORE_POSITION_SCALE_X    0x00002000  
#define orxFRAME_KU32_FLAG_IGNORE_POSITION_SCALE_Y    0x00004000  
#define orxFRAME_KU32_FLAG_IGNORE_POSITION_SCALE_Z    0x00008000  
#define orxFRAME_KU32_MASK_IGNORE_POSITION_SCALE      0x0000E000  
#define orxFRAME_KU32_FLAG_IGNORE_POSITION_POSITION_X 0x00010000  
#define orxFRAME_KU32_FLAG_IGNORE_POSITION_POSITION_Y 0x00020000  
#define orxFRAME_KU32_FLAG_IGNORE_POSITION_POSITION_Z 0x00040000  
#define orxFRAME_KU32_MASK_IGNORE_POSITION_POSITION   0x00070000  
#define orxFRAME_KU32_MASK_IGNORE_POSITION            0x0007F000  
#define orxFRAME_KU32_MASK_IGNORE_ALL                 0x0007FF00  
#define orxFRAME_KU32_MASK_USER_ALL                   0x0007FFFF  
typedef enum __orxFRAME_SPACE_t
{
  orxFRAME_SPACE_GLOBAL = 0,
  orxFRAME_SPACE_LOCAL,

  orxFRAME_SPACE_NUMBER,

  orxFRAME_SPACE_NONE = orxENUM_NONE

} orxFRAME_SPACE;


typedef struct __orxFRAME_t                   orxFRAME;


extern orxDLLAPI orxU32 orxFASTCALL           orxFrame_GetIgnoreFlagValues(const orxSTRING _zFlags);

extern orxDLLAPI const orxSTRING orxFASTCALL  orxFrame_GetIgnoreFlagNames(orxU32 _u32Flags);


extern orxDLLAPI void orxFASTCALL             orxFrame_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL        orxFrame_Init();

extern orxDLLAPI void orxFASTCALL             orxFrame_Exit();


extern orxDLLAPI orxFRAME *orxFASTCALL        orxFrame_Create(orxU32 _u32Flags);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxFrame_Delete(orxFRAME *_pstFrame);


extern orxDLLAPI void orxFASTCALL             orxFrame_SetParent(orxFRAME *_pstFrame, orxFRAME * _pstParent);

extern orxDLLAPI orxFRAME *orxFASTCALL        orxFrame_GetParent(const orxFRAME *_pstFrame);

extern orxDLLAPI orxFRAME *orxFASTCALL        orxFrame_GetChild(const orxFRAME *_pstFrame);

extern orxDLLAPI orxFRAME *orxFASTCALL        orxFrame_GetSibling(const orxFRAME *_pstFrame);

extern orxDLLAPI orxBOOL orxFASTCALL          orxFrame_IsRootChild(const orxFRAME *_pstFrame);


extern orxDLLAPI void orxFASTCALL             orxFrame_SetPosition(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, const orxVECTOR *_pvPos);

extern orxDLLAPI void orxFASTCALL             orxFrame_SetRotation(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxFLOAT _fRotation);

extern orxDLLAPI void orxFASTCALL             orxFrame_SetScale(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, const orxVECTOR *_pvScale);


extern orxDLLAPI orxVECTOR *orxFASTCALL       orxFrame_GetPosition(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvPos);

extern orxDLLAPI orxFLOAT orxFASTCALL         orxFrame_GetRotation(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace);

extern orxDLLAPI orxVECTOR *orxFASTCALL       orxFrame_GetScale(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvScale);


extern orxDLLAPI orxVECTOR *orxFASTCALL       orxFrame_TransformPosition(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvPos);

extern orxDLLAPI orxFLOAT orxFASTCALL         orxFrame_TransformRotation(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxFLOAT _fRotation);

extern orxDLLAPI orxVECTOR *orxFASTCALL       orxFrame_TransformScale(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvScale);

#endif /* _orxFRAME_H_ */