gl2d_clip_rule_interface.h

Go to the documentation of this file.

#ifndef SDK_GL2D_CLIP_RULE_INTERFACE_H_
#define SDK_GL2D_CLIP_RULE_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 <visualizationlayer/inc/gl2d/gl2d_mesh_interface.h>
#include <visualizationlayer/inc/triang2d/gl2d_mesh_coll_interface.h>
 
#include "gl2d_mesh_interface.h"
 
SDK_GL2D_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IGL2DCanvas);
FWD_DECL_INTERFACE(IGL2DClipRule);
FWD_DECL_INTERFACE(IGL2DIntersectClipRule);
FWD_DECL_INTERFACE(IGL2DExcludeClipRule);
 
enum GL2DClipRulePropertyIDs
{
};
 
enum GL2DClipRuleType
{
  // Clip rule - Unknown
  kGL2DClipRuleType_Unknown = 0,
 
  // Clip rule - Intersect:
  // Resulting no-clip area is an intersection (common part) of all of 
  // pushed clip meshes. Only given area will be filled with pixels data during 
  // rendering of further primitives, every pixel outside given area will 
  // be clipped out.
  //
  // Mesh 1 - labeled with '1':
  // +----+
  // |1111|
  // |1111|
  // |1111|
  // |0001|
  // +----+
  // 
  // Mesh 2 - labeled with '2':
  // +----+
  // |0022|
  // |2002|
  // |2222|
  // |2020|
  // +----+
  // 
  // No-clip area - result of intersection of mesh 1 with 2, labeled with X:
  // +----+
  // |00XX|
  // |X00X|
  // |XXXX|
  // |0000|
  // +----+
  //
  // See IGL2DIntersectClipRule interface
  kGL2DClipRuleType_Intersect = 1,
 
  // Clip rule - Exclude:
  // Resulting no-clip area is main mesh minus all of exclude meshes
  // Only given area will be filled with pixels data during rendering of further 
  // primitives, every pixel outside given area will be clipped out
  //
  // Main mesh - labeled with 'M':
  // +----+
  // |M00M|
  // |MMMM|
  // |MMMM|
  // |00MM|
  // +----+
  // 
  // Exclude mesh 1 - labeled with '1':
  // +----+
  // |0011|
  // |0011|
  // |0000|
  // |1010|
  // +----+
  // 
  // Exclude mesh 2 - labeled with '2':
  // +----+
  // |0000|
  // |2000|
  // |2200|
  // |0000|
  // +----+
  // 
  // No-clip area = Main mesh - (Exclude mesh 1 + Exclude mesh 2), labeled with X:
  // +----+
  // |X000|
  // |0X00|
  // |00XX|
  // |000X|
  // +----+
  //
  // See IGL2DExcludeClipRule interface
  kGL2DClipRuleType_Exclude = 2,
};
 
class IGL2DClipRule : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetParent() const throw() = 0;
 
  virtual GL2DClipRuleType SDK_CALLTYPE GetType() const throw() = 0;
 
  virtual bool SDK_CALLTYPE IsEmpty() const throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DClipRule)
  SDK_END_INTERFACE(IGL2DClipRule)
};
SDK_DECLARE_IID(IGL2DClipRule)
 
class IGL2DIntersectClipRule : public IGL2DClipRule
{
public:
  virtual SDKResult SDK_CALLTYPE PushClippingMesh(
    const IGL2DMeshSP& mesh, const SDKMatrix3X2& objects_transformation,
    const SDKMatrix3X2& canvas_transformation) throw() = 0;
  virtual SDKResult SDK_CALLTYPE PushClippingMeshColl(
    const SDK_TRIANG2D_NAMESPACE::IGL2DMeshCollSP& mesh_coll,
    const SDKMatrix3X2& objects_transformation,
    const SDKMatrix3X2& canvas_transformation) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE PushClippingMesh(const IGL2DMeshSP& mesh) throw() = 0;
  virtual SDKResult SDK_CALLTYPE PushClippingMeshColl(
    const SDK_TRIANG2D_NAMESPACE::IGL2DMeshCollSP& mesh_coll) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE PopClippingMesh() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Clear() throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetNumberOfAppliedClippingMeshes() const throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DIntersectClipRule)
  SDK_END_INTERFACE(IGL2DIntersectClipRule)
};
SDK_DECLARE_IID(IGL2DIntersectClipRule)
 
class IGL2DExcludeClipRule : public IGL2DClipRule
{
public:
  virtual SDKResult SDK_CALLTYPE SetMesh(const IGL2DMeshSP& mesh_to_clip, 
    const SDKMatrix3X2& objects_transformation,
    const SDKMatrix3X2& canvas_transformation) throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetMeshColl(
    const SDK_TRIANG2D_NAMESPACE::IGL2DMeshCollSP& mesh_coll_to_clip,
    const SDKMatrix3X2& objects_transformation,
    const SDKMatrix3X2& canvas_transformation) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetMesh(
    const IGL2DMeshSP& mesh_to_clip) throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetMeshColl(
    const SDK_TRIANG2D_NAMESPACE::IGL2DMeshCollSP& mesh_coll_to_clip) throw() = 0;
 
  inline SDKResult SDK_CALLTYPE ResetMesh()
  { return SetMesh(IGL2DMeshSP()); }
 
  virtual SDKResult SDK_CALLTYPE PushExcludeMesh(const IGL2DMeshSP& exclude_mesh, 
    const SDKMatrix3X2& objects_transformation,
    const SDKMatrix3X2& canvas_transformation) throw() = 0;
  virtual SDKResult SDK_CALLTYPE PushExcludeMeshColl(
    const SDK_TRIANG2D_NAMESPACE::IGL2DMeshCollSP& exclude_mesh_coll,
    const SDKMatrix3X2& objects_transformation,
    const SDKMatrix3X2& canvas_transformation) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE PushExcludeMesh(
    const IGL2DMeshSP& exclude_mesh) throw() = 0;
  virtual SDKResult SDK_CALLTYPE PushExcludeMeshColl(
    const SDK_TRIANG2D_NAMESPACE::IGL2DMeshCollSP& exclude_mesh_coll) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE PopExcludeMesh() throw() = 0;
  virtual SDKResult SDK_CALLTYPE ResetExcludeMeshes() throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetExcludeMeshesCount() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Clear() throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DExcludeClipRule)
  SDK_END_INTERFACE(IGL2DExcludeClipRule)
};
SDK_DECLARE_IID(IGL2DExcludeClipRule)
 
SDK_GL2D_END_NAMESPACE
 
#endif // SDK_GL2D_CLIP_RULE_INTERFACE_H_