3 * A PNG image generator
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class PngImage extends BaseImage {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set part description
35 $this->setObjectDescription("PNG image");
37 // Create unique ID number
38 $this->generateUniqueId();
42 * Creates an instance of this image class
44 * @param $templateInstance A template instance
45 * @return $imageInstance An instance of this image class
47 public final static function createPngImage(CompileableTemplate $templateInstance) {
49 $imageInstance = new PngImage();
51 // Set template instance
52 $imageInstance->setTemplateInstance($templateInstance);
55 $imageInstance->setImageType('png');
57 // Return the instance
58 return $imageInstance;
62 * Finish this image by producing it
66 public function finishImage () {
68 parent::finishImage();
70 // Get a file name for our image
71 $cacheFile = $this->getTemplateInstance()->getImageCacheFqfn();
73 // Finish the image and send it to a cache file
74 imagepng($this->getImageResource(), $cacheFile, 9, PNG_ALL_FILTERS);