DbSectionViewStyle.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 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_SECTIONVIEWSTYLE_H
#define OD_SECTIONVIEWSTYLE_H
 
#include "DbModelDocViewStyle.h"
#include "Ge/GeDoubleArray.h"
 
#include "TD_PackPush.h"
 
class TOOLKIT_EXPORT OdDbSectionViewStyle : public OdDbModelDocViewStyle
{
public:
  ODDB_DECLARE_MEMBERS(OdDbSectionViewStyle);
 
  enum IdentifierPosition {
    kEndCuttingPlane             = 0, // The identifier is placed at the end of the cutting plane.
    kAboveDirectionArrowLine     = 1, // The identifier is placed above the direction arrow line.
    kAboveDirectionArrowSymbol   = 2, // The identifier is placed above the direction arrow symbol.
    kStartDirectionArrow         = 3, // The identifier is placed at the start of the direction arrow.
    kEndDirectionArrow           = 4, // The identifier is placed at the end of the direction arrow.
  };
 
  enum ArrowDirection {
    kTowardsCuttingPlane    = 0, // The arrowheads are oriented towards the cutting plane.
    kAwayFromCuttingPlane   = 1, // The arrowheads are oriented away from the cutting plane.
  };
 
  OdDbSectionViewStyle();
  ~OdDbSectionViewStyle();
   
  OdDbObjectId identifierStyleId() const;
 
  OdResult setIdentifierStyleId(const OdDbObjectId &objId);
 
  OdCmColor identifierColor() const;
 
  OdResult setIdentifierColor(const OdCmColor& color);
 
  double identifierHeight() const;
 
  OdResult setIdentifierHeight(double height);
 
  OdString identifierExcludeCharacters() const;
 
  OdResult setIdentifierExcludeCharacters(const OdString& str);
 
  OdDbObjectId arrowStartSymbolId() const;
 
  OdResult setArrowStartSymbolId(const OdDbObjectId &arrowSymbolId);
 
  OdDbObjectId arrowEndSymbolId() const;
 
  OdResult setArrowEndSymbolId(const OdDbObjectId &arrowSymbolId);
 
  OdCmColor arrowSymbolColor() const;
 
  OdResult setArrowSymbolColor(const OdCmColor& color);
 
  double arrowSymbolSize() const;
 
  OdResult setArrowSymbolSize(double size);
 
  double arrowSymbolExtensionLength() const;
 
  OdResult setArrowSymbolExtensionLength(double length);
 
  OdDb::LineWeight planeLineWeight() const;
 
  OdResult setPlaneLineWeight(OdDb::LineWeight lineweight);
 
  OdCmColor planeLineColor() const;
 
  OdResult setPlaneLineColor(const OdCmColor& color);
 
  OdDbObjectId planeLineTypeId() const;
 
  OdResult setPlaneLineTypeId(const OdDbObjectId &objId);
 
  OdCmColor bendLineColor() const;
 
  OdResult setBendLineColor(const OdCmColor& color);
 
  OdDb::LineWeight  bendLineWeight() const;
 
  OdResult setBendLineWeight(OdDb::LineWeight lineweight);
 
  OdDbObjectId bendLineTypeId() const;
 
  OdResult setBendLineTypeId(const OdDbObjectId &objId);
 
  double bendLineLength() const;
 
  OdResult setBendLineLength(double length);
 
  double endLineLength() const;
 
  OdResult setEndLineLength(double length);
 
  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);
 
  OdString hatchPattern() const;
 
  OdResult setHatchPattern(const OdString& pattern);
 
  OdCmColor hatchColor() const;
 
  OdResult setHatchColor(const OdCmColor& color);
 
  OdCmColor hatchBackgroundColor() const;
 
  OdResult setHatchBackgroundColor(const OdCmColor& color);
 
  double hatchScale() const;
 
  OdResult setHatchScale(double scale);
 
  const OdGeDoubleArray& hatchAngles() const;
 
  OdResult setHatchAngles(const OdGeDoubleArray& angleArray);
 
  OdResult setHatchTransparency(const OdCmTransparency& transparency);
 
  OdCmTransparency hatchTransparency() const;
 
  bool isContinuousLabeling() const;
 
  OdResult setContinuousLabeling(bool bValue);
 
  bool showArrowheads() const;
 
  OdResult setShowArrowheads(bool bValue);
 
  bool showViewLabel() const;
 
  OdResult setShowViewLabel(bool bValue);
 
  bool showAllPlaneLines() const;
 
  OdResult setShowAllPlaneLines(bool bValue);
 
  bool showAllBendIndentifiers() const;
 
  OdResult setShowAllBendIndentifiers(bool bValue);
 
  bool showEndAndBendLines() const;
 
  OdResult setShowEndAndBendLines(bool bValue);
 
  bool showHatching() const;
 
  OdResult setShowHatching(bool bValue);
 
  //  Inspects the string that defines the excluded characters of an identifier and checks it
  //  for valid characters and the correct format.
  //
  //  \param [in] str  String of characters that is set as the excluded characters for the identifier.
  //
  //  \returns
  //  True if the string is formatted correctly; false otherwise.
  //*/
  //static bool validateIdentifierExcludeCharacters(const OdString& str);
 
  OdDbSectionViewStyle::IdentifierPosition viewIdentifierPosition() const;
 
  OdResult setViewIdentifierPosition(OdDbSectionViewStyle::IdentifierPosition type);
 
  double viewIdentifierOffset() const;
 
  OdResult setViewIdentifierOffset(double offset);
 
  OdDbSectionViewStyle::ArrowDirection arrowPosition() const;
 
  OdResult setArrowPosition(OdDbSectionViewStyle::ArrowDirection type);
 
  double endLineOvershoot() const;
 
  OdResult setEndLineOvershoot(double length);
 
  // 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;
 
//protected:
//  // For internal use only
//  virtual OdDbObjectPtr subDeepClone(OdDbObject* pOwner,
//                                     OdDbIdMapping& idMap, bool isPrimary = true) const;
//  virtual OdDbObjectPtr subWblockClone(OdDbObject* pOwner,
//                                       OdDbIdMapping& idMap, bool isPrimary = true) const;
};
 
typedef OdSmartPtr<OdDbSectionViewStyle> OdDbSectionViewStylePtr;
 
#include "TD_PackPop.h"
 
#endif // OD_SECTIONVIEWSTYLE_H