Class: Magick::ImageList

Inherits:
Array
  • Object
show all
Includes:
Comparable, Enumerable
Defined in:
lib/RMagick.rb,
lib/rmagick4j/image_list.rb

Overview

class Magick::Image

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*filenames, &block) ⇒ ImageList

Initialize new instances



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

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.



1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
 
# File 'lib/RMagick.rb', line 1673

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.



1273
1274
1275
 
# File 'lib/RMagick.rb', line 1273

def scene
  @scene
end

Instance Method Details

#*(n) ⇒ Object 



1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'lib/RMagick.rb', line 1365

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 



1376
1377
1378
1379
1380
1381
 
# File 'lib/RMagick.rb', line 1376

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



1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
 
# File 'lib/RMagick.rb', line 1388

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 



1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/RMagick.rb', line 1409

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 



1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/RMagick.rb', line 1419

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



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

alias_method :__respond_to__?, :respond_to?

#affinity ⇒ Object

ImageMagic used affinity in 6.4.3, switch to remap in 6.4.4.



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

alias_method :affinity, :remap

#clear ⇒ Object 



1450
1451
1452
1453
 
# File 'lib/RMagick.rb', line 1450

def clear
    @scene = nil
    @images.clear
end

#clone ⇒ Object 



1455
1456
1457
1458
1459
 
# File 'lib/RMagick.rb', line 1455

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

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

override Enumerable#collect



1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/RMagick.rb', line 1462

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__! 



1471
1472
1473
1474
1475
 
# File 'lib/RMagick.rb', line 1471

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

#compact ⇒ Object 



1502
1503
1504
1505
1506
1507
1508
1509
 
# File 'lib/RMagick.rb', line 1502

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 



1511
1512
1513
1514
1515
1516
 
# File 'lib/RMagick.rb', line 1511

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

#concat(other) ⇒ Object 



1518
1519
1520
1521
1522
1523
 
# File 'lib/RMagick.rb', line 1518

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



1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/RMagick.rb', line 1478

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



1487
1488
1489
1490
1491
1492
 
# File 'lib/RMagick.rb', line 1487

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

#delay=(d) ⇒ Object

Set same delay for all images



1526
1527
1528
1529
1530
1531
 
# File 'lib/RMagick.rb', line 1526

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 



1533
1534
1535
1536
1537
1538
1539
 
# File 'lib/RMagick.rb', line 1533

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 



1541
1542
1543
1544
1545
1546
 
# File 'lib/RMagick.rb', line 1541

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

#delete_if(&block) ⇒ Object 



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

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

#dup ⇒ Object 



1555
1556
1557
1558
1559
1560
1561
 
# File 'lib/RMagick.rb', line 1555

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) 


1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'lib/RMagick.rb', line 1563

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 



1574
1575
1576
1577
1578
1579
1580
1581
 
# File 'lib/RMagick.rb', line 1574

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



1584
1585
1586
1587
1588
1589
1590
1591
 
# File 'lib/RMagick.rb', line 1584

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 



6
7
8
9
10
11
12
13
14
 
# File 'lib/rmagick4j/image_list.rb', line 6

def flatten_images
  img = @images.map { |obj| obj._image }
  
  image = img.inject do |memo, obj|
    memo.flatten(obj)
  end
  
  Image.from_image(image)
end

#from_blob(*blobs, &block) ⇒ Object 



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'lib/RMagick.rb', line 1594

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

#insert(index, *args) ⇒ Object 



1618
1619
1620
1621
1622
1623
1624
 
# File 'lib/RMagick.rb', line 1618

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



1627
1628
1629
1630
1631
 
# File 'lib/RMagick.rb', line 1627

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



1634
1635
1636
1637
1638
1639
1640
1641
 
# File 'lib/RMagick.rb', line 1634

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 



1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
 
# File 'lib/RMagick.rb', line 1643

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

#marshal_dump ⇒ Object

Custom marshal/unmarshal for Ruby 1.8.



1657
1658
1659
1660
1661
 
# File 'lib/RMagick.rb', line 1657

def marshal_dump()
   ary = [@scene]
   @images.each {|i| ary << Marshal.dump(i)}
   ary
end

#marshal_load(ary) ⇒ Object 



1663
1664
1665
1666
1667
 
# File 'lib/RMagick.rb', line 1663

def marshal_load(ary)
   @scene = ary.shift
   @images = []
   ary.each {|a| @images << Marshal.load(a)}
end

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

Create a new image and add it to the end



1689
1690
1691
 
# File 'lib/RMagick.rb', line 1689

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

#nitems ⇒ Object 



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

def nitems()
   @images.nitems()
end

#partition(&block) ⇒ Object 



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

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



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

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 



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

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

#push(*objs) ⇒ Object 



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

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

#read(*files, &block) ⇒ Object

Read files and concatenate the new images



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

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



1745
1746
1747
1748
1749
1750
1751
1752
 
# File 'lib/RMagick.rb', line 1745

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 



1754
1755
1756
1757
1758
1759
1760
 
# File 'lib/RMagick.rb', line 1754

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 



16
17
18
 
# File 'lib/rmagick4j/image_list.rb', line 16

def remap
	# TODO: Implement. Just here to avoid RMagick 2.9 errors.
end

#replace(other) ⇒ Object 



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

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) 


1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'lib/RMagick.rb', line 1774

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 



1783
1784
1785
1786
1787
1788
1789
 
# File 'lib/RMagick.rb', line 1783

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

#reverse! ⇒ Object 



1791
1792
1793
1794
1795
1796
 
# File 'lib/RMagick.rb', line 1791

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

#reverse_each ⇒ Object 



1798
1799
1800
1801
 
# File 'lib/RMagick.rb', line 1798

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

#shift ⇒ Object 



1803
1804
1805
1806
1807
1808
 
# File 'lib/RMagick.rb', line 1803

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

#slice(*args) ⇒ Object 



1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
 
# File 'lib/RMagick.rb', line 1810

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 



1826
1827
1828
1829
1830
1831
 
# File 'lib/RMagick.rb', line 1826

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

#ticks_per_second=(t) ⇒ Object 



1833
1834
1835
1836
1837
1838
 
# File 'lib/RMagick.rb', line 1833

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 



1840
1841
1842
1843
1844
 
# File 'lib/RMagick.rb', line 1840

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

#to_blob(&add) ⇒ Object 



20
21
22
23
 
# File 'lib/rmagick4j/image_list.rb', line 20

def to_blob(&add)
  # TODO Support lists.
  first.to_blob(&add)
end

#uniq ⇒ Object 



1846
1847
1848
1849
1850
1851
1852
 
# File 'lib/RMagick.rb', line 1846

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 



1854
1855
1856
1857
1858
1859
 
# File 'lib/RMagick.rb', line 1854

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

#unshift(obj) ⇒ Object 



1862
1863
1864
1865
1866
1867
 
# File 'lib/RMagick.rb', line 1862

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

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



1869
1870
1871
1872
1873
1874
1875
 
# File 'lib/RMagick.rb', line 1869

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