scene_2d_interface.h

Go to the documentation of this file.

 
#ifndef SDK_VIS_SCENE_2D_INTERFACE_H_
#define SDK_VIS_SCENE_2D_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/forward_declarations.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/edit/lock_interface.h>
 
#include "layer_interface.h"
#include "scene_viewports_interface.h"
 
namespace sdk {
namespace vis {
namespace scene {
 
FWD_DECL_INTERFACE(IScene2D);
FWD_DECL_INTERFACE(IScene2DCallbacks);
FWD_DECL_INTERFACE(ILayer);
FWD_DECL_INTERFACE(IBackend);
FWD_DECL_INTERFACE(IRenderer);
 
static const LayerID kSceneRootLayerID = 1;
 
enum CreateLayerFlags
{
  kCreateLayerFlag_NoFlags  = 0x00,  
};
 
enum Scene2DPropertyIDs
{
  kScene2DProperty_SingleThreaded         = 0x00,
 
  kScene2DProperty_UseThreadsForRendering = 0x01,
 
  kScene2DProperty_RenderingThreadsNumber = 0x02,
 
  kScene2DProperty_InternalLayersGraphicContextType = 0x03,
 
  kScene2DProperty_LayersInRenderingList = 0x04,
 
  kScene2DProperty_CacheDisplay = 0x05,
 
  kScene2DProperty_DebugLoggingOn = 0x06,
 
  kScene2DProperty_SceneName = 0x07,
  
  kScene2DProperty_DisplayLock = 0x08,
 
  kScene2DProperty_MinLayersNumToUseBlitter = 0x09,
};
 
class IScene2D : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetLayer(const LayerID& id, ILayerSP& layer) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetLayerByName(const SDKString& name, ILayerSP& layer) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE AddLayer(const LayerID& parent_id, const SDKString& name, 
    const LayerPriority& priority, const SDKRectF2D& bounds, const SDKUInt64& flags, 
    const ResourceType& layer_resource_type, ILayerSP& new_layer, 
    IRenderersSetSP& new_layer_renderers_set) throw() = 0;
  virtual SDKResult SDK_CALLTYPE DeleteLayer(const LayerID& id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Render(const SDKArray& layers_to_render) throw() = 0;
  virtual SDKResult SDK_CALLTYPE Display() throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AttachBackend(const IBackendSP& backend) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetBackend(IBackendSP& backend) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CreateViewport(Scene2DViewportTypes type, 
    IScene2DViewportBaseSP& viewport) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetViewport(const IScene2DViewportBaseSP& viewport) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetViewport(IScene2DViewportBaseSP& viewport) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE WinToScene(const SDKPointF2D& win_coordinate, 
    SDKPointF2D& scene_coordinate) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE SceneToWin(const SDKPointF2D& scene_coordinate, 
    SDKPointF2D& win_coordinate) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetCallback(const IScene2DCallbacksSP& listener) throw() = 0;
 
  SDK_IMPLEMENT_IID(IScene2D)
  SDK_END_INTERFACE(IScene2D)
};
SDK_DECLARE_IID(IScene2D)
 
 
enum Scene2DEventID
{
  kScene2DEvent_LayerRenderingTaskInQueue = 0, 
  kScene2DEvent_LayerRenderingStarted     = 1, 
  kScene2DEvent_LayerRenderingFinished    = 2, 
  kScene2DEvent_LayerResourceBeforeSwap   = 3, 
  kScene2DEvent_IsLayerResourceSwapNeeded = 4, 
  kScene2DEvent_LayerResourceSwapped      = 5, 
  kScene2DEvent_BeforeDisplayLock         = 6, 
  kScene2DEvent_AfterDisplayLock          = 7, 
  kScene2DEvent_LayerRenderingStopped     = 8, 
};
 
class IScene2DCallbacks : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE OnEvent(const Scene2DEventID& id, const SDKAny& param) throw() = 0;
 
  SDK_IMPLEMENT_IID(IScene2DCallbacks)
  SDK_END_INTERFACE(IScene2DCallbacks)
};
SDK_DECLARE_IID(IScene2DCallbacks)
 
} // namespace scene
} // namespace vis
} // namespace sdk
 
#endif // SDK_VIS_SCENE_2D_INTERFACE_H_