GiCommonDraw.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 __ODGICOMMONDRAW_H__
#define __ODGICOMMONDRAW_H__
 
#include "TD_PackPush.h"
 
#include "RxObject.h"
#include "Gi/Gi.h"
 
class OdGiGeometry;
class OdGiContext;
class OdGiSubEntityTraits;
class OdDbStub;
typedef OdRxObject OdDbBaseDatabase;
class OdGePoint3d;
class OdGiDrawable;
class OdGiPathNode;
class OdGiSelectionStyle;

typedef OdSmartPtr<OdGiDrawable> OdGiDrawablePtr;

typedef enum
{
  eOdGiRegenTypeInvalid         = 0,  // Invalid regen type. 
  kOdGiStandardDisplay          = 2,  // Regenerating for 2D wireframe display. 
  kOdGiHideOrShadeCommand       = 3,  // Regenerating for legacy hide or shade commands. 
  kOdGiRenderCommand            = 4,  // Regenerating for rendered display.
  kOdGiForExplode               = 5,  // Regenerating for explode.  
  kOdGiSaveWorldDrawForProxy    = 6,  // Regenerating for proxy. 
  kOdGiForExtents               = 7   // Regenerating for extents. 
} OdGiRegenType;

typedef enum
{
  kOdGiMaxDevForCircle      = 0,  // Set maximum deviation for circles.
  kOdGiMaxDevForCurve       = 1,  // Set maximum deviation for curves.
  kOdGiMaxDevForBoundary    = 2,  // Set maximum deviation for boundaries.
  kOdGiMaxDevForIsoline     = 3,  // Set maximum deviation for isolines.
  kOdGiMaxDevForFacet       = 4   // Set maximum deviation for facets.
} OdGiDeviationType;
 
class OdGiCommonDraw;
class OdGiTextStyle;
class OdPsPlotStyleData;
class OdGiConveyorGeometry;

enum
{
  kOdGiIncludeScores    = 2,  // Include scores during text vectorization.
  kOdGiRawText          = 4,  // Vectorize text in one raw.
  kOdGiIncludePenups    = 8,  // Include penups during text vectorization.
  kOdGiDrawShape        = 16, // Draw shapes during text vectorization.
  kOdGiIgnoreMIF        = 32,  // Ignore MIF during text vectorization.
  kOdGiLastPosOnly      = 64,   // Calculate last position only (for internal use only)
  kForMTextExtents      = 128  // 
 ,kOdGiTextExtents      = 0x10000000 //FELIX_CHANGE
};
 
class OdGiSectionGeometryManager;
typedef OdSmartPtr<OdGiSectionGeometryManager> OdGiSectionGeometryManagerPtr;

class FIRSTDLL_EXPORT OdGiContext : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdGiContext);

  virtual OdDbBaseDatabase* database() const = 0;

  virtual OdGiDrawablePtr openDrawable(
    OdDbStub* drawableId) = 0;

  virtual OdDb::LineWeight defaultLineWeight() const;

  virtual double commonLinetypeScale() const;

  virtual void getDefaultTextStyle(
    OdGiTextStyle& textStyle);

  virtual void drawShape(
    OdGiCommonDraw* pDraw, 
    OdGePoint3d& position, 
    int shapeNumber, 
    const OdGiTextStyle* pTextStyle);

  virtual void drawShape(
    OdGiConveyorGeometry* pDest,
    const OdGePoint3d& position,
    const OdGeVector3d& direction, 
    const OdGeVector3d& upVector,
    int shapeNumber, 
    const OdGiTextStyle* pTextStyle,
    const OdGeVector3d* pExtrusion);

  virtual void drawText(
    OdGiCommonDraw* pDraw, 
    OdGePoint3d& position,
    const OdChar* msg, 
    OdInt32 numBytes,
    const OdGiTextStyle* pTextStyle, 
    OdUInt32 flags = 0);

  virtual void drawText(
    OdGiCommonDraw* pDraw, 
    OdGePoint3d& position,
    double height, 
    double width, 
    double oblique, 
    const OdString& msg);

  virtual void drawText(
    OdGiConveyorGeometry* pDest,
    const OdGePoint3d& position,
    const OdGeVector3d& direction, 
    const OdGeVector3d& upVector,
    const OdChar* msg, 
    OdInt32 numBytes, 
    bool raw,
    const OdGiTextStyle* pTextStyle,
    const OdGeVector3d* pExtrusion);

  virtual void textExtentsBox(
    const OdGiTextStyle& textStyle, 
    const OdChar* msg, 
    int nLength,
    OdUInt32 flags, 
    OdGePoint3d& min, 
    OdGePoint3d& max, 
    OdGePoint3d* pEndPos = 0);

  virtual void shapeExtentsBox(
    const OdGiTextStyle& textStyle, 
    int shapeNumber, 
    OdGePoint3d& min, 
    OdGePoint3d& max);

  virtual unsigned int circleZoomPercent(
    OdDbStub* viewportId) const;

  virtual bool isPlotGeneration() const;

  virtual ODCOLORREF paletteBackground() const;

  virtual bool fillTtf() const;

  virtual OdUInt32 numberOfIsolines() const;

  virtual bool fillMode() const;

  virtual bool quickTextMode() const;

  virtual OdUInt32 textQuality() const;

  virtual bool useTtfTriangleCache() const;

  virtual double getAnnotationScale(OdDbStub* viewportId);

  enum ImageQuality
  {
    kImageQualityDraft = 0,  // Draft quality.
    kImageQualityHigh  = 1   // High quality.
  };

  virtual ImageQuality imageQuality() const;

  enum ImageSelectionFlags
  {
    kImageHighlight = (1 << 0), // Highlight contents of a raster image.
    kImageSelect    = (1 << 1)  // Select contents of a raster image.
  };

  virtual OdUInt32 imageSelectionBehavior() const;

  enum FadingType
  {
    kLockedLayerFade = 0,  // Fading objects on locked layers.
    kXrefFade        = 1,  // Fading xref objects.
    kRefEditFade     = 2   // Fading references being edited.
  };

  virtual OdUInt32 fadingIntensityPercentage(FadingType fadingType) const;

  enum GlyphType
  {
    kLightGlyph  = 0,  // Light glyph.
    kCameraGlyph = 1   // Camera glyph.
  };

  virtual OdUInt32 glyphSize(GlyphType glyphType) const;
  
  enum LineWeightStyle
  {
    kPointLineWeight = 0,  // Point lineweight style.
    kLineCapStyle    = 1,  // Line cap style.
    kLineJoinStyle   = 2   // Line join style.
  };

  virtual OdUInt32 lineWeightConfiguration(LineWeightStyle styleEntry) const;
  
  virtual OdUInt32 selectionStyle(OdUInt32 nStyle, OdGiSelectionStyle &selStyle) const;

  enum CoordinatesSystem
  {
    kWCS = 0,
    kECS = 1,
    kNDC = 2,
    kDCS = 3
  };

  virtual CoordinatesSystem customViewportGeometryCS(CoordinatesSystem csType) const;

  enum DrawableFilterInputFlags 
  { 
    kNestedDrawable = 0x1000000  // Nested drawable flag.
  };
  
  enum DrawableFilterOutputFlags 
  { 
    kSkipVectorization = 1  // Skip vectorization flag.
  };
  
  enum DrawableFilterRanges 
  { 
          kDrawableFilterAppRangeStart = 0x1000000                    // Start of the drawable filter range.
#if defined(OD_SWIGCSHARP)
    , kDrawableFilterAppRangeMask          = (uint)0xFF000000     // Drawable filter range mask for C#.
#elif defined(OD_SWIGJAVA)
    , kDrawableFilterAppRangeMask          = (long)0xFF000000     // Drawable filter range mask for Java.
#else
    , kDrawableFilterAppRangeMask          = (OdInt32)0xFF000000  // Drawable filter range mask for other languages.
#endif
  };

  virtual OdIntPtr drawableFilterFunctionId(OdDbStub* viewportId) const;

  virtual OdUInt32 drawableFilterFunction(OdIntPtr functionId, const OdGiDrawable *pDrawable, OdUInt32 nFlags) ODRX_FINAL;

  virtual OdUInt32 drawableFilterFunction(OdIntPtr functionId, const OdGiPathNode* pPathNode, OdUInt32 nFlags);

  virtual bool ttfPolyDraw() const;

  virtual bool regenAbort() const;

  enum PStyleType
  {
    kPsNone           = 0,  // Style is disabled.
    kPsByColor        = 1,  // "By color" style.
    kPsByName         = 2   // "By name" style.
  };
  
  virtual PStyleType plotStyleType() const;
  
  virtual void plotStyle(
    int penNumber, 
    OdPsPlotStyleData& plotStyleData) const;

  virtual void plotStyle(
    OdDbStub* objectId, 
    OdPsPlotStyleData& plotStyleData) const;

  virtual OdDbStub* getStubByID( OdUInt64 persistentId ) const;

  virtual OdUInt64 getIDByStub( OdDbStub* objectId ) const;

  virtual OdDbBaseDatabase *getDatabaseByStub( OdDbStub* objectId ) const;

  virtual OdDbStub* getOwnerIDByStub( OdDbStub* objectId ) const;

  virtual OdDbStub* getStubByMatName( OdDbBaseDatabase *pBaseDb, const OdString& strMatName ) const;

  virtual OdDbStub* getStubByMaterialId(OdDbBaseDatabase *pBaseDb, const OdUInt64& materialId) const;

  enum SilhouetteType
  {
    kNoSilhouettes      = 0,        // Disables all types of silhouettes.
    kMeshSilhouettes    = (1 << 0), // Generates silhouettes for mesh primitives on Gi side.
    kModelerSilhouettes = (1 << 1), // Generates silhouettes for Brep's on modeler geometry side.
    kAllSilhouettes     = kMeshSilhouettes | kModelerSilhouettes // Enables all types of silhouettes.
  };

  virtual OdUInt32 displaySilhouettes() const;
  inline bool displayMeshSilhouettes() const    { return GETBIT(displaySilhouettes(), kMeshSilhouettes); }
  inline bool displayModelerSilhouettes() const { return GETBIT(displaySilhouettes(), kModelerSilhouettes); }

  virtual OdGiSectionGeometryManagerPtr getSectionGeometryManager();

  virtual OdUInt32 antiAliasingMode() const;

  virtual bool xrefPropertiesOverride() const;

  virtual bool multiplyByBlockLinetypeScales() const;
};

class FIRSTDLL_EXPORT OdGiCommonDraw : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdGiCommonDraw);

  virtual OdGiRegenType regenType() const = 0;

  virtual bool regenAbort() const = 0;

  virtual OdGiSubEntityTraits& subEntityTraits() const = 0;

  virtual OdGiGeometry& rawGeometry() const = 0;

  virtual bool isDragging() const = 0;
  
  virtual double deviation(
    const OdGiDeviationType deviationType, 
    const OdGePoint3d& pointOnCurve) const = 0;

  virtual OdUInt32 numberOfIsolines() const = 0;

  virtual OdGiContext* context() const = 0;

  virtual const OdGiPathNode* currentGiPath() const;

  virtual bool displayModelerSilhouettes() const;
};

class FIRSTDLL_EXPORT OdGiDrawFlagsHelper
{
  protected:
    OdGiSubEntityTraits *m_pTraits;
    OdUInt32 m_prevFlags;
  public:
    
    OdGiDrawFlagsHelper(OdGiSubEntityTraits &pTraits, OdUInt32 addFlags, OdUInt32 delFlags = 0)
      : m_pTraits(NULL)
      , m_prevFlags(0)
    {
      if (addFlags || delFlags)
      {
        m_prevFlags = pTraits.drawFlags();
        OdUInt32 newFlags = (m_prevFlags & ~delFlags) | addFlags;
        if (m_prevFlags != newFlags)
        {
          pTraits.setDrawFlags(newFlags);
          m_pTraits = &pTraits;
        }
      }
    }
    
    ~OdGiDrawFlagsHelper()
    {
      if (m_pTraits)
        m_pTraits->setDrawFlags(m_prevFlags);
    }
};
 
class OdGiSelectionGeomState
{
protected:
  OdGiSubEntityTraits* m_pTraits;
  bool m_bSaved;
public:
  OdGiSelectionGeomState(OdGiSubEntityTraits* pTraits, bool bOn) : m_pTraits(pTraits), m_bSaved(false)
  {
    if (m_pTraits)
    {
      m_bSaved = m_pTraits->selectionGeom();
      m_pTraits->setSelectionGeom(bOn);
    }
  }
  
  ~OdGiSelectionGeomState()
  {
    if (m_pTraits)
      m_pTraits->setSelectionGeom(m_bSaved);
  }
};
#include "TD_PackPop.h"
 
#endif