DbDetailViewStyle.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 OD_DETAILVIEWSTYLE_H
#define OD_DETAILVIEWSTYLE_H
 
#include "DbModelDocViewStyle.h"
 
#include "TD_PackPush.h"
 
class DBENT_EXPORT OdDbDetailViewStyle : public OdDbModelDocViewStyle
{
public:
  ODDB_DECLARE_MEMBERS(OdDbDetailViewStyle);
 
        enum IdentifierPlacement {
          kOutsideBoundary = 0, // Identifier is placed outside of the detail view symbol boundary.
    kOutsideBoundaryWithLeader = 1, // Identifier is placed outside of the detail view symbol boundary, and the leader between the identifier and the boundary is drawn.
    kOnBoundary = 2, // Identifier is placed on the detail view symbol boundary.
    kOnBoundaryWithLeader, // Identifier is placed on the detail view symbol boundary. If then the identifier is moved out of the boundary, the leader is added.
  };
 
  enum ModelEdge {
    kSmooth = 0, // The edge of detail view symbol is to be smooth.
    kSmoothWithBorder,
    kSmoothWithConnectionLine,
    kJagged,
  };
 
  OdDbDetailViewStyle();
  ~OdDbDetailViewStyle();
 
  OdDbObjectId identifierStyleId() const;
 
  OdResult setIdentifierStyleId(const OdDbObjectId& objId);
 
  OdCmColor identifierColor() const;
 
  OdResult setIdentifierColor(const OdCmColor& color);
 
  double identifierHeight() const;
 
  OdResult setIdentifierHeight(double height);
 
  double identifierOffset() const;
 
  OdResult setIdentifierOffset(double offset);
 
  OdDbDetailViewStyle::IdentifierPlacement identifierPlacement() const;
 
  OdResult setIdentifierPlacement(OdDbDetailViewStyle::IdentifierPlacement placement);
 
  OdDbObjectId arrowSymbolId() const;
 
  OdResult setArrowSymbolId(const OdDbObjectId& arrowSymbolId);
 
  OdCmColor arrowSymbolColor() const;
 
  OdResult setArrowSymbolColor(const OdCmColor& color);
 
  double arrowSymbolSize() const;
 
  OdResult setArrowSymbolSize(double size);
 
  bool showArrows() const;
  OdResult setShowArrows(bool bValue);
 
  OdDb::LineWeight  boundaryLineWeight() const;
 
  OdResult setBoundaryLineWeight(OdDb::LineWeight lineweight);
 
  OdCmColor boundaryLineColor() const;
 
  OdResult setBoundaryLineColor(const OdCmColor& color);
 
  OdDbObjectId boundaryLineTypeId() const;
  
  OdResult setBoundaryLineTypeId(const OdDbObjectId &objId);
 
  OdDb::LineWeight connectionLineWeight() const;
 
  OdResult setConnectionLineWeight(OdDb::LineWeight lineweight);
 
  OdCmColor connectionLineColor() const;
 
  OdResult setConnectionLineColor(const OdCmColor& color);
 
  OdDbObjectId connectionLineTypeId() const;
 
  OdResult setConnectionLineTypeId(const OdDbObjectId& objId);
 
  OdDbObjectId viewLabelTextStyleId() const;
 
  OdResult setViewLabelTextStyleId(const OdDbObjectId &objId);
 
  OdCmColor viewLabelTextColor() const;
 
  OdResult setViewLabelTextColor(const OdCmColor& color);
 
  double viewLabelTextHeight() const;
  OdResult setViewLabelTextHeight(double height);
 
  double viewLabelOffset() const;
 
  OdResult setViewLabelOffset(double offset);
 
  OdDbModelDocViewStyle::AttachmentPoint viewLabelAttachment() const;
 
  OdResult setViewLabelAttachment(OdDbModelDocViewStyle::AttachmentPoint attachment);
 
  OdDbModelDocViewStyle::TextAlignment viewLabelAlignment() const;
 
  OdResult setViewLabelAlignment(OdDbModelDocViewStyle::TextAlignment alignment);
 
  OdString viewLabelPattern() const;
 
  OdString getViewLabelPattern(OdDbField* pField = NULL) const;
 
  OdResult setViewLabelPattern(const OdString& pattern,
                                        const OdDbField* pField = NULL);
 
  bool showViewLabel() const;
  OdResult setShowViewLabel(bool bValue);
 
  OdDbDetailViewStyle::ModelEdge modelEdge() const;
 
  OdResult setModelEdge(OdDbDetailViewStyle::ModelEdge placement);
 
  OdDb::LineWeight borderLineWeight() const;
 
  OdResult setBorderLineWeight(OdDb::LineWeight lineweight);
 
  OdCmColor borderLineColor() const;
 
  OdResult setBorderLineColor(const OdCmColor& color);
 
  OdDbObjectId borderLineTypeId() const;
 
  OdResult setBorderLineTypeId(const OdDbObjectId &objId);
 
  // OdDbModelDocViewStyle overridden functions
  virtual OdDbObjectId postViewStyleToDb(OdDbDatabase* pDb, const OdString& styleName);
 
protected:
  // OdDbObject overridden functions
  virtual OdResult dwgInFields(OdDbDwgFiler* pFiler);
  virtual void dwgOutFields(OdDbDwgFiler* pFiler) const;
  virtual OdResult dxfInFields(OdDbDxfFiler* pFiler);
  virtual void dxfOutFields(OdDbDxfFiler* pFiler) const;
 
  // For internal use only
//  virtual OdDbObjectPtr subDeepClone(OdDbIdMapping& idMap, OdDbObject* pOwner, bool isPrimary = true) const;
  virtual OdDbObjectPtr subWblockClone(OdDbIdMapping& idMap, OdDbObject* pOwner, bool isPrimary = true) const;
};
 
typedef OdSmartPtr<OdDbDetailViewStyle> OdDbDetailViewStylePtr;
 
#include "TD_PackPop.h"
 
#endif // OD_DETAILVIEWSTYLE_H