PlotStyles.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.
 
 
 
// RxPlotStyle.h -- interfaces for setting up plotstyles support for rendering
 
#ifndef __OD_RX_PLOT_STYLE__
#define __OD_RX_PLOT_STYLE__
 
 
#include "RxObject.h"
#include "CmColorBase.h"
#include "RxModule.h"
#include "Ge/GeDoubleArray.h"
#include "StringArray.h"
 
#define STL_USING_MAP
#define STL_USING_ALGORITHM
#include "OdaSTL.h"
 
class OdStreamBuf;
 
#include "TD_PackPush.h"

namespace OdPs
{
  enum FillStyle
  {
    kFsSolid            = 64,
    kFsCheckerboard     = 65,
    kFsCrosshatch       = 66,
    kFsDiamonds         = 67,
    kFsHorizontalBars   = 68,
    kFsSlantLeft        = 69,
    kFsSlantRight       = 70,
    kFsSquareDots       = 71,
    kFsVerticalBars     = 72,
    kFsUseObject        = 73,
 
    kFsLast             = kFsUseObject
  };
 
  enum LineEndStyle
  {
    kLesButt          = 0,
    kLesSquare        = 1,
    kLesRound         = 2,
    kLesDiamond       = 3,
    kLesUseObject     = 4
  };
  
  enum LineJoinStyle
  {
    kLjsMiter         = 0,
    kLjsBevel         = 1,
    kLjsRound         = 2,
    kLjsDiamond       = 3,
    kLjsUseObject     = 5
  };
  
  // plotstyle's linetype
  
  enum LineType
  {
    kLtpSolid                            = 0,
    kLtpDashed                           = 1,
    kLtpDotted                           = 2,
    kLtpDashDot                          = 3,
    kLtpShortDash                        = 4,
    kLtpMediumDash                       = 5,
    kLtpLongDash                         = 6,
    kLtpShortDashX2                      = 7,
    kLtpMediumDashX2                     = 8,
    kLtpLongDashX2                       = 9,
    kLtpMediumLongDash                   = 10,
    kLtpMediumDashShortDashShortDash     = 11,
    kLtpLongDashShortDash                = 12,
    kLtpLongDashDotDot                   = 13,
    kLtpLongDashDot                      = 14,
    kLtpMediumDashDotShortDashDot        = 15,
    kLtpSparseDot                        = 16,
    kLtpISODash                          = 17,
    kLtpISODashSpace                     = 18,
    kLtpISOLongDashDot                   = 19,
    kLtpISOLongDashDoubleDot             = 20,
    kLtpISOLongDashTripleDot             = 21,
    kLtpISODot                           = 22,
    kLtpISOLongDashShortDash             = 23,
    kLtpISOLongDashDoubleShortDash       = 24,
    kLtpISODashDot                       = 25,
    kLtpISODoubleDashDot                 = 26,
    kLtpISODashDoubleDot                 = 27,
    kLtpISODoubleDashDoubleDot           = 28,
    kLtpISODashTripleDot                 = 29,
    kLtpISODoubleDashTripleDot           = 30,
    kLtpUseObject                        = 31,
 
    kLtpLast = kLtpUseObject
  };
 
}

class OdPsPlotStyleData
{
public:
  enum ColorPolicy
  {
    kDither       = 1,
    kGrayScale    = 2,
    kNotUseObject = 4
  };
 
protected:
  OdCmEntityColor       m_color; 
  OdInt16               m_colorPolicy;
  bool                  m_bAdaptiveLinetype; // not in color policy
  OdInt16               m_screening;
  OdInt16               m_physPenNum;
  OdInt16               m_virtPenNum;
  OdInt16               m_psLt;
  OdInt16               m_fillStyle;
  OdInt16               m_lineEndStyle;
  OdInt16               m_lineJoinStyle;
  double                m_dLinePatSz;
  double                m_lineweight;
 
public:
 
  OdPsPlotStyleData()
    : m_color(255, 255, 255)
    , m_colorPolicy(0)
    , m_bAdaptiveLinetype(false)
    , m_screening(100)
    , m_physPenNum(-1)
    , m_virtPenNum(-1)
    , m_psLt(OdInt16(OdPs::kLtpUseObject))
    , m_fillStyle(OdInt16(OdPs::kFsUseObject))
    , m_lineEndStyle(OdInt16(OdPs::kLesUseObject))
    , m_lineJoinStyle(OdInt16(OdPs::kLjsUseObject))
    , m_dLinePatSz(0.0)
    , m_lineweight(-1)
  {}
 
  FIRSTDLL_EXPORT FIRSTDLL_EXPORT_STATIC static const OdPsPlotStyleData kDefault;
 
   // m_color(255, 255, 255) indicates "UseEntity: in PlotStyles

  bool operator ==(const OdPsPlotStyleData& other) const
  {
    return (
        m_color             == other.m_color             &&
        m_colorPolicy       == other.m_colorPolicy       &&
        m_bAdaptiveLinetype == other.m_bAdaptiveLinetype &&
        m_screening         == other.m_screening         &&
        m_physPenNum        == other.m_physPenNum        &&
        m_virtPenNum        == other.m_virtPenNum        &&
        m_psLt              == other.m_psLt              &&
        m_fillStyle         == other.m_fillStyle         &&
        m_lineEndStyle      == other.m_lineEndStyle      &&
        m_lineJoinStyle     == other.m_lineJoinStyle     &&
        m_dLinePatSz        == other.m_dLinePatSz        &&
        m_lineweight        == other.m_lineweight        
      );
  }

  bool operator !=(const OdPsPlotStyleData& other) const { return !operator ==(other); }

  const OdCmEntityColor&  color() const { return m_color; }
 
  OdInt16 colorPolicy() const { return m_colorPolicy; }
  OdInt16                 physicalPenNumber() const { return m_physPenNum; }
  OdInt16                 virtualPenNumber() const { return m_virtPenNum; }
  
  int                     screening() const { return m_screening; }

  double                  linePatternSize() const { return m_dLinePatSz; }
  OdPs::LineType          linetype() const { return OdPs::LineType(m_psLt); }

  bool                    isAdaptiveLinetype() const { return m_bAdaptiveLinetype; }
  bool                    isGrayScaleOn() const { return GETBIT(m_colorPolicy, kGrayScale); }
  bool                    isDitherOn() const { return GETBIT(m_colorPolicy, kDither); }
  double                  lineweight() const { return m_lineweight; }
  OdPs::FillStyle         fillStyle() const { return OdPs::FillStyle(m_fillStyle); }
  OdPs::LineEndStyle      endStyle()  const { return OdPs::LineEndStyle(m_lineEndStyle); }
  OdPs::LineJoinStyle     joinStyle() const { return OdPs::LineJoinStyle(m_lineJoinStyle); }

  void setColor(const OdCmEntityColor& color) 
  { 
    m_color = color;
    SETBIT(m_colorPolicy, kNotUseObject, !(color.red()==255 && color.green()==255 && color.blue()==255));
    // #CORE-11537 : turn off kNotUseObject bit if kGrayScale bit is set
    if (isGrayScaleOn() && GETBIT(m_colorPolicy, kNotUseObject))
      SETBIT_0(m_colorPolicy, kNotUseObject);
  }
  
  void setColorPolicy(OdInt16 colorPolicy) { m_colorPolicy = colorPolicy; }

  void setPhysicalPenNumber(OdInt16 physicalPenNumber) { m_physPenNum = physicalPenNumber; }
  void setVirtualPenNumber(OdInt16 virtualPenNumber) { m_virtPenNum = virtualPenNumber; }
  void setScreening(int screening) { m_screening = OdInt16(screening); }
  void setLinePatternSize(double linePatternSize) { m_dLinePatSz = linePatternSize; }
  void setLinetype(OdPs::LineType linetype) { m_psLt = OdInt16(linetype); }
  
  void setAdaptiveLinetype(bool adaptiveLinetype) { m_bAdaptiveLinetype = adaptiveLinetype; }
  void setGrayScaleOn(bool grayScaleOn)
  {
    if (grayScaleOn)
    {
      // #CORE-11537 : turn off kNotUseObject bit 
      SETBIT(m_colorPolicy, kNotUseObject, false);
    }
    else
    {
      // #CORE-11537 : turn on kNotUseObject bit if m_color is not white
      SETBIT(m_colorPolicy, kNotUseObject, !(m_color.red() == 255 && m_color.green() == 255 && m_color.blue() == 255));
    }
    SETBIT(m_colorPolicy, kGrayScale, grayScaleOn);
  }

  void setDitherOn(bool ditherOn) { SETBIT(m_colorPolicy, kDither, ditherOn); }
  void setLineweight(double lineweight) { m_lineweight = lineweight; }
  void setFillStyle(OdPs::FillStyle fillStyle) { m_fillStyle = OdInt16(fillStyle); }
  void setEndStyle(OdPs::LineEndStyle lineEndStyle) { m_lineEndStyle = OdInt16(lineEndStyle); }
  void setJoinStyle(OdPs::LineJoinStyle lineJoinStyle) { m_lineJoinStyle = OdInt16(lineJoinStyle); }
};

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

  virtual OdString  name() const = 0;

  virtual OdString  description() const = 0;
  virtual void      getData(OdPsPlotStyleData& data) const = 0;
  virtual OdString  localizedName() const = 0;
 
  virtual void      setData(const OdPsPlotStyleData& data) = 0;
 
  virtual void      setDescription(const OdString& desc) = 0;
 
  virtual void      setName(const OdString& name) = 0;
 
  virtual void      setLocalizedName(const OdString& name) = 0;
 
};

typedef OdSmartPtr<OdPsPlotStyle> OdPsPlotStylePtr;
 
typedef std::map<const OdChar*, OdPsPlotStylePtr, OdString::lessnocase> OdPsPlotStylesMap;
typedef OdArray<OdPsPlotStylePtr> OdPsPlotStylesArray;

class FIRSTDLL_EXPORT OdPsPlotStyleTable : public OdRxObject
{
public:  
  ODRX_DECLARE_MEMBERS(OdPsPlotStyleTable);
 
  virtual OdRxObjectPtr clone() const = 0;
 
  virtual void copyFrom(const OdRxObject* pSource) = 0;

  virtual bool      isApplyScaleFactor() const = 0;

  virtual OdString  description() const = 0;

  virtual double    scaleFactor() const = 0;

  virtual bool      isDisplayCustomLineweightUnits() const = 0;

  virtual double    getLineweightAt(OdUInt32 index) const = 0;

  virtual OdPsPlotStylePtr plotStyleAt(const OdString& name) const = 0;

  virtual OdPsPlotStylePtr plotStyleAt(int index) const = 0;

  virtual unsigned int plotStyleSize() const = 0;
 
  virtual unsigned int lineweightSize() const = 0;
 
  virtual bool isAciTableAvailable() const = 0;
 
  virtual OdPsPlotStylePtr addNewPlotStyle(const OdString& styleName) = 0;
 
  virtual OdPsPlotStylePtr delPlotStyle(OdPsPlotStylePtr pPsPtr) = 0;
 
  virtual void setDescription(const OdString& desc) = 0;
 
  virtual void setScaleFactor(double scFac) = 0;
 
  virtual void setApplyScaleFactor(bool flag) = 0;
 
  virtual void setDisplayCustomLineweightUnits(bool flag) = 0;
 
  virtual void setLineweightAt(double value, OdUInt32 index) = 0;
 
  virtual void setLineweights(const OdGeDoubleArray& lineweights) = 0;
 
  // Methods added in 2.7.0
 
  virtual void setAciTableAvailable(bool flag) = 0;
 
  virtual void setPlotStylesIndexed(const OdPsPlotStylesArray plotStylesIndexed) = 0;
 
  virtual void setPlotStyles(const OdPsPlotStylesMap plotStyles) = 0;
 
  virtual void addPlotStyle(OdPsPlotStyle* pPs) = 0;
 
  virtual void setOrdering(const OdStringArray& order) = 0;
 
  virtual OdPsPlotStylesMap plotStyles() const = 0;
 
  virtual OdPsPlotStylesArray plotStylesIndexed() const = 0;
};

typedef OdSmartPtr<OdPsPlotStyleTable> OdPsPlotStyleTablePtr;

class FIRSTDLL_EXPORT OdPsPlotStyleServices : public OdRxModule
{
public:
  ODRX_DECLARE_MEMBERS(OdPsPlotStyleServices);

  virtual OdPsPlotStyleTablePtr createPlotStyleTable() = 0;
  virtual OdPsPlotStyleTablePtr loadPlotStyleTable(OdStreamBuf* pStreamBuf) = 0;
  virtual void                  savePlotStyleTable(OdStreamBuf* pBuf, OdPsPlotStyleTablePtr pPSTab) = 0;
 
};

typedef OdSmartPtr<OdPsPlotStyleServices> OdPsPlotStyleServicesPtr;
 
#include "TD_PackPop.h"
 
#endif // __OD_RX_PLOT_STYLE__