Class: Magick::ImageList

Inherits:
Object
  • Object
show all
Includes:
Comparable, Enumerable
Defined in:
lib/RMagick.rb,
ext/RMagick/rmmain.c

Overview

class Magick::Image

Defined Under Namespace

Classes: Montage

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*filenames, &block) ⇒ ImageList

Initialize new instances



1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
 
# File 'lib/RMagick.rb', line 1579

def initialize(*filenames, &block)
    @images = []
    @scene = nil
    filenames.each { |f|
        Magick::Image.read(f, &block).each { |n| @images << n }
        }
    if length > 0
        @scene = length - 1     # last image in array
    end
    self
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(methID, *args, &block) ⇒ Object

The ImageList class supports the Magick::Image class methods by simply sending the method to the current image. If the method isn’t explicitly supported, send it to the current image in the array. If there are no images, send it up the line. Catch a NameError and emit a useful message.



1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
 
# File 'lib/RMagick.rb', line 1633

def method_missing(methID, *args, &block)
    begin
        if @scene
            @images[@scene].send(methID, *args, &block)
        else
            super
        end
    rescue NoMethodError
      Kernel.raise NoMethodError, "undefined method `#{methID.id2name}' for #{self.class}"
    rescue Exception
        $@.delete_if { |s| /:in `send'$/.match(s) || /:in `method_missing'$/.match(s) }
        Kernel.raise
    end
end

Instance Attribute Details

#scene ⇒ Object

Returns the value of attribute scene.



1253
1254
1255
 
# File 'lib/RMagick.rb', line 1253

def scene
  @scene
end

Instance Method Details

#*(n) ⇒ Object 



1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
 
# File 'lib/RMagick.rb', line 1345

def *(n)
    unless n.kind_of? Integer
        Kernel.raise ArgumentError, "Integer required (#{n.class} given)"
    end
    current = get_current()
    ilist = self.class.new
    (@images * n).each {|image| ilist << image}
    ilist.set_current current
    return ilist
end

#<<(obj) ⇒ Object 



1356
1357
1358
1359
1360
1361
 
# File 'lib/RMagick.rb', line 1356

def <<(obj)
    is_an_image obj
    @images << obj
    @scene = @images.length - 1
    self
end

#<=>(other) ⇒ Object

Compare ImageLists Compare each image in turn until the result of a comparison is not 0. If all comparisons return 0, then

return if A.scene != B.scene
return A.length <=> B.length



1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'lib/RMagick.rb', line 1368

def <=>(other)
    unless other.kind_of? self.class
       Kernel.raise TypeError, "#{self.class} required (#{other.class} given)"
    end
    size = [self.length, other.length].min
    size.times do |x|
        r = self[x] <=> other[x]
        return r unless r == 0
    end
    if @scene.nil? && other.scene.nil?
        return 0
    elsif @scene.nil? && ! other.scene.nil?
        Kernel.raise TypeError, "cannot convert nil into #{other.scene.class}"
    elsif ! @scene.nil? && other.scene.nil?
        Kernel.raise TypeError, "cannot convert nil into #{self.scene.class}"
    end
    r = self.scene <=> other.scene
    return r unless r == 0
    return self.length <=> other.length
end

#[](*args) ⇒ Object 



1389
1390
1391
1392
1393
1394
1395
1396
1397
 
# File 'lib/RMagick.rb', line 1389

def [](*args)
    a = @images[*args]
    if a.respond_to?(:each) then
        ilist = self.class.new
        a.each {|image| ilist << image}
        a = ilist
    end
    return a
end

#[]=(*args) ⇒ Object 



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
 
# File 'lib/RMagick.rb', line 1399

def []=(*args)
    obj = @images.[]=(*args)
    if obj && obj.respond_to?(:each) then
        is_an_image_array(obj)
        set_current obj.last.__id__
    elsif obj
        is_an_image(obj)
        set_current obj.__id__
    else
        set_current nil
    end
    return obj
end

#__respond_to__? ⇒ Object

Ensure respond_to? answers correctly when we are delegating to Image



1733
 
# File 'lib/RMagick.rb', line 1733

alias_method :__respond_to__?, :respond_to?

#animate ⇒ Object

#append ⇒ Object

#average ⇒ Object

#clear ⇒ Object 



1423
1424
1425
1426
 
# File 'lib/RMagick.rb', line 1423

def clear
    @scene = nil
    @images.clear
end

#clone ⇒ Object 



1428
1429
1430
1431
1432
 
# File 'lib/RMagick.rb', line 1428

def clone
    ditto = dup
    ditto.freeze if frozen?
    return ditto
end

#coalesce ⇒ Object

#collect(&block) ⇒ Object Also known as: __map__

override Enumerable#collect



1435
1436
1437
1438
1439
1440
1441
1442
 
# File 'lib/RMagick.rb', line 1435

def collect(&block)
    current = get_current()
    a = @images.collect(&block)
    ilist = self.class.new
    a.each {|image| ilist << image}
    ilist.set_current current
    return ilist
end

#collect!(&block) ⇒ Object Also known as: map!, __map__! 



1444
1445
1446
1447
1448
 
# File 'lib/RMagick.rb', line 1444

def collect!(&block)
    @images.collect!(&block)
    is_an_image_array @images
    self
end

#compact ⇒ Object 



1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/RMagick.rb', line 1475

def compact
    current = get_current()
    ilist = self.class.new
    a = @images.compact
    a.each {|image| ilist << image}
    ilist.set_current current
    return ilist
end

#compact! ⇒ Object 



1484
1485
1486
1487
1488
1489
 
# File 'lib/RMagick.rb', line 1484

def compact!
    current = get_current()
    a = @images.compact!    # returns nil if no changes were made
    set_current current
    return a.nil? ? nil : self
end

#composite_layers ⇒ Object

#concat(other) ⇒ Object 



1491
1492
1493
1494
1495
1496
 
# File 'lib/RMagick.rb', line 1491

def concat(other)
    is_an_image_array other
    other.each {|image| @images << image}
    @scene = length-1
    return self
end

#copy ⇒ Object

Make a deep copy



1451
1452
1453
1454
1455
1456
1457
 
# File 'lib/RMagick.rb', line 1451

def copy
    ditto = self.class.new
    @images.each { |f| ditto << f.copy }
    ditto.scene = @scene
    ditto.taint if tainted?
    return ditto
end

#cur_image ⇒ Object

Return the current image



1460
1461
1462
1463
1464
1465
 
# File 'lib/RMagick.rb', line 1460

def cur_image
    if ! @scene
        Kernel.raise IndexError, "no images in this list"
    end
    @images[@scene]
end

#deconstruct ⇒ Object

#delay=(d) ⇒ Object

Set same delay for all images



1499
1500
1501
1502
1503
1504
 
# File 'lib/RMagick.rb', line 1499

def delay=(d)
    if Integer(d) < 0
        raise ArgumentError, "delay must be greater than or equal to 0"
    end
    @images.each { |f| f.delay = Integer(d) }
end

#delete(obj, &block) ⇒ Object 



1506
1507
1508
1509
1510
1511
1512
 
# File 'lib/RMagick.rb', line 1506

def delete(obj, &block)
    is_an_image obj
    current = get_current()
    a = @images.delete(obj, &block)
    set_current current
    return a
end

#delete_at(ndx) ⇒ Object 



1514
1515
1516
1517
1518
1519
 
# File 'lib/RMagick.rb', line 1514

def delete_at(ndx)
    current = get_current()
    a = @images.delete_at(ndx)
    set_current current
    return a
end

#delete_if(&block) ⇒ Object 



1521
1522
1523
1524
1525
1526
 
# File 'lib/RMagick.rb', line 1521

def delete_if(&block)
    current = get_current()
    @images.delete_if(&block)
    set_current current
    self
end

#display ⇒ Object Also known as: __display__

#dup ⇒ Object 



1528
1529
1530
1531
1532
1533
1534
 
# File 'lib/RMagick.rb', line 1528

def dup
    ditto = self.class.new
    @images.each {|img| ditto << img}
    ditto.scene = @scene
    ditto.taint if tainted?
    return ditto
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
 
# File 'lib/RMagick.rb', line 1536

def eql?(other)
  is_an_image_array other
  eql = other.eql?(@images)
  begin # "other" is another ImageList
    eql &&= @scene == other.scene
  rescue NoMethodError
    # "other" is a plain Array
  end
  return eql
end

#fill(*args, &block) ⇒ Object 



1547
1548
1549
1550
1551
1552
1553
1554
 
# File 'lib/RMagick.rb', line 1547

def fill(*args, &block)
    is_an_image args[0] unless block_given?
    current = get_current()
    @images.fill(*args, &block)
    is_an_image_array self
    set_current current
    self
end

#find_all(&block) ⇒ Object Also known as: select

Override Enumerable’s find_all



1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/RMagick.rb', line 1557

def find_all(&block)
    current = get_current()
    a = @images.find_all(&block)
    ilist = self.class.new
    a.each {|image| ilist << image}
    ilist.set_current current
    return ilist
end

#flatten_images ⇒ Object

#from_blob(*blobs, &block) ⇒ Object 



1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
 
# File 'lib/RMagick.rb', line 1567

def from_blob(*blobs, &block)
    if (blobs.length == 0)
        Kernel.raise ArgumentError, "no blobs given"
    end
    blobs.each { |b|
        Magick::Image.from_blob(b, &block).each { |n| @images << n  }
        }
    @scene = length - 1
    self
end

#fx ⇒ Object

#insert(index, *args) ⇒ Object 



1591
1592
1593
1594
1595
1596
1597
 
# File 'lib/RMagick.rb', line 1591

def insert(index, *args)
    args.each {|image| is_an_image image}
    current = get_current()
    @images.insert(index, *args)
    set_current current
    return self
end

#inspect ⇒ Object

Call inspect for all the images



1600
1601
1602
1603
1604
 
# File 'lib/RMagick.rb', line 1600

def inspect
    img = []
    @images.each {|image| img << image.inspect }
    img = "[" + img.join(",\n") + "]\nscene=#{@scene}"
end

#iterations=(n) ⇒ Object

Set the number of iterations of an animated GIF



1607
1608
1609
1610
1611
1612
1613
1614
 
# File 'lib/RMagick.rb', line 1607

def iterations=(n)
    n = Integer(n)
    if n < 0 || n > 65535
        Kernel.raise ArgumentError, "iterations must be between 0 and 65535"
    end
    @images.each {|f| f.iterations=n}
    self
end

#last(*args) ⇒ Object 



1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
 
# File 'lib/RMagick.rb', line 1616

def last(*args)
    if args.length == 0
      a = @images.last
    else
      a = @images.last(*args)
      ilist = self.class.new
      a.each {|img| ilist << img}
      @scene = a.length - 1
      a = ilist
    end
    return a
end

#map ⇒ Object

#montage ⇒ Object

#morph ⇒ Object

#mosaic ⇒ Object

#new_image(cols, rows, *fill, &info_blk) ⇒ Object

Create a new image and add it to the end



1649
1650
1651
 
# File 'lib/RMagick.rb', line 1649

def new_image(cols, rows, *fill, &info_blk)
    self << Magick::Image.new(cols, rows, *fill, &info_blk)
end

#optimize_layers ⇒ Object

#partition(&block) ⇒ Object 



1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
 
# File 'lib/RMagick.rb', line 1653

def partition(&block)
  a = @images.partition(&block)
  t = self.class.new
  a[0].each { |img| t << img}
  t.set_current nil
  f = self.class.new
  a[1].each { |img| f << img}
  f.set_current nil
  [t, f]
end

#ping(*files, &block) ⇒ Object

Ping files and concatenate the new images



1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'lib/RMagick.rb', line 1665

def ping(*files, &block)
    if (files.length == 0)
        Kernel.raise ArgumentError, "no files given"
    end
    files.each { |f|
        Magick::Image.ping(f, &block).each { |n| @images << n }
        }
    @scene = length - 1
    self
end

#pop ⇒ Object 



1676
1677
1678
1679
1680
1681
 
# File 'lib/RMagick.rb', line 1676

def pop
    current = get_current()
    a = @images.pop       # can return nil
    set_current current
    return a
end

#push(*objs) ⇒ Object 



1683
1684
1685
1686
1687
1688
1689
1690
 
# File 'lib/RMagick.rb', line 1683

def push(*objs)
    objs.each do |image|
        is_an_image image
        @images << image
    end
    @scene = length - 1
    self
end

#quantize ⇒ Object

#read(*files, &block) ⇒ Object

Read files and concatenate the new images



1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
 
# File 'lib/RMagick.rb', line 1693

def read(*files, &block)
    if (files.length == 0)
        Kernel.raise ArgumentError, "no files given"
    end
    files.each { |f|
        Magick::Image.read(f, &block).each { |n| @images << n }
        }
    @scene = length - 1
    self
end

#reject(&block) ⇒ Object

override Enumerable’s reject



1705
1706
1707
1708
1709
1710
1711
1712
 
# File 'lib/RMagick.rb', line 1705

def reject(&block)
    current = get_current()
    ilist = self.class.new
    a = @images.reject(&block)
    a.each {|image| ilist << image}
    ilist.set_current current
    return ilist
end

#reject!(&block) ⇒ Object 



1714
1715
1716
1717
1718
1719
1720
 
# File 'lib/RMagick.rb', line 1714

def reject!(&block)
    current = get_current()
    a = @images.reject!(&block)
    @images = a if !a.nil?
    set_current current
    return a.nil? ? nil : self
end

#remap ⇒ Object Also known as: affinity

#replace(other) ⇒ Object 



1722
1723
1724
1725
1726
1727
1728
1729
1730
 
# File 'lib/RMagick.rb', line 1722

def replace(other)
    is_an_image_array other
    current = get_current()
    @images.clear
    other.each {|image| @images << image}
    @scene = self.length == 0 ? nil : 0
    set_current current
    self
end

#respond_to?(methID, priv = false) ⇒ Boolean

Returns:

  • (Boolean) 


1734
1735
1736
1737
1738
1739
1740
1741
 
# File 'lib/RMagick.rb', line 1734

def respond_to?(methID, priv=false)
    return true if __respond_to__?(methID, priv)
    if @scene
        @images[@scene].respond_to?(methID, priv)
    else
        super
    end
end

#reverse ⇒ Object 



1743
1744
1745
1746
1747
1748
1749
 
# File 'lib/RMagick.rb', line 1743

def reverse
    current = get_current()
    a = self.class.new
    @images.reverse_each {|image| a << image}
    a.set_current current
    return a
end

#reverse! ⇒ Object 



1751
1752
1753
1754
1755
1756
 
# File 'lib/RMagick.rb', line 1751

def reverse!
    current = get_current()
    @images.reverse!
    set_current current
    self
end

#reverse_each ⇒ Object 



1758
1759
1760
1761
 
# File 'lib/RMagick.rb', line 1758

def reverse_each
    @images.reverse_each {|image| yield(image)}
    self
end

#shift ⇒ Object 



1763
1764
1765
1766
1767
1768
 
# File 'lib/RMagick.rb', line 1763

def shift
    current = get_current()
    a = @images.shift
    set_current current
    return a
end

#slice(*args) ⇒ Object 



1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
 
# File 'lib/RMagick.rb', line 1770

def slice(*args)
    current = get_current()
    slice = @images.slice(*args)
    if slice
        ilist = self.class.new
        if slice.respond_to?(:each) then
            slice.each {|image| ilist << image}
        else
            ilist << slice
        end
    else
        ilist = nil
    end
    return ilist
end

#slice!(*args) ⇒ Object 



1786
1787
1788
1789
1790
1791
 
# File 'lib/RMagick.rb', line 1786

def slice!(*args)
    current = get_current()
    a = @images.slice!(*args)
    set_current current
    return a
end

#ticks_per_second=(t) ⇒ Object 



1793
1794
1795
1796
1797
1798
 
# File 'lib/RMagick.rb', line 1793

def ticks_per_second=(t)
    if Integer(t) < 0
        Kernel.raise ArgumentError, "ticks_per_second must be greater than or equal to 0"
    end
    @images.each { |f| f.ticks_per_second = Integer(t) }
end

#to_a ⇒ Object 



1800
1801
1802
1803
1804
 
# File 'lib/RMagick.rb', line 1800

def to_a
    a = Array.new
    @images.each {|image| a << image}
    return a
end

#to_blob ⇒ Object

#uniq ⇒ Object 



1806
1807
1808
1809
1810
1811
1812
 
# File 'lib/RMagick.rb', line 1806

def uniq
    current = get_current()
    a = self.class.new
    @images.uniq.each {|image| a << image}
    a.set_current current
    return a
end

#uniq!(*args) ⇒ Object 



1814
1815
1816
1817
1818
1819
 
# File 'lib/RMagick.rb', line 1814

def uniq!(*args)
    current = get_current()
    a = @images.uniq!
    set_current current
    return a.nil? ? nil : self
end

#unshift(obj) ⇒ Object 



1822
1823
1824
1825
1826
1827
 
# File 'lib/RMagick.rb', line 1822

def unshift(obj)
    is_an_image obj
    @images.unshift(obj)
    @scene = 0
    self
end

#values_at(*args) ⇒ Object Also known as: indexes, indices 



1829
1830
1831
1832
1833
1834
1835
 
# File 'lib/RMagick.rb', line 1829

def values_at(*args)
    a = @images.values_at(*args)
    a = self.class.new
    @images.values_at(*args).each {|image| a << image}
    a.scene = a.length - 1
    return a
end

#write ⇒ Object