opennurbs_annotationbase.h

/* $NoKeywords: $ */
/*
//
// Copyright (c) 1993-2012 Robert McNeel & Associates. All rights reserved.
// OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert
// McNeel & Associates.
//
// THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY.
// ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF
// MERCHANTABILITY ARE HEREBY DISCLAIMED.
//
// For complete openNURBS copyright information see <http://www.opennurbs.org>.
//
////////////////////////////////////////////////////////////////
*/

#if !defined(OPENNURBS_ANNOTATIONBASE_INC_)
#define OPENNURBS_ANNOTATIONBASE_INC_




class ON_CLASS ON_Annotation : public ON_Geometry
{
  ON_OBJECT_DECLARE(ON_Annotation);

protected:
  ON_Annotation( ON::AnnotationType annotation_type );
  ON_Annotation( const ON_Annotation& src);
  ~ON_Annotation();
  ON_Annotation& operator=(const ON_Annotation& src);

public:
  static ON_Annotation* CreateFromV2Annotation(
    const class ON_OBSOLETE_V2_Annotation& V2_annotation,
    const class ON_3dmAnnotationContext* annotation_context
  );

public:
  static ON_Annotation* CreateFromV5Annotation(
    const class ON_OBSOLETE_V5_Annotation& V5_annotation,
    const class ON_3dmAnnotationContext* annotation_context
  );

protected:
  void Internal_SetDimStyleFromV5Annotation(
    const class ON_OBSOLETE_V5_Annotation& V5_annotation,
    const class ON_3dmAnnotationContext* annotation_context
  );


private:
  ON_Annotation() = delete;

private:
  void Internal_CopyFrom(const ON_Annotation& src);
  void Internal_Destroy();

public:
  /*
  Returns:
    An ON::AnnotationType value that indicates the
    type of the annotation.
  */
  ON::AnnotationType Type() const;

  ON::object_type ObjectType() const override;
  bool IsValid( class ON_TextLog* text_log = nullptr ) const override;

  virtual bool GetAnnotationBoundingBox(
    const ON_Viewport* vp,
    const ON_DimStyle* dimstyle,
    double dimscale,
    double* boxmin,
    double* boxmax,
    bool bGrow = false
  ) const = 0;

  /*
  Parameters:
    vp - [in]
      nullptr or viewport where annotation object is displayed
    dimstyle - [in]
      &this->DimensionStyle(const ON_DimStyle& parent_dimstyle)
    bApplyDimStyleDimScale - [in]
      If true, dimsytyle->DimScale() is applied.
      If vp is a page view, bApplyDimStyleDimScale is generally false.
      If vp is a model view, bApplyDimStyleDimScale is generally 
      the value of a model property IsAnnotationScalingEnabled().
      from 
    bSingleStrokeFont - [in]
      True if text uses a single font that is a single stroke font and returned contours
      should be left open.
    text_contours - [out]
  */
  bool GetTextGlyphContours(
    const ON_Viewport* vp,
    const ON_DimStyle* dimstyle,
    bool bApplyDimStyleDimScale,
    bool bSingleStrokeFont,
    ON_ClassArray< ON_ClassArray< ON_SimpleArray< ON_Curve* > > >& text_contours
  ) const;

protected:

  /*
  Parameters:
    vp - [in]
      nullptr or viewport where annotation object is displayed
    dimstyle - [in]
      &this->DimensionStyle(const ON_DimStyle& parent_dimstyle)
  */
  const ON_SHA1_Hash Internal_GetBBox_InputHash(
    const ON_Viewport* vp,
    const ON_DimStyle* dimstyle,
    double dimscale,
    const ON_2dPoint& text_point,
    unsigned int point_count,
    const ON_2dPoint* points
  ) const;

  /*
  Parameters:
    vp - [in]
      nullptr or viewport where annotation object is displayed
    dimstyle - [in]
      &this->DimensionStyle(const ON_DimStyle& parent_dimstyle)
  */
  bool Internal_GetBBox_TextGlyphBox(
    const ON_Viewport* vp,
    const ON_DimStyle* dimstyle,
    double dimscale,
    ON_BoundingBox& text_glyph_box
  ) const;

  /*
  Returns:
    True if a cached bounding box was found
    and boxmin, boxmax are set.
  */
  bool Internal_GetBBox_Begin(
    const ON_SHA1_Hash& hash,
    double* boxmin,
    double* boxmax,
    bool bGrow
  ) const;

  /*
  Returns:
    True if a boxmin, boxmax is a valid bounding box
  */
  bool Internal_GetBBox_End(
    const ON_BoundingBox& bbox,
    const ON_SHA1_Hash& hash,
    double* boxmin,
    double* boxmax,
    bool bGrow
  ) const;

public:
  
  virtual bool GetTextXform(
    const ON_Viewport* vp,
    const ON_DimStyle* dimstyle,
    double dimscale,
    ON_Xform& text_xform_out
  ) const = 0;

  void SetPlane(const ON_Plane& plane);
  const ON_Plane& Plane() const;

  void SetHorizontalDirection(ON_2dVector);
  const ON_2dVector HorizontalDirection() const;

  // Returns a 2d vector to use as annotation horizontal
  // Use this function when you don't have a known horizontal direction
  static ON_3dVector GetDefaultHorizontal(const ON_Plane& plane);

  /*
  Returns:
    Rich text that can contain rich text formatting instructions.
  */
  const ON_wString RichText() const;

  /*
  Returns:
  Text information with rich text formatting insturctions removed.
  Fields are not evaluated.
  */
  const ON_wString PlainText() const;

  /*
  Returns:
  Text information with rich text formatting insturctions removed.
  The result string from evaluating fields is included
  Field results may be cached from previous evaluation
  */
  const ON_wString PlainTextWithFields() const;

  // Return the id of the main (parent) dimstyle used by this object.
  // The style with this id should not be used directly if there is 
  // an override dimstyle present. 
  // Use this->DimensionStyle(parent_style) to get the effective
  // dimstyle for this object.
  ON_UUID DimensionStyleId() const;

  // Sets the id of the main (parent) dimstyle used by this annotation object
  // Any override dimstyle on this object will be deleted when this is called,
  // resetting any style overrides.
  void SetDimensionStyleId(ON_UUID dimstyle_id);

  /*
  Description:
    Set the id of the main (parent) dimstyle used by this annotation object
    and allow an expert user to control what happens to style override settings
    in cases where id collisions occur and ids need to be changed.
  Parameters:
    bKeepOverrides - [in]
      If you are not an expert oding something low level and complicated, then
      call SetDimensionStyleId(dimstyle_id) or pass bKeepOverrides = false.

      If bKeepOverrides is true and dimstyle_id is not nil and this object has 
      valid overrides, those overrides are retained. In all other cases, any 
      existing overrides are deleted.
  */
  void SetDimensionStyleIdForExperts(
    ON_UUID dimstyle_id,
    bool bKeepOverrides
  );

  /*
  parameters:
    dim_style - [in]
      If dim_style.ParentId() is nil, then this function
      calls SetDimensionStyleId(dim_style.Id()) and returns.
      If dim_style.ParentId() is not nil, then this functions 
      calls SetDimensionStyleId(dim_style.ParentId()) and uses a copy
      of dim_style as the override dimstyle.
  */
  void SetDimensionStyleId(
    const class ON_DimStyle& dim_style
    );

  // Get the proper dimension style, including overrides, to use for this
  // annotation object.
  // If there is an override in place, that dimstyle will be returned
  // If there is no override, the parent style passed in will be returned
  // If the content of the parent style has changed since the override was made,
  // the override style will be updated with the non-overriden values from  
  // the parent before returning.
  // If your annotation object has an override style and you call either of
  // these functions with a dimstyle other than the correct parent style
  // for this annotation, the override style will be removed.
  const ON_DimStyle& DimensionStyle(const ON_DimStyle& parent_dimstyle) const;
  const ON_DimStyle& DimensionStyle(
    const ON_DimStyle& parent_dimstyle,
    bool bForceOverrideUpdate
  ) const;

  // Apply a dimstyle with overrides set to this annotation object.
  //
  // Use ON_Annotation::IsOverrideDimStyleCandidate() to determine if a non-nullptr
  // override_style is a valid to be used to set overrides.
  //
  // The override dimstyle memory will be managed and deleted by the annotation object and
  // must have been allocated using new. 
  // On return, if this function returns true, 
  // The dimstyle id of the annotation object must be set before this function is called.
  // Calling SetOverrideDimensionStyle(nullptr) will remove all overrides for this object.
  // override_dimstyle will be null.
  //
  // Returns:
  //   true if the override style was successfully set
  //   false if this->m_dimstyle_id is ON_nil_uuid causing failure
  bool SetOverrideDimensionStyle(ON_DimStyle*& override_style) const;

  /*
  Description:
    Removes any override dimension style that is present.
  */
  void ClearOverrideDimensionStyle();

  /*
  Description:
    If this->IsOverrideDimStyleCandidate(override_style_candidate,bRequireSetOverrides)
    is true, then a managed copy of override_style_candidate is set as an override.
  Returns:
    True if an override is set.
  */
  bool SetOverrideDimensionStyle(
    const ON_DimStyle* override_style_candidate,
    bool bRequireSetOverrides
  );


  /*
  Description:
    A valid override dimstyle candidate has all of the following properties.
      override_style_candidate != nullptr.
      IsDeleted() = false;
      Id() = ON_nil_uuid;
      Name() is empty.
      Index() = ON_ModelComponent::Unset.Index()
      bRequireSetOverrides is false or HasOverrides() returns true.
  Parameters:
    override_style_candidate -[in]
      style candidate to evaluate.
    bRequireSetOverrides - [in]
      If bRequireSetOverrides is true, then override_style_candidate->HasOverrides() must be true for a valid candidate.
      If bRequireSetOverrides is flase, then override_style_candidate->HasOverrides() can have any value.
  Returns:
    True if override_style could be successfully used as the parameter 
    to SetOverrideDimensionStyle.
  */
  bool IsOverrideDimStyleCandidate(
    const ON_DimStyle* override_style_candidate,
    bool bRequireSetOverrides
  ) const;

protected:
  static bool Internal_IsOverrideDimStyleCandidate(
    const ON_DimStyle* override_style_candidate,
    ON_UUID parent_id,
    bool bRequireSetOverrides,
    bool bIssueErrorsAndWarnings
  );


public:
  // Quickly check if this annotation object has style overrides applied.
  bool HasDimensionStyleOverrides() const;

  const ON_TextContent* Text() const;
  ON_TextContent* Text();
  void SetText(ON_TextContent*& text) const;
  void ClearText() const;

  // return angle in radians between text plane and object plane
  virtual double TextRotationRadians() const;
  virtual void SetTextRotationRadians(double rotation);

  // return angle in degrees between text plane and object plane
  virtual double TextRotationDegrees() const;
  virtual void SetTextRotationDegrees(double rotation);

  //virtual bool Explode(
  //  const ON_DimStyle* dimstyle,
  //  ON_SimpleArray<const ON_Geometry*> object_parts) const = 0;

  /*
  Returns:
     The value of ON_DimStyle.TextPositionPropertiesHash() from the dimension style used
     to calculate the runtime text position (location, glyphs, and size).
  */
  ON_SHA1_Hash DimStyleTextPositionPropertiesHash() const;

  /*
  Returns:
    True if this text position information used to create this text
    is identical to the text position paramters on dimstyle.
  */
  bool EqualTextPositionProperties(
    const class ON_DimStyle* dimstyle
  ) const;

  const wchar_t* RtfText() const;

  bool ReplaceTextString(
    const wchar_t* RtfString,
    const ON_DimStyle* dimstyle
  );

  void GetAlignment(ON::TextHorizontalAlignment& horz, ON::TextVerticalAlignment& vert) const;
  void SetAlignment(ON::TextHorizontalAlignment horz, ON::TextVerticalAlignment vert);

  // FormattingRectangleWidth is a width set by text wrapping. It's in model units
  double FormattingRectangleWidth() const;
  void SetFormattingRectangleWidth(double width);

  // Get corners of the whole text object
  // corners requires space for 4 points
  bool GetText3dCorners(ON_3dPoint corners[4]) const;

  /*
  Parameters:
    ptr - [in]
      pointer to test
  Returns:
    True if ptr is not nullptr and points to the override style mangaged by this 
    instance.
  */
  bool IsOverrideStylePointer(
    const ON_DimStyle* ptr
  ) const;

protected:
  ON::AnnotationType m_annotation_type = ON::AnnotationType::Unset;
  unsigned char m_reserved1 = 0;
  unsigned char m_reserved2 = 0;
  unsigned char m_reserved3 = 0;
  unsigned int m_reserved4 = 0;
  ON_UUID m_dimstyle_id = ON_DimStyle::Default.Id();
  ON_Plane m_plane = ON_Plane::World_xy; // plane origin used for alignment point
  ON_2dVector m_horizontal_direction = ON_2dVector::XAxis;  // direction used as horizontal to draw annotation, especially text
  mutable ON_TextContent* m_text = nullptr;  // Deleted by ~ON_Annotation()
private:
  // Pointer to an override dimstyle when style properties are overridden for this annotation object
  // If this pointer is null, use the style with id = m_dimstyle_id
  // Copy and delete this dimstyle (not this pointer) with the object.
  // This dimstyle should never be one held in a dimstyle table.  It is owned by this object
  mutable ON_DimStyle* m_override_dimstyle = nullptr;
  mutable ON__UINT64 m_parent_dimstyle_content_version_number = 0;
  void Internal_DeleteOverrideDimstyle() const;

  mutable ON_BoundingBoxCache m_bbox_cache;

protected:
  bool Internal_WriteAnnotation(
    ON_BinaryArchive& archive
    ) const;

  bool Internal_ReadAnnotation(
    ON_BinaryArchive& archive
    );

private:
  ON_DimStyle* Internal_GetOverrideStyle(bool bCreateIfNull) const;

  /*
  Description:
    Gets the appropriate ON_DimStyle to query for a property value.
  Parameters:
    parent_style - [in]
      parent style pased to the ON_Annotation query function
    field_id - [in]
      field being queried - this is used to select between using the override style or the parent style.
  */

  const ON_DimStyle& Internal_StyleForFieldQuery(
    const ON_DimStyle* parent_style,
    ON_DimStyle::field field_id
  ) const;

private:
  static bool Internal_DimStyleDoubleChanged(
    const double current_value,
    double candidate_value
  );

public:
  void ClearFieldOverride(ON_DimStyle::field field);
   
  bool FieldIsOverridden(ON_DimStyle::field field) const;

  // These next several functions are to set overrides on individual annotation objects

  // Extension line extension
  double ExtensionLineExtension(const ON_DimStyle* parent_style) const;
  void SetExtensionLineExtension(const ON_DimStyle* parent_style, double d);

  // Extension line offset
  double ExtensionLineOffset(const ON_DimStyle* parent_style) const;
  void SetExtensionLineOffset(const ON_DimStyle* parent_style, double d);

  // Arrow size
  double ArrowSize(const ON_DimStyle* parent_style) const;
  void SetArrowSize(const ON_DimStyle* parent_style, double d);

  // Arrow size
  double LeaderArrowSize(const ON_DimStyle* parent_style) const;
  void SetLeaderArrowSize(const ON_DimStyle* parent_style, double d);

  // Centermark size
  double CenterMarkSize(const ON_DimStyle* parent_style) const;
  void SetCenterMarkSize(const ON_DimStyle* parent_style, double d);

  // Centermark style
  ON_DimStyle::centermark_style CenterMarkStyle(const ON_DimStyle* parent_style) const;
  void SetCenterMarkStyle(const ON_DimStyle* parent_style, ON_DimStyle::centermark_style style);

  // The location of text relative to the dimension line in linear, angular, and ordinate dimensions.
  ON_DimStyle::TextLocation DimTextLocation(const ON_DimStyle* parent_style) const;
  void SetDimTextLocation(const ON_DimStyle* parent_style, ON_DimStyle::TextLocation dim_text_location);

  // The location of text relative to the dimension line in radial dimensions.
  ON_DimStyle::TextLocation DimRadialTextLocation(const ON_DimStyle* parent_style) const;
  void SetDimRadialTextLocation(const ON_DimStyle* parent_style, ON_DimStyle::TextLocation dim_text_location);

  // Angle units - Degrees, Degrees-Minutes-Seconds, Radians
  ON_DimStyle::angle_format AngleFormat(const ON_DimStyle* parent_style) const;
  void SetAngleFormat(const ON_DimStyle* parent_style, ON_DimStyle::angle_format format);

  // Display resolution for distance measurements
  int LengthResolution(const ON_DimStyle* parent_style) const;
  void SetLengthResolution(const ON_DimStyle* parent_style, int r);

  // Display resolution for angle measurements
  int AngleResolution(const ON_DimStyle* parent_style) const;
  void SetAngleResolution(const ON_DimStyle* parent_style, int r);

  // Distance from dimension lines to text
  double TextGap(const ON_DimStyle* parent_style) const;
  void SetTextGap(const ON_DimStyle* parent_style, double gap);

  // Height of dimension text
  double TextHeight(const ON_DimStyle* parent_style) const;
  void SetTextHeight(const ON_DimStyle* parent_style, double height);

  // Scale factor for displayed distances
  double LengthFactor(const ON_DimStyle* parent_style) const;
  void SetLengthFactor(const ON_DimStyle* parent_style, double);

  // Additional measurement display toggle
  bool Alternate(const ON_DimStyle* parent_style) const;
  void SetAlternate(const ON_DimStyle* parent_style, bool);

  // Distance scale factor for alternate display
  double AlternateLengthFactor(const ON_DimStyle* parent_style) const;
  void SetAlternateLengthFactor(const ON_DimStyle* parent_style, double);

  // Display resolution for alternate length measurements
  int AlternateLengthResolution(const ON_DimStyle* parent_style) const;
  void SetAlternateLengthResolution(const ON_DimStyle* parent_style, int);

  // Dimension prefix text
  const wchar_t* Prefix(const ON_DimStyle* parent_style) const;
  void SetPrefix(const ON_DimStyle* parent_style, const wchar_t*);

  // Dimension suffix text
  const wchar_t* Suffix(const ON_DimStyle* parent_style) const;
  void SetSuffix(const ON_DimStyle* parent_style, const wchar_t*);

  // Dimension alternate prefix text
  const wchar_t* AlternatePrefix(const ON_DimStyle* parent_style) const;
  void SetAlternatePrefix(const ON_DimStyle* parent_style, const wchar_t*);

  // Dimension alternate suffix text
  const wchar_t* AlternateSuffix(const ON_DimStyle* parent_style) const;
  void SetAlternateSuffix(const ON_DimStyle* parent_style, const wchar_t*);

  // Suppress first dimension extension line
  bool SuppressExtension1(const ON_DimStyle* parent_style) const;
  void SetSuppressExtension1(const ON_DimStyle* parent_style, bool b);

  // Suppress second dimension extension line
  bool SuppressExtension2(const ON_DimStyle* parent_style) const;
  void SetSuppressExtension2(const ON_DimStyle* parent_style, bool b);

  // Extension of dimension line past extension lines
  double DimExtension(const ON_DimStyle* parent_style) const;
  void SetDimExtension(const ON_DimStyle* parent_style, const double e);

  ON_DimStyle::tolerance_format ToleranceFormat(const ON_DimStyle* parent_style) const;
  void SetToleranceFormat(const ON_DimStyle* parent_style, ON_DimStyle::tolerance_format format);

  int  ToleranceResolution(const ON_DimStyle* parent_style) const;
  void SetToleranceResolution(const ON_DimStyle* parent_style, int resolution);

  double ToleranceUpperValue(const ON_DimStyle* parent_style) const;
  void SetToleranceUpperValue(const ON_DimStyle* parent_style, double upper_value);

  double ToleranceLowerValue(const ON_DimStyle* parent_style) const;
  void SetToleranceLowerValue(const ON_DimStyle* parent_style, double lower_value);

  double ToleranceHeightScale(const ON_DimStyle* parent_style) const;
  void SetToleranceHeightScale(const ON_DimStyle* parent_style, double scale);

  double BaselineSpacing(const ON_DimStyle* parent_style) const;
  void SetBaselineSpacing(const ON_DimStyle* parent_style, double spacing);

  // Determines whether or not to draw a Text Mask
  bool DrawTextMask(const ON_DimStyle* parent_style) const;
  void SetDrawTextMask(const ON_DimStyle* parent_style, bool bDraw);

  // Determines where to get the color to draw a Text Mask
  ON_TextMask::MaskType  MaskFillType(const ON_DimStyle* parent_style) const;
  void SetMaskFillType(const ON_DimStyle* parent_style, ON_TextMask::MaskType  source);

  ON_Color MaskColor(const ON_DimStyle* parent_style) const;  // Only works right if MaskColorSource returns 1.
  void SetMaskColor(const ON_DimStyle* parent_style, ON_Color color);   // Does not return viewport background color

  // Offset for the border around text to the rectangle used to draw the mask
  // This number is the offset on each side of the tight rectangle around the
  // text characters to the mask rectangle.
  double MaskBorder(const ON_DimStyle* parent_style) const;
  void SetMaskBorder(const ON_DimStyle* parent_style, double offset);

  // The ON_TextMask class contains the property values for
  //   DrawTextMask()
  //   MaskColor()
  //   MaskFillType()
  //   MaskBorder()
  // Use the 
  //   DrawTextMask()
  //   MaskColor()
  //   MaskFillType()
  //   MaskBorder()
  //   functions to query individual text mask properties.
  void SetTextMask(const ON_DimStyle* parent_style, const ON_TextMask& mask);
  
  double FixedExtensionLength(const ON_DimStyle* parent_style) const;
  void SetFixedExtensionLength(const ON_DimStyle* parent_style, double l);

  bool FixedExtensionLengthOn(const ON_DimStyle* parent_style) const;
  void SetFixedExtensionLengthOn(const ON_DimStyle* parent_style, bool on);

  int AlternateToleranceResolution(const ON_DimStyle* parent_style) const;
  void SetAlternateToleranceResolution(const ON_DimStyle* parent_style, int r);

  bool SuppressArrow1(const ON_DimStyle* parent_style) const;
  void SetSuppressArrow1(const ON_DimStyle* parent_style, bool s);

  bool SuppressArrow2(const ON_DimStyle* parent_style) const;
  void SetSuppressArrow2(const ON_DimStyle* parent_style, bool s);

  int TextMoveLeader(const ON_DimStyle* parent_style) const;
  void SetTextMoveLeader(const ON_DimStyle* parent_style, int m);

  int ArcLengthSymbol(const ON_DimStyle* parent_style) const;
  void SetArcLengthSymbol(const ON_DimStyle* parent_style, int m);

  ON_DimStyle::stack_format StackFractionFormat(const ON_DimStyle* parent_style) const;
  void SetStackFractionFormat(const ON_DimStyle* parent_style, ON_DimStyle::stack_format f);

  double StackHeightScale(const ON_DimStyle* parent_style) const;
  void SetStackHeightScale(const ON_DimStyle* parent_style, double f);

  double RoundOff(const ON_DimStyle* parent_style) const;
  void SetRoundOff(const ON_DimStyle* parent_style, double r);

  double AlternateRoundOff(const ON_DimStyle* parent_style) const;
  void SetAlternateRoundOff(const ON_DimStyle* parent_style, double r);

  double AngleRoundOff(const ON_DimStyle* parent_style) const;
  void SetAngleRoundOff(const ON_DimStyle* parent_style, double r);

  ON_DimStyle::suppress_zero ZeroSuppress(const ON_DimStyle* parent_style) const;
  void SetZeroSuppress(const ON_DimStyle* parent_style, ON_DimStyle::suppress_zero s);

  ON_DimStyle::suppress_zero AlternateZeroSuppress(const ON_DimStyle* parent_style) const;
  void SetAlternateZeroSuppress(const ON_DimStyle* parent_style, ON_DimStyle::suppress_zero s);

  // OBSOLETE - The ZeroSuppress() or  AlternateZeroSuppress() property
  // is used to format tolerance display.  ToleranceZeroSuppress() is ignored.
  ON_DimStyle::suppress_zero ToleranceZeroSuppress(const ON_DimStyle* parent_style) const;

  // OBSOLETE - The ZeroSuppress() or  AlternateZeroSuppress() property
  // is used to format tolerance display.  ToleranceZeroSuppress() is ignored.
  void SetToleranceZeroSuppress(const ON_DimStyle* parent_style, ON_DimStyle::suppress_zero s);

  ON_DimStyle::suppress_zero AngleZeroSuppress(const ON_DimStyle* parent_style) const;
  void SetAngleZeroSuppress(const ON_DimStyle* parent_style, ON_DimStyle::suppress_zero s);

  bool AlternateBelow(const ON_DimStyle* parent_style) const;
  void SetAlternateBelow(const ON_DimStyle* parent_style, bool below);

  ON_Arrowhead::arrow_type ArrowType1(const ON_DimStyle* parent_style) const;
  void SetArrowType1(const ON_DimStyle* parent_style, ON_Arrowhead::arrow_type);

  ON_Arrowhead::arrow_type ArrowType2(const ON_DimStyle* parent_style) const;
  void SetArrowType2(const ON_DimStyle* parent_style, ON_Arrowhead::arrow_type);

  void SetArrowType1And2(const ON_DimStyle* parent_style, ON_Arrowhead::arrow_type);

  ON_Arrowhead::arrow_type LeaderArrowType(const ON_DimStyle* parent_style) const;
  void SetLeaderArrowType(const ON_DimStyle* parent_style, ON_Arrowhead::arrow_type);

  ON_UUID ArrowBlockId1(const ON_DimStyle* parent_style) const;
  void SetArrowBlockId1(const ON_DimStyle* parent_style, ON_UUID id);

  ON_UUID ArrowBlockId2(const ON_DimStyle* parent_style) const;
  void SetArrowBlockId2(const ON_DimStyle* parent_style, ON_UUID id);

  ON_UUID LeaderArrowBlockId(const ON_DimStyle* parent_style) const;
  void SetLeaderArrowBlockId(const ON_DimStyle* parent_style, ON_UUID id);

  ON::TextVerticalAlignment TextVerticalAlignment(const ON_DimStyle* parent_style) const;
  void SetTextVerticalAlignment(const ON_DimStyle* parent_style, ON::TextVerticalAlignment style);

  ON::TextVerticalAlignment LeaderTextVerticalAlignment(const ON_DimStyle* parent_style) const;
  void SetLeaderTextVerticalAlignment(const ON_DimStyle* parent_style, ON::TextVerticalAlignment style);

  ON_DimStyle::ContentAngleStyle LeaderContentAngleStyle(const ON_DimStyle* parent_style) const;
  void SetLeaderContentAngleStyle(const ON_DimStyle* parent_style, ON_DimStyle::ContentAngleStyle style);

  ON_DimStyle::leader_curve_type LeaderCurveType(const ON_DimStyle* parent_style) const;
  void SetLeaderCurveType(const ON_DimStyle* parent_style, ON_DimStyle::leader_curve_type type);

  bool LeaderHasLanding(const ON_DimStyle* parent_style) const;
  void SetLeaderHasLanding(const ON_DimStyle* parent_style, bool landing);

  double LeaderLandingLength(const ON_DimStyle* parent_style) const;
  void SetLeaderLandingLength(const ON_DimStyle* parent_style, double length);

  double LeaderContentAngleRadians(const ON_DimStyle* parent_style) const;
  void SetLeaderContentAngleRadians(const ON_DimStyle* parent_style, double angle_radians);

  double LeaderContentAngleDegrees(const ON_DimStyle* parent_style) const;
  void SetLeaderContentAngleDegrees(const ON_DimStyle* parent_style, double angle_degrees);

  ON_DimStyle::ContentAngleStyle DimTextAngleStyle(const ON_DimStyle* parent_style) const;
  void SetDimTextAngleStyle(const ON_DimStyle* parent_style, ON_DimStyle::ContentAngleStyle style);

  ON_DimStyle::ContentAngleStyle DimRadialTextAngleStyle(const ON_DimStyle* parent_style) const;
  void SetDimRadialTextAngleStyle(const ON_DimStyle* parent_style, ON_DimStyle::ContentAngleStyle style);

  ON::TextHorizontalAlignment TextHorizontalAlignment(const ON_DimStyle* parent_style) const;
  void SetTextHorizontalAlignment(const ON_DimStyle* parent_style, ON::TextHorizontalAlignment halign);

  ON::TextHorizontalAlignment LeaderTextHorizontalAlignment(const ON_DimStyle* parent_style) const;
  void SetLeaderTextHorizontalAlignment(const ON_DimStyle* parent_style, ON::TextHorizontalAlignment halign);

  ON::TextOrientation TextOrientation(const ON_DimStyle* parent_style) const;
  void SetTextOrientation(const ON_DimStyle* parent_style, ON::TextOrientation orientation);

  ON::TextOrientation LeaderTextOrientation(const ON_DimStyle* parent_style) const;
  void SetLeaderTextOrientation(const ON_DimStyle* parent_style, ON::TextOrientation orientation);

  ON::TextOrientation DimTextOrientation(const ON_DimStyle* parent_style) const;
  void SetDimTextOrientation(const ON_DimStyle* parent_style, ON::TextOrientation orientation);

  ON::TextOrientation DimRadialTextOrientation(const ON_DimStyle* parent_style) const;
  void SetDimRadialTextOrientation(const ON_DimStyle* parent_style, ON::TextOrientation orientation);

  bool DrawForward(const ON_DimStyle* parent_style) const;
  void SetDrawForward(const ON_DimStyle* parent_style, bool drawforward);

  bool TextUnderlined(const ON_DimStyle* parent_style) const;
  void SetTextUnderlined(const ON_DimStyle* parent_style, bool underlined);

  bool SignedOrdinate(const ON_DimStyle* parent_style) const;
  void SetSignedOrdinate(const ON_DimStyle* parent_style, bool allowsigned);

  double DimScale(const ON_DimStyle* parent_style) const;
  void SetDimScale(const ON_DimStyle* parent_style, double scale);

  ON_DimStyle::LengthDisplay DimensionLengthDisplay(const ON_DimStyle* parent_style) const;
  void SetDimensionLengthDisplay(const ON_DimStyle* parent_style, ON_DimStyle::LengthDisplay length_display);

  ON_DimStyle::LengthDisplay AlternateDimensionLengthDisplay(const ON_DimStyle* parent_style) const;
  void SetAlternateDimensionLengthDisplay(const ON_DimStyle* parent_style, ON_DimStyle::LengthDisplay length_display);

  /// <summary>
  /// Parameters:
  ///   model_sn - 0, a model serial number, or ON_UNSET_UINT_INDEX to
  ///   use the dimstyle's ModelSerialNumber() value.
  /// Returns
  ///   Unit system for dimension length display.
  ///   If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits
  ///   and model_sn > 0, then the value of ON::LengthUnitSystemFromModelSerialNumber(model_sn)
  ///   is returned.
  ///   If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits
  ///   and model_sn == 0, then ON::LengthUnitSystem::None is returned.
  ///</summary>
  ON::LengthUnitSystem DimensionLengthDisplayUnit(
    const ON_DimStyle* parent_style,
    unsigned int model_sn
    ) const;

  /// <summary>
  /// Parameters:
  ///   model_sn - 0, a model serial number, or ON_UNSET_UINT_INDEX to
  ///   use the dimstyle's ModelSerialNumber() value.
  /// Returns
  ///   Unit system for dimension length display.
  ///   If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits
  ///   and model_sn > 0, then the value of ON::LengthUnitSystemFromModelSerialNumber(model_sn)
  ///   is returned.
  ///   If DimensionLengthDisplay() == ON_DimStyle::LengthDisplay::ModelUnits
  ///   and model_sn == 0, then ON::LengthUnitSystem::None is returned.
  ///</summary>
  ON::LengthUnitSystem AlternateDimensionLengthDisplayUnit(
    const ON_DimStyle* parent_style,
    unsigned int model_sn
    ) const;

  /*
  Description:
  Set the font used to render text.
  Parameters:
  font_characteristics - [in]
  This parameter does not have to be a managed font.
  Remarks:
  If the parameter is a managed font (font_characteristics.IsManagedFont() is true),
  then the identical value is returned by ON_DimStyle.Font().
  If the parameter is not a managed font (font_characteristics.IsManagedFont() is false),
  then the ON_Font::GetManagedFont(font_characteristics) will be returned by
  ON_DimStyle.Font().
  */
  void SetFont(const ON_DimStyle* parent_style,  const class ON_Font& font_characteristics);

  /*
  Returns:
  The managed font used to render text.
  */
  const class ON_Font& Font(const ON_DimStyle* parent_style) const;

  /*
  Returns:
  A copy of the font_characteristics information.
  Remarks:
  You probably want to use Font(). This function is only useful
  in isolated situations and is typically used to study font
  substitutions when a model moves between computers or platforms.
  */
  const class ON_Font& FontCharacteristics(const ON_DimStyle* parent_style) const;

  /*
  Returns:
  True if the font returned by Font() is a substitute
  for the font passed to SetFont().
  Remarks:
  Font substitution can occur when a model is moved between
  computers that have different fonts installed.
  */
  const bool FontSubstituted(const ON_DimStyle* parent_style) const;



  bool SetAnnotationBold(bool bold, const ON_DimStyle* dimstyle);
  bool SetAnnotationItalic(bool italic, const ON_DimStyle* dimstyle);
  bool SetAnnotationUnderline(bool underline, const ON_DimStyle* dimstyle);
  bool SetAnnotationFacename(bool set_or_clear, const wchar_t* facename, const ON_DimStyle* parent_style);
  static bool SetAnnotationTextFormat(ON_wString& rtf_in, const wchar_t* fmt_str_on, const wchar_t* fmt_str_off, bool set_on);

  static bool SetRtfFmt(ON_wString& rtf_in, const wchar_t* fmt_str);
  static bool ClearRtfFmt(const wchar_t* fmt_str_on, const wchar_t* fmt_str_off, ON_wString& rtf_in);
  static int FindRtfTable(ON_wString rtf_in, int startidx, const wchar_t* tablename);

  static bool FirstCharTextProperties(const wchar_t* rtf_in, bool& bold, bool& italic, bool& underline, ON_wString& facename);
};


/*
  A simple dot with text that doesn't rotate witn the world axes
*/
class ON_CLASS ON_TextDot : public ON_Geometry
{
  ON_OBJECT_DECLARE(ON_TextDot);
public:
  static const wchar_t* DefaultFontFace; // Arial
  static const int DefaultHeightInPoints; // 14 points
  static const int MinimumHeightInPoints; // 3 points
  static const ON_TextDot Unset;

  ON_TextDot();
  ~ON_TextDot();
  ON_TextDot( const ON_TextDot& ) = default;
  ON_TextDot& operator=( const ON_TextDot& ) = default;

  ON_TextDot(
    ON_3dPoint center_point,
    const wchar_t* primary_text,
    const wchar_t* secondary_text
    );

  static ON_TextDot* CreateFromV2AnnotationTextDot(
    const class ON_OBSOLETE_V2_TextDot& V2_text_dot,
    const class ON_3dmAnnotationContext* annotation_context,
    ON_TextDot* destination
  );

  void EmergencyDestroy();

  //---------------------------
  // ON_Object overrides

  bool IsValid( class ON_TextLog* text_log = nullptr ) const override;

  /*
    Description: Write data values to a text file for debugging
  */
  void Dump( ON_TextLog& log) const override;

  /*
    Description: Writes the object to a file

    Returns:
      @untitled Table
      true     Success
      false    Failure
  */
  bool Write( ON_BinaryArchive& ar) const override;

  /*
    Description: Reads the object from a file

    Returns:
      @untitled Table
      true     Success
      false    Failure
  */
  bool Read( ON_BinaryArchive& ar) override;

  /*
    Returns: The Object Type of this object
  */
  ON::object_type ObjectType() const override;

  //---------------------------
  // ON_Geometry overrides

  /*
    Returns the geometric dimension of the object ( usually 3)
  */
  int Dimension() const override;

  // virtual ON_Geometry GetBBox override       
  bool GetBBox( double* boxmin, double* boxmax, bool bGrowBox = false ) const override;

  /*
    Description:
      Transform the object by a 4x4 xform matrix
    Parameters:
      [in] xform  - An ON_Xform with the transformation information
    Returns:
      true = Success
      false = Failure
    Remarks:
      The object has been transformed when the function returns
  */
  bool Transform( const ON_Xform& xform) override;

  // virtual ON_Geometry::IsDeformable() override
  bool IsDeformable() const override;

  // virtual ON_Geometry::MakeDeformable() override
  bool MakeDeformable() override;


  ON_3dPoint CenterPoint() const;
  void SetCenterPoint(
    ON_3dPoint center_point
    );

  ON_DEPRECATED_MSG("use CenterPoint")
  const ON_3dPoint& Point() const;
  ON_DEPRECATED_MSG("use SetCenterPoint")
  void SetPoint(const ON_3dPoint& point);

  /*
  Returns:
    Text height in "points".
  Remarks:
    Default height = 14;
  */
  int HeightInPoints() const;
  void SetHeightInPoints(
    int height_in_points
    );

  /*
  Returns:
    Dot's primary text displayed in the model
    Typically a short and terse string.
    Default = empty string.
  Remarks:
    Additional information can be saved as secondary text.

    Never save the pointer value for future use.
    Save a copy in ON_wString if the text is needed beyond the scope of
    the call to Text().
  */
  const wchar_t* PrimaryText() const;
  void SetPrimaryText( 
    const wchar_t* primary_dot_text
    );

  ON_DEPRECATED_MSG("use PrimaryText")
  const wchar_t* TextString() const;
  ON_DEPRECATED_MSG("use SetPrimaryText")
  void SetTextString(const wchar_t* string);
  /*
  Returns:
    Dot's secondary text displayed when a user interface event like cliking or hovering occurs.
    Typically longer and more detailed than the primary text.
    Default = empty string.
  Remarks:
    Never save the pointer value for future use.
    Save a copy in ON_wString if the text is needed beyond the scope of
    the call to Text().
  */
  const wchar_t* SecondaryText() const;
  void SetSecondaryText(
    const wchar_t* secondary_dot_text
    );


  /*
  Returns:
    Primary text font face.
    Default = "Arial Bold";
  Remarks:
    Never save the pointer value for future use.
    Save a copy in ON_wString if the text is needed beyond the scope of
    the call to FontFace().
  */
  const wchar_t* FontFace() const;
  void SetFontFace( 
    const wchar_t* font_face)
    ;
  
  /*
    Description:
      Get or Set whether the dot is drawn "On Top" of other geometry
    Parameters:
      [in] bTop  bool - It is or isn't on top
    Returns:
      @untitled table
      true - on top
      false - not on top
  */
  void SetAlwaysOnTop(
    bool bAlwaysOnTop
    );
  bool AlwaysOnTop() const;

  /*
    Description:
      Get or Set whether the dot is drawn with a transparent background
    Parameters:
      [in] bTransparent  bool - It is or isn't transparent
    Returns:
      @untitled table
      true - transparent
      false - not transparent
  */
  void SetTransparent(
    bool bTransparent
    );
  bool Transparent() const;

  /*
    Description:
      Get or Set whether the dot is drawn with Bold text
    Parameters:
      [in] bBold  bool - It is or isn't Bold
    Returns:
      @untitled table
      true - Bold
      false - not Bold
  */
  void SetBold(
    bool bBold
    );
  bool Bold() const;

  /*
    Description:
      Get or Set whether the dot is drawn with Italic text
    Parameters:
      [in] bItalic  bool - It is or isn't Italic
    Returns:
      @untitled table
      true - Italic
      false - not Italic
  */
  void SetItalic(
    bool bItalic
    );
  bool Italic() const;

private:
  // Location of the center of the text dot.
  ON_3dPoint m_center_point = ON_3dPoint::UnsetPoint;

private:
  ON_wString m_primary_text; // default is empty

private:
  ON_wString m_secondary_text; // default is empty

private:
  ON_wString m_font_face;   // Empty means ON_TextDot::DefaultFontFace

private:
  unsigned int m_display_bits = 0;

private:
  int m_height_in_points = ON_TextDot::DefaultHeightInPoints;
};

#endif