Class: DYI::Drawing::Pen

Inherits:
PenBase show all
Defined in:
lib/dyi/drawing/pen.rb

Overview

Pen object holds a Painting object and a Font object. Using these object, Pen object creates instances of concrete subclass of Shape::Base; a created instance has a painting attribute and a font attribute that Pen object holds.

Pen class has been optimized to draw a line or a outline of the shape. Synonym methods of attributes stroke_xxx has been defined in this class: color(synonym of stroke), dashoffset(synonym of stroke_dashoffset), linecap(synonym of stroke_linecap), linejoin(synonym of stroke_linejoin), miterlimit(synonym of stroke_miterlimit) and width(synonym of stroke_width).

This class has shortcut contractors: color_name_pen, which a line color is specified in.

Examples:

pen = DYI::Drawing::Pen.red_pen(:wdith => 3)
# the followings is the same processing
# pen = DYI::Drawing::Pen.new(:color => 'red', :wdith => 3)
# pen = DYI::Drawing::Pen.new(:stroke => 'red', :stroke_wdith => 3)

canvas = DYI::Canvas.new(100, 50)
pen.draw_line(canvas, [10, 20], [90, 40])

Since:

  • 0.0.0

Direct Known Subclasses

CubicPen

Constant Summary collapse

ALIAS_ATTRIBUTES =

Since:

  • 0.0.0

Painting::IMPLEMENT_ATTRIBUTES.inject({}) do |hash, key|
  hash[$'.empty? ? :color : $'.to_sym] = key if key.to_s =~ /^(stroke_|stroke$)/ && key != :stroke_opacity
  hash
end

Constants inherited from PenBase

DYI::Drawing::PenBase::DROP_SHADOW_OPTIONS

Instance Attribute Summary collapse

Attributes inherited from PenBase

#display, #drop_shadow, #fill, #fill_opacity, #fill_rule, #opacity, #stroke, #stroke_dasharray, #stroke_dashoffset, #stroke_linecap, #stroke_linejoin, #stroke_miterlimit, #stroke_opacity, #stroke_width, #visibility

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PenBase

#draw_circle, #draw_closed_path, #draw_ellipse, #draw_image, #draw_line, #draw_line_on_direction, #draw_path, #draw_polygon, #draw_polyline, #draw_rectangle, #draw_rectangle_on_corner, #draw_sector, #draw_toroid, #import_image

Constructor Details

#initialize(options = {}) ⇒ Pen

Returns a new instance of Pen.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :font (Font, Hash) —

    the value of attribute font

  • :color (Color, #write_as) —

    the value of attribute color

  • :dasharray (Array<Length>, String) —

    the value of attribute dasharray

  • :dashoffset (Length) —

    the value of attribute dashoffset

  • :linecap (String) —

    the value of attribute linecap

  • :linejoin (String) —

    the value of attribute linejoin

  • :miterlimit (#to_f) —

    the value of attribute mitterlimit

  • :width (Lengthf) —

    the value of attribute width

  • :display (String) —

    the value of attribute display; one of following values: "block", "none"

  • :fill (Color, #write_as) —

    the value of attribute fill

  • :fill_opacity (#to_f) —

    the value of attribute fill_opacity

  • :fill_rule (String) —

    the value of attribute fill_rule; one of following values: "nonzero", "evenodd"

  • :opacity (#to_f) —

    the value of attribute opacity

  • :stroke (Color, #write_as) —

    the value of attribute stroke

  • :stroke_dasharray (Array<Length>, String) —

    the value of attribute stroke_dasharray

  • :stroke_dashoffset (Length) —

    the value of attribute stroke_dashoffset

  • :stroke_linecap (String) —

    the value of attribute stroke_linecap; one of following values: "butt", "round", "square"

  • :stroke_linejoin (String) —

    the value of attribute stroke_linejoin; one of following values: "miter", "round", "bevel"

  • :stroke_miterlimit (#to_f) —

    the value of attribute stroke_miterlimit

  • :stroke_opacity (#to_f) —

    the value of attribute stroke_opacity

  • :stroke_width (Length) —

    the value of attribute stroke_width

  • :visible (String) —

    the value of attribute visibility; one of following values: "visible", "hidden"

Since:

  • 0.0.0



585
586
587
588
589
590
591
592
 
# File 'lib/dyi/drawing/pen.rb', line 585

def initialize(options={})
  options = options.clone
  ALIAS_ATTRIBUTES.each do |key, value|
    options[value] = options.delete(key) if options.key?(key) && !options.key?(value)
  end
  options[:stroke] = 'black' unless options.key?(:stroke)
  super
end

Instance Attribute Details

#color ⇒ Color, ...

Synonym of attribute stroke. +++ Synonym of attribute stroke_dasharray. +++ Synonym of attribute stroke_dashoffset. +++ Synonym of attribute stroke_linecap. +++ Synonym of attribute stroke_linejoin. +++ Synonym of attribute stroke_miterlimit. +++ Synonym of attribute stroke_width.

Returns:

  • (Color, #write_as) —

    the value of attribute stroke

  • (Array<Length>) —

    the value of attribute stroke_dasharray

  • (Length) —

    the value of attribute stroke_dashoffset

  • (String) —

    the value of attribute stroke_linecap

  • (String) —

    the value of attribute stroke_linejoin

  • (Float) —

    the value of attribute stroke_mitterlimit

  • (Length) —

    the value of attribute stroke_width



621
622
623
624
 
# File 'lib/dyi/drawing/pen.rb', line 621

ALIAS_ATTRIBUTES.each do |key, value|
  alias_method key, value
  alias_method "#{key}=", "#{value}="
end

#dasharray ⇒ Color, ...

Synonym of attribute stroke. +++ Synonym of attribute stroke_dasharray. +++ Synonym of attribute stroke_dashoffset. +++ Synonym of attribute stroke_linecap. +++ Synonym of attribute stroke_linejoin. +++ Synonym of attribute stroke_miterlimit. +++ Synonym of attribute stroke_width.

Returns:

  • (Color, #write_as) —

    the value of attribute stroke

  • (Array<Length>) —

    the value of attribute stroke_dasharray

  • (Length) —

    the value of attribute stroke_dashoffset

  • (String) —

    the value of attribute stroke_linecap

  • (String) —

    the value of attribute stroke_linejoin

  • (Float) —

    the value of attribute stroke_mitterlimit

  • (Length) —

    the value of attribute stroke_width



621
622
623
624
 
# File 'lib/dyi/drawing/pen.rb', line 621

ALIAS_ATTRIBUTES.each do |key, value|
  alias_method key, value
  alias_method "#{key}=", "#{value}="
end

#dashoffset ⇒ Color, ...

Synonym of attribute stroke. +++ Synonym of attribute stroke_dasharray. +++ Synonym of attribute stroke_dashoffset. +++ Synonym of attribute stroke_linecap. +++ Synonym of attribute stroke_linejoin. +++ Synonym of attribute stroke_miterlimit. +++ Synonym of attribute stroke_width.

Returns:

  • (Color, #write_as) —

    the value of attribute stroke

  • (Array<Length>) —

    the value of attribute stroke_dasharray

  • (Length) —

    the value of attribute stroke_dashoffset

  • (String) —

    the value of attribute stroke_linecap

  • (String) —

    the value of attribute stroke_linejoin

  • (Float) —

    the value of attribute stroke_mitterlimit

  • (Length) —

    the value of attribute stroke_width



621
622
623
624
 
# File 'lib/dyi/drawing/pen.rb', line 621

ALIAS_ATTRIBUTES.each do |key, value|
  alias_method key, value
  alias_method "#{key}=", "#{value}="
end

#linecap ⇒ Color, ...

Synonym of attribute stroke. +++ Synonym of attribute stroke_dasharray. +++ Synonym of attribute stroke_dashoffset. +++ Synonym of attribute stroke_linecap. +++ Synonym of attribute stroke_linejoin. +++ Synonym of attribute stroke_miterlimit. +++ Synonym of attribute stroke_width.

Returns:

  • (Color, #write_as) —

    the value of attribute stroke

  • (Array<Length>) —

    the value of attribute stroke_dasharray

  • (Length) —

    the value of attribute stroke_dashoffset

  • (String) —

    the value of attribute stroke_linecap

  • (String) —

    the value of attribute stroke_linejoin

  • (Float) —

    the value of attribute stroke_mitterlimit

  • (Length) —

    the value of attribute stroke_width



621
622
623
624
 
# File 'lib/dyi/drawing/pen.rb', line 621

ALIAS_ATTRIBUTES.each do |key, value|
  alias_method key, value
  alias_method "#{key}=", "#{value}="
end

#linejoin ⇒ Color, ...

Synonym of attribute stroke. +++ Synonym of attribute stroke_dasharray. +++ Synonym of attribute stroke_dashoffset. +++ Synonym of attribute stroke_linecap. +++ Synonym of attribute stroke_linejoin. +++ Synonym of attribute stroke_miterlimit. +++ Synonym of attribute stroke_width.

Returns:

  • (Color, #write_as) —

    the value of attribute stroke

  • (Array<Length>) —

    the value of attribute stroke_dasharray

  • (Length) —

    the value of attribute stroke_dashoffset

  • (String) —

    the value of attribute stroke_linecap

  • (String) —

    the value of attribute stroke_linejoin

  • (Float) —

    the value of attribute stroke_mitterlimit

  • (Length) —

    the value of attribute stroke_width



621
622
623
624
 
# File 'lib/dyi/drawing/pen.rb', line 621

ALIAS_ATTRIBUTES.each do |key, value|
  alias_method key, value
  alias_method "#{key}=", "#{value}="
end

#miterlimit ⇒ Color, ...

Synonym of attribute stroke. +++ Synonym of attribute stroke_dasharray. +++ Synonym of attribute stroke_dashoffset. +++ Synonym of attribute stroke_linecap. +++ Synonym of attribute stroke_linejoin. +++ Synonym of attribute stroke_miterlimit. +++ Synonym of attribute stroke_width.

Returns:

  • (Color, #write_as) —

    the value of attribute stroke

  • (Array<Length>) —

    the value of attribute stroke_dasharray

  • (Length) —

    the value of attribute stroke_dashoffset

  • (String) —

    the value of attribute stroke_linecap

  • (String) —

    the value of attribute stroke_linejoin

  • (Float) —

    the value of attribute stroke_mitterlimit

  • (Length) —

    the value of attribute stroke_width



621
622
623
624
 
# File 'lib/dyi/drawing/pen.rb', line 621

ALIAS_ATTRIBUTES.each do |key, value|
  alias_method key, value
  alias_method "#{key}=", "#{value}="
end

#width ⇒ Color, ...

Synonym of attribute stroke. +++ Synonym of attribute stroke_dasharray. +++ Synonym of attribute stroke_dashoffset. +++ Synonym of attribute stroke_linecap. +++ Synonym of attribute stroke_linejoin. +++ Synonym of attribute stroke_miterlimit. +++ Synonym of attribute stroke_width.

Returns:

  • (Color, #write_as) —

    the value of attribute stroke

  • (Array<Length>) —

    the value of attribute stroke_dasharray

  • (Length) —

    the value of attribute stroke_dashoffset

  • (String) —

    the value of attribute stroke_linecap

  • (String) —

    the value of attribute stroke_linejoin

  • (Float) —

    the value of attribute stroke_mitterlimit

  • (Length) —

    the value of attribute stroke_width



621
622
623
624
 
# File 'lib/dyi/drawing/pen.rb', line 621

ALIAS_ATTRIBUTES.each do |key, value|
  alias_method key, value
  alias_method "#{key}=", "#{value}="
end

Class Method Details

.method_missing(method_name, *args, &block) ⇒ Object

Since:

  • 0.0.0



641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/dyi/drawing/pen.rb', line 641

def method_missing(method_name, *args, &block)
  if method_name.to_s =~ /^([a-z]+)_pen$/
    if options = args.first
      self.new(options.merge(:stroke => $1))
    else
      self.new(:stroke => $1)
    end
  else
    super
  end
end

Instance Method Details

#draw_text(canvas, point, text, options = {}) ⇒ Shape::Text

Draws a text.

Parameters:

  • canvas (Element) —

    the element which the text is drawn on

  • point (Coordinate) —

    the point of the base-line of the text. See :text_anchor option

  • text (String) —

    the drawn text string

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :text_anchor (String) —

    the way of aligning a string of text relative to point argument. specifies one of the following vlaues: "start", "middle", "end"

  • :text_length (Length) —

    the length of the displayed text

  • :length_adjust (String) —

    the way of adjustments to make the rendered length of the text match text_length option. specifies one of the following vlaues: "spacing", "spacingAndGlyphs"

  • :text_decoration (String) —

    the decorations that are added to the text. specifies a string in a comma-separated combination of the following vlaues: "underline", "overline", "line-through", "blink"

  • :writing_mode (String) —

    the inline-progression-direction for a text. specifies one of the following vlaues: "lr-tb", "rl-tb", "tb-rl", "lr", "rl", "tb"

  • :show_border (Boolean) —

    whether the border is shown

  • :border_rx (Length) —

    the x-axis radius of the ellipse used to round off the corners of the rectangle when the rounded border is shown

  • :vertical_padding (Length) —

    the interval of vertical border line and text area

  • :horizontal_padding (Length) —

    the interval of horizontal border line and text area

  • :border_ry (Length) —

    the y-axis radius of the ellipse used to round off the corners of the rectangle when the rounded border is shown

  • :background_color (Color, #write_as) —

    the interior painting of the border-line when the border is shown

  • :border_color (Color, #write_as) —

    the painting along the border-line when the border is shown

  • :border_width (Length) —

    the width of border-line when the border is shown

Returns:

Since:

  • 0.0.0



627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/dyi/drawing/pen.rb', line 627

def draw_text(canvas, point, text, options={})
  painting = @painting
  text_painting = Painting.new(painting)
  text_painting.fill = painting.stroke
  text_painting.fill_opacity = painting.stroke_opacity
  text_painting.stroke = nil
  text_painting.stroke_width = nil
  @painting = text_painting
  shape = super
  @painting = painting
  shape
end