├── python └── met_blender_viewport_utils │ ├── __init__.py │ └── impl │ ├── __init__.py │ ├── state.py │ ├── viewport.py │ ├── shaders.py │ ├── shader.py │ └── font.py ├── examples ├── live_motion_path.py └── mask_with_text.py ├── README.md ├── package.py ├── .gitignore └── LICENSE /python/met_blender_viewport_utils/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /python/met_blender_viewport_utils/impl/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /examples/live_motion_path.py: -------------------------------------------------------------------------------- 1 | # temporarily removed, will re-instate once this is updated to the refactored api -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # met_blender_viewport_utils 2 | Blender specific implementation of met_viewport_utils 3 | 4 | This is an implementation of https://github.com/minimalefforttech/met_viewport_utils, separated to allow the base to be used in non GPL applications. -------------------------------------------------------------------------------- /package.py: -------------------------------------------------------------------------------- 1 | # rez package configuration 2 | name = "met_blender_viewport_utils" 3 | version = "0.0.1" 4 | authors = ["alex.telford"] 5 | description = "minimaleffort.tech Blender specific viewport utilities" 6 | requires = [ 7 | "python-3.9+<3.12", 8 | "blender-3.6+<4.1", 9 | "numpy-1.23+<2", 10 | "met_viewport_utils-0.1.1<0.2.0", 11 | ] 12 | build_requires = [ 13 | "python-3.9+<3.12", 14 | ] 15 | tools = [] 16 | variants = [] 17 | build_command = "python {root}/build.py {install}" 18 | 19 | tests = {} # TODO 20 | 21 | def commands(): 22 | env.MET_BLENDER_VIEWPORT_UTILS_ROOT = "{this.root}" 23 | env.MET_BLENDER_VIEWPORT_UTILS_VERSION = "{version}" 24 | env.PYTHONPATH.append("{this.root}/python") 25 | -------------------------------------------------------------------------------- /python/met_blender_viewport_utils/impl/state.py: -------------------------------------------------------------------------------- 1 | # copyright (c) 2024 Alex Telford, http://minimaleffort.tech 2 | class _ext: 3 | """ External Dependencies """ 4 | from met_viewport_utils.constants import GPUShaderState 5 | from met_viewport_utils.interfaces import IGPURestoreState 6 | import gpu 7 | 8 | 9 | class GPURestoreState(_ext.IGPURestoreState): 10 | """Context manager to temporarily set and restore state while drawing 11 | 12 | Args: 13 | flags (GpuShaderState): State flags to set 14 | 15 | Usage: 16 | with GpuRestoreState(GpuShaderState.Alpha|GpuShaderState.Depth): 17 | batch.draw() 18 | """ 19 | def _get_state(cls, state:_ext.GPUShaderState): 20 | if state == _ext.GPUShaderState.UseAlpha: 21 | return _ext.gpu.state.blend_get() 22 | elif state == _ext.GPUShaderState.UseDepth: 23 | return (_ext.gpu.state.depth_test_get(), _ext.gpu.state.depth_mask_get()) 24 | 25 | def _set_state(cls, state:_ext.GPUShaderState, param): 26 | if state == _ext.GPUShaderState.UseAlpha: 27 | _ext.gpu.state.blend_set(param) 28 | elif state == _ext.GPUShaderState.UseDepth: 29 | depth_test, depth_mask = param 30 | _ext.gpu.state.depth_test_set(depth_test) 31 | _ext.gpu.state.depth_mask_set(depth_mask) 32 | -------------------------------------------------------------------------------- /python/met_blender_viewport_utils/impl/viewport.py: -------------------------------------------------------------------------------- 1 | # copyright (c) 2024 Alex Telford, http://minimaleffort.tech 2 | class _ext: 3 | """ External Dependencies """ 4 | import typing 5 | import bpy 6 | from bpy_extras import view3d_utils 7 | import gpu 8 | from met_viewport_utils.interfaces import IViewport 9 | from met_viewport_utils.shape.rect import Rect 10 | from met_viewport_utils.algorithm import types 11 | from mathutils import Vector 12 | 13 | class BlenderViewport(_ext.IViewport): 14 | def __init__(self, context:_ext.bpy.types.Context): 15 | self._context = context 16 | 17 | def rect(self)->_ext.Rect: 18 | """Viewport rect, note that this may sometimes be the window rect depending on what context is passed 19 | If things are not snapping correctly, confirm this is the correct rect 20 | 21 | Returns: 22 | Rect 23 | """ 24 | x, y, width, height = _ext.gpu.state.viewport_get() 25 | return _ext.Rect([x, y], [width, height]) 26 | 27 | def screen_to_world(self, screen_position:_ext.types.Vector2fCompat, depth_point:_ext.types.Vector3f)->_ext.types.Vector3f: 28 | """From a position in the screen, return a tuple representing the ray origin and direction 29 | 30 | Args: 31 | screen_position (Vector2f): screen position 32 | depth_point(Vector3f): position in space to match 33 | 34 | Returns: 35 | Vector3f position 36 | """ 37 | screen_position = _ext.types.as_vector2f(screen_position) 38 | depth_point = _ext.types.as_vector3f(depth_point) 39 | region = self._context.region 40 | region3D = self._context.space_data.region_3d 41 | view_location = _ext.view3d_utils.region_2d_to_location_3d( 42 | region, region3D, _ext.screen_position(screen_position), _ext.Vector(depth_point)) 43 | return _ext.types.as_vector3f(view_location) 44 | 45 | def screen_to_ray(self, screen_position:_ext.types.Vector2fCompat)->_ext.typing.Tuple[_ext.types.Vector3f]: 46 | """From a position in the screen, return a tuple representing the ray origin and direction 47 | 48 | Args: 49 | screen_position (Vector2f): screen position 50 | 51 | Returns: 52 | Vector3f origin, ray_dir 53 | """ 54 | screen_position = _ext.types.as_vector2f(screen_position) 55 | region = self._context.region 56 | region3D = self._context.space_data.region_3d 57 | origin = _ext.view3d_utils.region_2d_to_origin_3d(region, region3D, _ext.Vector(screen_position)) 58 | ray = _ext.view3d_utils.region_2d_to_vector_3d(region, region3D, _ext.Vector(screen_position)) 59 | return (origin, ray) 60 | 61 | def world_to_screen(self, world_position:_ext.types.Vector3fCompat)->_ext.types.Vector2f: 62 | """From a position in the screen, return a tuple representing the ray origin and direction 63 | 64 | Args: 65 | world_position (Vector2f): screen position 66 | 67 | Returns: 68 | Vector2d screen_position 69 | """ 70 | world_position = _ext.types.as_vector3f(world_position) 71 | region = self._context.region 72 | region3D = self._context.space_data.region_3d 73 | point = _ext.Vector(world_position) 74 | view_location = _ext.view3d_utils.location_3d_to_region_2d(region, region3D, point) 75 | return _ext.types.as_vector2f(view_location) 76 | -------------------------------------------------------------------------------- /python/met_blender_viewport_utils/impl/shaders.py: -------------------------------------------------------------------------------- 1 | # copyright (c) 2024 Alex Telford, http://minimaleffort.tech 2 | """Built in shaders 3 | """ 4 | class _ext: 5 | """ External Dependencies """ 6 | from .shader import GPUShader 7 | from met_viewport_utils.constants import ( 8 | GPUShaderUniformType, 9 | GPUShaderPrimitiveType 10 | ) 11 | import gpu 12 | 13 | class FlatColorShader(_ext.GPUShader): 14 | """ 15 | Take a 3D position and color for each vertex without color interpolation. 16 | 17 | Args: 18 | polyline(bool): If true use the polyline shader 19 | 20 | ShaderParams: 21 | color: in vec4 22 | pos: in vec3 23 | """ 24 | def __init__(self, polyline:bool=False): 25 | if polyline: 26 | shader = _ext.gpu.shader.from_builtin('POLYLINE_FLAT_COLOR') 27 | else: 28 | shader = _ext.gpu.shader.from_builtin('FLAT_COLOR') 29 | super().__init__(shader) 30 | 31 | 32 | class VertexColorShader(_ext.GPUShader): 33 | """ 34 | Take a 3D position and color for each vertex with perspective correct interpolation. 35 | 36 | Args: 37 | polyline(bool): If true use the polyline shader 38 | 39 | ShaderParams: 40 | color: in vec4 41 | pos: in vec3 42 | """ 43 | def __init__(self, polyline:bool=False): 44 | if polyline: 45 | shader = _ext.gpu.shader.from_builtin('POLYLINE_SMOOTH_COLOR') 46 | else: 47 | shader = _ext.gpu.shader.from_builtin('SMOOTH_COLOR') 48 | super().__init__(shader) 49 | 50 | 51 | class UniformColorShader(_ext.GPUShader): 52 | """ 53 | Take a single color for all the vertices and a 3D position for each vertex. 54 | 55 | Args: 56 | polyline(bool): If true use the polyline shader 57 | 58 | ShaderParams: 59 | color: uniform vec4 60 | pos: in vec3 61 | """ 62 | def __init__(self, polyline:bool=False): 63 | if polyline: 64 | shader = _ext.gpu.shader.from_builtin('POLYLINE_UNIFORM_COLOR') 65 | else: 66 | shader = _ext.gpu.shader.from_builtin('UNIFORM_COLOR') 67 | super().__init__(shader) 68 | self._uniform_types["color"] = _ext.GPUShaderUniformType.Float 69 | 70 | 71 | class ImageShader(_ext.GPUShader): 72 | """ 73 | Draw a texture in 3D. Take a 3D position and a 2D texture coordinate for each vertex. 74 | 75 | ShaderParams: 76 | image: uniform sampler2D 77 | texCoord: in vec2 78 | pos: in vec3 79 | """ 80 | primitive_type = _ext.GPUShaderPrimitiveType.Tris 81 | def __init__(self): 82 | shader = _ext.gpu.shader.from_builtin('IMAGE') 83 | super().__init__(shader) 84 | self._uniform_types["sampler2D"] = _ext.GPUShaderUniformType.Sampler 85 | 86 | 87 | class ImageUniformColorShader(_ext.GPUShader): 88 | """ 89 | Take a 3D position and color for each vertex with linear interpolation in window space. 90 | 91 | ShaderParams: 92 | color: uniform vec4 93 | image: uniform sampler2D 94 | texCoord: in vec2 95 | pos: in vec3 96 | """ 97 | primitive_type = _ext.GPUShaderPrimitiveType.Tris 98 | def __init__(self): 99 | shader = _ext.gpu.shader.from_builtin('IMAGE_COLOR') 100 | super().__init__(shader) 101 | self._uniform_types["color"] = _ext.GPUShaderUniformType.Float 102 | self._uniform_types["sampler2D"] = _ext.GPUShaderUniformType.Sampler 103 | -------------------------------------------------------------------------------- /.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 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 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 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | -------------------------------------------------------------------------------- /python/met_blender_viewport_utils/impl/shader.py: -------------------------------------------------------------------------------- 1 | # copyright (c) 2024 Alex Telford, http://minimaleffort.tech 2 | class _ext: 3 | """ External Dependencies """ 4 | import gpu 5 | import bpy 6 | import typing 7 | import numpy as np 8 | from gpu_extras.batch import batch_for_shader 9 | from met_viewport_utils.constants import ( 10 | GPUShaderPrimitiveType, 11 | GPUShaderUniformType, 12 | GPUShaderState) 13 | from .state import GPURestoreState 14 | from met_viewport_utils.interfaces import IGPUShader 15 | 16 | 17 | class GPUShader(_ext.IGPUShader): 18 | """ Simple wrapper around a blender GPU shader draw 19 | 20 | Args: 21 | shader(GPUShader): Shader to draw 22 | 23 | Properties: 24 | shader(GPUShader): Internal shader 25 | primitive(GPUShaderPrimitiveType): primitive drawing type 26 | state(GPUShaderState): Optional state to set while drawing this shader 27 | size(float): Width of points or lines 28 | """ 29 | # Set the typing on the root 30 | shader:_ext.gpu.types.GPUShader = None # Internal shader pointer 31 | 32 | def __init__(self, shader:_ext.gpu.types.GPUShader): 33 | super().__init__(shader) 34 | self._last_batch = None 35 | 36 | 37 | def _batch(self, 38 | vertex_in:_ext.typing.Dict[str, _ext.typing.Any], 39 | primitive_type:_ext.GPUShaderPrimitiveType, 40 | indices:_ext.typing.Optional[_ext.typing.List[int]]=None)->_ext.gpu.types.GPUBatch: 41 | """Batch the shader for processing 42 | 43 | Args: 44 | vertex_in (Dict[str, Any]): vertex shader inputs 45 | primitive_type (GPUShaderPrimitiveType): primitive type to draw 46 | indices (List[int], optional): Optional indices to pass for mapping inputs 47 | 48 | Returns: 49 | gpu.types.GPUBatch 50 | """ 51 | 52 | if not self._last_batch: 53 | batch = _ext.batch_for_shader(self.shader, primitive_type.value, vertex_in, indices=indices) 54 | self._last_batch = [batch, primitive_type, vertex_in, indices] 55 | return batch 56 | 57 | last_batch, last_primitive, last_vertex_in, last_indices = self._last_batch 58 | try: 59 | # There may be numpy arrays, this is a lazy equality operator 60 | _ext.np.testing.assert_equal(vertex_in, last_vertex_in) 61 | _ext.np.testing.assert_equal(indices, last_indices) 62 | except AssertionError: 63 | pass 64 | else: 65 | if primitive_type == last_primitive: 66 | return last_batch 67 | 68 | batch = _ext.batch_for_shader(self.shader, primitive_type.value, vertex_in, indices=indices) 69 | self._last_batch = [batch, primitive_type, vertex_in, indices] 70 | return batch 71 | 72 | def _set_uniform_by_type(self, name:str, value): 73 | if isinstance(value, _ext.gpu.types.GPUTexture): 74 | self._uniform_types[name] = _ext.GPUShaderUniformType.Sampler 75 | self.shader.uniform_sampler(name, value) 76 | else: 77 | super()._set_uniform_by_type(name, value) 78 | 79 | def draw(self, 80 | vertex_in:_ext.typing.Dict[str, _ext.typing.Any], 81 | primitive_type:_ext.GPUShaderPrimitiveType=None, 82 | indices:_ext.typing.Optional[_ext.typing.List[int]]=None, 83 | size:_ext.typing.Optional[float]=None, 84 | state:_ext.typing.Optional[_ext.GPUShaderState]=None, 85 | **kwargs): 86 | """Draw this shader 87 | 88 | Args: 89 | vertex_in (Dict[str, Any]): Inputs to vertex shader 90 | primitive_type (GPUShaderPrimitiveType, optional): Primitive override 91 | indices (List[int], optional): indices map, optional 92 | size (float, optional): size override 93 | state (GPUShaderState, optional): state override 94 | """ 95 | if state is None: 96 | state = self.state 97 | if size is None: 98 | size = self.size 99 | if size: 100 | _ext.gpu.state.line_width_set(size) 101 | _ext.gpu.state.point_size_set(size) 102 | primitive_type = primitive_type or self.primitive_type 103 | batch = self._batch(vertex_in, primitive_type, indices) 104 | self._prep_shader() 105 | for key, value in kwargs.items(): 106 | self.set_uniform(key, value) 107 | with _ext.GPURestoreState(state): 108 | batch.draw(self.shader) -------------------------------------------------------------------------------- /python/met_blender_viewport_utils/impl/font.py: -------------------------------------------------------------------------------- 1 | # copyright (c) 2024 Alex Telford, http://minimaleffort.tech 2 | from __future__ import annotations 3 | class _ext: 4 | """ External Dependencies """ 5 | import logging 6 | import blf 7 | from met_viewport_utils.constants import Align 8 | from met_viewport_utils.algorithm.color import parse_color 9 | from met_viewport_utils.shape.rect import Rect 10 | from met_viewport_utils.algorithm import types 11 | from met_viewport_utils.interfaces import IGPUFont 12 | 13 | LOGGER = _ext.logging.getLogger("met_blender_viewport_utils.impl.font") 14 | 15 | class GPUFont(_ext.IGPUFont): 16 | """ Convenience class for drawing text to screen 17 | 18 | Args: 19 | base(GPUFont): Optional base to start from 20 | 21 | Properties: 22 | id(int): readonly, the active font id 23 | path(Path): Path to font file 24 | 25 | family(str) 26 | weight(FontWeight) 27 | style(FontStyle) 28 | align(Align) 29 | path(Path) 30 | 31 | color(Vector) 32 | shadow_color(Vector) 33 | shadow_offset(Vector) 34 | shadow_blur(int) 35 | point_size(int) 36 | angle(float) 37 | """ 38 | id:int = 0 39 | 40 | def copy(self)->GPUFont: 41 | copy = super().copy() 42 | copy.id = self.id 43 | return copy 44 | 45 | def _load_path(self): 46 | """ Load the font """ 47 | self.id = _ext.blf.load(self.path.as_posix()) 48 | 49 | def _preprocess(self, text:str, position:_ext.types.Vector2f, point_size:int, angle:float)->_ext.Rect: 50 | """ Preps the font and determins the bounds 51 | """ 52 | # Todo 53 | # _ext.blf.disable(self.id, _ext.blf.CLIPPING) 54 | # _ext.blf.disable(self.id, _ext.blf.KERNING_DEFAULT) 55 | if angle == 0.0: 56 | _ext.blf.disable(self.id, _ext.blf.ROTATION) 57 | else: 58 | _ext.blf.enable(self.id, _ext.blf.ROTATION) 59 | _ext.blf.rotation(self.id, angle) 60 | 61 | if self.shadow_color is not None: 62 | _ext.blf.enable(self.id, _ext.blf.SHADOW) 63 | _ext.blf.shadow(self.id, self.shadow_blur, *_ext.parse_color(self.shadow_color)) 64 | _ext.blf.shadow_offset(self.id, int(self.shadow_offset[0]), int(self.shadow_offset[1])) 65 | else: 66 | _ext.blf.disable(self.id, _ext.blf.SHADOW) 67 | 68 | _ext.blf.size(self.id, point_size) 69 | 70 | width, height = _ext.blf.dimensions(self.id, text) 71 | position = _ext.types.as_vector2f(position) 72 | if self.align & _ext.Align.Right: 73 | position[0] -= width 74 | elif self.align & _ext.Align.HCenter: 75 | position[0] -= width/2.0 76 | elif self.align & _ext.Align.Left: 77 | pass # default 78 | 79 | if self.align & _ext.Align.Top: 80 | position[1] -= height 81 | elif self.align & _ext.Align.VCenter: 82 | position[1] -= height/2.0 83 | elif self.align & _ext.Align.Bottom: 84 | pass # default 85 | 86 | _ext.blf.position(self.id, position[0], position[1], 0) 87 | return _ext.Rect(position, [width, height]) 88 | 89 | def draw(self, text:str, position:_ext.types.Vector2f, point_size:int=None, 90 | angle:float=None, color:_ext.types.Vector2f=None)->_ext.Rect: 91 | """ Draw the font with optional overrides 92 | 93 | Args: 94 | text(str): text to draw 95 | position(Vector): 2d position to draw text 96 | point_size(int): optional point_size, defaults to self.point_size 97 | angle(float): optional angle, defaults to self.angle 98 | color(Vector): optional color, defaults to self.color 99 | 100 | Returns: 101 | Bounds of text just drawn 102 | """ 103 | rect = self._preprocess( 104 | text, 105 | position, 106 | point_size if point_size is not None else self.point_size, 107 | angle if angle is not None else self.angle 108 | ) 109 | color = _ext.parse_color(color) if color is not None else self.color 110 | if len(color) == 3: 111 | # Specify alpha 112 | _ext.blf.color(self.id, *color, 1.0) 113 | else: 114 | _ext.blf.color(self.id, *color) 115 | _ext.blf.draw(self.id, text) 116 | return rect 117 | 118 | def bounds(self, text:str, position:_ext.types.Vector2f, point_size:int=None, 119 | angle:float=None)->_ext.Rect: 120 | """ Get the bounding box of this text without drawing it 121 | 122 | Args: 123 | text(str): text to draw 124 | position(Vector): 2d position to draw text 125 | point_size(int): optional point_size, defaults to self.point_size 126 | angle(float): optional angle, defaults to self.angle 127 | 128 | Returns: 129 | Bounds 130 | """ 131 | return self._preprocess( 132 | text, 133 | position, 134 | point_size if point_size is not None else self.point_size, 135 | angle if angle is not None else self.angle 136 | ) 137 | -------------------------------------------------------------------------------- /examples/mask_with_text.py: -------------------------------------------------------------------------------- 1 | # copyright (c) 2024 Alex Telford, http://minimaleffort.tech 2 | # pylint: disable=fixme, import-error 3 | from __future__ import annotations 4 | import bpy 5 | import numpy as np 6 | from met_viewport_utils.constants import ( 7 | Axis, Align, MouseButton, KeyboardModifier, FontWeight, 8 | GPUShaderPrimitiveType, GPUShaderState, FontStyle, ItemState, InteractionFlags) 9 | from met_viewport_utils.shape.rect import Rect 10 | from met_viewport_utils.shape.margins import Margins 11 | from met_viewport_utils.shape.generate import border2d, square2d, arrow2d 12 | from met_viewport_utils.algorithm.color import parse_color 13 | from met_viewport_utils.items.hud_item import HudItem 14 | from met_viewport_utils.items.font_item import FontItem 15 | 16 | from met_blender_viewport_utils.impl.font import GPUFont 17 | from met_blender_viewport_utils.impl.viewport import BlenderViewport 18 | from met_blender_viewport_utils.impl.shaders import UniformColorShader 19 | 20 | 21 | DEFAULT_FONT = GPUFont.from_props("Arial", weight=FontWeight.Normal) 22 | DEFAULT_FONT.point_size = 16 23 | DEFAULT_FONT.align = Align.Center 24 | DEFAULT_FONT.color = "#FFFFFF" 25 | DEFAULT_FONT.shadow_color = "#000000" 26 | 27 | 28 | 29 | class HudMaskItem(HudItem): 30 | def __init__(self): 31 | super().__init__() 32 | self.flags |= InteractionFlags.Draggable 33 | self._shader = UniformColorShader() 34 | self._color = parse_color("#000000", alpha=0.5) 35 | self._shader.set_uniform("color", self._color) 36 | self._shader.primitive_type = GPUShaderPrimitiveType.Tris 37 | 38 | self._shader.state = GPUShaderState.UseAlpha 39 | self._handle:Align = None 40 | self._handle_drag_start = np.array([0, 0]) 41 | self._drag_margins = Margins() 42 | 43 | self._handle_shader = UniformColorShader() 44 | self._handle_shader.set_uniform("color", [1.0, 1.0, 1.0, 0.3]) 45 | self._handle_shader.primitive_type = GPUShaderPrimitiveType.Tris 46 | self._handle_shader.state = GPUShaderState.UseAlpha 47 | 48 | self._edge_default_color = [1.0, 1.0, 1.0, 0.3] 49 | self._edge_active_color = parse_color("#1E90FF", alpha=0.5) 50 | self._edge_shader = UniformColorShader() 51 | self._edge_shader.set_uniform("color", self._edge_default_color) 52 | self._edge_shader.primitive_type = GPUShaderPrimitiveType.Tris 53 | self._edge_shader.state = GPUShaderState.UseAlpha 54 | 55 | self._font = DEFAULT_FONT.copy() 56 | self._font.point_size = 24 57 | self._font.align = Align.Center 58 | 59 | @property 60 | def color(self): 61 | return self._color 62 | 63 | @color.setter 64 | def color(self, color): 65 | self._color = parse_color(color) 66 | self._shader.set_uniform("color", self._color) 67 | 68 | def _get_drag_data(self): 69 | return Margins(*self.margins) 70 | 71 | def _drag_move(self, 72 | viewport, 73 | start_data, 74 | delta, 75 | modifier): 76 | if not self._handle: 77 | return None 78 | if self._handle & Align.Left: 79 | self.margins.left = start_data.left + delta[0] 80 | self.margins.right = start_data.right + delta[0] 81 | if self._handle & Align.Top: 82 | self.margins.top = start_data.top - delta[1] 83 | self.margins.bottom = start_data.bottom - delta[1] 84 | if self._handle & Align.Right: 85 | self.margins.right = start_data.right - delta[0] 86 | self.margins.left = start_data.left - delta[0] 87 | if self._handle & Align.Bottom: 88 | self.margins.bottom = start_data.bottom + delta[1] 89 | self.margins.top = start_data.top + delta[1] 90 | 91 | def screen_rect(self, viewport:BlenderViewport)->Rect: 92 | return Rect(self.position, self.size) 93 | 94 | def _is_under_mouse(self, viewport, local_position, screen_position)->bool: 95 | outline = self.screen_rect(viewport).adjusted(self.margins) 96 | # Give 10px selection radius 97 | inner = outline.adjusted(Margins(5, 5, 5, 5)) 98 | if inner.contains(screen_position): 99 | return False 100 | outer = outline.adjusted(Margins(-5, -5, -5, -5)) 101 | return outer.contains(screen_position) 102 | 103 | def draw(self, viewport): 104 | # TODO: Compute points if viewport and margins are different 105 | rect = self.screen_rect(viewport) 106 | mesh = border2d(rect, self.margins) 107 | self._shader.draw({"pos": mesh.points}, indices=mesh.indices) 108 | 109 | if self._handle is not None: 110 | inner_rect = rect.adjusted(self.margins) 111 | box_width = 6 112 | if self._handle == Align.Left: 113 | box = Rect((inner_rect.left()-box_width/2, inner_rect.bottom()), 114 | (box_width, inner_rect.height)) 115 | elif self._handle == Align.Right: 116 | box = Rect((inner_rect.right()-box_width/2, inner_rect.bottom()), 117 | (box_width, inner_rect.height)) 118 | elif self._handle == Align.Bottom: 119 | box = Rect((inner_rect.left(), inner_rect.bottom()-box_width/2), 120 | (inner_rect.width, box_width)) 121 | elif self._handle == Align.Top: 122 | box = Rect((inner_rect.left(), inner_rect.top()-box_width/2), 123 | (inner_rect.width, box_width)) 124 | else: 125 | return 126 | 127 | if self.state & ItemState.Dragging: 128 | self._handle_shader.set_uniform("color", self._edge_active_color) 129 | else: 130 | self._handle_shader.set_uniform("color", self._edge_default_color) 131 | mesh = square2d(box) 132 | self._handle_shader.draw({"pos": mesh.points}, indices=mesh.indices) 133 | 134 | if self.state & ItemState.Dragging: 135 | center = inner_rect.center() 136 | aspect = inner_rect.width / inner_rect.height 137 | aspect_rect = self._font.draw(f"Aspect: {aspect:.2f}", center) 138 | self._font.draw(f"Margins: {self.margins.left:.0f}, {self.margins.top:.0f}, {self.margins.right:.0f}, {self.margins.bottom:.0f}", 139 | center - np.array((0, aspect_rect.height + 5), dtype=np.float32)) 140 | 141 | axis = self._handle 142 | if axis & (Align.Top|Align.Bottom): 143 | axis |= Align.HCenter 144 | else: 145 | axis |= Align.VCenter 146 | 147 | handle_position = inner_rect.point_at(axis) 148 | 149 | arrow_size = np.array((50, 50), dtype=np.float32) 150 | box = Rect(handle_position, arrow_size, Align.Center) 151 | arrow = arrow2d(box, heads=2) 152 | if self._handle & (Align.Top|Align.Bottom): 153 | arrow.rotate_by(90.0) 154 | 155 | self._handle_shader.draw({"pos": arrow.points}, indices=arrow.indices) 156 | 157 | def mouse_moved(self, 158 | viewport, 159 | local_position, 160 | screen_position, 161 | modifier): 162 | result = super().mouse_moved(viewport, local_position, screen_position, modifier) 163 | if self.state & ItemState.Dragging: 164 | return result 165 | outline = self.screen_rect(viewport).adjusted(self.margins) 166 | left_bound = Rect(outline.bottom_left(), [10, outline.height], Align.BottomCenter) 167 | if left_bound.contains(screen_position): 168 | self._handle = Align.Left 169 | return True 170 | 171 | right_bound = Rect(outline.bottom_right(), [10, outline.height], Align.BottomCenter) 172 | if right_bound.contains(screen_position): 173 | self._handle = Align.Right 174 | return True 175 | 176 | top_bound = Rect(outline.top_left(), [outline.width, 10], Align.LeftCenter) 177 | if top_bound.contains(screen_position): 178 | self._handle = Align.Top 179 | return True 180 | 181 | bottom_bound = Rect(outline.bottom_left(), [outline.width, 10], Align.LeftCenter) 182 | if bottom_bound.contains(screen_position): 183 | self._handle = Align.Bottom 184 | return True 185 | 186 | self._handle = None 187 | return result 188 | 189 | 190 | 191 | 192 | class HudOverlayOperator(bpy.types.Operator): 193 | """Hud Overlay""" 194 | bl_idname = "view3d.hud_overlay" 195 | bl_label = "HUD Overlay" 196 | _handle = None 197 | _root = None 198 | 199 | @classmethod 200 | def _RemoveHandler(cls): 201 | if cls._handle is not None: 202 | bpy.types.SpaceView3D.draw_handler_remove(cls._handle, 'WINDOW') 203 | cls._handle = None 204 | 205 | def modal(self, context:bpy.types.Context, event:bpy.types.Event): 206 | is_hud_interaction = False 207 | if context.area.type == 'VIEW_3D': 208 | viewport = BlenderViewport(context) 209 | context.area.tag_redraw() 210 | context.view_layer.update() 211 | modifier = KeyboardModifier.NoKeyboardModifier 212 | if event.ctrl: 213 | modifier |= KeyboardModifier.Ctrl 214 | if event.shift: 215 | modifier |= KeyboardModifier.Shift 216 | if event.alt: 217 | modifier |= KeyboardModifier.Alt 218 | 219 | if event.type == 'MOUSEMOVE': 220 | mouse_pos = np.array([event.mouse_region_x, event.mouse_region_y], dtype=np.float32) 221 | self._root.mouse_moved(viewport, mouse_pos, mouse_pos, modifier) 222 | 223 | elif event.type == 'LEFTMOUSE': 224 | mouse_pos = np.array([event.mouse_region_x, event.mouse_region_y], dtype=np.float32) 225 | if event.value == "PRESS": 226 | # TODO: right clicks 227 | is_hud_interaction = self._root.mouse_pressed(viewport, mouse_pos, mouse_pos, MouseButton.Left, modifier) 228 | else: # release 229 | is_hud_interaction = self._root.mouse_released(viewport, mouse_pos, mouse_pos, MouseButton.Left, modifier) 230 | 231 | elif event.type in {'ESC'}: 232 | self._RemoveHandler() 233 | return {'CANCELLED'} 234 | 235 | return {'RUNNING_MODAL'} if is_hud_interaction else {'PASS_THROUGH'} 236 | 237 | def invoke(self, context, event): 238 | if context.area.type == 'VIEW_3D': 239 | args = (self, context) 240 | self._root = HudMaskItem() 241 | self._root.margins = Margins(100, 50, 100, 50) 242 | item = FontItem("{scene.frame_current}", DEFAULT_FONT) 243 | item.data["scene"] = context.scene 244 | item.align = Align.BottomCenter 245 | item.font.align = Align.TopCenter 246 | item.parent = self._root 247 | item = FontItem("SampleProject", DEFAULT_FONT) 248 | item.flags = InteractionFlags.Draggable 249 | item.align = Align.BottomLeft 250 | item.font.align = Align.TopLeft 251 | item.parent = self._root 252 | item = FontItem("{camera.lens:.2f}mm", DEFAULT_FONT) 253 | item.data["camera"] = bpy.data.cameras["Camera"] 254 | item.align = Align.BottomRight 255 | item.font.align = Align.TopRight 256 | item.parent = self._root 257 | 258 | item = FontItem("This text can move", DEFAULT_FONT) 259 | item.font.color = parse_color("#1E90FF") 260 | item.font.point_size = 24 261 | item.font.weight = FontWeight.Bold 262 | item.font.style = FontStyle.Italic 263 | item.align = Align.TopLeft 264 | item.flags = InteractionFlags.Draggable 265 | item.parent = self._root 266 | 267 | self.__class__._handle = bpy.types.SpaceView3D.draw_handler_add( 268 | self.__class__.draw, args, 'WINDOW', 'POST_PIXEL') 269 | 270 | context.window_manager.modal_handler_add(self) 271 | return {'RUNNING_MODAL'} 272 | else: 273 | self.report({'WARNING'}, "View3D not found, cannot run operator") 274 | return {'CANCELLED'} 275 | 276 | 277 | def draw(self, context:bpy.types.Context): 278 | if context.area.type == 'VIEW_3D': 279 | viewport = BlenderViewport(context) 280 | self._root.size = viewport.rect().size 281 | self._root.draw(viewport) 282 | for item in self._root.iter_descendants(HudItem): 283 | if item.state & ItemState.Visible: 284 | item.draw(viewport) 285 | 286 | def register(): 287 | bpy.utils.register_class(HudOverlayOperator) 288 | 289 | 290 | def unregister(): 291 | bpy.utils.unregister_class(HudOverlayOperator) 292 | 293 | if __name__ == "__main__": 294 | register() 295 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------