├── docs └── img │ ├── add_image_basic.png │ ├── basefont_output.png │ ├── add_image_extended.png │ ├── extended_font_output.png │ ├── gradient_square_after.png │ └── gradient_square_before.png ├── image ├── font │ ├── fonts │ │ └── arialbd.ttf │ ├── Font.php │ ├── BaseFont.php │ └── ExtendedFont.php ├── color │ ├── components │ │ ├── ColorComponent.php │ │ └── RGB.php │ ├── SingleColor.php │ ├── Color.php │ └── Gradient.php ├── shapes │ ├── Circle.php │ ├── Square.php │ ├── Rectangle.php │ ├── LineGraph.php │ ├── BaseShape.php │ ├── Ellipse.php │ ├── Polygon.php │ └── Line.php └── Image.php ├── composer.json ├── utils ├── FlipTypes.php ├── Utils.php └── SquareConverter.php ├── position └── Vector2.php ├── README.md └── LICENSE /docs/img/add_image_basic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HimmelKreis4865/ImageLib/HEAD/docs/img/add_image_basic.png -------------------------------------------------------------------------------- /docs/img/basefont_output.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HimmelKreis4865/ImageLib/HEAD/docs/img/basefont_output.png -------------------------------------------------------------------------------- /image/font/fonts/arialbd.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HimmelKreis4865/ImageLib/HEAD/image/font/fonts/arialbd.ttf -------------------------------------------------------------------------------- /docs/img/add_image_extended.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HimmelKreis4865/ImageLib/HEAD/docs/img/add_image_extended.png -------------------------------------------------------------------------------- /docs/img/extended_font_output.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HimmelKreis4865/ImageLib/HEAD/docs/img/extended_font_output.png -------------------------------------------------------------------------------- /docs/img/gradient_square_after.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HimmelKreis4865/ImageLib/HEAD/docs/img/gradient_square_after.png -------------------------------------------------------------------------------- /docs/img/gradient_square_before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HimmelKreis4865/ImageLib/HEAD/docs/img/gradient_square_before.png -------------------------------------------------------------------------------- /image/color/components/ColorComponent.php: -------------------------------------------------------------------------------- 1 | =8.0" 8 | }, 9 | "autoload": { 10 | "psr-4": { 11 | "image\\": "image/", 12 | "position\\": "position/", 13 | "utils\\": "utils/" 14 | } 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /utils/FlipTypes.php: -------------------------------------------------------------------------------- 1 | size; 26 | } 27 | 28 | public function draw(GdImage $image): void { 29 | $ellipse = new Ellipse($this->getPadding(), $this->getColor(), $this->getSize(), $this->getSize(), $this->filled); 30 | $ellipse->draw($image); 31 | } 32 | } -------------------------------------------------------------------------------- /image/shapes/Square.php: -------------------------------------------------------------------------------- 1 | getPadding()->getY(); $i < ($this->size + $this->getPadding()->getY()); $i++) { 25 | imageline($image, $this->getPadding()->getX(), $i, ($this->size + $this->getPadding()->getX()), $i, $this->getColor()->getColor($image, $i, ($this->getPadding()->getY() + $this->size))); 26 | } 27 | } 28 | } -------------------------------------------------------------------------------- /image/font/Font.php: -------------------------------------------------------------------------------- 1 | getPadding()->getY(); $i < ($this->getPadding()->getY() + $this->height); $i++) { 26 | imageline($image, $this->getPadding()->getX(), $i, ($this->getPadding()->getX() + $this->width), $i, $this->getColor()->getColor($image, $i, ($this->getPadding()->getY() + $this->height))); 27 | } 28 | } 29 | } -------------------------------------------------------------------------------- /image/shapes/LineGraph.php: -------------------------------------------------------------------------------- 1 | points = array_filter($points, function($key) { 26 | return ($key instanceof Vector2); 27 | }); 28 | } 29 | 30 | public function draw(GdImage $image): void { 31 | $lastPos = new Vector2(0, 0); 32 | foreach ($this->points as $point) { 33 | $line = new Line($lastPos, $point, $this->size, $this->getColor()); 34 | $line->draw($image); 35 | } 36 | } 37 | } -------------------------------------------------------------------------------- /image/shapes/BaseShape.php: -------------------------------------------------------------------------------- 1 | padding = $padding ?? new Vector2(0, 0); 21 | $this->color = $color ?? new SingleColor(new RGB(255, 255, 255)); 22 | } 23 | 24 | /** 25 | * Draws the shape on an image 26 | * 27 | * @api 28 | * 29 | * @param GdImage $image 30 | * 31 | * @return void 32 | */ 33 | abstract public function draw(GdImage $image): void; 34 | 35 | 36 | /** 37 | * @return Color 38 | */ 39 | public function getColor(): Color { 40 | return $this->color; 41 | } 42 | 43 | /** 44 | * @return Vector2 45 | */ 46 | public function getPadding(): Vector2 { 47 | return $this->padding; 48 | } 49 | } -------------------------------------------------------------------------------- /image/color/SingleColor.php: -------------------------------------------------------------------------------- 1 | color->getRed(), $this->color->getGreen(), $this->color->getBlue()); 42 | } 43 | } -------------------------------------------------------------------------------- /image/color/Color.php: -------------------------------------------------------------------------------- 1 | width; 22 | } 23 | 24 | /** 25 | * @return int 26 | */ 27 | public function getHeight(): int { 28 | return $this->height; 29 | } 30 | 31 | public function draw(GdImage $image): void { 32 | if ($this->filled) { 33 | imagefilledellipse($image, ($this->getPadding()->getX() + ($this->getWidth() / 2)), ($this->getPadding()->getY() + ($this->getHeight() / 2)), $this->getWidth(), $this->getHeight(), $this->getColor()->getColor($image, 0, $this->getWidth())); 34 | } else { 35 | imageellipse($image, ($this->getPadding()->getX() + ($this->getWidth() / 2)), ($this->getPadding()->getY() + ($this->getHeight() / 2)), $this->getWidth(), $this->getHeight(), $this->getColor()->getColor($image, 0, $this->getWidth())); 36 | } 37 | } 38 | } -------------------------------------------------------------------------------- /image/font/BaseFont.php: -------------------------------------------------------------------------------- 1 | text; 29 | } 30 | 31 | /** 32 | * Returns the fontsize passed above 33 | * 34 | * @api 35 | * 36 | * @return float 37 | */ 38 | public function getFontSize(): float { 39 | return $this->fontSize; 40 | } 41 | 42 | /** 43 | * Returns the padding, if null, it will return a new Vector2 at position 0, 0 44 | * 45 | * @api 46 | * 47 | * @return Vector2 48 | */ 49 | public function getPadding(): Vector2 { 50 | return $this->padding ?? new Vector2(0, 0); 51 | } 52 | 53 | /** 54 | * Returns the color of the font or black in case it's null 55 | * 56 | * @api 57 | * 58 | * @return RGB 59 | */ 60 | public function getColor(): RGB { 61 | return $this->color ?? new RGB(0, 0, 0); 62 | } 63 | } -------------------------------------------------------------------------------- /image/color/Gradient.php: -------------------------------------------------------------------------------- 1 | end->getRed() - $this->begin->getRed()) / $size)) + $this->begin->getRed()), (floor(($i * ($this->end->getGreen() - $this->begin->getGreen()) / $size)) + $this->begin->getGreen()), (floor(($i * ($this->end->getBlue() - $this->begin->getBlue()) / $size)) + $this->begin->getBlue())); 44 | } 45 | } -------------------------------------------------------------------------------- /image/shapes/Polygon.php: -------------------------------------------------------------------------------- 1 | positions; 29 | } 30 | 31 | public function draw(GdImage $image): void { 32 | $finalPositions = []; 33 | $positions = array_map(function($vector2) { 34 | return [$vector2->getX(), $vector2->getY()]; 35 | }, array_filter($this->positions, function ($vector2) { 36 | return ($vector2 instanceof Vector2); 37 | })); 38 | 39 | foreach ($positions as $position) { 40 | $finalPositions[] = $position[0]; 41 | $finalPositions[] = $position[1]; 42 | } 43 | 44 | if ($this->filled) { 45 | imagefilledpolygon($image, $finalPositions, (count($positions)), $this->getColor()->getColor($image, 0, 0)); 46 | } else { 47 | imagepolygon($image, $finalPositions, (count($positions)), $this->getColor()->getColor($image, 0, 0)); 48 | } 49 | } 50 | } -------------------------------------------------------------------------------- /image/shapes/Line.php: -------------------------------------------------------------------------------- 1 | getBeginPos()->getX() !== $this->getEndPos()->getX() and $this->getBeginPos()->getY() !== $this->getEndPos()->getY()) 16 | throw new InvalidArgumentException("Cannot create a line with completely different coordinates!"); 17 | } 18 | 19 | /** 20 | * @return Vector2|null 21 | */ 22 | public function getEndPos(): ?Vector2 { 23 | return $this->endPos; 24 | } 25 | 26 | /** 27 | * @return Vector2 28 | */ 29 | public function getBeginPos(): Vector2 { 30 | return parent::getPadding(); 31 | } 32 | 33 | public function draw(GdImage $image): void { 34 | if ($this->getBeginPos()->getX() < $this->getEndPos()->getX()) { 35 | $size = ($this->getEndPos()->getX() - $this->getBeginPos()->getX()); 36 | for ($i = $this->getBeginPos()->getX(); $i < $this->getEndPos()->getX(); $i++) { 37 | imageline($image, $i, ($this->getBeginPos()->getY() - $this->size), $i, $this->getEndPos()->getY(), $this->getColor()->getColor($image, $i, $size)); 38 | } 39 | } else { 40 | $size = ($this->getEndPos()->getY() - $this->getBeginPos()->getY()); 41 | for ($i = $this->getBeginPos()->getY(); $i < $this->getEndPos()->getY(); $i++) { 42 | imageline($image, ($this->getBeginPos()->getX() - $this->size), $i, $this->getEndPos()->getX(), $i, $this->getColor()->getColor($image, $i, $size)); 43 | } 44 | } 45 | } 46 | } -------------------------------------------------------------------------------- /position/Vector2.php: -------------------------------------------------------------------------------- 1 | x = $x; 20 | $this->y = $y; 21 | } 22 | 23 | /** 24 | * Sets the Y coordinate of the vector 25 | * 26 | * @api 27 | * 28 | * @param int $x 29 | */ 30 | public function setX(int $x): void { 31 | $this->x = $x; 32 | } 33 | 34 | /** 35 | * Sets the Y coordinate of the vector 36 | * 37 | * @api 38 | * 39 | * @param int $y 40 | */ 41 | public function setY(int $y): void { 42 | $this->y = $y; 43 | } 44 | 45 | /** 46 | * Returns the X coordinate of the vector 47 | * 48 | * @api 49 | * 50 | * @return int 51 | */ 52 | public function getX(): int { 53 | return $this->x; 54 | } 55 | 56 | /** 57 | * Returns the Y coordinate of the vector 58 | * 59 | * @api 60 | * 61 | * @return int 62 | */ 63 | public function getY(): int { 64 | return $this->y; 65 | } 66 | 67 | /** 68 | * Returns whether two vectors are equivalent or not 69 | * 70 | * @api 71 | * 72 | * @param Vector2 $vector2 73 | * 74 | * @return bool 75 | */ 76 | public function equals(Vector2 $vector2): bool { 77 | return ($vector2->getX() === $this->getX() and $vector2->getY() === $this->getY()); 78 | } 79 | 80 | /** 81 | * Returns the position as array ( [x, y] ) 82 | * 83 | * @api 84 | * 85 | * @return int[] 86 | */ 87 | public function toArray(): array { 88 | return [$this->getX(), $this->getY()]; 89 | } 90 | } -------------------------------------------------------------------------------- /image/font/ExtendedFont.php: -------------------------------------------------------------------------------- 1 | fontPath)) { 25 | // todo: clean this up 26 | $this->fontPath = __DIR__ . DIRECTORY_SEPARATOR . "fonts" . DIRECTORY_SEPARATOR . $this->fontPath; 27 | if (!file_exists($this->fontPath)) throw new InvalidArgumentException("Could not find a font under name " . $this->fontPath); 28 | } 29 | } 30 | 31 | /** 32 | * Returns the content of the text 33 | * 34 | * @api 35 | * 36 | * @return string 37 | */ 38 | public function getText(): string { 39 | return $this->text; 40 | } 41 | 42 | /** 43 | * Returns the fontsize registered 44 | * 45 | * @api 46 | * 47 | * @return float 48 | */ 49 | public function getFontSize(): float { 50 | return $this->fontSize; 51 | } 52 | 53 | /** 54 | * Returns the padding for the text, if $this->padding is null, it'll create a new Vector2 at position 0;0 55 | * 56 | * @api 57 | * 58 | * @return Vector2 59 | */ 60 | public function getPadding(): Vector2 { 61 | return $this->padding ?? new Vector2(0, 0); 62 | } 63 | 64 | /** 65 | * Returns the path to the font file 66 | * 67 | * @api 68 | * 69 | * @return string 70 | */ 71 | public function getFontPath(): string { 72 | return $this->fontPath; 73 | } 74 | 75 | /** 76 | * Returns the angle you wanted to have 77 | * 78 | * @api 79 | * 80 | * @return float 81 | */ 82 | public function getAngle(): float { 83 | return $this->angle; 84 | } 85 | 86 | public function getColor(): RGB { 87 | return $this->color ?? new RGB(0, 0, 0); 88 | } 89 | } -------------------------------------------------------------------------------- /utils/SquareConverter.php: -------------------------------------------------------------------------------- 1 | getX(), $padding->getY(), $size, $size, $size, $size); 38 | return $img; 39 | } 40 | 41 | /** 42 | * Converts the left side of an image 43 | * 44 | * @internal 45 | * 46 | * @param $image 47 | * 48 | * @return false|\GdImage|resource 49 | */ 50 | public static function converterToRight($image) { 51 | $size = self::getSize($image); 52 | $img = imagecreatetruecolor($size, $size); 53 | $padding = new Vector2((imagesx($image) - $size), 0); 54 | imagecopyresampled($img, $image, 0, 0, $padding->getX(), $padding->getY(), $size, $size, $size, $size); 55 | return $img; 56 | } 57 | /** 58 | * Converts the right side of an image 59 | * 60 | * @internal 61 | * 62 | * @param $image 63 | * 64 | * @return false|\GdImage|resource 65 | */ 66 | public static function converterToLeft($image) { 67 | $size = self::getSize($image); 68 | $img = imagecreatetruecolor($size, $size); 69 | $padding = new Vector2(0, 0); 70 | imagecopyresampled($img, $image, 0, 0, $padding->getX(), $padding->getY(), $size, $size, $size, $size); 71 | return $img; 72 | } 73 | 74 | /** 75 | * Returns the size needed for each side of the square, here we'll choose the min value of the sides 76 | * 77 | * @internal 78 | * 79 | * @param $image 80 | * 81 | * @return int 82 | */ 83 | private static function getSize($image): int { 84 | return min(imagesx($image), imagesy($image)); 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /image/color/components/RGB.php: -------------------------------------------------------------------------------- 1 | parseRGB($rgb); 29 | return; 30 | } 31 | $this->red = $red; 32 | } 33 | 34 | 35 | /** 36 | * Returns the red portion of the color 37 | * 38 | * @api 39 | * 40 | * @return int 41 | */ 42 | public function getRed(): int { 43 | return $this->red; 44 | } 45 | 46 | /** 47 | * Returns the green portion of the color 48 | * 49 | * @api 50 | * 51 | * @return int 52 | */ 53 | public function getGreen(): int { 54 | return $this->green; 55 | } 56 | 57 | /** 58 | * Returns the blue portion of the color 59 | * 60 | * @api 61 | * 62 | * @return int 63 | */ 64 | public function getBlue(): int { 65 | return $this->blue; 66 | } 67 | 68 | /** 69 | * Converts itself into an Array 70 | * 71 | * @api 72 | * 73 | * @return int[] 74 | */ 75 | public function toArray(): array { 76 | return [$this->getRed(), $this->getGreen(), $this->getBlue()]; 77 | } 78 | 79 | /** 80 | * Parses another RGB class to itself and assigns colors (also overwriting old colors!) 81 | * 82 | * @api 83 | * 84 | * @param RGB $rgb 85 | */ 86 | public function parseRGB(RGB $rgb) { 87 | $this->red = $rgb->red; 88 | $this->blue = $rgb->blue; 89 | $this->green = $rgb->green; 90 | } 91 | 92 | /** 93 | * Tries to create a RGB instance from a simple array 94 | * 95 | * @api 96 | * 97 | * @param array $array 98 | * 99 | * @return RGB|null 100 | */ 101 | public static function fromArray(array $array): ?RGB { 102 | $array = array_filter($array, function ($key) { 103 | return (is_numeric($key) and (intval($key) >= self::MIN_VAL) and (intval($key) <= self::MAX_VAL)); 104 | }); 105 | if (count($array) < 3) return null; 106 | return new RGB(array_shift($array), array_shift($array), array_shift($array)); 107 | } 108 | 109 | /** 110 | * Converts itself to an image int (mostly a hex value as int such as 0xFF0000) 111 | * 112 | * @api 113 | * 114 | * @param $image 115 | * 116 | * @return int 117 | */ 118 | public function toImageInt($image): int { 119 | return imagecolorallocate($image, $this->getRed(), $this->getGreen(), $this->getBlue()); 120 | } 121 | 122 | /** 123 | * Returns whether any data can be converted to RGB 124 | * 125 | * @api 126 | * 127 | * @param mixed $data 128 | * 129 | * @return bool 130 | */ 131 | public static function isValid($data): bool { 132 | return (is_array($data) and self::fromArray($data) instanceof RGB or $data instanceof RGB); 133 | } 134 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ImageLib 2 | Discord 3 | 4 | This PHP Library is designed to be as easy understandable as possible. 5 | A better README will follow soon, this is just a simple documentation of the functions you have! 6 | This project is mainly designed to interact with phpcord. 7 | 8 | ### Installation 9 | You can either download this repository directly from github (you have to create your own autoloader in that case) 10 | or by installing it with [Composer](https://getcomposer.org/). 11 | You simply would execute `composer require himmelkreis4865/imagelib` once you installed it on your device. 12 | _You can also download the phar and run it with php as well_ 13 | 14 | To enjoy composer's autoload you have to add 15 | ```php 16 | require_once __DIR__ . "/vendor/autoload.php"; 17 | ``` 18 | before accessing the first class. 19 | 20 | # Explanation 21 | - `Padding` is the distance between the top left corner and the object. It's telling object's position 22 | 23 | ## Documentation 24 | ### Creating images 25 | You can either create images by getting them from a file: 26 | 27 | ```php 28 | display();` to display your image or save it with `$image->save("your/path/to/file.png");` (you have to pass your own path and filename) 47 | 48 | ### Changing the background 49 | 50 | ```php 51 | use image\color\components\RGB; 52 | use image\color\Gradient; 53 | use image\color\SingleColor; 54 | use image\Image; 55 | 56 | $image = Image::make(300, 200); 57 | 58 | // fill the background either with a singlecolor (red in this case) or a gradient (red -> yellow in this case) 59 | $image->fill(new SingleColor(new RGB(255))); 60 | // creates a smooth animation between the 2 colors 61 | $image->fill(new Gradient(new RGB(255), new RGB(255, 255))); 62 | ``` 63 | 64 | ### Add Text to an image 65 | There are two ways to create a text, 66 | 67 | the simple but more ugly way: 68 | ```php 69 | fill(new SingleColor(new RGB(0, 0, 0))); 81 | 82 | // add a white default font 83 | $image->addBaseText(new BaseFont("A test string", 4, new Vector2(50, 15), new RGB(255, 255, 255))); 84 | 85 | $image->display(); 86 | ``` 87 | This will create an output like 88 | 89 | basefont_output.png 90 | 91 | The other option you have, is creating an extended font: 92 | 93 | ```php 94 | fill(new SingleColor(new RGB(0, 0, 0))); 106 | 107 | // add a white font of the family "arial" with fontsize 12(px) 108 | $image->addExtendedText(new ExtendedFont("A test string", "arial.ttf", 12, 0.0, new Vector2(50, 30), new RGB(255, 255, 255))); 109 | 110 | $image->display(); 111 | ``` 112 | This will create an output like 113 | 114 | basefont_output.png 115 | 116 | **Notice:** You can use the fonts `arial.ttf` and `arialbd.ttf` (bold arial) for now, more fonts are coming soon. 117 | 118 | ### Create Shapes 119 | Shapes are objects such as squares, circles,... that can be added to your image. 120 | 121 | Simple do: 122 | 123 | ```php 124 | // default usage: 125 | $image->drawShape(BaseShape); 126 | 127 | // sample: 128 | 129 | use image\color\components\RGB;use image\color\SingleColor;use image\shapes\Circle;use position\Vector2; 130 | 131 | // This will create a red circle with a padding of 50px in each direction and a size of 100 pixels 132 | $image->drawShape(new Circle(new Vector2(50, 50), new SingleColor(new RGB(255)), 100)); 133 | ``` 134 | 135 | Since nearly every shape has a different constructor, you should always take a look at the api before using it. 136 | Current shapes: `image\shapes\Circle`, `image\shapes\Ellipse`, `image\shapes\Line`, `image\shapes\Polygon`, `image\shapes\Rectangle` and `image\shapes\Square` 137 | 138 | ### Rotation and Flipping 139 | A `image\Image` can be rotated with 140 | ```php 141 | $image->rotate($degrees, $change); 142 | ``` 143 | `$degrees` is an Integer containing the angle (-360 up to 360) 144 | `$change` is an optional parameter, a boolean that tells the system modify the image directly (`true`) or just return the image (`false`), default is `true` 145 | 146 | If you want to flip an Image you can do this by: 147 | ```php 148 | use utils\FlipTypes; 149 | 150 | $image->flip(FlipTypes::TYPE_HORIZONTAL); 151 | ``` 152 | Available flip modes: `FlipTypes::TYPE_HORIZONTAL` (like a mirror), `FlipTypes::TYPE_VERTICAL` (like a 180° rotation) and `FlipTypes::TYPE_BOTH` applying both modes 153 | 154 | ### Square and resize images 155 | "square images" stand for images, that are having the same width as height which is pretty useful regarding resizing and other tools 156 | This can be done by 157 | 158 | There are three different square positions, 159 | `SquareConverter::TYPE_CENTER`, `SquareConverter::TYPE_LEFT`, `SquareConverter::TYPE_RIGHT` 160 | 161 | ```php 162 | fill(new Gradient(new RGB(255, 255), new RGB(0, 0, 255))); 174 | 175 | // now rotating the image because gradients are only applied from top to bottom (we need it vertical) 176 | $image->rotate(90); 177 | 178 | // now bringing the center: 179 | $image->toSquare(SquareConverter::TYPE_CENTER); 180 | 181 | $image->display(); 182 | ``` 183 | 184 | Sample output: 185 | 186 | gradient_square_after.png 187 | 188 | By the way, before squaring it, the image looked like that: 189 | gradient_square_before.png 190 | 191 | You can make some tests for squaring the left or right side with this code too, but we're not presenting it here. 192 | 193 | 194 | To resize an image, you can do the following: `$image->resizeTo($new_width, $new_height)` 195 | Sometimes it's a good Idea to square it before resizing. 196 | 197 | ### Put images into another Image 198 | 199 | #### Basic version: 200 | ```php 201 | fill(new SingleColor(new RGB(255))); 211 | 212 | // creating the target image: (here a sample one you won't find in the code) 213 | $target = Image::fromFile("test.png"); 214 | 215 | // squaring and resizing it to get the best result 216 | // default parameter is center so I leave it out 217 | $target->toSquare(); 218 | 219 | $target->resizeTo(400, 400); 220 | 221 | // now add the target image to the default one 222 | $image->addImage($target, new Vector2(50, 50)); 223 | 224 | $image->display(); 225 | ``` 226 | 227 | Output: 228 | 229 | add_image_basic.png 230 | 231 | #### Extended version: 232 | The difference seems unimportant, but is quite huge: 233 | ```php 234 | fill(new SingleColor(new RGB(255))); 244 | 245 | // creating the target image: (here a sample one you won't find in the code) 246 | $target = Image::fromFile("test.png"); 247 | 248 | // squaring and resizing it to get the best result 249 | // default parameter is center so I leave it out 250 | $target->toSquare(); 251 | 252 | $target->resizeTo(400, 400); 253 | 254 | // now add the target image to the default one 255 | $image->addImage($target, new Vector2(50, 50), true, 70); 256 | 257 | $image->display(); 258 | ``` 259 | 260 | Output: 261 | 262 | add_image_extended.png 263 | 264 | This is caused by the 2 additional parameters in `addImage()`: 265 | - `true` tells the api to make your image round 266 | - `70` is the opacity for this object (`100` is fully covered, `0` makes it invisible) 267 | 268 | ### More description is on the way... 269 | 270 | ## Autoloader 271 | Depending on your OS and folder structure, in a structure like 272 | ``` 273 | docs 274 | image 275 | position 276 | utils 277 | index.php <- Your Entry point 278 | ``` 279 | 280 | You can use this autoloader (**Before the first class usage**) 281 | 282 | ```php 283 | spl_autoload_register(function(string $class) { 284 | include str_replace("\u{005C}", DIRECTORY_SEPARATOR, $class) . ".php"; 285 | }); 286 | ``` 287 | This should be device independent too 288 | 289 | -------------------------------------------------------------------------------- /image/Image.php: -------------------------------------------------------------------------------- 1 | getY(); $i < ($size + $position->getY()); $i++) { 137 | imageline($this->image, $i, $i, ($size + $position->getX()), $i, $color->getColor($this->image, $i, $size)); 138 | } 139 | } 140 | 141 | /** 142 | * Fills an image with given color 143 | * 144 | * @api 145 | * 146 | * @param Color $color Can be a gradient 147 | */ 148 | public function fill(Color $color): void { 149 | if ($color->isSingleColored()) { 150 | imagefill($this->image, 0, 0, $color->getColor($this->image, 0, 0)); 151 | return; 152 | } 153 | for ($i = 0; $i < $this->height; $i++) { 154 | imageline($this->image, 0, $i, $this->height, $i, $color->getColor($this->image, $i, $this->height)); 155 | } 156 | } 157 | 158 | /** 159 | * Returns the rotated image or directly changes it in image if $change is true 160 | * 161 | * @api 162 | * 163 | * @param int $degrees 164 | * @param bool $change if true, the image will automatically change its rotation too 165 | * 166 | * @return false|GdImage|resource 167 | */ 168 | public function rotate(int $degrees, bool $change = true): false|GdImage { 169 | if ($degrees < 0 or $degrees > 360) throw new OutOfRangeException("You can only rotate between 0-360 degrees! $degrees is out of range!"); 170 | $image = imagerotate($this->image, floatval($degrees), 0); 171 | if ($change) $this->image = $image; 172 | return $image; 173 | } 174 | 175 | /** 176 | * Draws a shape on the image, mostly having a padding, color and some other properties 177 | * 178 | * @api 179 | * 180 | * @param BaseShape $baseShape 181 | */ 182 | public function drawShape(BaseShape $baseShape): void { 183 | $baseShape->draw($this->image); 184 | } 185 | 186 | /** 187 | * Displays the whole image as png in browser 188 | * 189 | * @api 190 | */ 191 | public function display(): void { 192 | header('Content-Type: image/png'); 193 | imagepng($this->image); 194 | imagedestroy($this->image); 195 | } 196 | 197 | /** 198 | * Stores the image to a file to keep it save 199 | * 200 | * @api 201 | * 202 | * @param string $path 203 | */ 204 | public function save(string $path): void { 205 | if (file_exists($path) or is_dir($path)) throw new InvalidArgumentException("Cannot overwrite an existing element for save progress!"); 206 | 207 | switch (Utils::getFileExtension($path)) { 208 | case "png": 209 | imagepng($this->image, $path); 210 | break; 211 | case "jpg": 212 | case "jpeg": 213 | imagejpeg($this->image, $path); 214 | break; 215 | } 216 | } 217 | 218 | /** 219 | * Sets a base text to the image, if you want to use custom texts, @see Image::addExtendedText() 220 | * 221 | * @api 222 | * 223 | * @param string|Font $text 224 | */ 225 | public function addBaseText(Font|string $text): void { 226 | if (is_string($text)) $text = new BaseFont($text); 227 | if (!$text instanceof Font) throw new InvalidArgumentException("You can either pass a Font instance or a string to add!"); 228 | imagestring($this->image, $text->getFontSize(), $text->getPadding()->getX(), $text->getPadding()->getY(), $text->getText(), $text->getColor()->toImageInt($this->image)); 229 | } 230 | 231 | /** 232 | * Adds a customizable Text to the image including custom fonts, angles, padding, color, size and much more 233 | * 234 | * @api 235 | * 236 | * @param ExtendedFont $font 237 | */ 238 | public function addExtendedText(ExtendedFont $font): void { 239 | imagettftext($this->image, $font->getFontSize(), $font->getAngle(), $font->getPadding()->getX(), $font->getPadding()->getY(), $font->getColor()->toImageInt($this->image), $font->getFontPath(), $font->getText()); 240 | } 241 | 242 | /** 243 | * This image adds another image to this image, will cover everything under it unless you decrease opacity 244 | * 245 | * @api 246 | * 247 | * @param Image $image 248 | * @param Vector2 $padding 249 | * @param bool $rounded if true, the image will be round like a circle, false will display the original image 250 | * For a great experience and nice looking pictures, use @see Image::toSquare() before 251 | * @param int $opacity 252 | */ 253 | public function addImage(Image $image, Vector2 $padding, bool $rounded = false, int $opacity = 100): void { 254 | $image = $image->image; 255 | $width = imagesx($image); 256 | $height = imagesy($image); 257 | 258 | if ($rounded) { 259 | $mask = imagecreatetruecolor($width, $height); 260 | $maskTransparent = imagecolorallocate($mask, 255, 0, 255); 261 | imagecolortransparent($mask, $maskTransparent); 262 | imagefilledellipse($mask, $width / 2, $height / 2, $width, $height, $maskTransparent); 263 | 264 | imagecopymerge($image, $mask, 0, 0, 0, 0, $width, $height, 100); 265 | 266 | $dstTransparent = imagecolorallocate($image, 255, 0, 255); 267 | imagefill($image, 0, 0, $dstTransparent); 268 | imagefill($image, $height - 1, 0, $dstTransparent); 269 | imagefill($image, 0, $height - 1, $dstTransparent); 270 | imagefill($image, $width - 1, $width - 1, $dstTransparent); 271 | imagecolortransparent($image, $dstTransparent); 272 | } 273 | 274 | imagecopymerge($this->image, $image, $padding->getX(), $padding->getY(), 0, 0, $width, $height, $opacity); 275 | } 276 | 277 | /** 278 | * Resizes an image to given width and height, may become ugly so try to use @link Image::toSquare() before 279 | * 280 | * @api 281 | * 282 | * @param int $width 283 | * @param int $height 284 | */ 285 | public function resizeTo(int $width, int $height): void { 286 | $new = imagecreatetruecolor($width, $height); 287 | imagecopyresampled($new, $this->image, 0, 0, 0, 0, $width, $height, imagesx($this->image), imagesy($this->image)); 288 | $this->image = $new; 289 | $this->width = $width; 290 | $this->height = $height; 291 | } 292 | 293 | /** 294 | * Converts an image to a squared image, either center, left or right aligned 295 | * 296 | * @api 297 | * 298 | * @param int $type 299 | */ 300 | public function toSquare(int $type = SquareConverter::TYPE_CENTER): void { 301 | switch ($type) { 302 | case SquareConverter::TYPE_CENTER: 303 | $this->image = SquareConverter::converterToCenter($this->image); 304 | break; 305 | case SquareConverter::TYPE_LEFT: 306 | $this->image = SquareConverter::converterToLeft($this->image); 307 | break; 308 | case SquareConverter::TYPE_RIGHT: 309 | $this->image = SquareConverter::converterToRight($this->image); 310 | break; 311 | } 312 | } 313 | 314 | /** 315 | * Flips an image in a given mode 316 | * 317 | * @api 318 | * 319 | * @param int $flipMode for valid modes, 320 | * checkout @see FlipTypes 321 | */ 322 | public function flip(int $flipMode): void { 323 | if (in_array($flipMode, [FlipTypes::TYPE_HORIZONTAL, FlipTypes::TYPE_VERTICAL, FlipTypes::TYPE_BOTH])) 324 | imageflip($this->image, $flipMode); 325 | } 326 | 327 | public function getRawData(): string { 328 | ob_start(); 329 | imagejpeg($this->image); 330 | $content = ob_get_contents(); 331 | ob_end_clean(); 332 | return $content; 333 | } 334 | 335 | public function getDataUrl(): string { 336 | return "data:image/jpeg;base64," . base64_encode($this->getRawData()); 337 | } 338 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------