layer_interface.h

Go to the documentation of this file.

 
#ifndef SDK_VIS_LAYER_INTERFACE_H_
#define SDK_VIS_LAYER_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/geometry/geometry_base_types.h>
#include <base/inc/math/matrix_base_types.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include "renderer_interface.h"
 
namespace sdk {
namespace vis {
namespace scene {
 
FWD_DECL_INTERFACE(ILayer);
FWD_DECL_INTERFACE(ILayerEnum);
FWD_DECL_INTERFACE(ILayerResource);
FWD_DECL_INTERFACE(ILayerContext);
FWD_DECL_INTERFACE(IRenderContext);
FWD_DECL_INTERFACE(ILayerClipping);
FWD_DECL_INTERFACE(IShader);
 
typedef SDKUInt64 LayerID;
typedef float LayerPriority;
 
typedef SDKUInt32 RenderingThreadID;
 
static const RenderingThreadID kUndefinedRenderingThreadID = 0;
 
enum LayerRenderingPriorities
{
  kLayerRenderingPriority_High, 
  kLayerRenderingPriority_Normal, 
  kLayerRenderingPriority_Low, 
};
 
enum LayerPropertiesID
{
  kLayerProperty_Opacity,             
  kLayerProperty_BindToSceneViewport, 
  kLayerProperty_RenderingPriority,   
  kLayerProperty_RenderingOrder,      
  kLayerProperty_Dynamic,             
  kLayerProperty_OpaqueLayer,         
  kLayerProperty_Max,                 
};
 
enum LayerTransformationType
{
  kLayerTransformationType_Local, 
  kLayerTransformationType_World, 
 
  kLayerTransformationType_Position2, 
  kLayerTransformationType_Position3, 
  kLayerTransformationType_Position4, 
};
 
class ILayer : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetLayerId(LayerID& id) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetLayerName(SDKString& name) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetRenderersSet(
    IRenderersSetSP& renderers_set) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSubLayer(
    const LayerID& id, ILayerSP& layer) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetBounds(
    SDKRectF2D& bounds, bool evaluate) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetPriority(
    const LayerPriority& priority) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetPriority(
    LayerPriority& priority) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetVisibilityFlag(
    SDKUInt8 is_visible) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetVisibilityFlag(
    SDKUInt8& is_visible, bool evaluate) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetViewport(
    const SDKRectF2D& viewport) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetViewport(
    SDKRectF2D& viewport, bool evaluate) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetTransform(const SDKMatrix4X4& transform, 
    LayerTransformationType type) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetTransform(SDKMatrix4X4& transform, 
    LayerTransformationType* type, bool evaluate) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetClipping(
    const ILayerClippingSP& clipping) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetClipping(
    ILayerClippingSP& clipping, bool evaluate) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetShader(
    const IShaderSP& shader) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetShader(
    IShaderSP& shader, bool evaluate) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetParent(ILayerSP& layer) throw() = 0;
  virtual SDKResult SDK_CALLTYPE EnumChildren(ILayerEnumSP& children) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetPreferableRenderingThreadID(
    const RenderingThreadID& rendering_thread_id) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetPreferableRenderingThreadID(
    RenderingThreadID& rendering_thread_id) const throw() = 0;
 
  SDK_IMPLEMENT_IID(ILayer)
  SDK_END_INTERFACE(ILayer)
};
SDK_DECLARE_IID(ILayer)
 
class ILayerEnum : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Next(ILayerSP& layer) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILayerEnum)
  SDK_END_INTERFACE(ILayerEnum)
};
SDK_DECLARE_IID(ILayerEnum)
 
enum RenderParametersID
{
  kRenderParameter_Viewport_SizeX, 
  kRenderParameter_Viewport_SizeY, 
  kRenderParameter_Viewport_Max, 
};
 
class IRenderContext : public ISDKParameters
{
public:
  SDK_IMPLEMENT_IID(IRenderContext)
  SDK_END_INTERFACE(IRenderContext)
};
SDK_DECLARE_IID(IRenderContext)
 
class ILayerClipping : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE SetPoints(const SDKPointF2D* points, SDKUInt32 points_num, 
    const SDKUInt32* polysizes, SDKUInt32 polys_num) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetPoints(SDKPointF2D** points, SDKUInt32& points_num, 
    SDKUInt32** polysizes, SDKUInt32& polys_num) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILayerClipping)
  SDK_END_INTERFACE(ILayerClipping)
};
SDK_DECLARE_IID(ILayerClipping)
 
 
} // namespace scene
} // namespace vis
} // namespace sdk
 
#endif // SDK_VIS_LAYER_INTERFACE_H_