visual_object_interface.h

Go to the documentation of this file.

#ifndef VISUAL_OBJECT_INTERFACE_H_
#define VISUAL_OBJECT_INTERFACE_H_
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_string_handler.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/interfaces/stream/stream_interface.h>
#include <base/inc/interfaces/enum/enum_interface.h>
 
#include <geometry/inc/geometry/geometry2d/2d_geometry_objects.h>
#include <geometry/inc/geometry/geometry2d/2d_geometry_path_interface.h>
 
#include <visualizationlayer/inc/graphics/2d_render_target_interface.h>
 
#include <visualizationlayer/inc/scene/texture_interface.h>
#include <visualizationlayer/inc/scene/graphic_context_interface.h>
 
#include <visualizationlayer/inc/portrayal/sdl/sdl_interface.h>
 
#include <base/inc/sdk_pshpack1.h>
 
namespace sdk {
namespace vis {
namespace sdl {
 
SDK_PACK(struct SDKPosition
{
  SDKPointF2D m_pos;
  float       m_angle;
});
 
FWD_DECL_INTERFACE(ISpriteElementCollection);
FWD_DECL_INTERFACE(IShapeCollection);
FWD_DECL_INTERFACE(ISpriteElement);
FWD_DECL_INTERFACE(IShapeElement);
FWD_DECL_INTERFACE(IPositionsCollection);
 
typedef enum VisualObjectFlags
{
  VisualObject_CanBeSprite      = 0x01,
  VisualObject_IsSprite         = 0x02,
  VisualObject_HasPositions     = 0x04,
  VisualObject_CreatingSprite   = 0x08,
  VisualObject_CanBeCached      = 0x10,
  VisualObject_NotToScale       = 0x20,
  VisualObject_ShouldBeClipped  = 0x40,
 
  VisualObject_UnitsMeter       = 0x80,
 
  VisualObject_LayoutOwner      = 0x0100,
  VisualObject_DoNotCache       = 0x0200,
} VisualObjectFlags;
 
class IVisualObject : 
  public sdk::ISDKComponent
{
public:
 
  virtual SDKResult SDK_CALLTYPE GetUniqueId(
    SDKUInt16& id, SDKAny& var_key) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolGeometryType(
    SymbolGeometryType& geom_type) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSymbolType(
    SymbolType& type) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Draw(
    SDKUInt16 palette_id,
    const sdk::gfx::RenderTargetSP& target,
    const sdk::ISDKComponentSP& geometry,
    const SDKMatrix3X2& transformation_matrix,
    const IDrawingContextSP& context) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Attach(
    IVisualObjectSP& child_vo,
    AnchorType anchor, 
    float x_offset, float y_offset) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMetrics(
    SDKSizeF& size, 
    SDKPointF2D& origin, 
    const sdk::gfx::RenderTargetSP& target) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetAnchorOffset(
    AnchorType anchor, 
    SDKPointF2D& offset) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSprites(
    ISpriteElementCollectionSP& sprites) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetShapes(
    IShapeCollection& sprites) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetOffset(
    const SDKPointF2D& offset) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetOffset(
    SDKPointF2D& offset) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetFlags(
    SDKUInt16& flags) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetFlags(
    SDKUInt16 flags) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetScale(
    float& scale) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetAABB(
    RectF2D& aabb) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE AddAABB(
    const RectF2D& aabb, const PointF2D& offset) throw() = 0;
 
  SDK_IMPLEMENT_IID(IVisualObject)
  SDK_END_INTERFACE(IVisualObject)
};
SDK_DECLARE_IID(IVisualObject)
 
class ISpriteElementCollection : 
  public sdk::ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Count(SDKUInt32& count) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSprite(
    SDKUInt32 index, 
    ISpriteElementSP& sprite) throw() = 0;
 
  SDK_IMPLEMENT_IID(ISpriteElementCollection)
  SDK_END_INTERFACE(ISpriteElementCollection)
}; 
SDK_DECLARE_IID(ISpriteElementCollection)
 
class ISpriteElement : 
  public sdk::ISDKComponent
{
public:
 
  virtual SDKResult SDK_CALLTYPE GetUniqueId(
    SDKUInt16& id, SDKAny& var_key) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CreateTexture(
    const sdk::gfx::RenderTargetSP& target,
    SDKPointI2D& org,
    SDKRect2D& rect) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetPosition(
    const sdk::gfx::RenderTargetSP& target,
    const sdk::geometry::GeometryPathSP& geometry,
    const IDrawingContextSP& context,
    SDKAny& positions) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetVisualObject(
    IVisualObjectSP& vo) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetFlags(
    const SDKUInt16 flags) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetFlags(
    SDKUInt16& flags) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE ClearVectorData(void) throw() = 0;
 
  SDK_IMPLEMENT_IID(ISpriteElement)
  SDK_END_INTERFACE(ISpriteElement)
}; 
SDK_DECLARE_IID(ISpriteElement)
 
class IPositionsCollection : 
  public sdk::ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Count(SDKUInt32& count) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetPosition(
    SDKUInt32 index, 
    SDKPosition& pos) throw() = 0;
 
  SDK_IMPLEMENT_IID(IPositionsCollection)
  SDK_END_INTERFACE(IPositionsCollection)
}; 
SDK_DECLARE_IID(IPositionsCollection)
} // namespace sdl
} // namespace vis
} // namespace sdk 
 
#include <base/inc/sdk_poppack.h>
 
#endif // VISUAL_OBJECT_INTERFACE_H_