GiConveyorGeometry.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef __ODGICONVEYORGEOMETRY_H__
#define __ODGICONVEYORGEOMETRY_H__
 
#include "Gi/GiGeometry.h"
#include "Gi/GiCommonDraw.h"
#include "Gs/GsSelectionReactor.h"
#include "Gi/GiSubEntityTraitsData.h"
 
class OdGiRasterImage;
class OdGiMetafile;
class OdGiViewport;
class OdGiPointCloudFilter;
class OdGsView;
class OdGiCommonDraw;
class OdGiDeviation;
class OdGeExtents3d;
class OdGeBoundBlock3d;

class OdGiConveyorContext
{
public:
  virtual ~OdGiConveyorContext() {}

  virtual OdGiContext& giContext() const = 0;

  virtual OdGiSubEntityTraits& subEntityTraits() const = 0;

  virtual const OdGiSubEntityTraitsData& effectiveTraits() const = 0;

  virtual void setEffectiveTraits(const OdGiSubEntityTraitsData& traits,
                                  const OdGeVector3d* fillNormal = NULL) = 0;

  virtual bool effectivelyVisible() const { return effectiveTraits().visibility(); }

  virtual const OdGiDrawableDesc* currentDrawableDesc() const = 0;

  virtual const OdGiDrawable* currentDrawable() const = 0;

  virtual const OdGiViewport* giViewport() const = 0;

  virtual const OdGsView* gsView() const = 0;

  virtual void onTraitsModified() = 0;

  virtual void onTextProcessing(const OdGePoint3d& /*position*/,
                                const OdGeVector3d& /*direction*/,
                                const OdGeVector3d& /*upVector*/) { }

  virtual bool regenAbort() const = 0;

  virtual const OdGiPathNode* currentGiPath() const = 0;

  virtual const OdGiDeviation& worldDeviation() const = 0;
  virtual const OdGiDeviation& modelDeviation() const = 0;
  virtual const OdGiDeviation& eyeDeviation() const = 0;

  virtual OdGeMatrix3d getModelToWorldTransform() const = 0;

  virtual OdGeMatrix3d getWorldToModelTransform() const = 0;

  virtual const OdGiLineweightOverride *currentLineweightOverride() const { return NULL; }

  enum ConveyorContextFlags
  {
    // Spatial filter as simplifier
    kSpatialFilterSimplPline = 1, // Simplify plineProc() by spatial filter
    kSpatialFilterSimplNurbs = 2, // Simplify nurbsProc() by spatial filter
    kSpatialFilterSimplText  = 4, // Simplify textProc () by spatial filter
    kSpatialFilterSimplShape = 8, // Simplify shapeProc() by spatial filter
    kSpatialFilterSimplAll   = (kSpatialFilterSimplPline | kSpatialFilterSimplNurbs |
                                kSpatialFilterSimplText  | kSpatialFilterSimplShape), // All spatial filter options
    // Conveyor embranchment as simplifier
    kEmbranchmentSimplText   = 16, // Simplify textProc () by conveyor embranchment
    kEmbranchmentSimplNurbs  = 32, // Simplify nurbsProc() by conveyor embranchment
    kEmbranchmentSimplAll    = (kEmbranchmentSimplText | kEmbranchmentSimplNurbs), // All conveyor embranchment options
    kConveyorSimplAll        = (kSpatialFilterSimplAll | kEmbranchmentSimplAll), // All simplification options
    // Pline subentity markers
    kPlineMarkers            = 64, // Enable subentity markers set per pline() call
    kForceMarkersOnModified  = 128, // Force onTraitsModified call for each subentity marker change
    // Polyline subentity markers
    kPolylineMarkers         = 256, // Enable subentity markers set per polyline() call
    // Pline geometry
    kPlineAllowArcProc       = 512, // Vectorizer will draw arc segments of polyline as arcs (otherwise as sample points)
    // Enable test-specific functionality
    kTestMode                = 1024, // Enable test mode
    // Specific vectorization mode
    kLineTyperAfterMetafile  = 2048  // Specific mode (for example in GDI device) when the Line type node are follows by the metafile
  };

  virtual OdUInt32 drawContextFlags() const { return 0; }

  virtual double annotationScale() const { return 1.0; }
};

class OdGiConveyorContextWrapper : public OdGiConveyorContext
{
protected:
  OdGiConveyorContext *m_pCtx;
public:
  OdGiConveyorContext *getOriginalContext() const { return m_pCtx; }
  
  void setOriginalContext(OdGiConveyorContext *pCtx) { m_pCtx = pCtx; }
  
  explicit OdGiConveyorContextWrapper(OdGiConveyorContext *pCtx = NULL) : m_pCtx(pCtx) { }
 
  
  OdGiContext& giContext() const { return m_pCtx->giContext(); }
  
  OdGiSubEntityTraits& subEntityTraits() const { return m_pCtx->subEntityTraits(); }
  
  const OdGiSubEntityTraitsData& effectiveTraits() const { return m_pCtx->effectiveTraits(); }
  
  void setEffectiveTraits(const OdGiSubEntityTraitsData& traits,
                          const OdGeVector3d* fillNormal = NULL) { m_pCtx->setEffectiveTraits(traits, fillNormal); }
  
  bool effectivelyVisible() const { return m_pCtx->effectivelyVisible(); }
  
  const OdGiDrawableDesc* currentDrawableDesc() const { return m_pCtx->currentDrawableDesc(); }
  
  const OdGiDrawable* currentDrawable() const { return m_pCtx->currentDrawable(); }
  
  const OdGiViewport* giViewport() const { return m_pCtx->giViewport(); }
  
  const OdGsView* gsView() const { return m_pCtx->gsView(); }
  
  void onTraitsModified() { m_pCtx->onTraitsModified(); }
  
  void onTextProcessing(const OdGePoint3d& position, const OdGeVector3d& direction, const OdGeVector3d& upVector)
    { m_pCtx->onTextProcessing(position, direction, upVector); }
  
  bool regenAbort() const { return m_pCtx->regenAbort(); }
  
  const OdGiPathNode* currentGiPath() const { return m_pCtx->currentGiPath(); }
  
  const OdGiDeviation& worldDeviation() const { return m_pCtx->worldDeviation(); }
  
  const OdGiDeviation& modelDeviation() const { return m_pCtx->modelDeviation(); }
  
  const OdGiDeviation& eyeDeviation() const { return m_pCtx->eyeDeviation(); }
  
  OdGeMatrix3d getModelToWorldTransform() const { return m_pCtx->getModelToWorldTransform(); }
  
  OdGeMatrix3d getWorldToModelTransform() const { return m_pCtx->getWorldToModelTransform(); }
  
  const OdGiLineweightOverride *currentLineweightOverride() const { return m_pCtx->currentLineweightOverride(); }
  
  OdUInt32 drawContextFlags() const { return m_pCtx->drawContextFlags(); }
};

class ODGI_EXPORT OdGiConveyorGeometry
{
public:
  virtual ~OdGiConveyorGeometry() {}

  virtual void plineProc(const OdGiPolyline& polyline,
    const OdGeMatrix3d* pXfm = 0,
    OdUInt32 fromIndex = 0,
    OdUInt32 numSegs = 0) = 0;

  virtual void polylineProc(
    OdInt32 numPoints, const OdGePoint3d* vertexList,
    const OdGeVector3d* pNormal = 0,
    const OdGeVector3d* pExtrusion = 0,
    OdGsMarker baseSubEntMarker = -1) = 0;
 
 
#if defined(_MSC_VER)
 
// The right function prototype was changed (see above). Old one left to cause compilation error
  virtual void polylineProc(
    OdInt32 /*numPoints*/, const OdGePoint3d* /*vertexList*/,
    const OdGeVector3d* /*pNormal*/,
    const OdGeVector3d* /*pExtrusion*/,
    OdInt32 /*baseSubEntMarker*/) final {ODA_FAIL();}
#endif

  virtual void polygonProc(
    OdInt32 numPoints, const OdGePoint3d* vertexList,
    const OdGeVector3d* pNormal = 0,
    const OdGeVector3d* pExtrusion = 0) = 0;

  virtual void xlineProc(
    const OdGePoint3d& firstPoint, const OdGePoint3d& secondPoint) = 0;

  virtual void rayProc(
    const OdGePoint3d& basePoint, const OdGePoint3d& throughPoint) = 0;

  virtual void meshProc(
    OdInt32 numRows, 
    OdInt32 numColumns,
    const OdGePoint3d* vertexList,
    const OdGiEdgeData* pEdgeData = 0,
    const OdGiFaceData* pFaceData = 0,
    const OdGiVertexData* pVertexData = 0) = 0;

  virtual void shellProc(
    OdInt32 numVertices, const OdGePoint3d* vertexList,
    OdInt32 faceListSize, const OdInt32* faceList,
    const OdGiEdgeData* pEdgeData = 0,
    const OdGiFaceData* pFaceData = 0,
    const OdGiVertexData* pVertexData = 0) = 0;

  virtual void circleProc(
    const OdGePoint3d& center, 
    double radius, 
    const OdGeVector3d& normal, 
    const OdGeVector3d* pExtrusion = 0) = 0;

  virtual void circleProc2(
    const OdGePoint3d& center,
    double radius,
    const OdGeVector3d& normal,
    const OdGeVector3d& /*startVector*/,
    const OdGeVector3d* pExtrusion = 0)
  {
    circleProc(center, radius, normal, pExtrusion);
  }

  virtual void circleProc(
    const OdGePoint3d& firstPoint, 
    const OdGePoint3d& secondPoint, 
    const OdGePoint3d& thirdPoint, 
    const OdGeVector3d* pExtrusion = 0) = 0;
  
  virtual void circularArcProc(
    const OdGePoint3d& center,
    double radius,
    const OdGeVector3d& normal,
    const OdGeVector3d& startVector,
    double sweepAngle,
    OdGiArcType arcType = kOdGiArcSimple, const OdGeVector3d* pExtrusion = 0) = 0;
  
  virtual void circularArcProc(
    const OdGePoint3d& firstPoint,
    const OdGePoint3d& secondPoint,
    const OdGePoint3d& thirdPoint,
    OdGiArcType arcType = kOdGiArcSimple, const OdGeVector3d* pExtrusion = 0) = 0;

  virtual void ellipArcProc(
    const OdGeEllipArc3d& ellipArc,
    const OdGePoint3d* endPointOverrides = 0,
    OdGiArcType arcType = kOdGiArcSimple, const OdGeVector3d* pExtrusion = 0) = 0;

  virtual void nurbsProc(
    const OdGeNurbCurve3d& nurbsCurve) = 0;

  virtual void textProc(
    const OdGePoint3d& position,
    const OdGeVector3d& direction, 
    const OdGeVector3d& upVector,
    const OdChar* msg, 
    OdInt32 numBytes, 
    bool raw, 
    const OdGiTextStyle* pTextStyle,
    const OdGeVector3d* pExtrusion = 0) = 0;

  virtual void textProc2(
    const OdGePoint3d& position,
    const OdGeVector3d& direction, 
    const OdGeVector3d& upVector,
    const OdChar* msg, 
    OdInt32 numBytes, 
    bool raw, 
    const OdGiTextStyle* pTextStyle,
    const OdGeVector3d* pExtrusion = 0,
    const OdGeExtents3d* /*extentsBox*/ = 0)
  {
    textProc(position, direction, upVector, msg, numBytes, raw, pTextStyle, pExtrusion);
  }

  virtual void shapeProc(
    const OdGePoint3d& position,
    const OdGeVector3d& direction, 
    const OdGeVector3d& upVector,
    int shapeNumber, 
    const OdGiTextStyle* pTextStyle,
    const OdGeVector3d* pExtrusion = 0) = 0;

  virtual void rasterImageProc(
    const OdGePoint3d& origin,
    const OdGeVector3d& u,
    const OdGeVector3d& v,
    const OdGiRasterImage* pImage, 
    const OdGePoint2d* uvBoundary, 
    OdUInt32 numBoundPts,
    bool transparency = false,
    double brightness = 50.0,
    double contrast = 50.0,
    double fade = 0.0) = 0;

  virtual void metafileProc(
    const OdGePoint3d& origin,
    const OdGeVector3d& u,
    const OdGeVector3d& v,
    const OdGiMetafile* pMetafile,
    bool dcAligned = true,
    bool allowClipping = false) = 0;

  virtual void xlineProc2(const OdGePoint3d& basePoint, const OdGeVector3d& direction)
  {
    xlineProc(basePoint, basePoint + direction);
  }
  
  virtual void rayProc2(const OdGePoint3d& basePoint, const OdGeVector3d& direction)
  {
    rayProc(basePoint, basePoint + direction);
  }

  virtual void setExtentsProc(const OdGePoint3d * /*pPoints*/, bool /*bTransform*/ = true) { }

  enum ETtfCharProcFlags
  {
    kTtfCharProcEnable     = 1,
    kTtfCharProcBoundBlock = 2
  };
  
  virtual int ttfCharProcFlags() const { return 0; }
  virtual bool ttfCharProc(OdChar /*character*/, bool /*isGlyph*/, const OdGePoint3d& /*position*/,
    const OdGeBoundBlock3d* /*pBoundBlock*/) { return false; }

  virtual void ttfPolyDrawProc(
    OdInt32 numVertices, const OdGePoint3d* vertexList,
    OdInt32 faceListSize, const OdInt32* faceList,
    const OdUInt8* /*pBezierTypes*/, const OdGiFaceData* pFaceData = 0)
  {
    shellProc(numVertices, vertexList, faceListSize, faceList, 0, pFaceData);
  }
  
  enum EConveyorBoundaryInfoFlags
  {
    kBoundaryProcXform       = 1, // Non-identity Xform available at least once
    kBoundaryProcXformNonUni = 2, // Non-uni-scale Xform available at least once
    kBoundaryProcProjection  = 4, // Projective Xform available at least once
    kBoundaryProcClip        = 8, // Boundary clipped partially or completely at least once
    kBoundaryProcClipFull   = 16 // Boundary completely clipped at least once
  };
  virtual void conveyorBoundaryInfoProc(
    const OdGeBoundBlock3d & /*boundBlock*/, // {I} represent block for apply check
    OdUInt32 & /*outputFlags*/) // {O} will represent set of EConveyorBoundaryInfoFlags flags on out
  {
  }

  void polypointProc2(OdGiConveyorContext* pContext,
    OdInt32 numPoints, const OdGePoint3d* vertexList, const OdCmEntityColor* pColors = 0,
    const OdCmTransparency *pTransparency = 0, const OdGeVector3d* pNormals = 0, const OdGeVector3d* pExtrusions = 0,
    const OdGsMarker* pSubEntMarkers = 0, OdInt32 nPointSize = 0);
  
  void rowOfDotsProc2(OdInt32 numPoints, const OdGePoint3d& startPoint, const OdGeVector3d& dirToNextPoint);

  virtual void polypointProc(
    OdInt32 numPoints, const OdGePoint3d* vertexList, const OdCmEntityColor* pColors,
    const OdCmTransparency* pTransparency = 0, const OdGeVector3d* pNormals = 0, const OdGeVector3d* pExtrusions = 0,
    const OdGsMarker* pSubEntMarkers = 0, OdInt32 nPointSize = 0) = 0;

  void polyPolygonProc2(OdGiConveyorContext *pContext,
    OdUInt32 numIndices, const OdUInt32 *pNumPositions, const OdGePoint3d *pPositions,
    const OdUInt32 *pNumPoints, const OdGePoint3d *pPoints,
    const OdCmEntityColor *pOutlineColors = NULL, const OdUInt32 *pOutlinePsLinetypes = NULL,
    const OdCmEntityColor *pFillColors = NULL, const OdCmTransparency *pFillTransparencies = NULL);

  virtual void rowOfDotsProc(
    OdInt32 numPoints, const OdGePoint3d& startPoint, const OdGeVector3d& dirToNextPoint) = 0;
 
  void pointCloudProc2(OdGiConveyorContext* pContext, const OdGiPointCloud &pCloud, const OdGiPointCloudFilter *pFilter);
  virtual void pointCloudProc(const OdGiPointCloud &pCloud, const OdGiPointCloudFilter *pFilter = NULL) = 0;

  virtual void edgeProc(
    const OdGiEdge2dArray& edges, const OdGeMatrix3d* pXform = 0) = 0;
};
 
#endif //#ifndef __ODGICONVEYORGEOMETRY_H__