Name

---

      RULER__DEFINE

Purpose

---

      The purpose of this routine is to create a simple ruler for display
      in the coordinate system of the underlying image. Users will define the
      length of the ruler (e.g., 5 cm) and the ruler will display
      this value on the image.

Authors

---

        FANNING SOFTWARE CONSULTING BURRIDGE COMPUTING
        1645 Sheely Drive 18 The Green South
        Fort Collins Warborough, Oxon
        CO 80526 USA OX10 7DN, ENGLAND
        Phone: 970-221-0438 Phone: +44 (0)1865 858279
        E-mail: davidf@dfanning.com E-mail: davidb@burridgecomputing.co.uk

Category

---

      Objects.

Syntax

---

      theObject = Obj_New("RULER")

Superclasses

---

      SELECTABLEOBJECT
      CATATOM
      CATCONTAINER IDLITCOMPONENT
      IDL_CONTAINER

Class Structure

---

  class = { RULER, $
            charsize: 0.0, $ ; The character size.
            format: '', $ ; The character format.
            length: 0.0, $ ; The absolute length of the ruler.
            parent_coord: Obj_New(), $ ; The coordinate object of the parent.
            minor: 0L, $ ; The number of minor tick intervals.
            thick: 0L, $ ; The thickness of the ruler lines.
            ticklen: 0.0, $ ; The tick length in normalized coordinates.
            ticks: 0L, $ ; The number of major tick intervals.
            title: '', $ ; The title of the ruler.
            vertical: 0B, $ ; The vertical flag.
            x: 0.0, $ ; The normalized X coordinate of ruler center.
            y: 0.0, $ ; The normalized Y coordinate of ruler center.
            INHERITS SELECTABLEOBJECT $
          }

Messages

---

  None.

Modification History

---

      Written by: David W Fanning, March 9, 2005.