gl2d_sprites_interface.h

#ifndef SDK_GL2D_SPRITES_INTERFACE_H_
#define SDK_GL2D_SPRITES_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_base.h>
#include <base/inc/math/matrix_base_types.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <visualizationlayer/inc/vis_const.h>
 
#include "gl2d_texture_interface.h"
 
SDK_GL2D_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IGL2DCanvas);
FWD_DECL_INTERFACE(IGL2DSpritePos);
FWD_DECL_INTERFACE(IGL2DSprite);
FWD_DECL_INTERFACE(IGL2DSprites);
 
class AutoStartFinishSpriteEdit;
 
enum GL2DSpritePosPropertyIDs
{
};
 
class IGL2DSpritePos : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetCanvas() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetID(SDKString& id) const throw() = 0;
  virtual SDKPointF2D SDK_CALLTYPE GetPosition() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetPositionTransform(
    const SDKMatrix3X2& position_transform) throw() = 0;
  virtual SDKMatrix3X2 SDK_CALLTYPE GetPositionTransform() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetSpriteSizeFixedFlag(
    const bool& is_sprite_size_fixed) throw() = 0;
  virtual bool SDK_CALLTYPE GetSpriteSizeFixedFlag() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetSpriteRotationFixedFlag(
    const bool& is_sprite_rotation_fixed) throw() = 0;
  virtual bool SDK_CALLTYPE GetSpriteRotationFixedFlag() const throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DSpritePos)
  SDK_END_INTERFACE(IGL2DSpritePos)
};
SDK_DECLARE_IID(IGL2DSpritePos)
 
enum GL2DSpritePropertyIDs
{
};
 
class IGL2DSprite : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetCanvas() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetID(SDKString& id) const throw() = 0;
  virtual SDKRect2D SDK_CALLTYPE GetTextureRect() const throw() = 0;
  virtual SDKPointF2D SDK_CALLTYPE GetPivotPoint() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDefaultSpritePositionTransform(
    const SDKMatrix3X2& sprite_transform) throw() = 0;
  virtual SDKMatrix3X2 SDK_CALLTYPE GetDefaultSpritePositionTransform() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDefaultSpriteSizeFixedFlag(
    const bool& is_sprite_size_fixed) throw() = 0;
  virtual bool SDK_CALLTYPE GetDefaultSpriteSizeFixedFlag() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDefaultSpriteRotationFixedFlag(
    const bool& is_sprite_rotation_fixed) throw() = 0;
  virtual bool SDK_CALLTYPE GetDefaultSpriteRotationFixedFlag() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE ApplySpritePositionTransform(
    const SDKMatrix3X2& sprite_transform) throw() = 0;
  virtual SDKResult SDK_CALLTYPE ApplySpriteSizeFixedFlag(
    const bool& is_sprite_size_fixed) throw() = 0;
  virtual SDKResult SDK_CALLTYPE ApplySpriteRotationFixedFlag(
    const bool& is_sprite_rotation_fixed) throw() = 0;
 
  virtual IGL2DSpritePosSP SDK_CALLTYPE AddPosition(
    const SDKString& id, const SDKPointF2D& position) throw() = 0;
  virtual SDKResult SDK_CALLTYPE RemovePosition(const SDKString& id) throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetPositionsCount() const throw() = 0;
  virtual IGL2DSpritePosSP SDK_CALLTYPE GetPositionByIndex(
    const SDKUInt32& index) const throw() = 0;
  virtual IGL2DSpritePosSP SDK_CALLTYPE GetPositionByID(
    const SDKString& id) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DSprite)
  SDK_END_INTERFACE(IGL2DSprite)
};
SDK_DECLARE_IID(IGL2DSprite)
 
enum GL2DSpritesPropertyIDs
{
};
 
enum GL2DSpritesType
{
  // Unknown sprites type
  kGL2DSpritesType_Unknown      = 0,
 
  // Following sprites can't be used with projection
 
  // Generic sprites
  kGL2DSpritesType_Generic      = 1,
 
  // Following sprites can be used with any of perspective projections
  // (see GL2DProjectionType)
 
  // Sprites for perspective projection, similar to kGL2DSpritesType_Generic, 
  // but can be projected via any perspective projection during rendering
  kGL2DSpritesType_ForPerspProj = 2,
};
 
class IGL2DSprites : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetParent() const throw() = 0;
 
  virtual GL2DSpritesType SDK_CALLTYPE GetType() const throw() = 0;
  virtual IGL2DTextureSP SDK_CALLTYPE GetTexture() const throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetMemSize() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetSpritePositionsCount() const throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetSpritesCount() const throw() = 0;
  virtual IGL2DSpriteSP SDK_CALLTYPE GetSpriteByIndex(
    const SDKUInt32& index) const throw() = 0;
  virtual IGL2DSpriteSP SDK_CALLTYPE GetSpriteByID(
    const SDKString& id) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE StartEdit() throw() = 0;
  virtual SDKResult SDK_CALLTYPE FinishEdit() throw() = 0;
  virtual bool SDK_CALLTYPE IsEditing() const throw() = 0;
 
  virtual IGL2DSpriteSP SDK_CALLTYPE AddSprite(
    const SDKString& id, const SDKRect2D& texture_rect,
    const SDKPointF2D& pivot_point) throw() = 0;
  virtual SDKResult SDK_CALLTYPE RemoveSprite(const SDKString& id) throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DSprites)
  SDK_END_INTERFACE(IGL2DSprites)
};
SDK_DECLARE_IID(IGL2DSprites)
 
class AutoStartFinishSpriteEdit
{
public:
  AutoStartFinishSpriteEdit(const IGL2DSpritesSP& sprites)
    : m_sprites(sprites), m_started(false)
  { 
    if (m_sprites) 
      m_started = SDK_SUCCEEDED(m_sprites->StartEdit());
  }
 
  virtual ~AutoStartFinishSpriteEdit()
  { if (m_started) m_sprites->FinishEdit(); }
 
  inline bool IsEditing() const
  { return m_sprites ? m_sprites->IsEditing() : false; }
 
private:
  const IGL2DSpritesSP m_sprites;
  bool                 m_started;
};
 
SDK_GL2D_END_NAMESPACE
 
#endif // SDK_GL2D_SPRITES_INTERFACE_H_