lib/CXGN/Cview/ImageI.pm

   1
   2 =head1 NAME
   3
   4 CXGN::Cview::ImageI - an interface for top-level Cview images.
   5
   6 =head1 DESCRIPTION
   7
   8 =head1 AUTHOR(S)
   9
  10 Lukas Mueller (lam87@cornell.edu)
  11
  12 =head1 FUNCTIONS
  13
  14
  15 =cut
  16
  17 use strict;
  18
  19 package CXGN::Cview::ImageI;
  20
  21 use GD;
  22
  23 =head2 function new
  24
  25   Synopsis:
  26   Arguments:
  27   Returns:
  28   Side effects:
  29   Description:
  30
  31 =cut
  32
  33 sub new {
  34     my $class = shift;
  35     my $self = bless {}, $class;
  36
  37     # set some defaults...
  38     #
  39     $self->set_width(600);
  40     $self->set_height(400);
  41
  42     return $self;
  43 }
  44
  45 =head2 function render
  46
  47   Synopsis:
  48   Arguments:
  49   Returns:
  50   Side effects:
  51   Description:
  52
  53 =cut
  54
  55 sub render {
  56 }
  57
  58 =head2 accessors get_width(), set_width()
  59
  60   Synopsis:     $width = $ii->get_width()
  61   Property:     the width, in pixels, of the canvas
  62   Side effects:
  63   Description:
  64
  65 =cut
  66
  67 sub get_width {
  68     my $self=shift;
  69     return $self->{width};
  70 }
  71
  72
  73 sub set_width {
  74     my $self=shift;
  75     $self->{width}=shift;
  76 }
  77
  78 =head2 accessors get_height(), set_height()
  79
  80   Synopsis:     my $height = $ii->get_height()
  81   Property:     the height in pixels of the canvas
  82   Side effects:
  83   Description:
  84
  85 =cut
  86
  87 sub get_height {
  88     my $self=shift;
  89     return $self->{height};
  90 }
  91
  92 sub set_height {
  93     my $self=shift;
  94     $self->{height}=shift;
  95 }
  96
  97 =head2 accessors get_image(), set_image()
  98
  99   Synopsis:     my $i = $ii->get_image()
 100   Property:     the GD::Image used for drawing on this canvas
 101   Side effects:
 102   Description:
 103
 104 =cut
 105
 106 sub get_image {
 107     my $self=shift;
 108     return $self->{image};
 109 }
 110
 111 sub set_image {
 112     my $self=shift;
 113     $self->{image}=shift;
 114 }
 115
 116 =head2 function add_image_object
 117
 118   Synopsis:
 119   Arguments:
 120   Returns:
 121   Side effects:
 122   Description:
 123
 124 =cut
 125
 126 sub add_image_object {
 127     my $self = shift;
 128     my $object = shift;
 129     if (!exists($self->{image_objects})) { $self->{image_objects}= []; }
 130     push @{$self->{image_objects}}, $object;
 131 }
 132
 133 =head2 function get_image_objects
 134
 135   Synopsis:
 136   Arguments:
 137   Returns:
 138   Side effects:
 139   Description:
 140
 141 =cut
 142
 143 sub get_image_objects {
 144     my $self = shift;
 145     return @{$self->{image_objects}};
 146 }
 147
 148 =head2 accessors get_name, set_name
 149
 150  Usage:
 151  Desc:
 152  Property
 153  Side Effects:
 154  Example:
 155
 156 =cut
 157
 158 sub get_name {
 159   my $self = shift;
 160   return $self->{name};
 161 }
 162
 163 sub set_name {
 164   my $self = shift;
 165   $self->{name} = shift;
 166 }
 167
 168 return 1;