├── icon.png ├── images ├── box.png ├── up.png ├── down.png ├── left.png ├── right.png ├── split_h.png └── split_v.png ├── __init__.py ├── README.md ├── metadata.txt ├── CHANGELOG.md ├── mapItem.py ├── .gitignore ├── swipe.py ├── mapTool.py └── LICENSE /icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/luolingchun/MapSwipeTool/HEAD/icon.png -------------------------------------------------------------------------------- /images/box.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/luolingchun/MapSwipeTool/HEAD/images/box.png -------------------------------------------------------------------------------- /images/up.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/luolingchun/MapSwipeTool/HEAD/images/up.png -------------------------------------------------------------------------------- /images/down.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/luolingchun/MapSwipeTool/HEAD/images/down.png -------------------------------------------------------------------------------- /images/left.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/luolingchun/MapSwipeTool/HEAD/images/left.png -------------------------------------------------------------------------------- /images/right.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/luolingchun/MapSwipeTool/HEAD/images/right.png -------------------------------------------------------------------------------- /images/split_h.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/luolingchun/MapSwipeTool/HEAD/images/split_h.png -------------------------------------------------------------------------------- /images/split_v.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/luolingchun/MapSwipeTool/HEAD/images/split_v.png -------------------------------------------------------------------------------- /__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # @Author : llc 3 | # @Time : 2020/3/10 14:54 4 | 5 | 6 | def classFactory(iface): 7 | from .swipe import Swipe 8 | return Swipe(iface) 9 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MapSwipeTool 2 | 3 | QGIS插件——地图卷帘工具，参考已有的[地图卷帘工具](https://github.com/lmotta/mapswipetool_plugin)，做了一些优化： 4 | 5 | - 图层组支持 6 | - 图层选择 7 | - 操作优化 8 | - 图层隐藏 9 | 10 | ## 安装说明 11 | 12 | [下载zip包](https://github.com/luolingchun/MapSwipeTool/archive/refs/heads/master.zip)，使用QGIS中Install from ZIP安装 13 | 14 | ## 使用说明 15 | 16 | - 点击鼠标左键并拖动：开始卷帘 17 | - 按下`Ctrl`键同时点击鼠标左键：隐藏上方图层 18 | -------------------------------------------------------------------------------- /metadata.txt: -------------------------------------------------------------------------------- 1 | [general] 2 | name=MapSwipeTool 3 | description=Swipe active layer 4 | 5 | version=1.2.3 6 | tags=swipe,layers 7 | qgisMinimumVersion=3.0 8 | author=llc 9 | email=luolingchun@outlook.com 10 | homepage=https://github.com/luolingchun/MapSwipeTool 11 | tracker=https://github.com/luolingchun/MapSwipeTool/issues 12 | repository=https://github.com/luolingchun/MapSwipeTool 13 | 14 | icon=icon.png 15 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## v1.2.3 2025-04-12 2 | 3 | - 适应高分辨率缩放 4 | 5 | ## v1.2.2 2024-05-12 6 | 7 | - 修复半个像素错误 8 | 9 | ## v1.2.1 2023-02-21 10 | 11 | - 优化地图渲染过程中鼠标样式和逻辑 12 | 13 | ## v1.2.0 2022-02-24 14 | 15 | - 按下`Ctrl`键同时点击鼠标左键：隐藏上方图层 16 | 17 | ## v1.1.2 2021-06-12 18 | 19 | - 当图层数少于两个时提示信息 20 | 21 | ## v1.1.1 2021-03-20 22 | 23 | - 工具栏添加tooltip 24 | - 优化一些代码 25 | 26 | ## v1.1.0 2020-11-29 27 | 28 | - BUG：卷帘时只渲染已勾选的图层 29 | - 优化：鼠标光标大小自适应 30 | - 优化：使用单独的工具栏 31 | 32 | ## v1.0.0 2020-03-10 33 | 34 | - 第一个版本 35 | -------------------------------------------------------------------------------- /mapItem.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # @Author : llc 3 | # @Time : 2020/3/10 14:59 4 | 5 | from qgis.PyQt.QtCore import QRectF, Qt, QLineF 6 | from qgis.PyQt.QtGui import QPen, QColor 7 | from qgis.gui import QgsMapCanvasItem 8 | 9 | 10 | class SwipeMapItem(QgsMapCanvasItem): 11 | def __init__(self, mapCanvas): 12 | super(SwipeMapItem, self).__init__(mapCanvas) 13 | self.image = None 14 | self.line = None 15 | self.startPaint = False 16 | 17 | self.direction = -1 18 | self.x = 0 19 | self.y = 0 20 | self.w = 0 21 | self.h = 0 22 | 23 | def updateImageRect(self, x, y): 24 | w = self.boundingRect().width() 25 | h = self.boundingRect().height() 26 | if self.direction == -1: # all 27 | self.x = 0 28 | self.y = 0 29 | self.w = w 30 | self.h = h 31 | elif self.direction == 0: # 0:'⬇' 32 | self.x = 0 33 | self.y = 0 34 | self.w = w 35 | self.h = y 36 | self.line = QLineF(0, y, w, y) 37 | elif self.direction == 1: # 1:'⬆' 38 | self.x = 0 39 | self.y = y 40 | self.w = w 41 | self.h = h - y 42 | self.line = QLineF(0, y, w, y) 43 | elif self.direction == 2: # 2:'➡' 44 | self.x = 0 45 | self.y = 0 46 | self.w = x 47 | self.h = h 48 | self.line = QLineF(x, 0, x, h) 49 | else: # 3:'⬅' 50 | self.x = x 51 | self.y = 0 52 | self.w = w - x 53 | self.h = h 54 | self.line = QLineF(x, 0, x, h) 55 | self.startPaint = True 56 | self.update() 57 | 58 | def paint(self, painter, *args): 59 | if self.startPaint is False: 60 | return 61 | 62 | pen = QPen(Qt.DashDotDotLine) 63 | pen.setColor(QColor(18, 150, 219)) 64 | pen.setWidth(4) 65 | painter.setPen(pen) 66 | if self.line: 67 | painter.drawLine(self.line) 68 | 69 | image = self.image.copy(int(self.x), int(self.y), int(self.w), int(self.h)) 70 | painter.drawImage(QRectF(self.x, self.y, self.w, self.h), image) 71 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | .idea -------------------------------------------------------------------------------- /swipe.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # @Author : llc 3 | # @Time : 2020/3/10 14:58 4 | 5 | import os 6 | 7 | from qgis.PyQt.QtCore import Qt 8 | from qgis.PyQt.QtGui import QIcon 9 | from qgis.PyQt.QtWidgets import QComboBox, QAction, QToolBar 10 | from qgis.core import QgsProject 11 | from qgis.gui import QgisInterface 12 | 13 | from .mapTool import SwipeMapTool 14 | 15 | here = os.path.dirname(__file__) 16 | project = QgsProject.instance() 17 | 18 | 19 | class Swipe: 20 | 21 | def __init__(self, iface): 22 | self.iface: QgisInterface = iface 23 | self.mapCanvas = self.iface.mapCanvas() 24 | self.preMapTool = None 25 | 26 | self.toolBar: QToolBar = self.iface.addToolBar('Swipe Toolbar') 27 | self.toolBar.setToolTip("Swipe Toolbar") 28 | self.swipeAction = QAction(QIcon(os.path.join(here, 'icon.png')), 'Swipe Tool', self.toolBar) 29 | self.swipeAction.setCheckable(True) 30 | self.swipeAction.triggered.connect(self.swipeActionTriggered) 31 | self.layerCombobox = QComboBox() 32 | self.layerCombobox.setSizeAdjustPolicy(QComboBox.AdjustToContents) 33 | self.layerCombobox.setFixedHeight(self.iface.iconSize().height()) 34 | 35 | self.swipeTool = SwipeMapTool(self.layerCombobox, self.mapCanvas) 36 | 37 | # 图层变化信号 38 | project.layerTreeRoot().layerOrderChanged.connect(self.updateCombobox) 39 | project.layerTreeRoot().visibilityChanged.connect(self.updateCombobox) 40 | project.layerTreeRoot().nameChanged.connect(self.updateCombobox) 41 | # 地图工具变化 42 | self.mapCanvas.mapToolSet.connect(self.mapCanvasMapToolSet) 43 | # 初始化图层 44 | self.updateCombobox() 45 | 46 | def initGui(self): 47 | self.toolBar.addAction(self.swipeAction) 48 | self.toolBar.addWidget(self.layerCombobox) 49 | 50 | def unload(self): 51 | project.layerTreeRoot().layerOrderChanged.disconnect(self.updateCombobox) 52 | project.layerTreeRoot().visibilityChanged.disconnect(self.updateCombobox) 53 | project.layerTreeRoot().nameChanged.disconnect(self.updateCombobox) 54 | self.mapCanvas.mapToolSet.disconnect(self.mapCanvasMapToolSet) 55 | self.mapCanvas.unsetMapTool(self.swipeTool) 56 | 57 | del self.toolBar 58 | 59 | def swipeActionTriggered(self): 60 | if self.layerCombobox.count() < 2: 61 | self.swipeAction.setChecked(False) 62 | self.iface.messageBar().pushMessage("At least two layers are required.") 63 | return 64 | self.swipeAction.setChecked(True) 65 | if self.mapCanvas.mapTool() != self.swipeTool: 66 | self.mapCanvas.setMapTool(self.swipeTool) 67 | 68 | def updateCombobox(self): 69 | self.layerCombobox.clear() 70 | layers = project.layerTreeRoot().checkedLayers() 71 | for layer in layers: 72 | self.layerCombobox.addItem(layer.name(), layer.id()) 73 | if self.layerCombobox.count() < 2: 74 | self.swipeAction.setChecked(False) 75 | self.mapCanvas.unsetMapTool(self.swipeTool) 76 | 77 | def mapCanvasMapToolSet(self, newTool, _): 78 | if newTool.__class__.__name__ != 'SwipeMapTool': 79 | self.swipeAction.setChecked(False) 80 | if self.preMapTool == "SwipeMapTool": 81 | self.mapCanvas.renderStarting.disconnect(self.renderStarting) 82 | self.mapCanvas.renderComplete.disconnect(self.renderComplete) 83 | self.preMapTool = None 84 | else: 85 | self.preMapTool = "SwipeMapTool" 86 | self.mapCanvas.renderStarting.connect(self.renderStarting) 87 | self.mapCanvas.renderComplete.connect(self.renderComplete) 88 | 89 | def renderStarting(self): 90 | self.mapCanvas.setCursor(Qt.BusyCursor) 91 | 92 | def renderComplete(self): 93 | cursor = self.mapCanvas.cursor() 94 | pos = cursor.pos() 95 | # 触发鼠标移动事件 96 | cursor.setPos(pos.x() + 1, pos.y() + 1) 97 | -------------------------------------------------------------------------------- /mapTool.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # @Author : llc 3 | # @Time : 2020/3/10 14:58 4 | 5 | import os 6 | 7 | from qgis.PyQt.QtCore import Qt 8 | from qgis.PyQt.QtGui import QCursor, QPixmap 9 | from qgis.core import QgsProject, QgsMapSettings, QgsMapRendererParallelJob 10 | from qgis.gui import QgsMapTool 11 | 12 | from .mapItem import SwipeMapItem 13 | 14 | here = os.path.dirname(__file__) 15 | project = QgsProject.instance() 16 | 17 | 18 | class SwipeMapTool(QgsMapTool): 19 | def __init__(self, layerCombobox, mapCanvas): 20 | super(SwipeMapTool, self).__init__(mapCanvas) 21 | self.layerCombobox = layerCombobox 22 | self.mapCanvas = mapCanvas 23 | self.mapItem = SwipeMapItem(self.mapCanvas) 24 | self.startSwipe = False 25 | self.controlDown = False 26 | self.layers = [] 27 | 28 | self.cursorSV = QCursor(QPixmap(os.path.join(here, 'images/split_v.png'))) 29 | self.cursorSH = QCursor(QPixmap(os.path.join(here, 'images/split_h.png'))) 30 | self.cursorUp = QCursor(QPixmap(os.path.join(here, 'images/up.png'))) 31 | self.cursorDown = QCursor(QPixmap(os.path.join(here, 'images/down.png'))) 32 | self.cursorLeft = QCursor(QPixmap(os.path.join(here, 'images/left.png'))) 33 | self.cursorRight = QCursor(QPixmap(os.path.join(here, 'images/right.png'))) 34 | self.cursorBox = QCursor(QPixmap(os.path.join(here, 'images/box.png'))) 35 | 36 | def activate(self): 37 | self.connect() 38 | self.startSwipe = False 39 | self.setLayersSwipe() 40 | 41 | def connect(self, is_connect=True): 42 | if is_connect: 43 | self.mapCanvas.mapCanvasRefreshed.connect(self.setMapLayers) 44 | self.layerCombobox.currentIndexChanged.connect(self.setLayersSwipe) 45 | else: 46 | self.mapCanvas.mapCanvasRefreshed.disconnect(self.setMapLayers) 47 | self.layerCombobox.currentIndexChanged.disconnect(self.setLayersSwipe) 48 | 49 | def setLayersSwipe(self, ): 50 | self.layers = project.layerTreeRoot().checkedLayers() 51 | currentLayer = project.mapLayer(self.layerCombobox.currentData()) 52 | if currentLayer in self.layers: 53 | self.layers.remove(currentLayer) 54 | self.setMapLayers() 55 | 56 | def setMapLayers(self): 57 | def finished(): 58 | self.mapItem.image = job.renderedImage() 59 | self.mapItem.setRect(self.mapCanvas.extent()) 60 | 61 | if len(self.layers) == 0: 62 | return 63 | 64 | settings = QgsMapSettings(self.mapCanvas.mapSettings()) 65 | settings.setLayers(self.layers) 66 | 67 | # 适应高分辨率缩放 68 | settings.setDevicePixelRatio(1) 69 | 70 | job = QgsMapRendererParallelJob(settings) 71 | job.start() 72 | job.finished.connect(finished) 73 | job.waitForFinished() 74 | 75 | def keyPressEvent(self, e): 76 | if self.mapCanvas.isDrawing(): 77 | return 78 | if e.modifiers() == Qt.ControlModifier: 79 | self.mapCanvas.setCursor(self.cursorBox) 80 | self.controlDown = True 81 | 82 | def keyReleaseEvent(self, e) -> None: 83 | if self.mapCanvas.isDrawing(): 84 | return 85 | if not e.isAutoRepeat(): 86 | self.controlDown = False 87 | pos = self.cursorBox.pos() 88 | # 触发鼠标移动事件 89 | self.cursorBox.setPos(pos.x() + 1, pos.y() + 1) 90 | 91 | def canvasPressEvent(self, e): 92 | if self.mapCanvas.isDrawing(): 93 | return 94 | self.startSwipe = True 95 | w, h = self.mapCanvas.width(), self.mapCanvas.height() 96 | if not self.controlDown: 97 | if 0.25 * w < e.x() < 0.75 * w and e.y() < 0.5 * h: 98 | self.mapItem.direction = 0 # '⬇' 99 | self.mapCanvas.setCursor(self.cursorSH) 100 | elif 0.25 * w < e.x() < 0.75 * w and e.y() > 0.5 * h: 101 | self.mapItem.direction = 1 # '⬆' 102 | self.mapCanvas.setCursor(self.cursorSH) 103 | elif e.x() < 0.25 * w: 104 | self.mapItem.direction = 2 # '➡' 105 | self.mapCanvas.setCursor(self.cursorSV) 106 | else: # elif e.x() > 0.75 * w: 107 | self.mapItem.direction = 3 # '⬅' 108 | self.mapCanvas.setCursor(self.cursorSV) 109 | self.mapItem.updateImageRect(e.x(), e.y()) 110 | else: 111 | self.mapItem.direction = -1 # all 112 | self.mapItem.updateImageRect(w, h) 113 | 114 | def canvasMoveEvent(self, e): 115 | if self.mapCanvas.isDrawing(): 116 | return 117 | if self.controlDown: 118 | return 119 | if self.startSwipe: 120 | self.mapItem.updateImageRect(e.x(), e.y()) 121 | else: 122 | # 设置当前cursor 123 | w, h = self.mapCanvas.width(), self.mapCanvas.height() 124 | if e.x() < 0.25 * w: 125 | self.mapCanvas.setCursor(self.cursorRight) 126 | if e.x() > 0.75 * w: 127 | self.mapCanvas.setCursor(self.cursorLeft) 128 | if 0.25 * w < e.x() < 0.75 * w and e.y() < 0.5 * h: 129 | self.mapCanvas.setCursor(self.cursorDown) 130 | if 0.25 * w < e.x() < 0.75 * w and e.y() > 0.5 * h: 131 | self.mapCanvas.setCursor(self.cursorUp) 132 | 133 | def canvasReleaseEvent(self, e): 134 | self.startSwipe = False 135 | self.canvasMoveEvent(e) 136 | # 鼠标释放后重新绘制 137 | self.mapItem.startPaint = False 138 | self.mapItem.update() 139 | 140 | def deactivate(self): 141 | self.connect(False) 142 | self.deactivated.emit() 143 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------