DbMText.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_DBMTEXT_H
#define OD_DBMTEXT_H
 
#include "TD_PackPush.h"
 
#include "DbEntity.h"
#include "TextDefs.h"
#include "Ge/GePoint2d.h"
#include "Ge/GePoint3d.h"
#include "Ge/GeDoubleArray.h"
 
class OdGeVector3d;
class OdGePoint2d;
 
struct OdDbMTextFragment
{
  OdGePoint3d location;           // Insertion point.
 
  /* OdGeVector3d normal;
     OdGeVector3d direction;
  */
 
  OdString text;                  // Text string.
 
  OdString font;                  // SHX Font.
  OdString bigfont;               // SHX Bigfont.
 
  OdGePoint2d extents;            // Extents in OCS.
  double capsHeight;              // Height.
  double widthFactor;             // Width factor.
  double obliqueAngle;            // Obliquing angle.
  double trackingFactor;          // Tracking factor.
 
  // OdUInt16 colorIndex;
 
  OdCmEntityColor color;          // Color.
  bool vertical;                  // Text is vertical.
 
  bool stackTop;                  // Text is top of stacked text.
  bool stackBottom;               // Text is bottom of stacked text.
 
  bool underlined;                // Text is underlined.
  bool overlined;                 // Text is overlined.
  bool strikethrough;
 
  OdGePoint3d underPoints[2];     // Underline endpoints.
  OdGePoint3d overPoints[2];      // Overline endpoints.
  OdGePoint3d strikePoints[2];
 
  //  true type font data
 
  OdString  fontname;             // TrueType font name, or empty string.
  int       charset;              // TrueType character set.
  bool      bold;                 // Text is bold.
  bool      italic;               // Text is italic.
 
  // 0 - no change 1 - change to original 2 - change to other
 
  int      changeStyle;           // 0 == No change; 1 == Change to original; 2 == Change to other
  bool     lineBreak;             // Text is followed by a line break.
  bool     newParagraph;          // Text fragment starts new paragraph.
};
 
struct OdDbMTextIndent
{
  double  paragraphInd;  // Subsequent line indent.
 
  double  firstLineInd;  // First line indent.
 
  OdGeDoubleArray tabs; // Tab settings.
};
 
typedef int(*OdDbMTextEnum)(
    OdDbMTextFragment *,
    void *);
 
typedef OdArray<OdDbMTextIndent> OdDbMTextIndents;
 
class OdDbText;
 
class TOOLKIT_EXPORT OdDbMText : public OdDbEntity
{
public:
  ODDB_DECLARE_MEMBERS(OdDbMText);
 
  OdDbMText();
 
  OdGePoint3d location() const;
 
  void setLocation(
    const OdGePoint3d& location);
 
  OdGeVector3d normal() const;
 
  void setNormal(
    const OdGeVector3d& normal);
 
  OdGeVector3d direction() const;
 
  void setDirection(
    const OdGeVector3d& direction);
 
  double rotation() const;
 
  void setRotation(
    double rotation);
 
  double width() const;
 
  void setWidth(
    double width);
 
  OdDbObjectId textStyle() const;
 
  void setTextStyle(
    OdDbObjectId textStyleId);
 
  double textHeight() const;
 
  void setTextHeight(
    double height);
 
  enum AttachmentPoint
  {
    kTopLeft        = 1,    // Top Left
    kTopCenter      = 2,    // Top Center
    kTopRight       = 3,    // Top Right
    kMiddleLeft     = 4,    // Middle Left
    kMiddleCenter   = 5,    // Middle Center
    kMiddleRight    = 6,    // Middle Right
    kBottomLeft     = 7,    // Bottom Left
    kBottomCenter   = 8,    // Bottom Center
    kBottomRight    = 9,    // Bottom Right
    kBaseLeft       = 10,   // Baseline Left /reserved for future use/
    kBaseCenter     = 11,   // Baseline Center /reserved for future use/
    kBaseRight      = 12,   // Baseline Right /reserved for future use/
    kBaseAlign      = 13,   // Baseline Aligned /reserved for future use/
    kBottomAlign    = 14,   // Bottom Aligned /reserved for future use/
    kMiddleAlign    = 15,   // Middle Aligned /reserved for future use/
    kTopAlign       = 16,   // Top Aligned /reserved for future use/
    kBaseFit        = 17,   // Baseline Fit /reserved for future use/
    kBottomFit      = 18,   // Bottom Fit /reserved for future use/
    kMiddleFit      = 19,   // Middle Fit /reserved for future use/
    kTopFit         = 20,   // Top Fit /reserved for future use/
    kBaseMid        = 21,   // Baseline Middled /reserved for future use/
    kBottomMid      = 22,   // Bottom Middled /reserved for future use/
    kMiddleMid      = 23,   // Middle Middled /reserved for future use/
    kTopMid         = 24    // Top Middled /reserved for future use/
  };
 
  AttachmentPoint attachment() const;
 
  void setAttachment(
    AttachmentPoint type);
 
  enum FlowDirection
  {
    kLtoR     = 1,  // Left to Right
    kRtoL     = 2,  // Right to Left
    kTtoB     = 3,  // Top to Bottom
    kBtoT     = 4,  // Bottom to Top
    kByStyle  = 5   // By Style
  };
 
  FlowDirection flowDirection() const;
 
  void setFlowDirection(
    FlowDirection flowDirection);
 
  OdString contents() const;
 
  int setContents(const OdString& text);
 
  int setContentsRTF(const OdString& text);
 
  double actualWidth() const;
 
  static const OdString nonBreakSpace();
 
  static const OdString overlineOn();
 
  static const OdString overlineOff();
 
  static const OdString underlineOn();
 
  static const OdString underlineOff();
 
  static const OdString colorChange();
 
  static const OdString fontChange();
 
  static const OdString heightChange();
 
  static const OdString widthChange();
 
  static const OdString obliqueChange();
 
  static const OdString trackChange();
 
  static const OdString lineBreak();
 
  static const OdString paragraphBreak();
 
  static const OdString stackStart();
 
  static const OdString alignChange();
 
  static const OdString blockBegin();
 
  static const OdString blockEnd();
 
  static const OdString strikethroughOn(); 
 
  static const OdString strikethroughOff();
 
  void setLineSpacingStyle(
    OdDb::LineSpacingStyle lineSpacingStyle);
 
  OdDb::LineSpacingStyle lineSpacingStyle() const;
 
  void setLineSpacingFactor(
    double lineSpacingFactor);
 
  double lineSpacingFactor() const;
 
  OdDb::TextHorzMode horizontalMode() const;
 
  void setHorizontalMode(
    OdDb::TextHorzMode horizontalMode);
 
  OdDb::TextVertMode verticalMode() const;
 
  void setVerticalMode(
    OdDb::TextVertMode verticalMode);
 
  OdGeMatrix3d getEcs( ) const;
  
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
  bool subWorldDraw(
    OdGiWorldDraw* pWd) const;
 
  void subViewportDraw(
    OdGiViewportDraw* pVd) const;
 
  virtual OdResult subTransformBy(const OdGeMatrix3d& xfm);
 
  virtual OdResult subExplode(
    OdRxObjectPtrArray& entitySet) const;
 
  virtual OdResult explodeGeometry(
    OdRxObjectPtrArray& entitySet) const;
 
  OdResult subGetClassID(
    void* pClsid) const;
 
  void subClose();
 
  void explodeFragments(
    OdDbMTextEnum fragmentFn,
    void *params,
    OdGiWorldDraw *ctxt = 0) const;
 
  double actualHeight(
    OdGiWorldDraw *ctxt = 0) const;
 
  void getActualBoundingPoints(
    OdGePoint3dArray& boundingPoints, double dGapX = 0., double dGapY = 0.) const;
 
  void getBoundingPoints(
    OdGePoint3dArray& boundingPoints) const;
 
  OdResult setAttachmentMovingLocation(
    AttachmentPoint attachment);
 
  virtual OdResult subGetGeomExtents(
    OdGeExtents3d& extents) const;
 
  bool backgroundFillOn() const;
 
  void setBackgroundFill(
    bool bEnable);
 
  OdCmColor getBackgroundFillColor() const;
 
  void setBackgroundFillColor(
    const OdCmColor& color);
 
  double getBackgroundScaleFactor() const;
 
  void setBackgroundScaleFactor(
    const double scaleFactor);
 
  OdCmTransparency getBackgroundTransparency() const;
 
  void setBackgroundTransparency(
    const OdCmTransparency& transparency);
 
  bool useBackgroundColorOn() const;
 
  void setUseBackgroundColor(
    bool enable);
 
  void getParagraphsIndent(
    OdDbMTextIndents& indents) const;
 
  OdDbObjectId setField(
    const OdString& fieldName,
    OdDbField* pField);
  OdResult removeField(
    OdDbObjectId fieldId);
  OdDbObjectId removeField(
    const OdString& fieldName);
 
  void convertFieldToText();
 
  void subSetDatabaseDefaults(
    OdDbDatabase *pDb,
    bool doSubents);
 
  enum ColumnType {
    kNoColumns,
    kStaticColumns,
    kDynamicColumns
  };
 
  void setDynamicColumns(double width, double gutter, bool bAutoHeigh);
  void setStaticColumns(double width, double gutter, OdInt16 count);
 
  ColumnType getColumnType() const;
 
  void setColumnType(ColumnType colType);
 
  bool getColumnAutoHeight() const;
 
  void setColumnAutoHeight(bool bAutoHeigh);
 
  OdInt32 getColumnCount() const;
 
  void setColumnCount(OdInt32 numCol);
 
  double getColumnWidth() const;
 
  void setColumnWidth(double colWidth);
 
  double getColumnGutterWidth() const;
 
  void setColumnGutterWidth(double colGutter);
 
  bool getColumnFlowReversed() const;
 
  void setColumnFlowReversed(bool bFlowRev);
 
  double getColumnHeight(OdInt16 col) const;
 
  void setColumnHeight(OdInt16 col, double colHeight);
 
  double height() const;
 
  void setHeight(double value);
 
  virtual OdResult getPlane(OdGePlane& plane, OdDb::Planarity& planarity) const;
 
  virtual OdResult subGetTransformedCopy(const OdGeMatrix3d& mat, OdDbEntityPtr& pCopy) const;
 
  double      ascent() const;
 
  double      descent() const;
 
  void setShowBorders(bool bEnable);
 
  bool showBorders();
 
  OdString text();
};
 
typedef OdSmartPtr<OdDbMText> OdDbMTextPtr;
 
#include "TD_PackPop.h"
 
#endif