1Ace::Graphics::GlyphFacUtsoerry(C3o)ntributed Perl DocumAecnet:a:tGiroanphics::GlyphFactory(3)
2
6 Ace::Graphics::GlyphFactory - Create Ace::Graphics::Glyphs
7
9 use Ace::Graphics::GlyphFactory;
10 my $factory = Ace::Graphics::GlyphFactory($glyph_name,@options);
12
14 The Ace::Graphics::GlyphFactory class is used internally by
15 Ace::Graphics::Track and Ace::Graphics::Glyph to hold the options
16 pertaining to a set of related glyphs and creating them on demand.
17 This class is not ordinarily useful to the end-developer.
18
20 This section describes the class and object methods for
21 Ace::Graphics::GlyphFactory.
22 CONSTRUCTORS
24 There is only one constructor, the new() method. It is ordinarily
25 called by Ace::Graphics::Track, in the make_factory() subroutine.
26 $factory = Ace::Graphics::GlyphFactory->new($glyph_name,@options)
28 The new() method creates a new factory object. The object will
29 create glyphs of type $glyph_name, and using the options specified
30 in @options. Generic options are described in
31 Ace::Graphics::Panel, and specific options are described in each of
32 the Ace::Graphics::Glyph::* manual pages. =back
33 OBJECT METHODS
35 Once a track is created, the following methods can be invoked:
36 $glyph = $factory->glyph($feature)
38 Given a sequence feature, creates an Ace::Graphics::Glyph object to
39 display it. The various attributes of the glyph are set from the
40 options provided at factory creation time.
41 $option = $factory->option($option_name [,$new_option])
43 Given an option name, returns its value. If a second argument is
44 provided, sets the option to the new value and returns its previous
45 one.
46 $index = $factory->fgcolor
48 Returns the desired foreground color for the glyphs in the form of
49 an GD::Image color index. This may be the one of the special
50 colors gdBrushed and gdStyled. This is only useful while the
51 enclosing Ace::Graphics::Panel object is rendering the object. In
52 other contexts it returns undef.
53 $scale = $factory->scale([$scale])
55 Get or set the scale, in pixels/bp, for the glyph. This is
56 ordinarily set by the Ace::Graphics::Track object just prior to
57 rendering, and called by each glyphs' map_pt() method when
58 performing the rendering.
59 $color = $factory->bgcolor([$color])
61 Get or set the background color for the glyphs.
62 $color = $factory->fillcolor([$color])
64 Get or set the fill color for the glyphs.
65 $font = $factory->font([$font])
67 Get or set the font to use for rendering the glyph.
68 $color = $factory->fontcolor
70 Get the color for the font (to set it, use fgcolor()). This is
71 subtly different from fgcolor() itself, because it will never
72 return a styled color, such as gdBrushed.
73 $panel = $factory->panel([$panel])
75 Get or set the panel that contains the GD::Image object used by
76 this factory.
77 $index = $factory->translate($color)
79 @rgb = $factory->rgb($index)
80 These are convenience procedures that are passed through to the
81 enclosing Panel object and have the same effect as the like-named
82 methods in that class. See Ace::Graphics::Panel.
83
85 Please report them.
86
88 Ace::Sequence, Ace::Sequence::Feature, Ace::Graphics::Panel,
89 Ace::Graphics::Track, Ace::Graphics::Glyph
90
92 Lincoln Stein <lstein@cshl.org>.
93 Copyright (c) 2001 Cold Spring Harbor Laboratory
95 This library is free software; you can redistribute it and/or modify it
97 under the same terms as Perl itself. See DISCLAIMER.txt for
98 disclaimers of warranty.
99
101 Hey! The above document had some coding errors, which are explained
102 below:
103 Around line 191:
105 You forgot a '=back' before '=head2'
106perl v5.28.0 2001-09-17 Ace::Graphics::GlyphFactory(3)