DbFlattenViewsHelper.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 _FLATTENEDVIEWSHELPER_DEFINED
#define _FLATTENEDVIEWSHELPER_DEFINED
 
#include "DbSectionHLRHelper.h"
#include "DbHatch.h"

struct DBENT_EXPORT OdDbHLRCurveProperties
{
  OdDbHLRCurveProperties();
  void applyToEntity(OdDbEntity* pEnt, const OdDbDatabase* pDb) const;
  OdDbObjectId     idLayer;
  OdCmColor        color;
  OdDb::LineWeight lineWeight;
  OdDbObjectId     idLineType;
  double           dLineTypeScale;
  OdCmTransparency transparency;
};
 
//====================================================================================================

struct DBENT_EXPORT OdDbSectionHatchPatternSettings
{
  OdDbSectionHatchPatternSettings();
  OdDbHLRCurveProperties      hatchCurveProperties;
  OdString                    strPatternName;
  OdDbHatch::HatchPatternType patternType;
  OdHatchPattern              userDefinedPattern;
  double                      dPatternAngle;
  double                      dPatternScale;
};
 
//====================================================================================================

class DBENT_EXPORT OdDbFlattenViewsHelper
{
  public:
    OdDbFlattenViewsHelper( OdDbDatabase* pDb );

    virtual ~OdDbFlattenViewsHelper();

    OdDbDatabase* database() const;

    OdResult          setProjectionPlane(const OdGePoint3d& ptBase, const OdGeVector3d& vrDir, const OdGeVector3d& vrUp);

    OdGePoint3d   projectionBase() const;

    OdGeVector3d  projectionDirection() const;

    OdGeVector3d  projectionUp() const;

    bool          includeTangentalEdgesFlag() const;

    void          setIncludeTangentalEdgesFlag(bool bSet);

    void          setTangentalEdgesAngle(double dAngle);

    OdResult      setEntities(const OdDbObjectIdArray& arr3dObjects);

    const OdArray<OdDbObjectId>& getEntities() const;

    OdGeExtents3d getExtents() const;

    OdResult      createSectionHLR(bool bCreateSection, bool bCreateHiddenLines);

    OdResult      addToBlock(OdDbBlockTableRecord* pOwner, const OdGeMatrix3d& matTransform = OdGeMatrix3d::kIdentity);

    const OdDbHLRCurveProperties& foregroundCurveProperties() const;

    void               setForegroundCurveProperties(const OdDbHLRCurveProperties& curveProp);

    const OdDbHLRCurveProperties& obscuredCurveProperties() const;

    void               setObscuredCurveProperties(const OdDbHLRCurveProperties& curveProp);

    const OdDbSectionHatchPatternSettings& sectionHatchSettings() const;

    void               setSectionHatchSettings(const OdDbSectionHatchPatternSettings& patternSettings);

    bool          getSectionHatches(OdRxObjectPtrArray& arrHatches, bool bSetProperties) const;

    bool          getHiddenLines(OdRxObjectPtrArray& arrHiddenLines, bool bSetProperties) const;

    bool          getVisibleLines(OdRxObjectPtrArray& arrVisibleLines, bool bSetProperties) const;
 
private:
  OdDbSectionHLRHelperPtr         m_pSectionHLRHelper;
  OdDbHLRCurveProperties          m_foregroundProperties;
  OdDbHLRCurveProperties          m_obscuredProperties;
  OdDbSectionHatchPatternSettings m_sectionHatchSettings;
};

 
#endif  /* _FLATTENEDVIEWSHELPER_DEFINED */