fe282253895abfcb0f98cc8eddea9e33da511a34
[shipsimu.git] / inc / classes / main / images / extended / class_PngImage.php
1 <?php
2 /**
3  * A PNG image generator
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class PngImage extends BaseImage {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33
34                 // Set part description
35                 $this->setObjectDescription("PNG image");
36
37                 // Create unique ID number
38                 $this->generateUniqueId();
39         }
40
41         /**
42          * Creates an instance of this image class
43          *
44          * @param       $templateInstance       A template instance
45          * @return      $imageInstance          An instance of this image class
46          */
47         public final static function createPngImage(CompileableTemplate $templateInstance) {
48                 // Get a new instance
49                 $imageInstance = new PngImage();
50
51                 // Set template instance
52                 $imageInstance->setTemplateInstance($templateInstance);
53
54                 // Set image type
55                 $imageInstance->setImageType('png');
56
57                 // Return the instance
58                 return $imageInstance;
59         }
60
61         /**
62          * Finish this image by producing it
63          *
64          * @return      void
65          */
66         public function finishImage () {
67                 // Call parent method
68                 parent::finishImage();
69
70                 // Get a file name for our image
71                 $cacheFile = $this->getTemplateInstance()->getImageCacheFqfn();
72
73                 // Finish the image and send it to a cache file
74                 imagepng($this->getImageResource(), $cacheFile, 9, PNG_ALL_FILTERS);
75         }
76 }
77
78 // [EOF]
79 ?>