Add html datasources
Browse filesThis view is limited to 50 files because it contains too many changes.
See raw diff
- html/klayout_docs/www.klayout.de/build.html +0 -0
- html/klayout_docs/www.klayout.de/build_until_25.html +429 -0
- html/klayout_docs/www.klayout.de/command_args.html +351 -0
- html/klayout_docs/www.klayout.de/contact.html +117 -0
- html/klayout_docs/www.klayout.de/credits.html +234 -0
- html/klayout_docs/www.klayout.de/development.html +0 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/25d_view.html +255 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/about_libraries.html +163 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/about_pcells.html +170 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/basic_lib.html +198 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/connectivity.html +154 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/custom_queries.html +433 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref.html +123 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref_drc.html +642 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref_global.html +0 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref_layer.html +0 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref_netter.html +496 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref_source.html +335 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/expressions.html +210 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/index.html +126 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/layer_mapping.html +213 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/layer_sources.html +190 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/layer_specs.html +170 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/lef_def_import.html +234 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/lvs_ref.html +123 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/lvs_ref_global.html +193 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/lvs_ref_netter.html +440 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/macro_editor.html +372 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/macro_in_menu.html +169 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/packages.html +295 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/rba_notation.html +159 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/symbolic_layers.html +141 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/technology_manager.html +211 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/transformations.html +219 -0
- html/klayout_docs/www.klayout.de/doc-qt5/about/variant_notation.html +131 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_AbsoluteProgress.html +154 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_AbstractMenu.html +156 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_AbstractProgress.html +134 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_Action.html +192 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_Annotation.html +256 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_Application.html +144 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_BitmapBuffer.html +145 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_Box.html +199 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_BrowserDialog.html +168 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_BrowserPanel.html +142 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_BrowserSource.html +151 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_ButtonState.html +149 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_Cell.html +0 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_CellInstArray.html +177 -0
- html/klayout_docs/www.klayout.de/doc-qt5/code/class_CellMapping.html +186 -0
html/klayout_docs/www.klayout.de/build.html
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
html/klayout_docs/www.klayout.de/build_until_25.html
ADDED
|
@@ -0,0 +1,429 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
|
| 33 |
+
|
| 34 |
+
</head>
|
| 35 |
+
|
| 36 |
+
<body>
|
| 37 |
+
|
| 38 |
+
<div class="klayout-header">
|
| 39 |
+
|
| 40 |
+
<div class="container mb-5">
|
| 41 |
+
|
| 42 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 43 |
+
|
| 44 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 45 |
+
|
| 46 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 47 |
+
|
| 48 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 49 |
+
|
| 50 |
+
<li class="nav-item dropdown active mr-4">
|
| 51 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 52 |
+
About
|
| 53 |
+
</a>
|
| 54 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 55 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 56 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 59 |
+
<div class="dropdown-divider"></div>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 61 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 63 |
+
</div>
|
| 64 |
+
</li>
|
| 65 |
+
<li class="nav-item active mr-4">
|
| 66 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 67 |
+
</li>
|
| 68 |
+
<li class="nav-item active mr-4">
|
| 69 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 70 |
+
</li>
|
| 71 |
+
<li class="nav-item active mr-5">
|
| 72 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 73 |
+
</li>
|
| 74 |
+
<li class="nav-item active">
|
| 75 |
+
<span class="nav-link klayout-menu">
|
| 76 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 77 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 78 |
+
</span>
|
| 79 |
+
</li>
|
| 80 |
+
|
| 81 |
+
</ul>
|
| 82 |
+
|
| 83 |
+
</div>
|
| 84 |
+
|
| 85 |
+
<!-- collapse button -->
|
| 86 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 87 |
+
<span class="navbar-toggler-icon"></span>
|
| 88 |
+
</button>
|
| 89 |
+
|
| 90 |
+
</nav>
|
| 91 |
+
|
| 92 |
+
</div>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
<div class="container">
|
| 97 |
+
|
| 98 |
+
<h1>Build instructions before version 0.25</h1>
|
| 99 |
+
|
| 100 |
+
<a name="build_unix"></a><h2>Building KLayout on Unix</h2>
|
| 101 |
+
|
| 102 |
+
<p>
|
| 103 |
+
System Requirements:
|
| 104 |
+
</p>
|
| 105 |
+
|
| 106 |
+
<ul>
|
| 107 |
+
<li>Linux system (tested on Ubuntu 8.04LTS, 10.04LTS, 12.04LTS, 14.02LTS, RHE 4/5/6, CentOS 6)</li>
|
| 108 |
+
<li>on Linux: gcc Version 4 or later (tested with 4.3.2, 4.4.3, 4.6.3, 4.8.4). Solaris is no longer supported.</li>
|
| 109 |
+
<li>Qt Version 4.5.x or later (4.5.2, 4.6.3, 4.7.4 and 4.8.2). </li>
|
| 110 |
+
<li>gcc C++ compiler (package "g++" on Debian)</li>
|
| 111 |
+
<li>zlib library and headers (package "zlib1g-dev" on Debian)</li>
|
| 112 |
+
<li>Recommended: Ruby 1.9.1 or later (Ruby 2.x will work too), Python 2.7 or later (Python 3.x will work too)</li>
|
| 113 |
+
</ul>
|
| 114 |
+
|
| 115 |
+
<p>
|
| 116 |
+
To build, the simplest way is to use the build.sh wrapper script
|
| 117 |
+
provided. Unpack the tarkit, change to the directory created
|
| 118 |
+
and type
|
| 119 |
+
</p>
|
| 120 |
+
|
| 121 |
+
<p class="indent">
|
| 122 |
+
<tt>
|
| 123 |
+
./build.sh
|
| 124 |
+
</tt>
|
| 125 |
+
</p>
|
| 126 |
+
|
| 127 |
+
<p>
|
| 128 |
+
If the script complains about missing tools are libraries, the Qt
|
| 129 |
+
installation needs to be specified. There are basically two ways:
|
| 130 |
+
either a Qt package was configured or installed using the environment
|
| 131 |
+
provided by TrollTech, or the system provides a Qt4 installtion itself.
|
| 132 |
+
</p>
|
| 133 |
+
|
| 134 |
+
<p>
|
| 135 |
+
In the first case, the actual Qt installation path can be specified with
|
| 136 |
+
the -qt option: i.e.
|
| 137 |
+
</p>
|
| 138 |
+
|
| 139 |
+
<p class="indent">
|
| 140 |
+
<tt>
|
| 141 |
+
./build.sh -qt ~/qt
|
| 142 |
+
</tt>
|
| 143 |
+
</p>
|
| 144 |
+
|
| 145 |
+
<p>
|
| 146 |
+
will locate the Qt include files in ~/qt/include, the Qt library in
|
| 147 |
+
~/qt/lib. The installation path is the prefix that was specified
|
| 148 |
+
on Qt's configure command line.
|
| 149 |
+
</p>
|
| 150 |
+
|
| 151 |
+
<p>
|
| 152 |
+
On LSB (Linux Standard Base) systems, the Qt4 library can be optionally
|
| 153 |
+
installed. It is common to have different
|
| 154 |
+
installation directories for include and library files. On
|
| 155 |
+
Ubuntu 6.10 with Qt4 for example, the libraries are located in "/usr/lib", the
|
| 156 |
+
development tools like "uic" are installed in "/usr/bin" and
|
| 157 |
+
the include files reside in "/usr/include/qt4".
|
| 158 |
+
In this case, use:
|
| 159 |
+
</p>
|
| 160 |
+
|
| 161 |
+
<p class="indent">
|
| 162 |
+
<tt>
|
| 163 |
+
./build.sh -qtbin /usr/bin -qtlib /usr/lib -qtinc /usr/include/qt4
|
| 164 |
+
</tt>
|
| 165 |
+
</p>
|
| 166 |
+
|
| 167 |
+
<p>
|
| 168 |
+
Since the above settings are the default, this is equivalent to specifying nothing
|
| 169 |
+
as shown above.
|
| 170 |
+
</p>
|
| 171 |
+
|
| 172 |
+
<p>
|
| 173 |
+
The build script does not determine the platform to build upon. By default,
|
| 174 |
+
32 bit Linux and "gcc" is configured as the build platform. To build for an other platform,
|
| 175 |
+
use
|
| 176 |
+
</p>
|
| 177 |
+
|
| 178 |
+
<p class="indent">
|
| 179 |
+
<tt>
|
| 180 |
+
./build.sh -platform </tt><platform><tt>
|
| 181 |
+
</tt>
|
| 182 |
+
</p>
|
| 183 |
+
|
| 184 |
+
<p>
|
| 185 |
+
The platforms and build variants available are listed with
|
| 186 |
+
</p>
|
| 187 |
+
|
| 188 |
+
<p class="indent">
|
| 189 |
+
<tt>
|
| 190 |
+
./build.sh -help
|
| 191 |
+
</tt>
|
| 192 |
+
</p>
|
| 193 |
+
|
| 194 |
+
<p>
|
| 195 |
+
The build script will create the final executable in
|
| 196 |
+
</p>
|
| 197 |
+
|
| 198 |
+
<p class="indent">
|
| 199 |
+
<tt>
|
| 200 |
+
./bin.</tt><platform><tt>/klayout
|
| 201 |
+
</tt>
|
| 202 |
+
</p>
|
| 203 |
+
|
| 204 |
+
<p>
|
| 205 |
+
To integrate other build variants, a new file can be created in the
|
| 206 |
+
"config" subdirectory. This is a partial Makefile that defined the
|
| 207 |
+
variables specific for a certain build.
|
| 208 |
+
</p>
|
| 209 |
+
|
| 210 |
+
<p>
|
| 211 |
+
If the build script finds a Ruby interpreter in the path and the Ruby development
|
| 212 |
+
packages are installed (i.e. "ruby1.9.1-dev"), Ruby script automation capabilities (RBA) are enabled.
|
| 213 |
+
It should no longer be necessary to specify the location of the libraries and
|
| 214 |
+
headers. <b>Ruby 1.9.1 or later</b> is recommended for that feature.
|
| 215 |
+
</p>
|
| 216 |
+
|
| 217 |
+
<p>
|
| 218 |
+
If the build script finds a Python interpreter in the path and the Python development
|
| 219 |
+
packages are installed (i.e. "python-dev"), Python script automation capabilities (pya) are enabled.
|
| 220 |
+
It should no longer be necessary to specify the location of the libraries and
|
| 221 |
+
headers. <b>Python 2.7 or later</b> is required for that feature.
|
| 222 |
+
</p>
|
| 223 |
+
|
| 224 |
+
<p>
|
| 225 |
+
For more details about RBA, see <a href="doc/programming/index.html">Programming scripts</a>.
|
| 226 |
+
</p>
|
| 227 |
+
|
| 228 |
+
<p>
|
| 229 |
+
<b>Qt bindings are not enabled by default.</b> The Qt bindings allow you to create Qt user interfaces
|
| 230 |
+
using Ruby scripts. To enable Qt bindings, you'll need Qt 4.6.2 at least and have to use the
|
| 231 |
+
following build script switch:
|
| 232 |
+
</p>
|
| 233 |
+
|
| 234 |
+
<p class="indent">
|
| 235 |
+
<tt>
|
| 236 |
+
build.sh -with-qtbinding
|
| 237 |
+
</tt>
|
| 238 |
+
</p>
|
| 239 |
+
|
| 240 |
+
<p>
|
| 241 |
+
Enabling Qt bindings will significantly increase the build times and size of the final executable.
|
| 242 |
+
For more details about the Qt binding, see <a href="doc/programming/qt_binding.html">The Qt Binding</a>.
|
| 243 |
+
</p>
|
| 244 |
+
|
| 245 |
+
<a name="build_macos"></a><h2>Building on MacOS</h2>
|
| 246 |
+
|
| 247 |
+
<p>
|
| 248 |
+
For building the executable on MacOS 10.5.7, the "mac-leopard-gcc-release" platform is provided. The build is based on the Xcode
|
| 249 |
+
installation. This build script call was used successfully with Qt 4.5.2 from the Xcode package:
|
| 250 |
+
</p>
|
| 251 |
+
|
| 252 |
+
<pre>
|
| 253 |
+
./build.sh -platform mac-leopard-gcc-release \
|
| 254 |
+
-qtbin /Developer/Tools/Qt \
|
| 255 |
+
-qtlib /usr/lib \
|
| 256 |
+
-rblib /usr/lib/libruby.dylib \
|
| 257 |
+
-rbinc /usr/lib/ruby/1.8/universal-darwin9.0
|
| 258 |
+
</pre>
|
| 259 |
+
|
| 260 |
+
<p>
|
| 261 |
+
On MacOS 10.6 this build script call was used successfully (Qt library is qt-mac-cocoa-opensource-4.6.2.dmg):
|
| 262 |
+
</p>
|
| 263 |
+
|
| 264 |
+
<pre>
|
| 265 |
+
./build.sh -platform mac-leopard-gcc-release \
|
| 266 |
+
-qtbin /Developer/Tools/Qt \
|
| 267 |
+
-qtlib /usr/lib \
|
| 268 |
+
-rblib /usr/lib/libruby.dylib \
|
| 269 |
+
-rbinc /usr/lib/ruby/1.8/universal-darwin10.0
|
| 270 |
+
</pre>
|
| 271 |
+
|
| 272 |
+
<p>Apparently, both 32 and 64 bit versions of Qt must be installed.</p>
|
| 273 |
+
|
| 274 |
+
<p><b>Note:</b> to enable Qt binding for RBA, add the "-with-qtbinding" switch:</p>
|
| 275 |
+
|
| 276 |
+
<pre>
|
| 277 |
+
./build.sh -with-qtbinding ...
|
| 278 |
+
</pre>
|
| 279 |
+
|
| 280 |
+
<p>
|
| 281 |
+
For compiling the Qt bindings, at least Qt 4.6.2 is required.
|
| 282 |
+
Enabling Qt bindings will significantly increase the build times and size of the final executable.
|
| 283 |
+
For more details about the Qt binding, see <a href="doc/programming/qt_binding.html">The Qt Binding</a>.
|
| 284 |
+
</p>
|
| 285 |
+
|
| 286 |
+
<a name="build_windows"></a><h2>Building KLayout for Windows 32 bit with MinGW</h2>
|
| 287 |
+
|
| 288 |
+
<p>
|
| 289 |
+
<b>Please note: severe issues have been observed with MinGW's gcc 4.4.0 distribution. Specifically, broken
|
| 290 |
+
support for exceptions in threads may make the application crash. Possibly a new distribution may solve that
|
| 291 |
+
issue. Until then, although basically functional, the use of the MinGW build is discouraged.
|
| 292 |
+
</b>
|
| 293 |
+
</p>
|
| 294 |
+
|
| 295 |
+
<p>
|
| 296 |
+
Starting with version 0.21, a build setup is provided for MinGW with the gcc. A good starting point for the
|
| 297 |
+
MinGW build is the Qt SDK which comes with a Qt reaily built for MinGW and the gcc
|
| 298 |
+
compiler suite.
|
| 299 |
+
</p>
|
| 300 |
+
|
| 301 |
+
<p>
|
| 302 |
+
To enable Ruby support, the Ruby interpreter, preferably version 1.9 is required.
|
| 303 |
+
A strange fact with building Ruby 1.9 is that one needs a Ruby interpreter to
|
| 304 |
+
build it. One possible solution is first to build a 1.8 version, put the executable
|
| 305 |
+
into the path and then run the Ruby build from the MinGW console.
|
| 306 |
+
</p>
|
| 307 |
+
|
| 308 |
+
<p>
|
| 309 |
+
To build KLayout on MinGW, simply open the MinGW shell (MSYS), unpack the KLayout source
|
| 310 |
+
package and cd to the destination folder. Then use build.sh as on Linux. For example, if
|
| 311 |
+
the Qt SDK was installed in "c:\Qt\2010.04", the build script call is
|
| 312 |
+
</p>
|
| 313 |
+
|
| 314 |
+
<p class="indent">
|
| 315 |
+
<tt>
|
| 316 |
+
build.sh -qt /c/Qt/2010.04/qt
|
| 317 |
+
</tt>
|
| 318 |
+
</p>
|
| 319 |
+
|
| 320 |
+
<p>
|
| 321 |
+
For ruby support use the -rblib and -rbinc options accordingly to specify the ruby installation
|
| 322 |
+
path.
|
| 323 |
+
</p>
|
| 324 |
+
|
| 325 |
+
<a name="build_vs"></a><h2>Building KLayout for Windows 32 bit and 64 bit with Visual Studio</h2>
|
| 326 |
+
|
| 327 |
+
<p>
|
| 328 |
+
Starting with version 0.21, a Visual Studio solution is included in the source branch of KLayout's
|
| 329 |
+
source tarkit ("klayout.sln"). The solution is provided for Visual Studio 2010.
|
| 330 |
+
</p>
|
| 331 |
+
|
| 332 |
+
<h3>Building KLayout for Version 0.24</h3>
|
| 333 |
+
|
| 334 |
+
<p>Version 0.24 is based on:</p>
|
| 335 |
+
|
| 336 |
+
<ul>
|
| 337 |
+
<li>Visual Studio 2010 (VC++ version 10)</li>
|
| 338 |
+
<li>Qt 4.8.2</li>
|
| 339 |
+
<li>Ruby 2.1.3 (get the package here: <a href="https://www.klayout.org/downloads/ruby-2.1.3.zip">ruby-2.1.3.zip</a>)</li>
|
| 340 |
+
<li>Python 3.4 (get the package here: <a href="https://www.klayout.org/downloads/Python34.zip">Python34.zip</a>)</li>
|
| 341 |
+
<li>STLPort 5.2.1 (get the package here: <a href="https://www.klayout.org/downloads/STLport-5.2.1.zip">STLport-5.2.1.zip</a>)</li>
|
| 342 |
+
</ul>
|
| 343 |
+
|
| 344 |
+
<p>A Visual Studio solution is provided (<tt>klayout.sln</tt>). The release mode configuration is
|
| 345 |
+
"Release (STLPort)" which is the one used for creating the prebuild packages.</p>
|
| 346 |
+
|
| 347 |
+
<p>The build requires the following environment variables to be set:</p>
|
| 348 |
+
|
| 349 |
+
<ul>
|
| 350 |
+
<li>$QTDIR to the installation path of Qt for 32 bit build ($QTDIR/bin being the location of the
|
| 351 |
+
executables, $QTDIR/lib being the location of the libraries and $QTDIR/include being the location
|
| 352 |
+
of the header files).</li>
|
| 353 |
+
<li>$QTDIR64 to the installation path of Qt for 64 bit build ($QTDIR64/bin being the location of the
|
| 354 |
+
executables, $QTDIR64/lib being the location of the libraries and $QTDIR64/include being the location
|
| 355 |
+
of the header files).</li>
|
| 356 |
+
<li>$STLPORT to the installation path of the STLPort library. $STLPORT/stlport must be
|
| 357 |
+
the location of the headers. This variable is the same for 32 and 64 bit builds.</li>
|
| 358 |
+
<li>$RUBY2 to the installation path of the Ruby 2.x library for the 32 bit build. $RUBY2/include/ruby-2.1.0 must be
|
| 359 |
+
the location of the ruby.h header.</li>
|
| 360 |
+
<li>$RUBY264 to the installation path of the Ruby 2.x library for the 64 bit build. $RUBY264/include/ruby-2.1.0 must be
|
| 361 |
+
the location of the ruby.h header.</li>
|
| 362 |
+
<li>$PYTHON to the installation path of the Python library for the 32 bit build. $PYTHON/include must be
|
| 363 |
+
the location of the python.h header.</li>
|
| 364 |
+
<li>$PYTHON64 to the installation path of the Python library for the 64 bit build. $PYTHON64/include must be
|
| 365 |
+
the location of the python.h header.</li>
|
| 366 |
+
</ul>
|
| 367 |
+
|
| 368 |
+
<p>
|
| 369 |
+
For further details see the next section.
|
| 370 |
+
</p>
|
| 371 |
+
|
| 372 |
+
<h3>Building KLayout for Version 0.21 to 0.23</h3>
|
| 373 |
+
|
| 374 |
+
<p>
|
| 375 |
+
To build KLayout with Visual Studio, the following requirements must be fulfilled:
|
| 376 |
+
</p>
|
| 377 |
+
|
| 378 |
+
<ul>
|
| 379 |
+
<li>Qt for Visual Studio 2010 (VC++ version 10). Currently this version must be built manually.
|
| 380 |
+
Qt version 4.7.1 is compatible with Visual Studio 2010 and building it is pretty straightforward.
|
| 381 |
+
</li>
|
| 382 |
+
<li>For a complete build including Ruby support, the ruby interpreter is required as well. Only version
|
| 383 |
+
1.9 is supporting the 64 bit platform. Building is straightforward, except that again a ruby interpreter
|
| 384 |
+
must be installed before version 1.9 can be built. If no interpreter is at hand, a 1.8 version must be
|
| 385 |
+
built before. The project files currently assume Ruby version 1.9.1.<br/>
|
| 386 |
+
A pre-built package for VS2010 can be downloaded here: <a href="https://www.klayout.org/downloads/ruby1.9.1-p430.zip">ruby1.9.1-p430.zip</a>. It
|
| 387 |
+
contains both the 32 bit and 64 bit builds in the 1.9.1-p430/x86 and 1.9.1-p420/x64 directories.
|
| 388 |
+
</li>
|
| 389 |
+
<li>For full performance, it is recommended to replace the standard STL implementation of VC++ with
|
| 390 |
+
the STLPort implementation which has a 2x performance impact in some cases. Building STLPort on
|
| 391 |
+
VC++ is straightforward and has been tested with version 5.2.1.<br/>
|
| 392 |
+
A pre-built package for VS2010 can be downloaded here: <a href="https://www.klayout.org/downloads/STLport-5.2.1.zip">STLport-5.2.1.zip</a>. It
|
| 393 |
+
contains both the 32 bit and 64 bit builds.
|
| 394 |
+
</li>
|
| 395 |
+
</ul>
|
| 396 |
+
|
| 397 |
+
<p>
|
| 398 |
+
Before building KLayout, it is required to set the following environment variables:
|
| 399 |
+
</p>
|
| 400 |
+
|
| 401 |
+
<ul>
|
| 402 |
+
<li>$QTDIR to the installation path of Qt for 32 bit build ($QTDIR/bin being the location of the
|
| 403 |
+
executables, $QTDIR/lib being the location of the libraries and $QTDIR/include being the location
|
| 404 |
+
of the header files).</li>
|
| 405 |
+
<li>$QTDIR64 to the installation path of Qt for 64 bit build ($QTDIR64/bin being the location of the
|
| 406 |
+
executables, $QTDIR64/lib being the location of the libraries and $QTDIR64/include being the location
|
| 407 |
+
of the header files).</li>
|
| 408 |
+
<li>$STLPORT to the installation path of the STLPort library (if required). $STLPORT/stlport must be
|
| 409 |
+
the location of the headers. This variable is the same for 32 and 64 bit builds.</li>
|
| 410 |
+
<li>$RUBY to the installation path of the Ruby library (if required) for the 32 bit build. $RUBY/include/ruby-1.9.1 must be
|
| 411 |
+
the location of the ruby.h header.</li>
|
| 412 |
+
<li>$RUBY64 to the installation path of the Ruby library (if required) for the 64 bit build. $RUBY64/include/ruby-1.9.1 must be
|
| 413 |
+
the location of the ruby.h header.</li>
|
| 414 |
+
</ul>
|
| 415 |
+
|
| 416 |
+
<p>
|
| 417 |
+
After this preparation, KLayout can be build from Visual Studio using the "Win32" platform for 32 bit and "x64"
|
| 418 |
+
platform for 64 bit. The recommended configurations are:
|
| 419 |
+
</p>
|
| 420 |
+
|
| 421 |
+
<ul>
|
| 422 |
+
<li>"Release (STLPort)" for the release build with Ruby support, QT bindings and using STLPort.</li>
|
| 423 |
+
<li>"Debug (STLPort)" for the debug build with Ruby support, QT bindings and using STLPort.</li>
|
| 424 |
+
</ul>
|
| 425 |
+
|
| 426 |
+
</div>
|
| 427 |
+
</body>
|
| 428 |
+
</html>
|
| 429 |
+
|
html/klayout_docs/www.klayout.de/command_args.html
ADDED
|
@@ -0,0 +1,351 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
|
| 33 |
+
|
| 34 |
+
</head>
|
| 35 |
+
|
| 36 |
+
<body>
|
| 37 |
+
|
| 38 |
+
<div class="klayout-header">
|
| 39 |
+
|
| 40 |
+
<div class="container mb-5">
|
| 41 |
+
|
| 42 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 43 |
+
|
| 44 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 45 |
+
|
| 46 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 47 |
+
|
| 48 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 49 |
+
|
| 50 |
+
<li class="nav-item dropdown active mr-4">
|
| 51 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 52 |
+
About
|
| 53 |
+
</a>
|
| 54 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 55 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 56 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 59 |
+
<div class="dropdown-divider"></div>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 61 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 63 |
+
</div>
|
| 64 |
+
</li>
|
| 65 |
+
<li class="nav-item active mr-4">
|
| 66 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 67 |
+
</li>
|
| 68 |
+
<li class="nav-item active mr-4">
|
| 69 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 70 |
+
</li>
|
| 71 |
+
<li class="nav-item active mr-5">
|
| 72 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 73 |
+
</li>
|
| 74 |
+
<li class="nav-item active">
|
| 75 |
+
<span class="nav-link klayout-menu">
|
| 76 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 77 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 78 |
+
</span>
|
| 79 |
+
</li>
|
| 80 |
+
|
| 81 |
+
</ul>
|
| 82 |
+
|
| 83 |
+
</div>
|
| 84 |
+
|
| 85 |
+
<!-- collapse button -->
|
| 86 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 87 |
+
<span class="navbar-toggler-icon"></span>
|
| 88 |
+
</button>
|
| 89 |
+
|
| 90 |
+
</nav>
|
| 91 |
+
|
| 92 |
+
</div>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
<div class="container">
|
| 97 |
+
<h1>Command-Line Arguments of KLayout</h1>
|
| 98 |
+
|
| 99 |
+
<p>
|
| 100 |
+
KLayout's command line basically looks like this:
|
| 101 |
+
</p>
|
| 102 |
+
|
| 103 |
+
<pre>
|
| 104 |
+
klayout [<options>] [<file>] ..
|
| 105 |
+
</pre>
|
| 106 |
+
|
| 107 |
+
<p>
|
| 108 |
+
Options start with a hyphen ("-") and can be mixed with file names. Files given on the command line without an option are
|
| 109 |
+
treated as layout files (GDS, OASIS, ...). Each option must be specified separately, i.e. "-ne" is <em>not</em> option "n" and "e".
|
| 110 |
+
Option arguments must be separated by a space from the option itself. For example:
|
| 111 |
+
</p>
|
| 112 |
+
|
| 113 |
+
<pre>
|
| 114 |
+
klayout -s file1.gds file2.gds -l layers.lyp
|
| 115 |
+
</pre>
|
| 116 |
+
|
| 117 |
+
<p>
|
| 118 |
+
This command will open "file1.gds" and "file2.gds" in the same view (option "-s") and use the layer properties file "layers.lyp".
|
| 119 |
+
</p>
|
| 120 |
+
|
| 121 |
+
<p>
|
| 122 |
+
The following is a description of KLayout's command-line options.
|
| 123 |
+
</p>
|
| 124 |
+
|
| 125 |
+
<h2>General Options</h2>
|
| 126 |
+
<table width="90%">
|
| 127 |
+
<tr>
|
| 128 |
+
<td width="20%"><tt>-b</tt></td>
|
| 129 |
+
<td>Batch mode (same as <tt>-zz -nc -rx</tt>).
|
| 130 |
+
</td>
|
| 131 |
+
</tr>
|
| 132 |
+
<tr>
|
| 133 |
+
<td><tt>-c</tt> <config file></td>
|
| 134 |
+
<td>Use the specified configuration file (reading it on start and writing it on exit) instead of the default configuration file.
|
| 135 |
+
This option allows to switch between different configurations.</td>
|
| 136 |
+
</tr>
|
| 137 |
+
<tr>
|
| 138 |
+
<td><tt>-nc</tt></td>
|
| 139 |
+
<td>Don't use a configuration file (implies <tt>-t</tt>).
|
| 140 |
+
</td>
|
| 141 |
+
</tr>
|
| 142 |
+
<tr>
|
| 143 |
+
<td><tt>-d</tt> <debug level></td>
|
| 144 |
+
<td>Controls the verbosity of the log output. Values are: 0 (silent), 10 (basic info), 11 (basic info plus basic timing), 20 (detailed info), 21 (detailed info plus detailed timing) to
|
| 145 |
+
40 or 41 for noisy log output and timing respectively.
|
| 146 |
+
</td>
|
| 147 |
+
</tr>
|
| 148 |
+
<tr>
|
| 149 |
+
<td><tt>-e</tt></td>
|
| 150 |
+
<td>Enter edit mode even if non-edit mode was specified in the configuration as default mode.</td>
|
| 151 |
+
</tr>
|
| 152 |
+
<tr>
|
| 153 |
+
<td><tt>-ne</tt></td>
|
| 154 |
+
<td>Enter viewer mode even if edit mode was specified in the configuration as default mode. If neither <tt>-e</tt> or <tt>-ne</tt> is specified, the default mode from the configuration will be used.</td>
|
| 155 |
+
</tr>
|
| 156 |
+
<tr>
|
| 157 |
+
<td><tt>-i</tt></td>
|
| 158 |
+
<td>Disable undo buffering (less memory requirements).</td>
|
| 159 |
+
</tr>
|
| 160 |
+
<tr>
|
| 161 |
+
<td><tt>-ni</tt></td>
|
| 162 |
+
<td>Enable undo buffering. This is the default. This option overrides previously set "<tt>-i</tt>" options.</td>
|
| 163 |
+
</tr>
|
| 164 |
+
<tr>
|
| 165 |
+
<td><tt>-j</tt> <path></td>
|
| 166 |
+
<td>Add the given path to the macro project paths.</td>
|
| 167 |
+
</tr>
|
| 168 |
+
<tr>
|
| 169 |
+
<td><tt>-l</tt> <lyp file></td>
|
| 170 |
+
<td>Use the specified layer properties file instead of the default layer properties.</td>
|
| 171 |
+
</tr>
|
| 172 |
+
<tr>
|
| 173 |
+
<td><tt>-lx</tt></td>
|
| 174 |
+
<td>Used with "<tt>-l</tt>": add other layers to the layer properties even if they are not defined in the properties file.</td>
|
| 175 |
+
</tr>
|
| 176 |
+
<tr>
|
| 177 |
+
<td><tt>-lf</tt></td>
|
| 178 |
+
<td>Used with "<tt>-l</tt>": use the ".lyp" file as it is (no expansion to multiple layouts).</td>
|
| 179 |
+
</tr>
|
| 180 |
+
<tr>
|
| 181 |
+
<td><tt>-m</tt> <database file></td>
|
| 182 |
+
<td>Load the given report database together with the previously defined layout. This option must <em>follow</em> a layout file argument.</td>
|
| 183 |
+
</tr>
|
| 184 |
+
<tr>
|
| 185 |
+
<td><tt>-mn</tt> <database file></td>
|
| 186 |
+
<td>Load the given L2N oder LVS database together with the previously defined layout. This option must <em>follow</em> a layout file argument.</td>
|
| 187 |
+
</tr>
|
| 188 |
+
<tr>
|
| 189 |
+
<td><tt>-n</tt> <technology></td>
|
| 190 |
+
<td>Technology to use for <em>next</em> layout(s) on command line.</td>
|
| 191 |
+
</tr>
|
| 192 |
+
<tr>
|
| 193 |
+
<td><tt>-nn</tt> <tech file></td>
|
| 194 |
+
<td>Technology file (".lyt") to use for next layout(s) on command line.</td>
|
| 195 |
+
</tr>
|
| 196 |
+
<tr>
|
| 197 |
+
<td><tt>-p</tt> <plugin></td>
|
| 198 |
+
<td>Load the plugin (a shared object). This option can be used multiple times.</td>
|
| 199 |
+
</tr>
|
| 200 |
+
<tr>
|
| 201 |
+
<td><tt>-r</tt> <script></td>
|
| 202 |
+
<td>Run the given script in interpreter mode. The script file can be either a raw Ruby or Python script, a generic ".lym" script or
|
| 203 |
+
a domain specific language script such as a DRC script (.drc).<br/>
|
| 204 |
+
In "-r" mode, KLayout will exit after the script is executed.
|
| 205 |
+
To start the KLayout application, the script must contain a "Application.exec" method call. The script is executed after all
|
| 206 |
+
other requisites from the command line have been loaded (files, plugins etc.)<br/>
|
| 207 |
+
This option can be combined with "<tt>-z</tt>" (no GUI) or "<tt>-zz</tt>" (no GUI at all).
|
| 208 |
+
That way, KLayout is converted into a Ruby or Python interpreter.</td>
|
| 209 |
+
</tr>
|
| 210 |
+
<tr>
|
| 211 |
+
<td><tt>-rr</tt> <script></td>
|
| 212 |
+
<td>Like "-r", but does not exit after executing the script.</td>
|
| 213 |
+
</tr>
|
| 214 |
+
<tr>
|
| 215 |
+
<td><tt>-rm</tt> <script></td>
|
| 216 |
+
<td>Run the given script before KLayout starts the user interface. In contrast to "<tt>-r</tt>", KLayout continues
|
| 217 |
+
normal execution after the script is executed successfully. This is the preferred way to install user interface
|
| 218 |
+
add-ons ("Modules"). In addition to the modules specified by "<tt>-rm</tt>", KLayout collects script files
|
| 219 |
+
from various places, i.e. the place specified with <tt>$KLAYOUTPATH</tt> or the installation folder.</td>
|
| 220 |
+
</tr>
|
| 221 |
+
<tr>
|
| 222 |
+
<td><tt>-rd</tt> <name>=<value></td>
|
| 223 |
+
<td>Define the variable in the Ruby or Python context with the given string value. In Ruby, the variable will be accessible as "<tt>$name</tt>".
|
| 224 |
+
</td>
|
| 225 |
+
</tr>
|
| 226 |
+
<tr>
|
| 227 |
+
<td><tt>-rx</tt></td>
|
| 228 |
+
<td>Ignore all implicit macros ("*.rbm", "rbainit", "*.lym"). This is a "safe" or "fast" mode since errors in those script cannot spoil the
|
| 229 |
+
application and starting will be faster.</td>
|
| 230 |
+
</tr>
|
| 231 |
+
<tr>
|
| 232 |
+
<td><tt>-s</tt></td>
|
| 233 |
+
<td>Load files into same view.</td>
|
| 234 |
+
</tr>
|
| 235 |
+
<tr>
|
| 236 |
+
<td><tt>-t</tt></td>
|
| 237 |
+
<td>Don't update the configuration file on exit (amnesia mode).</td>
|
| 238 |
+
</tr>
|
| 239 |
+
<tr>
|
| 240 |
+
<td><tt>-nt</tt></td>
|
| 241 |
+
<td>Update the configuration file on exit (default, overrides previous <tt>-t</tt> option).</td>
|
| 242 |
+
</tr>
|
| 243 |
+
<tr>
|
| 244 |
+
<td><tt>-u</tt> <file name></td>
|
| 245 |
+
<td>Restore the session from the given session file.</td>
|
| 246 |
+
</tr>
|
| 247 |
+
<tr>
|
| 248 |
+
<td><tt>-v</tt></td>
|
| 249 |
+
<td>Print program version and exit.</td>
|
| 250 |
+
</tr>
|
| 251 |
+
<tr>
|
| 252 |
+
<td><tt>-wd</tt> <name>=<value></td>
|
| 253 |
+
<td>Define a variable for use within expressions.
|
| 254 |
+
</td>
|
| 255 |
+
</tr>
|
| 256 |
+
<tr>
|
| 257 |
+
<td><tt>-x</tt></td>
|
| 258 |
+
<td>Synchronous drawing mode (non-threaded). This mode can be useful if scripts are run which produce screen snapshots. By using
|
| 259 |
+
this option is made sure that all drawing operations have finished before the snapshot method returns.</td>
|
| 260 |
+
</tr>
|
| 261 |
+
<tr>
|
| 262 |
+
<td><tt>-y</tt> <package></td>
|
| 263 |
+
<td>Automatic package installation mode. If used, will install the requested package and exit.
|
| 264 |
+
Can be used more than once. 'package' is a name or an URL and optionally a version in round
|
| 265 |
+
brackets. Plain '-y' will only install the given package. Use '-yd' to automatically
|
| 266 |
+
include dependencies in the installation.</td>
|
| 267 |
+
</tr>
|
| 268 |
+
<tr>
|
| 269 |
+
<td><tt>-yd</tt></td>
|
| 270 |
+
<td>Used together with '-y': automatically include dependencies in the installation.</td>
|
| 271 |
+
</tr>
|
| 272 |
+
<tr>
|
| 273 |
+
<td><tt>-z</tt></td>
|
| 274 |
+
<td>Non-GUI mode. KLayout will not bring up the user interface. See the "<tt>-r"</tt> option for useful applications of this option.
|
| 275 |
+
Please note that on Linux, this mode still requires a display connection.</td>
|
| 276 |
+
</tr>
|
| 277 |
+
<tr>
|
| 278 |
+
<td><tt>-zz</tt></td>
|
| 279 |
+
<td>Non-GUI mode. In that mode, the GUI is disabled completely. On Linux, this mode allows to
|
| 280 |
+
use KLayout as a script interpreter for Ruby scripts without a display connection. However,
|
| 281 |
+
some Ruby objects are not available (i.e. MainWindow).
|
| 282 |
+
</td>
|
| 283 |
+
</tr>
|
| 284 |
+
</table>
|
| 285 |
+
|
| 286 |
+
<h2>Special Options</h2>
|
| 287 |
+
<table width="90%">
|
| 288 |
+
<tr>
|
| 289 |
+
<td width="20%"><tt>-gr</tt> <file name></td>
|
| 290 |
+
<td>Record GUI actions in the given file for test purposes.</td>
|
| 291 |
+
</tr>
|
| 292 |
+
<tr>
|
| 293 |
+
<td><tt>-gp</tt> <file name></td>
|
| 294 |
+
<td>Replay the GUI actions from the given file for test purposes.</td>
|
| 295 |
+
</tr>
|
| 296 |
+
<tr>
|
| 297 |
+
<td><tt>-gb</tt> <line number></td>
|
| 298 |
+
<td>Stop replaying GUI actions at the given line for test purposes.</td>
|
| 299 |
+
</tr>
|
| 300 |
+
<tr>
|
| 301 |
+
<td><tt>-gx</tt> <milliseconds></td>
|
| 302 |
+
<td>Replay rate for GUI test file for test purposes.</td>
|
| 303 |
+
</tr>
|
| 304 |
+
<tr>
|
| 305 |
+
<td><tt>-gi</tt></td>
|
| 306 |
+
<td>Incremental logs on the GUI record file (crash safe logging).</td>
|
| 307 |
+
</tr>
|
| 308 |
+
<tr>
|
| 309 |
+
<td><tt>-y</tt> <package name></td>
|
| 310 |
+
<td>Package installation: install package(s) and exit - can be used more than once
|
| 311 |
+
('package' is a name, an URL and optionally a version in round brackets)</td>
|
| 312 |
+
</tr>
|
| 313 |
+
<tr>
|
| 314 |
+
<td><tt>-yd</tt></td>
|
| 315 |
+
<td>With -y: include dependencies.</td>
|
| 316 |
+
</tr>
|
| 317 |
+
</table>
|
| 318 |
+
|
| 319 |
+
<h2>Environment variables</h2>
|
| 320 |
+
|
| 321 |
+
<p>
|
| 322 |
+
KLayout reads the following environment variables:
|
| 323 |
+
</p>
|
| 324 |
+
|
| 325 |
+
<ul>
|
| 326 |
+
<li>
|
| 327 |
+
<tt>$KLAYOUT_PATH</tt>: contains a series of search locations separated by a ":" on Linux or ";" on Windows.
|
| 328 |
+
These are the locations searched for macros, libraries, plugins, ruby modules etc.
|
| 329 |
+
The first entry of that path will be the one where the configuration is stored when KLayout exits.
|
| 330 |
+
The installation site (where the KLayout executable resides) is always part of the search path. It cannot be disabled.
|
| 331 |
+
</li>
|
| 332 |
+
<li>
|
| 333 |
+
<tt>$KLAYOUT_HOME</tt>: This is the place where KLayout keeps the configuration files, local macros and
|
| 334 |
+
technology files. By default, this place is "~/.klayout" on Linux and "%HOME%/KLayout" on Windows.
|
| 335 |
+
</li>
|
| 336 |
+
<li>
|
| 337 |
+
<tt>$KLAYOUT_SALT_MINE</tt>: Contains the URL the package manager ("Salt Mine") will pull the package list from.
|
| 338 |
+
By default, the global package index is used. This environment variable can be used to provide a local package
|
| 339 |
+
index.
|
| 340 |
+
</li>
|
| 341 |
+
<li>
|
| 342 |
+
<tt>$KLAYOUT_PYTHONPATH</tt>: Used by the Python interpreter instead of "PYTHONHOME". This path can be used
|
| 343 |
+
to establish a Python search path.
|
| 344 |
+
</li>
|
| 345 |
+
</ul>
|
| 346 |
+
|
| 347 |
+
|
| 348 |
+
</div>
|
| 349 |
+
</body>
|
| 350 |
+
</html>
|
| 351 |
+
|
html/klayout_docs/www.klayout.de/contact.html
ADDED
|
@@ -0,0 +1,117 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
|
| 33 |
+
|
| 34 |
+
</head>
|
| 35 |
+
|
| 36 |
+
<body>
|
| 37 |
+
|
| 38 |
+
<div class="klayout-header">
|
| 39 |
+
|
| 40 |
+
<div class="container mb-5">
|
| 41 |
+
|
| 42 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 43 |
+
|
| 44 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 45 |
+
|
| 46 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 47 |
+
|
| 48 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 49 |
+
|
| 50 |
+
<li class="nav-item dropdown active mr-4">
|
| 51 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 52 |
+
About
|
| 53 |
+
</a>
|
| 54 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 55 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 56 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 59 |
+
<div class="dropdown-divider"></div>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 61 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 63 |
+
</div>
|
| 64 |
+
</li>
|
| 65 |
+
<li class="nav-item active mr-4">
|
| 66 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 67 |
+
</li>
|
| 68 |
+
<li class="nav-item active mr-4">
|
| 69 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 70 |
+
</li>
|
| 71 |
+
<li class="nav-item active mr-5">
|
| 72 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 73 |
+
</li>
|
| 74 |
+
<li class="nav-item active">
|
| 75 |
+
<span class="nav-link klayout-menu">
|
| 76 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 77 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 78 |
+
</span>
|
| 79 |
+
</li>
|
| 80 |
+
|
| 81 |
+
</ul>
|
| 82 |
+
|
| 83 |
+
</div>
|
| 84 |
+
|
| 85 |
+
<!-- collapse button -->
|
| 86 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 87 |
+
<span class="navbar-toggler-icon"></span>
|
| 88 |
+
</button>
|
| 89 |
+
|
| 90 |
+
</nav>
|
| 91 |
+
|
| 92 |
+
</div>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
<div class="container">
|
| 97 |
+
<h1>Contact</h1>
|
| 98 |
+
|
| 99 |
+
<p>
|
| 100 |
+
For suggestions, praise and support, please email to: <b>contact @ klayout . de</b>
|
| 101 |
+
</p>
|
| 102 |
+
|
| 103 |
+
<p>
|
| 104 |
+
For bug reports, community support, source code and project pulse, visit KLayout on
|
| 105 |
+
GitHub: <a href="https://github.com/klayoutmatthias/klayout"/>https://github.com/klayoutmatthias/klayout</a>.
|
| 106 |
+
</p>
|
| 107 |
+
|
| 108 |
+
<p>
|
| 109 |
+
For bug reports please provide a testcase if possible. In any case, I need a detailed description of
|
| 110 |
+
how to reproduce the bug. Please also provide information about the build and system it is run on.
|
| 111 |
+
</p>
|
| 112 |
+
|
| 113 |
+
|
| 114 |
+
</div>
|
| 115 |
+
</body>
|
| 116 |
+
</html>
|
| 117 |
+
|
html/klayout_docs/www.klayout.de/credits.html
ADDED
|
@@ -0,0 +1,234 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
|
| 33 |
+
|
| 34 |
+
</head>
|
| 35 |
+
|
| 36 |
+
<body>
|
| 37 |
+
|
| 38 |
+
<div class="klayout-header">
|
| 39 |
+
|
| 40 |
+
<div class="container mb-5">
|
| 41 |
+
|
| 42 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 43 |
+
|
| 44 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 45 |
+
|
| 46 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 47 |
+
|
| 48 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 49 |
+
|
| 50 |
+
<li class="nav-item dropdown active mr-4">
|
| 51 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 52 |
+
About
|
| 53 |
+
</a>
|
| 54 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 55 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 56 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 59 |
+
<div class="dropdown-divider"></div>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 61 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 63 |
+
</div>
|
| 64 |
+
</li>
|
| 65 |
+
<li class="nav-item active mr-4">
|
| 66 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 67 |
+
</li>
|
| 68 |
+
<li class="nav-item active mr-4">
|
| 69 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 70 |
+
</li>
|
| 71 |
+
<li class="nav-item active mr-5">
|
| 72 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 73 |
+
</li>
|
| 74 |
+
<li class="nav-item active">
|
| 75 |
+
<span class="nav-link klayout-menu">
|
| 76 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 77 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 78 |
+
</span>
|
| 79 |
+
</li>
|
| 80 |
+
|
| 81 |
+
</ul>
|
| 82 |
+
|
| 83 |
+
</div>
|
| 84 |
+
|
| 85 |
+
<!-- collapse button -->
|
| 86 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 87 |
+
<span class="navbar-toggler-icon"></span>
|
| 88 |
+
</button>
|
| 89 |
+
|
| 90 |
+
</nav>
|
| 91 |
+
|
| 92 |
+
</div>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
<div class="container">
|
| 97 |
+
|
| 98 |
+
<h1>Credits</h1>
|
| 99 |
+
|
| 100 |
+
<h2>Community</h2>
|
| 101 |
+
|
| 102 |
+
<p>Thanks to all the users sending me bug reports and spending a lot of time testing the software and reproducing bugs and helping with the releases.
|
| 103 |
+
</p>
|
| 104 |
+
|
| 105 |
+
<p>
|
| 106 |
+
Thanks for the numerous test cases I received and which I could hardly unearth myself. I know how painful it is to strip
|
| 107 |
+
every trace of intellectual property. Development would be impossible without that effort.
|
| 108 |
+
</p>
|
| 109 |
+
|
| 110 |
+
<p>
|
| 111 |
+
And finally: thanks for not stopping to bug me ... :-)
|
| 112 |
+
</p>
|
| 113 |
+
|
| 114 |
+
|
| 115 |
+
<h2>Tools</h2>
|
| 116 |
+
|
| 117 |
+
<p>
|
| 118 |
+
KLayout won't be there if there was not a basis I could build upon.
|
| 119 |
+
I have some companions and it's time to mention them here ...
|
| 120 |
+
</p>
|
| 121 |
+
|
| 122 |
+
<table>
|
| 123 |
+
<tr>
|
| 124 |
+
<td><img src="credits_qt.png" border="0"/></td>
|
| 125 |
+
<td>
|
| 126 |
+
<h3>Qt</h3>
|
| 127 |
+
<p><a href="http://qt-project.org">http://qt-project.org</a></p>
|
| 128 |
+
<p>The ultimate framework. Portable, comprehensible, fast, complete, ... There is little you will miss
|
| 129 |
+
and much to discover. Dedicated to open source development, extensibility and in many ways a reference for
|
| 130 |
+
coding quality. My reliable companion for more than a decade now. A+ rating, at least.
|
| 131 |
+
</p>
|
| 132 |
+
</td>
|
| 133 |
+
</tr>
|
| 134 |
+
<tr>
|
| 135 |
+
<td><img src="credits_trac.png" border="0"/></td>
|
| 136 |
+
<td>
|
| 137 |
+
<h3>Trac</h3>
|
| 138 |
+
<p><a href="http://trac.edgewall.org">http://trac.edgewall.org</a></p>
|
| 139 |
+
<p>Lightweight, fast and complete issue tracking, Wiki collaboration platform and lean project management.
|
| 140 |
+
Perfect integration with Subversion. My faithful tracker since many years. What else do you need?
|
| 141 |
+
</p>
|
| 142 |
+
</td>
|
| 143 |
+
</tr>
|
| 144 |
+
<tr>
|
| 145 |
+
<td><img src="credits_vim.png" border="0"/></td>
|
| 146 |
+
<td>
|
| 147 |
+
<h3>gvim</h3>
|
| 148 |
+
<p><a href="http://www.vim.org">http://www.vim.org</a></p>
|
| 149 |
+
<p>I've tried them all: Visual Studio, Eclipse and all the others. VIM looks like last century, but
|
| 150 |
+
I'm missing something without it. Maybe the busy sound of little beeps? Or the fingers gliding smoothly over the keyboard,
|
| 151 |
+
knowing every key has at least a second purpose? <tt>/this[Esc]cwsomethingelse[Esc]n.n.n.n.</tt> ... don't care about the mouse or
|
| 152 |
+
the RSI syndrome.
|
| 153 |
+
</p>
|
| 154 |
+
<p>Love it or hate it. I'll choose the first.
|
| 155 |
+
</p>
|
| 156 |
+
</td>
|
| 157 |
+
</tr>
|
| 158 |
+
<tr>
|
| 159 |
+
<td><img src="credits_ruby.png" border="0"/></td>
|
| 160 |
+
<td>
|
| 161 |
+
<h3>Ruby</h3>
|
| 162 |
+
<p><a href="https://www.ruby-lang.org">https://www.ruby-lang.org</a></p>
|
| 163 |
+
<p>No more hacking Perl, no more cursing Tcl ... just the language you need. Almost a Zen experience. Consistent,
|
| 164 |
+
lean, simple. A gem among the scripting languages and truly the programmer's best friend.
|
| 165 |
+
</p>
|
| 166 |
+
</td>
|
| 167 |
+
</tr>
|
| 168 |
+
<tr>
|
| 169 |
+
<td><img src="credits_svn.png" border="0"/></td>
|
| 170 |
+
<td>
|
| 171 |
+
<h3>Subversion</h3>
|
| 172 |
+
<p><a href="https://subversion.apache.org">https://subversion.apache.org</a></p>
|
| 173 |
+
<p>Yes, I know, there is the great other tool. But what if I'm not a whole community? I'll just stay with subversion -
|
| 174 |
+
lean, simple and stable. Never had a fail in ten years and well, it's okay I can't delete anything.
|
| 175 |
+
</p>
|
| 176 |
+
</td>
|
| 177 |
+
</tr>
|
| 178 |
+
<tr>
|
| 179 |
+
<td><img src="credits_inkscape.png" border="0"/></td>
|
| 180 |
+
<td>
|
| 181 |
+
<h3>Inkscape</h3>
|
| 182 |
+
<p><a href="http://www.inkscape.org">http://www.inkscape.org</a></p>
|
| 183 |
+
<p>Great tool and fun to work with. Without it, SVG would be a scary thing.
|
| 184 |
+
</p>
|
| 185 |
+
</td>
|
| 186 |
+
</tr>
|
| 187 |
+
<tr>
|
| 188 |
+
<td><img src="credits_valgrind.png" border="0"/></td>
|
| 189 |
+
<td>
|
| 190 |
+
<h3>Valgrind</h3>
|
| 191 |
+
<p><a href="http://valgrind.org">http://valgrind.org</a></p>
|
| 192 |
+
<p>Definitely essential. Memory checker, performance analyzer, debugger ... one tool for all and
|
| 193 |
+
no rebuilding. Amazing tool which helped me out of trouble in more than one case. Any have a look at
|
| 194 |
+
<a href="http://kcachegrind.sourceforge.net">KCachegrind</a> for an amazing experience of performance
|
| 195 |
+
analysis.
|
| 196 |
+
</p>
|
| 197 |
+
</td>
|
| 198 |
+
</tr>
|
| 199 |
+
<tr>
|
| 200 |
+
<td></td>
|
| 201 |
+
<td>
|
| 202 |
+
<h3>Coverity</h3>
|
| 203 |
+
<p><a href="http://www.coverity.com">http://www.coverity.com</a></p>
|
| 204 |
+
<p>Commerical tool with a heart for open source projects. They provide access to their static code analysis
|
| 205 |
+
engine for registered open source projects. Amazingly powerful, C++ aware and easy to use.
|
| 206 |
+
</p>
|
| 207 |
+
</td>
|
| 208 |
+
</tr>
|
| 209 |
+
<tr>
|
| 210 |
+
<td></td>
|
| 211 |
+
<td>
|
| 212 |
+
<h3>Vanilla</h3>
|
| 213 |
+
<p><a href="http://vanillaforums.org">http://vanillaforums.org</a></p>
|
| 214 |
+
<p>Powers the forum on the web site. Super easy to install, simple administration and customizable to every degree - if you like
|
| 215 |
+
CSS and PHP.
|
| 216 |
+
</p>
|
| 217 |
+
</td>
|
| 218 |
+
</tr>
|
| 219 |
+
<tr>
|
| 220 |
+
<td></td>
|
| 221 |
+
<td>
|
| 222 |
+
<h3>And many more ...</h3>
|
| 223 |
+
<p>The GNU toolchain, GIMP, TurtoiseSVN and all those other little and big helpers. Too many to mention and
|
| 224 |
+
every one an adorable piece of software.
|
| 225 |
+
</p>
|
| 226 |
+
</td>
|
| 227 |
+
</tr>
|
| 228 |
+
</table>
|
| 229 |
+
|
| 230 |
+
|
| 231 |
+
</div>
|
| 232 |
+
</body>
|
| 233 |
+
</html>
|
| 234 |
+
|
html/klayout_docs/www.klayout.de/development.html
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
html/klayout_docs/www.klayout.de/doc-qt5/about/25d_view.html
ADDED
|
@@ -0,0 +1,255 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » The 2.5d View</p><h1>The 2.5d View</h1><a name="k_1"></a><a name="k_2"></a><a name="k_3"></a><a name="k_4"></a><ul><li><a href="#h2-66">2.5d Script Anatomy</a></li><li><a href="#h2-199">Navigating the 2.5d View</a></li><li><a href="#h2-241">Colors in the 2.5d View</a></li><li><a href="#h2-252">Other Controls</a></li><li><a href="#h2-269">Material Visibility</a></li></ul><p>
|
| 120 |
+
The "2.5d view" offers a semi-3d view of the layout. It's not a full 3d view as the layers are only extruded vertically
|
| 121 |
+
into layers with a certain thickness. The view cannot model process topology, but it can visualize
|
| 122 |
+
wiring congestions in a three-dimensional space or the vertical relative dimensions of features of the process stack.
|
| 123 |
+
</p><p>
|
| 124 |
+
Currently, the performance is limited, a rough number for a
|
| 125 |
+
practical limit is around 100k polygons. The 2.5d view is only available, if KLayout was compiled with
|
| 126 |
+
OpenGL support.
|
| 127 |
+
</p><p>
|
| 128 |
+
In order to use the tool, you will need a script generating the material stack.
|
| 129 |
+
Such a script is a variant of a DRC script (see <a href="../manual/drc.html">Design Rule Check (DRC)</a>).
|
| 130 |
+
The DRC language is used to import or generate polygon layers which are then
|
| 131 |
+
extruded and placed on a certain z level.
|
| 132 |
+
</p><p>
|
| 133 |
+
To create a new script, use "Tools/2.5d View/New 2.5d Script". This will create a new script in the
|
| 134 |
+
macro editor.
|
| 135 |
+
</p><p>
|
| 136 |
+
A simple script is this one. It takes two layers - 1/0 and 2/0 - and extrudes then in a
|
| 137 |
+
stacked fashion, the first with 200nm thickness and the second one with 300nm:
|
| 138 |
+
</p><pre>
|
| 139 |
+
z(input(1, 0), zstart: 0.1.um, height: 200.nm) # extrudes layer 1/0 to a height of 200nm starting at z=100nm
|
| 140 |
+
z(input(2, 0), height: 300.nm) # adds layer 2/0 for the next 300nm
|
| 141 |
+
</pre><p>
|
| 142 |
+
To run the script, use the "Run" button from the macro IDE or pick the script
|
| 143 |
+
from the script list in the "Tools/2.5d View" menu. If your script is not shown in that
|
| 144 |
+
menu, check if it is configured to be bound to a menu item.
|
| 145 |
+
</p><p>
|
| 146 |
+
After the script was executed, the 2.5d window is displayed. If you closed that window, you can
|
| 147 |
+
re-open it with "Tools/2.5d View/Open Window". The window will show the layout section visible
|
| 148 |
+
in the layout view. To refresh the scene - also after changing the script - either run the script
|
| 149 |
+
again from the macro IDE or use the green "re-run" button in the upper left corner of the 2.5d view
|
| 150 |
+
window.
|
| 151 |
+
</p><p><img src="25d_screenshot.png"></p><a name="h2-66"></a><h2>2.5d Script Anatomy</h2><p>
|
| 152 |
+
As mentioned, a 2.5d script is a variant of a DRC script. You can basically use all features
|
| 153 |
+
of DRC, specifically boolean operations. Some practical restrictions exist:
|
| 154 |
+
</p><ul><li>You should not use external sources ("source" statement) as the 2.5d view is related to the loaded layout</li><li>Report generation or "output" statements are permitted, but do not make much sense in the context
|
| 155 |
+
of 2.5d view scripts.</li></ul><p>
|
| 156 |
+
2.5d scripts utilizes the DRC language with these two additional functions:
|
| 157 |
+
</p><ul><li><p><tt>z(</tt>layer [, options]<tt>)</tt></p><p>Extrudes the given layer. "layer" is a DRC layer (polygon, edge or even edge pair). "options" declare the z extrusion and display parameters.</p></li><li><p><tt>zz(</tt> [options] <tt>) {</tt> block <tt>}</tt></p><p>Declares a material group which combines multiple "z" statements under a single display group.
|
| 158 |
+
This allows generating 3d material geometries which are more than a single extruded plane.
|
| 159 |
+
The display parameters then are specified within "zz" for all "z" calls inside the block.</p></li></ul><a name="h3-94"></a><h3>"z" Function (plane extrusion)</h3><a name="k_5"></a><p>
|
| 160 |
+
The layer argument of the function is a DRC layer which is rendered as an extruded sheet.
|
| 161 |
+
Further arguments control the height, z location and colors.
|
| 162 |
+
When used inside the "zz" block, the color options of the "z" calls are ignored and
|
| 163 |
+
taken from "zz" instead.
|
| 164 |
+
</p><p>
|
| 165 |
+
Options for this function are:
|
| 166 |
+
</p><ul><li><b>zstart</b>: specifies the bottom coordinate of the extruded sheet. If this option is not given, the top coordinate of the previous "z" statement is used.</li><li><b>zstop</b>: specifies the top coordinate of the extruded sheet. Alternatively you can use "height".</li><li><b>height</b>: specifies the extrusion height. Alternatively you can use "zstop".</li><li><b>color</b>: specifies the color to use as a 24 bit hex RGB triplet (use "0xrrggbb" to specify the color similar to the HTML notation "#rrggbb").
|
| 167 |
+
A color specification gives a single color with not differentiation of frame and wall colors.</li><li><b>frame</b>: specifies the frame color to use as a 24 bit hex RGB triplet. If only a frame color is specified, the geometry will be rendered as wire frame only.</li><li><b>fill</b>: specifies the fill (wall) color to use as a 24 bit hex RGB triplet. This allows specifying a different color for wall and frame when used with "frame".</li><li><b>like</b>: specifies to use the same colors than used for some layer in the layout view.
|
| 168 |
+
If the layer is an original layer (i.e. taken from "input"), "like" defaults to the
|
| 169 |
+
original layer's source. If given, "like" needs to be a string representation of the
|
| 170 |
+
layer source (e.g. "7/0" for layer 7, datatype 0).</li><li><b>name</b>: gives the material a name for displaying in the material list.</li></ul><p>
|
| 171 |
+
Examples for the extrusion options:
|
| 172 |
+
</p><pre>
|
| 173 |
+
z(layer, 0.1 .. 0.2) extrude layer to z = 0.1 to 0.2 um
|
| 174 |
+
z(layer, zstart: 0.1, zstop: 0.2) same as above
|
| 175 |
+
z(layer, zstart: 0.1, height: 0.1) same as above, but with height instead of zstop
|
| 176 |
+
z(layer, height: 200.nm) extrude layer from last z position with a height of 200nm
|
| 177 |
+
</pre><p>
|
| 178 |
+
Examples for display options:
|
| 179 |
+
</p><pre>
|
| 180 |
+
z(..., color: 0xff0000) use bright red for the material color (RGB)
|
| 181 |
+
z(..., frame: 0xff0000) use bright red for the frame color (combine with "fill" for the fill color)
|
| 182 |
+
z(..., fill: 0x00ff00) use bright green for the fill color along (combine with "frame" for the frame color)
|
| 183 |
+
z(..., like: "7/0") borrow style from layout view's style for layer "7/0"
|
| 184 |
+
z(..., name: "M1") assigns a name to show for the material
|
| 185 |
+
</pre><a name="h3-146"></a><h3>"zz" Function (material groups)</h3><a name="k_6"></a><p>
|
| 186 |
+
The "zz" function forms a display group which clusters multiple "z" calls. The basic usage is with a block
|
| 187 |
+
containing the "z" calls. As DRC scripts are Ruby, the notation for the block is either "do .. end" or
|
| 188 |
+
curly brackets immediately after the "zz" call:
|
| 189 |
+
</p><pre>
|
| 190 |
+
zz( display options ... ) do
|
| 191 |
+
z(layer1, extrusion options ... )
|
| 192 |
+
z(layer2, extrusion options ... )
|
| 193 |
+
...
|
| 194 |
+
end
|
| 195 |
+
</pre><p>
|
| 196 |
+
The "z" calls do not need to have colors or other display options as they are
|
| 197 |
+
taken from "zz".
|
| 198 |
+
</p><p>
|
| 199 |
+
Material groups allow forming more complex, stacked geometries. Here is an example
|
| 200 |
+
forming a simple FinFET geometry using boolean and a sizing operation:
|
| 201 |
+
</p><pre>
|
| 202 |
+
gate = input(1, 0)
|
| 203 |
+
active = input(2, 0)
|
| 204 |
+
|
| 205 |
+
z(active, zstart: 0, height: 20.nm, name: "ACTIVE")
|
| 206 |
+
|
| 207 |
+
zz(name: "GATE", like: "1/0") do
|
| 208 |
+
|
| 209 |
+
active_sized = active.sized(10.nm)
|
| 210 |
+
gate_over_active_sized = active_sized & gate
|
| 211 |
+
|
| 212 |
+
z(gate - active, zstart: 0, height: 10.nm)
|
| 213 |
+
z(gate_over_active_sized - active, height: 10.nm)
|
| 214 |
+
z(gate_over_active_sized, height: 10.nm)
|
| 215 |
+
|
| 216 |
+
end
|
| 217 |
+
</pre><p>
|
| 218 |
+
Which renders this result:
|
| 219 |
+
</p><p><img src="25d_screenshot2.png"></p><a name="h2-199"></a><h2>Navigating the 2.5d View</h2><a name="k_7"></a><a name="k_8"></a><p>
|
| 220 |
+
The navigation is based on the movement of the camera while the scene is
|
| 221 |
+
formed by the extruded layout. The scene can be scaled to provide zoom features.
|
| 222 |
+
Scaling and rotation is relative to the pivot point which is indicated by the
|
| 223 |
+
compass icon on the ground plane.
|
| 224 |
+
</p><p>
|
| 225 |
+
This is a short list of the navigation controls which act on the camera:
|
| 226 |
+
</p><ul><li> Dragging with the right mouse button down: change azimuth and elevation angle </li><li> Dragging with the middle mouse button down: move the pivot up and down or left and right </li><li> Mouse wheel: moves the pivot forward and backward </li><li> Control key + mouse wheel: magnify or shrink the layout </li><li> Press and hold shift key: switch to top level view (see below) </li><li> Up/down keys: move the pivot forward or backward </li><li> Left/right keys: move the pivot to the left or the right </li><li> Control + up/down keys: change the elevation angle </li><li> Control + left/right keys: change the azimuth angle </li></ul><p>
|
| 227 |
+
In top level view, the navigation is slightly different:
|
| 228 |
+
</p><ul><li> Dragging with the right mouse button down: change azimuth angle </li><li> mouse wheel: magnify or shrink the layout </li><li> Up/down/left/right keys: move the pivot on the horizontal plane </li></ul><p>
|
| 229 |
+
Note: if the Shift key does not switch to top level view, click into the
|
| 230 |
+
scene view once.
|
| 231 |
+
</p><a name="h2-241"></a><h2>Colors in the 2.5d View</h2><p>
|
| 232 |
+
While the 2.5d view window is open, the layout view is still active. Layer
|
| 233 |
+
colors are applied also to the 2.5d view. Changing the fill color will change
|
| 234 |
+
the 2.5d view's face color. The frame color will be applied to the wire frame.
|
| 235 |
+
If a hollow stipple is selected, only the wire frame is shown. If a layer is
|
| 236 |
+
made invisible in the layout view, the corresponding blocks will also be
|
| 237 |
+
made invisible in the 2.5d view.
|
| 238 |
+
</p><a name="h2-252"></a><h2>Other Controls</h2><p>
|
| 239 |
+
The left zoom slider changes the overall scale factor. The right slider only changes the z (height) axis zoom factor.
|
| 240 |
+
This is useful as in many cases, the real height profile will result in a rather flat arrangement. Increasing the
|
| 241 |
+
z zoom factor will exaggerate the vertical axis hence making height variations more pronounced.
|
| 242 |
+
</p><p>
|
| 243 |
+
The edit boxes next to the scale sliders allow entering the scale factors manually.
|
| 244 |
+
</p><p>
|
| 245 |
+
The button bar at the top right side holds the view presets. Use them to reset the window to
|
| 246 |
+
front view, top view etc.
|
| 247 |
+
</p><a name="h2-269"></a><h2>Material Visibility</h2><p>
|
| 248 |
+
Using the check boxes from the material view right of the scene view you can disable
|
| 249 |
+
materials, so they are no longer rendered. From the material list's context menu,
|
| 250 |
+
you can hide or show all materials or just the selected ones.
|
| 251 |
+
</p></div>
|
| 252 |
+
</div>
|
| 253 |
+
</body>
|
| 254 |
+
</html>
|
| 255 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/about_libraries.html
ADDED
|
@@ -0,0 +1,163 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About Libraries</p><h1>About Libraries</h1><a name="k_1"></a><a name="k_2"></a><p>
|
| 120 |
+
Starting with version 0.22, KLayout offers a library concept.
|
| 121 |
+
Libraries are a way to import cell layout into a layout from the outside and
|
| 122 |
+
thus a convenient way to provide standard building blocks for the layout.
|
| 123 |
+
Using a cell from a library is easy: when asked for a cell, select
|
| 124 |
+
the library where to take the cell from and choose a cell from that
|
| 125 |
+
library.
|
| 126 |
+
</p><p>
|
| 127 |
+
Libraries are basically just foreign layouts that are virtually linked
|
| 128 |
+
to the current layout. When a cell is imported from a library, it is
|
| 129 |
+
copied into the current layout, so that the current layout by itself
|
| 130 |
+
is a valid entity.
|
| 131 |
+
</p><p>
|
| 132 |
+
When a layout containing library references is saved, KLayout stores
|
| 133 |
+
some meta information in that file which allows it to restore the
|
| 134 |
+
library links and related information.
|
| 135 |
+
For GDS, that meta information is stored in a separate top cell. For OASIS,
|
| 136 |
+
the meta information is stored in special per-cell properties.
|
| 137 |
+
For other formats, the meta information is not stored currently.
|
| 138 |
+
</p><p>
|
| 139 |
+
Libraries can be provided in several ways:
|
| 140 |
+
</p><ul><li><p><b>As ordinary layout files:</b>
|
| 141 |
+
Such libraries are simple layout files (GDS, OASIS or other support format). KLayout looks up
|
| 142 |
+
those libraries in the "libraries" subfolders of the search path and gathers all layout files
|
| 143 |
+
it finds there into the library repository.</p><p>The search path usually includes the installation site (where the KLayout executable resides)
|
| 144 |
+
and the application folder (i.e. "~/.klayout" on Linux). Hence libraries can be installed
|
| 145 |
+
locally (i.e. in "~/.klayout/libraries") or globally (at the installation site).
|
| 146 |
+
</p><p>
|
| 147 |
+
For GDS files, the library name will be the LIBNAME of the GDS file. Otherwise it will be the
|
| 148 |
+
name of the library file minus the extension.
|
| 149 |
+
</p></li><li><b>Coded libraries:</b>
|
| 150 |
+
Such libraries are provided by code, either through shared objects/DLL's or through Ruby code.
|
| 151 |
+
Basically such code has to provide a layout object containing the library cells.
|
| 152 |
+
A coded library can also provide PCells (parametrized cells) as library components.
|
| 153 |
+
Sell <a href="about_pcells.html">About PCells</a> for details about parametrized cells.
|
| 154 |
+
</li></ul><p>
|
| 155 |
+
Starting with version 0.25, libraries can be provides through packages. This means, they can be downloaded from some
|
| 156 |
+
repository and can be managed within the package manager. Library installation is very simple
|
| 157 |
+
this way. Library deinstallation too. See <a href="packages.html">About Packages</a> for details
|
| 158 |
+
about packages.
|
| 159 |
+
</p></div>
|
| 160 |
+
</div>
|
| 161 |
+
</body>
|
| 162 |
+
</html>
|
| 163 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/about_pcells.html
ADDED
|
@@ -0,0 +1,170 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About PCells</p><h1>About PCells</h1><p>
|
| 120 |
+
Starting with version 0.22, KLayout offers parametrized cells (PCells).
|
| 121 |
+
PCells are a feature found in other tools to simplify layout by providing generators
|
| 122 |
+
for common layout building blocks. Parametrized cells do not contain
|
| 123 |
+
static layout but are created dynamically by code using a given set of parameters.
|
| 124 |
+
</p><p>
|
| 125 |
+
For example, a circle PCell requires two parameters: the layer where the circle
|
| 126 |
+
should be produced and the radius of the circle to produce. The code is responsible
|
| 127 |
+
for creating the circle from these parameters.
|
| 128 |
+
</p><p>
|
| 129 |
+
Using a PCell is easy: choose the library and the PCell from that library when asked for
|
| 130 |
+
the cell in the instance options dialog. For PCells, KLayout offers an additional
|
| 131 |
+
parameters page where it asks for the parameter required by the PCell. The placement
|
| 132 |
+
of the PCell is done as for simple instances. PCells offer the same instantiation
|
| 133 |
+
options that normal cells.
|
| 134 |
+
</p><p>
|
| 135 |
+
KLayout provides a simple library called "Basic" with some useful basic PCells.
|
| 136 |
+
See <a href="basic_lib.html">About The Basic Library</a> for more details about that library.
|
| 137 |
+
</p><p>
|
| 138 |
+
Unlike other tools, KLayout offers the unique feature of "guiding shapes". A guiding shape
|
| 139 |
+
is some kind of "ghost shape" that is not produced as real layout but is present as a
|
| 140 |
+
part of the PCell instance. It is drawn in the style of the cell frame but can be edited
|
| 141 |
+
as a normal shape. In particular, a guiding shape can be manipulated with the properties
|
| 142 |
+
dialog and the partial edit mode. A special case is a point-like shape which can act
|
| 143 |
+
as a handle of the PCell. In move mode, these shapes can be moved to change the parameter
|
| 144 |
+
related to that handle.
|
| 145 |
+
</p><p>
|
| 146 |
+
Another use case for guiding shapes is the rounded path. This PCell uses a path as the
|
| 147 |
+
input shape and applies rounding to the path's spine corners to compute a new path
|
| 148 |
+
which smoothly bends around the corners. The radius of the bends is a numerical
|
| 149 |
+
PCell parameter while the input shape controlling the geometry and the width of the
|
| 150 |
+
path is the guiding shape.
|
| 151 |
+
</p><p>
|
| 152 |
+
A PCell implementation consists of at least three parts:
|
| 153 |
+
a description text, a parameter declaration and a production callback. In addition, a PCell
|
| 154 |
+
can provide a method that "fixes" parameters according to the PCells consistency rules
|
| 155 |
+
(coerce parameters). Technically, a PCell is a class implementing a certain interface with
|
| 156 |
+
these methods.
|
| 157 |
+
</p><p>
|
| 158 |
+
PCells are usually packed in libraries. PCell libraries can be provided as
|
| 159 |
+
shared objects/DLL's (in C++) or as Ruby scripts. Because PCell code is only executed if
|
| 160 |
+
required, performance usually is not the main objective. A Ruby implementation
|
| 161 |
+
will therefore be sufficient in most cases and
|
| 162 |
+
is a much easier to maintain. The Ruby approach also benefits from KLayout's integrated development
|
| 163 |
+
environment.
|
| 164 |
+
</p><p>
|
| 165 |
+
For an introduction into PCell programming with Ruby, see <a href="../programming/ruby_pcells.html">Coding PCells In Ruby</a>.
|
| 166 |
+
</p></div>
|
| 167 |
+
</div>
|
| 168 |
+
</body>
|
| 169 |
+
</html>
|
| 170 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/basic_lib.html
ADDED
|
@@ -0,0 +1,198 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About The Basic Library</p><h1>About The Basic Library</h1><ul><li><a href="#h2-10">The "Basic" library</a></li><li><a href="#h2-44">TEXT</a></li><li><a href="#h2-89">CIRCLE and ELLIPSE</a></li><li><a href="#h2-101">DONUT</a></li><li><a href="#h2-113">PIE and ARC</a></li><li><a href="#h2-125">ROUND_PATH</a></li><li><a href="#h2-143">ROUND_POLYGON</a></li><li><a href="#h2-161">STROKED_POLYGON or STROKED_BOX</a></li></ul><a name="h2-10"></a><h2>The "Basic" library</h2><p>
|
| 120 |
+
The "Basic" Library provides some useful generic PCells.
|
| 121 |
+
One use model is to draw a shape and convert the shape to one
|
| 122 |
+
of the provided PCells. This use model is suitable for creating
|
| 123 |
+
Circles, Ellipses, Donuts, Texts and rounded and stroked polygons or
|
| 124 |
+
rounded paths.
|
| 125 |
+
</p><p>
|
| 126 |
+
To use that feature, draw the shape and choose "Convert To PCells"
|
| 127 |
+
from the "Edit"/"Selection" menu. A dialog will be shown where the
|
| 128 |
+
target PCell can be selected. Only those PCells supporting that
|
| 129 |
+
shape type will be shown.
|
| 130 |
+
</p><p>
|
| 131 |
+
The "Basic" library provides the following PCells:
|
| 132 |
+
</p><ul><li><b>TEXT</b>: A text generator</li><li><b>CIRCLE</b>: A circle</li><li><b>DONUT</b>: A donut (circle with hole)</li><li><b>ELLIPSE</b>: An ellipse</li><li><b>PIE</b>: A pie (a segment of a circle)</li><li><b>ARC</b>: An arc (a segment of a donut)</li><li><b>ROUND_PATH</b>: A rounded path (a path bending around the corners with a given radius)</li><li><b>ROUND_POLYGON</b>: A rounded polygon (a polygon with rounded corners)</li><li><b>STROKED_BOX</b>: A stroked box (the "rim" of a box, optionally with smooth corners)</li><li><b>STROKED_POLYGON</b>: A stroked polygon (the "rim" of a polygon, optionally with smooth corners)</li></ul><a name="h2-44"></a><h2>TEXT</h2><p>
|
| 133 |
+
The text generator can produce texts in various forms.
|
| 134 |
+
The following sample shows inverse text, normal text and text with bias and
|
| 135 |
+
enlarged character spacing:
|
| 136 |
+
</p><p><img src="basic_text.png"></p><p>
|
| 137 |
+
It's even possible to install custom fonts. Fonts are basically GDS files
|
| 138 |
+
with the following features:
|
| 139 |
+
</p><ul><li>One cell per character. Cells must be either named like the character "A", "B", "0" etc. or
|
| 140 |
+
like the ASCII code in 3-digit decimal notation (i.e. "036" for the dollar character).
|
| 141 |
+
</li><li>The characters must be drawn in the character cells on layer 1/0. A box defining the
|
| 142 |
+
extension of the characters (including spacing) must be drawn on layer 2/0. Optionally a
|
| 143 |
+
background rectangle for the "inverse font" feature can be drawn on layer 3/0.
|
| 144 |
+
</li><li>One cell called "COMMENT" with text objects defining the basic text properties through their
|
| 145 |
+
strings, in particular:
|
| 146 |
+
<ul><li><b>design_grid=x</b>: specifies the basic grid the characters are designed on.
|
| 147 |
+
"x" is the grid in database units.
|
| 148 |
+
</li><li><b>line_width=x</b>: specifies the line width in database units.</li><li>A comment string which is displayed in the font selection box on the
|
| 149 |
+
PCell parameters page.
|
| 150 |
+
</li></ul></li></ul><p>
|
| 151 |
+
Custom fonts are installed by copying the font file to a folder named "fonts"
|
| 152 |
+
in one of the places in KLayout's path. The standard font can be found in
|
| 153 |
+
"src/db/db/std_font.gds" in the source package.
|
| 154 |
+
</p><a name="h2-89"></a><h2>CIRCLE and ELLIPSE</h2><p>These PCells define a circle and an ellipse. In both cases, the number of interpolation
|
| 155 |
+
points (per full circle) can be specified. The default is 64 points. A circle features
|
| 156 |
+
a handle to define the diameter. An ellipse features two handles defining the diameters in
|
| 157 |
+
x and y direction.
|
| 158 |
+
</p><p>When a shape is converted to a circle or ellipse PCell, the shape's bounding box will
|
| 159 |
+
be used to define the enclosing box of the circle or ellipse.
|
| 160 |
+
</p><a name="h2-101"></a><h2>DONUT</h2><p>The donut PCell creates a circle with a hole. This PCell features the same parameters than
|
| 161 |
+
the circle but an additional parameter defining the hole radius. For that, it provides two
|
| 162 |
+
handles - one for the outer and one for the inner radius.
|
| 163 |
+
</p><p>When a shape is converted to a donut, the shape's bounding box will be used to define the
|
| 164 |
+
enclosing box of the donut and the hole's diameter will be chosen to be half of the outer
|
| 165 |
+
diameter.
|
| 166 |
+
</p><a name="h2-113"></a><h2>PIE and ARC</h2><p>Both of these PCells are segments of circles or donuts. The PIE PCell features two handles to
|
| 167 |
+
define the radius and start and end angle. The ARC PCell also features two handles to define outer
|
| 168 |
+
and inner radius as well. The following image shows PIE and ARC in action:</p><p><img src="pie_arc.png"></p><p>Both PCells do not support conversion of shapes.</p><a name="h2-125"></a><h2>ROUND_PATH</h2><p>The round path is a PCell that is based on a path object but is capable of smoothing
|
| 169 |
+
the path's corners by applying a radius. The following image gives an example:
|
| 170 |
+
</p><p><img src="round_path.png"></p><p>
|
| 171 |
+
The PCell features a parameter that defines the radius. The path itself
|
| 172 |
+
can be manipulated as usual, in particular with partial edit mode.
|
| 173 |
+
Path objects can be converted to ROUND_PATH pcells. In that case, the initial radius
|
| 174 |
+
will be chosen to be roughly 10 percent of the minimum bounding box dimensions
|
| 175 |
+
of the original path.
|
| 176 |
+
</p><a name="h2-143"></a><h2>ROUND_POLYGON</h2><p>The round polygon is a PCell that is based on a polygon object but is capable of smoothing
|
| 177 |
+
the polygon's corners by applying a radius. The following image gives an example:
|
| 178 |
+
</p><p><img src="round_polygon.png"></p><p>
|
| 179 |
+
The PCell features a parameter that defines the radius. The polygon itself
|
| 180 |
+
can be manipulated as usual, in particular with partial edit mode.
|
| 181 |
+
Polygon, box or path objects can be converted to ROUND_POLYGON pcells. In that case, the initial radius
|
| 182 |
+
will be chosen to be roughly 10 percent of the minimum bounding box dimensions
|
| 183 |
+
of the original polygon.
|
| 184 |
+
</p><a name="h2-161"></a><h2>STROKED_POLYGON or STROKED_BOX</h2><p>The stroked polygon or box is a PCell that is based on a polygon object but will
|
| 185 |
+
produce the "rim" of this polygon. In addition, it can apply corner rounding with a
|
| 186 |
+
given radius.
|
| 187 |
+
</p><p><img src="stroked_polygon.png"></p><p>
|
| 188 |
+
The PCell features two parameters that define the radius and width of the "rim" line.
|
| 189 |
+
The polygon or box itself can be manipulated as usual.
|
| 190 |
+
Polygon, box or path objects can be converted to STROKED_POLYGON or STROKED_BOX pcells.
|
| 191 |
+
In that case, the initial radius will be zero. The width of the rim line will be chosen
|
| 192 |
+
to be roughly 10 percent of the minimum bounding box dimensions of the original polygon.
|
| 193 |
+
For STROKED_BOX, the bounding box of the original shape will be used as the basic shape.
|
| 194 |
+
</p></div>
|
| 195 |
+
</div>
|
| 196 |
+
</body>
|
| 197 |
+
</html>
|
| 198 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/connectivity.html
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » Connectivity</p><h1>Connectivity</h1><p>
|
| 120 |
+
Use the connectivity page to specify the conductor layers and their connections.
|
| 121 |
+
On a conductor layer, all touching or overlapping shapes are connected.
|
| 122 |
+
A connection is made between conductor layer when the shapes of the two conductor layers overlap.
|
| 123 |
+
Optionally a via layer can be specified which must be present to make a connection between the two conductor layer.
|
| 124 |
+
</p><p>
|
| 125 |
+
To specify a conductor layer
|
| 126 |
+
</p><ul><li>
|
| 127 |
+
Use "layer/datatype" notation to specify explicit GDS layers and datatypes.
|
| 128 |
+
</li><li>
|
| 129 |
+
Enter the layer name to specify either a named layer or a symbolic layer.
|
| 130 |
+
Symbolic layers must be defined in the symbol table (see <a href="symbolic_layers.html">Symbolic Connectivity Layers</a>)
|
| 131 |
+
and can be computed from boolean expressions.
|
| 132 |
+
</li><li>
|
| 133 |
+
Instead of using a symbolic layer,
|
| 134 |
+
enter a expression directly without defining a symbol (see <a href="symbolic_layers.html">Symbolic Connectivity Layers</a>).
|
| 135 |
+
Inside the expressions
|
| 136 |
+
<ul><li>
|
| 137 |
+
Use "layer/datatype" notation to specify an original layer with explicit GDS layers and datatypes.
|
| 138 |
+
</li><li>
|
| 139 |
+
Use the name to specify a named original layer or to refer to a different symbolic layer defined in a symbol entry.
|
| 140 |
+
</li><li>
|
| 141 |
+
Use the operators '+', '*', '-' and '^' to specify logical OR, AND, NOT and XOR respectively.
|
| 142 |
+
The precedence of evaluation is '^' and '*' before '+' and '-'.
|
| 143 |
+
</li><li>
|
| 144 |
+
Use round brackets to group expressions.
|
| 145 |
+
</li></ul></li></ul><p>
|
| 146 |
+
By creating conductor layers with boolean expressions, it is possible for example to separate an active area
|
| 147 |
+
layer of a CMOS transistor into source and drain regions by subtracting the gate poly. Symbolic layers are useful
|
| 148 |
+
to use "speaking" names for layers instead of the numeric layer/datatype specification.
|
| 149 |
+
Please note, that the net tracer is considerably slower when using boolean expressions.
|
| 150 |
+
</p></div>
|
| 151 |
+
</div>
|
| 152 |
+
</body>
|
| 153 |
+
</html>
|
| 154 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/custom_queries.html
ADDED
|
@@ -0,0 +1,433 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About Custom Layout Queries</p><h1>About Custom Layout Queries</h1><a name="k_1"></a><a name="k_2"></a><a name="k_3"></a><a name="k_4"></a><p>
|
| 120 |
+
Layout queries are an advanced feature of KLayout which provides a very generic
|
| 121 |
+
method to manipulate or search the geometrical or cell information of a layout.
|
| 122 |
+
The basic concept of custom queries is borrowed from SQL, the language widely used for
|
| 123 |
+
accessing databases. Instead of working on linear tables with rows and columns, KLayout's
|
| 124 |
+
queries work on the layout structure which basically a cell tree, a layer set orthogonal to that
|
| 125 |
+
and per-cell/per-layer geometrical information which itself is divided into shape classes.
|
| 126 |
+
</p><p>
|
| 127 |
+
Layout queries have a layered structure, like an onion: the core of the query
|
| 128 |
+
is a cell query which selects one or many cells with or without their children. The cell
|
| 129 |
+
query can be wrapped by a shape query which addresses the shapes of the selected cells or
|
| 130 |
+
instances, optionally confined to specific layers. The last layer is formed by the action: this is the activity that KLayout will
|
| 131 |
+
perform on the selected objects. The default action is simply to report the results.
|
| 132 |
+
It is also possible to delete the selected objects or to perform a custom operation on them.
|
| 133 |
+
</p><p>
|
| 134 |
+
On cell and shape level, conditions can be specified which will restrict the operation on a
|
| 135 |
+
subset of the selected objects. Reports can be sorted by a arbitrary key derived from the
|
| 136 |
+
current object.
|
| 137 |
+
</p><p>
|
| 138 |
+
On cell level three different relationship models are supported:
|
| 139 |
+
</p><ul><li>Individual cells: no hierarchy is involved</li><li>The cell tree: the cell tree is the parent/child relationship without explicit instantiation information</li><li>The cell instance tree: every individual instance of a cell is considered</li></ul><p>
|
| 140 |
+
Expressions play an important part in layout queries, both as actions (assignment type expressions)
|
| 141 |
+
as well as conditions or for the derivation of sorting keys. See <a href="expressions.html">About Expressions</a> for
|
| 142 |
+
details about expressions. Within expressions, RBA objects are used to represent shapes or instances (see <a href="../code/index.html">Class Index</a> for a list of classes available).
|
| 143 |
+
Depending on the context of the query, a variety of functions is available to access the properties of the current item and context.
|
| 144 |
+
</p><p>
|
| 145 |
+
The key to layout queries is the "Search and Replace" feature: this dialog uses custom queries
|
| 146 |
+
to emulate simple search and replace functionality on the first three tabs of the dialog ("Delete"
|
| 147 |
+
is regarded as a special kind of "replacement" here). However, the true power is revealed on the
|
| 148 |
+
forth page: here you can enter all kind of custom queries. Clicking on "Execute" will run the
|
| 149 |
+
query and display the results in the right panel.
|
| 150 |
+
</p><p>
|
| 151 |
+
If a search or replace action is specified on the first three tabs, the corresponding
|
| 152 |
+
custom layout query will be shown in the entry box of the forth one. That way it is very easy
|
| 153 |
+
to create a first query using the standard functions, switch to the custom query page
|
| 154 |
+
and adjust it to fit the specific requirements.
|
| 155 |
+
</p><a name="h2-67"></a><h2>Building queries: cells</h2><p>
|
| 156 |
+
The very core of a query is a cell expression. The most simple form of a cell expression is a simple cell name.
|
| 157 |
+
This expression will select the cell called "RINGO":
|
| 158 |
+
</p><pre>
|
| 159 |
+
RINGO
|
| 160 |
+
</pre><p>
|
| 161 |
+
Cell expressions can contain wildcard in the "glob" form
|
| 162 |
+
made popular by the Unix and Windows command line. "*" is for an arbitrary sequence of zero to many characters, "?"
|
| 163 |
+
for any single character. "{A,B,C}" is for either the character sequence "A", "B" or "C", "[ABC]" is any of the characters
|
| 164 |
+
"A", "B" or "C" and "[^ABC]" is for any character not "A", "B" or "C". Round brackets can be used to group
|
| 165 |
+
parts of the string for later reference. If brackets of any kind are used inside a match string, either single or
|
| 166 |
+
double quotes should be used around match strings in order to avoid ambiguities with other parts
|
| 167 |
+
of the query syntax.
|
| 168 |
+
</p><p>
|
| 169 |
+
This expression will select all cells starting with "T":
|
| 170 |
+
</p><pre>
|
| 171 |
+
T*
|
| 172 |
+
</pre><p>
|
| 173 |
+
Although it is not necessary to do so, it is recommended to mark a cell query explicitly
|
| 174 |
+
as such using the optional "cells" or "cell" keyword. This query has the same effect than the
|
| 175 |
+
previous one but is somewhat more robust if used in nested queries we will learn about later:
|
| 176 |
+
</p><pre>
|
| 177 |
+
cells T*
|
| 178 |
+
</pre><p>
|
| 179 |
+
A cell expression can already be used by its own. The report of such a query will simply contain the cells
|
| 180 |
+
selected by that expression. If combined with an action, such expressions already provide useful manipulation
|
| 181 |
+
functionality.
|
| 182 |
+
</p><p>
|
| 183 |
+
The "delete ..." action will delete the given cells:
|
| 184 |
+
</p><pre>
|
| 185 |
+
delete cells T*
|
| 186 |
+
</pre><p>
|
| 187 |
+
The "with .. do ..." action can be used to manipulate the cell. This example will rename the cell by replacing
|
| 188 |
+
the "T" prefix with a "S". The part after "do" is an expression which is evaluated for each hit.
|
| 189 |
+
Note that "$1" is used to refer to the first matching bracket in the last match.
|
| 190 |
+
"cell.name" is a method call on the object "cell" which is provided by the query in the context of a cell query.
|
| 191 |
+
"cell" is a "Cell" object (see <a href="../code/class_Cell.html">Cell</a>) and setting the name will basically rename the cell. The expression used
|
| 192 |
+
for the assignment will put an "S" in front of the rear part of the name, hence replace "T" by "S":
|
| 193 |
+
</p><pre>
|
| 194 |
+
with cells "T(*)" do cell.name = "S"+$1
|
| 195 |
+
</pre><p>
|
| 196 |
+
Note the quotes around the "T(*)" match expression. They are necessary to make the brackets part of the
|
| 197 |
+
match expression rather than the cell query. It is usually a good idea to put the match expression inside quotes
|
| 198 |
+
to avoid ambiguities.
|
| 199 |
+
</p><p>
|
| 200 |
+
The last example already demonstrates how a combination of two simple concepts - simple cell queries and expressions -
|
| 201 |
+
form a new and very generic feature. We will soon learn about the power of that concept.
|
| 202 |
+
</p><a name="h2-144"></a><h2>Building queries: cell trees</h2><p>
|
| 203 |
+
Cell queries are the most simple form of core queries. The next level is entered by extending
|
| 204 |
+
the concept to hierarchies. Cell hierarchies come on two flavors: a parent-to-child relationship tree (the cell tree)
|
| 205 |
+
and the instantiation tree. In the cell tree, each cell is at most present once in the context of a parent
|
| 206 |
+
cell, independent of the number of times a cell is used inside a parent cell. The cell tree just describes
|
| 207 |
+
the fact that a cell is a child cell of another, not how the cell is used. The instance tree adds this
|
| 208 |
+
detailed information as well: how many times a cell is used and what transformations are applied per
|
| 209 |
+
such instance.
|
| 210 |
+
</p><p>
|
| 211 |
+
The cell tree can be accessed within cell queries using the "." operator to separate parent and child cell.
|
| 212 |
+
The following cell query returns all cells which are children of a cell "A":
|
| 213 |
+
</p><pre>
|
| 214 |
+
cells A.*
|
| 215 |
+
</pre><p>
|
| 216 |
+
Multiple levels may be nested, for example the following query lists all cells which are second-level
|
| 217 |
+
children of the "A" cell:
|
| 218 |
+
</p><pre>
|
| 219 |
+
cells A.*.*
|
| 220 |
+
</pre><p>
|
| 221 |
+
Such expressions form a "path" leading from an initial cell to some cell, which is returned by
|
| 222 |
+
the query. The "." separates the path elements like the slash or backslash does in a file path.
|
| 223 |
+
</p><p>
|
| 224 |
+
Top cells can be addressed by a leading "." similar to the leading slash of an absolute file
|
| 225 |
+
path in Unix. The following query will return all top cells:
|
| 226 |
+
</p><pre>
|
| 227 |
+
cells .*
|
| 228 |
+
</pre><p>
|
| 229 |
+
Brackets can be used to group parts of the path. That has no immediate effect, but it can be
|
| 230 |
+
usedful in combination with quantifiers and branches as we will see soon. The following queries are equivalent:
|
| 231 |
+
</p><pre>
|
| 232 |
+
cells TOP.*.A
|
| 233 |
+
cells TOP(.*.A)
|
| 234 |
+
cells TOP(.*)(.A)
|
| 235 |
+
</pre><p>
|
| 236 |
+
Please note that brackets can only be put between the dot and the previous element.
|
| 237 |
+
A query like "cells TOP.(*.A)" is invalid since the opening bracket is after the dot.
|
| 238 |
+
</p><p>
|
| 239 |
+
Alternative paths can be specified by separating them with a comma. Such alternatives must
|
| 240 |
+
be put inside brackets. For example, this query selects all cells that are children of
|
| 241 |
+
"TOP" and start with an "A" or which are second-level children and start with an "E":
|
| 242 |
+
</p><pre>
|
| 243 |
+
cells TOP(.A*,.*.E*)
|
| 244 |
+
</pre><p>
|
| 245 |
+
Path elements can be made optional with a "?" symbol and expanded an variable number of times
|
| 246 |
+
using quantifiers like "*" (0 to many) and "+" (one to many) or "{n,m}" (n to m times). Note
|
| 247 |
+
that you'll have to put the expression subject to the quantifier in brackets in order to
|
| 248 |
+
avoid ambiguities of the star operator. The following expression will return the A cell in every
|
| 249 |
+
possible child context of "TOP", i.e. as direct child, second-level child and so on:
|
| 250 |
+
</p><pre>
|
| 251 |
+
cells TOP(.*)*.A
|
| 252 |
+
</pre><p>
|
| 253 |
+
To understand that query, note that the "*" inside the brackets is forming the match string while
|
| 254 |
+
the outer star is forming the quantifier. That query reads in expanded form "TOP.A", "TOP.*.A", "TOP.*.*.A" etc.
|
| 255 |
+
</p><p>
|
| 256 |
+
There is a useful abbreviation for the above case. The following query will also produce "A" in every
|
| 257 |
+
child context of "TOP":
|
| 258 |
+
</p><pre>
|
| 259 |
+
cells TOP..A
|
| 260 |
+
</pre><p>
|
| 261 |
+
The double dot operator matches an arbitrary part of the instantiation path before and after a cell
|
| 262 |
+
even without being anchored at one end. Used before a cell name, it will return all contexts a cell
|
| 263 |
+
is used in (including top cells and all child contexts). Used after a cell, it will return the cell
|
| 264 |
+
plus all child cells in each possible context. Used before a cell it will deliver all contexts that cell
|
| 265 |
+
is used in every top cells.
|
| 266 |
+
The following query will deliver "TOP" plus all its direct and indirect children:
|
| 267 |
+
</p><pre>
|
| 268 |
+
cells TOP..
|
| 269 |
+
</pre><p>
|
| 270 |
+
Note that the previous query may deliver the same cell multiple times - once for each context
|
| 271 |
+
(call path from TOP) it is used in. Hence "TOP.." will basically expand into the cell tree with
|
| 272 |
+
"TOP" as the root.
|
| 273 |
+
</p><p>
|
| 274 |
+
In order to get the names of all cells called from a given cell, you can use the "select" action
|
| 275 |
+
with the cell name and the "sorted by .. unique" output selector to remove duplicates of
|
| 276 |
+
cell names:
|
| 277 |
+
</p><pre>
|
| 278 |
+
select cell_name of cells TOP.. sorted by cell_name unique
|
| 279 |
+
</pre><p>
|
| 280 |
+
See below for a description of the "select" action.
|
| 281 |
+
</p><p>
|
| 282 |
+
Within a path, dynamically computed components can be inserted using the "$(..)" notation
|
| 283 |
+
which wraps an expression. That expression is evaluated in the context of the previous path
|
| 284 |
+
component. For example, the following query selects all child cells which are named like their
|
| 285 |
+
parent with an "A" prefix:
|
| 286 |
+
</p><pre>
|
| 287 |
+
cells *.$("A"+cell_name)
|
| 288 |
+
</pre><a name="h2-285"></a><h2>Building queries: instances</h2><p>
|
| 289 |
+
Cell trees can be expanded into instance trees simply by prepending "instances". This
|
| 290 |
+
will deliver all direct instances of "TOP":
|
| 291 |
+
</p><pre>
|
| 292 |
+
instances of TOP.*
|
| 293 |
+
</pre><p>
|
| 294 |
+
When asking for instances, more information is available inside the query. For
|
| 295 |
+
example, the instance's orientation and position is available. With the "instances" specification,
|
| 296 |
+
array references are expanded into single instances. To keep arrays as such, use "arrays" instead
|
| 297 |
+
of "instances":
|
| 298 |
+
</p><pre>
|
| 299 |
+
arrays of TOP.*
|
| 300 |
+
</pre><p>
|
| 301 |
+
Cell or instance queries can be filtered using the "where" clause. After the "where" an expression
|
| 302 |
+
is expected with a number of predefined variables that reflect the context (see below for the variables
|
| 303 |
+
available).
|
| 304 |
+
The following query selects all child cells of "A" where the cell name has a length of 5 characters:
|
| 305 |
+
</p><pre>
|
| 306 |
+
cells A.* where len(cell_name)==5
|
| 307 |
+
</pre><a name="h2-318"></a><h2>Building queries: shapes</h2><p>
|
| 308 |
+
So far we have dealt with cells and their instantiations.
|
| 309 |
+
We enter the next level now by introducing shapes.
|
| 310 |
+
</p><p>
|
| 311 |
+
Shape queries are built atop of the cell/instance level. A simple example selects all shapes
|
| 312 |
+
of the cell "TOP":
|
| 313 |
+
</p><pre>
|
| 314 |
+
shapes of cell TOP
|
| 315 |
+
</pre><p>
|
| 316 |
+
Shape queries can be confined to certain shape types. For example, this confines the query
|
| 317 |
+
to boxes:
|
| 318 |
+
</p><pre>
|
| 319 |
+
boxes from cell TOP
|
| 320 |
+
</pre><p>
|
| 321 |
+
Allowed shape type are "boxes", "polygons", "texts" and "paths". In the context of a shape query
|
| 322 |
+
additional variables are available for expressions. The most important one is "shape" which
|
| 323 |
+
is a Shape object (see <a href="../code/class_Shape.html">Shape</a>) That objects provides access to the shape addressed in a generic
|
| 324 |
+
way. Specialization to a specific shape type is possible through the shape specific accessor
|
| 325 |
+
methods (i.e. "shape.box_width") or the specific objects (i.e. "shape.box").
|
| 326 |
+
</p><p>
|
| 327 |
+
Multiple shape types can be given with "or" or a comma:
|
| 328 |
+
</p><pre>
|
| 329 |
+
boxes or polygons from cell TOP
|
| 330 |
+
</pre><p>
|
| 331 |
+
Shape queries can be confined to certain layers. This query will report all shapes from
|
| 332 |
+
layer 8, datatype 0:
|
| 333 |
+
</p><pre>
|
| 334 |
+
shapes on layer 8/0 from cell TOP
|
| 335 |
+
</pre><p>
|
| 336 |
+
Intervals can be specified with the hyphen ("-") and multiple layers or intervals can be
|
| 337 |
+
listed with a comma or semicolon. The following will list the shapes from layer 8, datatype
|
| 338 |
+
0 to 10 and layer 9, datatype 0 only (note that "no datatype" is interpreted as datatype 0):
|
| 339 |
+
</p><pre>
|
| 340 |
+
shapes on layer 8/0-10, 9 from cell TOP
|
| 341 |
+
</pre><p>
|
| 342 |
+
For formats that support named layers only (i.e. DXF), the layer name can be
|
| 343 |
+
given. The following query lists shapes from layers METAL and POLY (case sensitive!):
|
| 344 |
+
</p><pre>
|
| 345 |
+
shapes on layer METAL, POLY from cell TOP
|
| 346 |
+
</pre><p>
|
| 347 |
+
Any kind of cell query can be used inside the shape query. If a cell query renders multiple
|
| 348 |
+
cells, the shape query will be applied to each of the cells returned. If instances are selected
|
| 349 |
+
by the cell query, the shapes will be reported for each instance. Since the cumulated transformation
|
| 350 |
+
of a specific instance into the top cell is available through the "path_trans" (database units) or "path_dtrans" (micrometer units) variable,
|
| 351 |
+
it is possible to transform each shape into the top cell in the instance case. The following expression
|
| 352 |
+
combines a "with .. do" action with a shape query to flatten all shapes below "TOP":
|
| 353 |
+
</p><pre>
|
| 354 |
+
with shapes on layer 6 from instances of TOP.. do initial_cell.shapes(<10/0>).insert(shape).transform(path_trans)
|
| 355 |
+
</pre><p>
|
| 356 |
+
That expression reads all shapes of cell "TOP" and its children, inserts them into a new layer 10, datatype 0 and
|
| 357 |
+
transforms the shape after it has been inserted. This expression makes use of the variables "initial_cell" (a Cell object
|
| 358 |
+
representing the root cell of the cell query), "shape" (a pointer to the currently selected shape and "path_trans"
|
| 359 |
+
(a Trans object representing the transformation of the current shape into the root cell of the query).
|
| 360 |
+
It also employs the angle bracket layer constant notation which specifies a layer in the target notation
|
| 361 |
+
and can be used in place of the layer index value usually used inside the API. Note that the target
|
| 362 |
+
layer must exist already, i.e. must have been created in "Edit/Layer/New Layer" for example.
|
| 363 |
+
</p><p>
|
| 364 |
+
Shape queries can be confined with conditions. A condition is entered with a "where" clause
|
| 365 |
+
plus an expression that selects the shapes. This condition selects shapes with an area of more than
|
| 366 |
+
4 square micron (note that the "um2" unit must be given, since it will cause the value to be
|
| 367 |
+
converted into the database units used internally):
|
| 368 |
+
</p><pre>
|
| 369 |
+
shapes from cell TOP where shape.area < 4 um2
|
| 370 |
+
</pre><p>
|
| 371 |
+
Shape conditions can be combined with cell conditions. To avoid ambiguities, the cell query must be
|
| 372 |
+
put into brackets in that case:
|
| 373 |
+
</p><pre>
|
| 374 |
+
shapes from (cells * where len(cell_name)==4) where shape.area < 4 um2
|
| 375 |
+
</pre><a name="h2-430"></a><h2>Actions</h2><p>
|
| 376 |
+
Actions specify operations that are to be performed on the results of a query.
|
| 377 |
+
The default action is to just list the results. In the "Search and replace" dialog, the
|
| 378 |
+
results will be listed right to the query entry box as a table. Depending on the
|
| 379 |
+
context of the query, cell names, cell names plus parent cell, cell instances or shapes
|
| 380 |
+
are listed.
|
| 381 |
+
</p><a name="h3-440"></a><h3>"select" action</h3><p>
|
| 382 |
+
The "select" action will compute one or more results from each item returned by the query and
|
| 383 |
+
present the computed value in a table. The general form is:
|
| 384 |
+
</p><p><tt><b>select</b></tt> expr1, expr2, ... <tt><b>from</b></tt> query</p><p>
|
| 385 |
+
"expr1", "expr2" ... are expressions. For example this action computes area and perimeter for all
|
| 386 |
+
shapes of cell "TOP":
|
| 387 |
+
</p><pre>
|
| 388 |
+
select shape.area, shape.perimeter from shapes of cell TOP
|
| 389 |
+
</pre><p>
|
| 390 |
+
The "select" action offers sorting with optional reduction to unique values:
|
| 391 |
+
</p><p><tt><b>select</b></tt> expr1, expr2, ... <tt><b>from</b></tt> query <tt><b>sorted by</b></tt> sort_key</p><p><tt><b>select</b></tt> expr1, expr2, ... <tt><b>from</b></tt> query <tt><b>sorted by</b></tt> sort_key <tt><b>unique</b></tt></p><p>
|
| 392 |
+
Here "sort_key" is an expression which delivers the value by which the output will be sorted.
|
| 393 |
+
If "unique" is specified, items with identical sort key are reduced to a single output.
|
| 394 |
+
</p><a name="h3-470"></a><h3>"with" action</h3><p>
|
| 395 |
+
The "with" action executes an expression on each item returned by the expression.
|
| 396 |
+
In that sense it is basically equivalent to the "select" action but the results
|
| 397 |
+
of the operation are discarded and the intention of the expression is to modify
|
| 398 |
+
the results. The general form of that action is this:
|
| 399 |
+
</p><p><tt><b>with</b></tt> query <tt><b>do</b></tt> expr</p><p>
|
| 400 |
+
For example, this action will move all shapes of cell "TOP" from layer 6 to layer 10, datatype 0:
|
| 401 |
+
</p><pre>
|
| 402 |
+
with shapes on layer 6 of cell TOP do shape.layer = <10/0>
|
| 403 |
+
</pre><a name="h3-489"></a><h3>"delete" action</h3><p>
|
| 404 |
+
This action will simply delete the objects selected by the query:
|
| 405 |
+
</p><p><tt><b>delete</b></tt> query</p><p>
|
| 406 |
+
For example, this query deletes all shapes from layer 6, datatype 0 on cell TOP:
|
| 407 |
+
</p><pre>
|
| 408 |
+
delete shapes on layer 6 of cell TOP
|
| 409 |
+
</pre><a name="h2-505"></a><h2>Variables available per context</h2><a name="h3-507"></a><h3>Common variables</h3><p>
|
| 410 |
+
The following variables are available in all queries:
|
| 411 |
+
</p><table><tr><th>Name</th><th>Value type</th><th>Description</th></tr><tr><td>layout</td><td><a href="../code/class_Layout.html">Layout</a></td><td>The layout object that this query runs on.</td></tr></table><a name="h3-522"></a><h3>Cell query context</h3><p>
|
| 412 |
+
In the plain cell and cell tree context, the following variables are available:
|
| 413 |
+
</p><table><tr><th>Name</th><th>Value type</th><th>Description</th></tr><tr><td>path</td><td>Array</td><td>Array with the indexes of the cells in that path.<br>
|
| 414 |
+
For a plain cell, this array will have length 1 and contain the index of the selected cell only.</td></tr><tr><td>path_names</td><td>Array</td><td>Array with the names of the cells in that path.<br>
|
| 415 |
+
For a plain cell, this array will have length 1 and contain the name of the selected cell only.</td></tr><tr><td>initial_cell</td><td><a href="../code/class_Cell.html">Cell</a></td><td>Object representing the initial cell (first of path)</td></tr><tr><td>initial_cell_index</td><td>Integer</td><td>Index of initial cell (first of path)</td></tr><tr><td>initial_cell_name</td><td>String</td><td>Name of initial cell (first of path)</td></tr><tr><td>cell</td><td><a href="../code/class_Cell.html">Cell</a></td><td>Object representing the current cell (last of path)</td></tr><tr><td>cell_index</td><td>Integer</td><td>Index of current cell (last of path)</td></tr><tr><td>cell_name</td><td>String</td><td>Name of current cell (last of path)</td></tr><tr><td>hier_levels</td><td>Integer</td><td>Number of hierarchy levels in path (length of path - 1)</td></tr><tr><td>references</td><td>Integer</td><td>The number of instances of this cell in the parent cell. Array references count as 1.<br>
|
| 416 |
+
For plain cells, this value is 0.</td></tr><tr><td>weight</td><td>Integer</td><td>The number of instances of this cell in the parent cell. Array references count as multiple instances.<br>
|
| 417 |
+
For plain cells, this value is 0.</td></tr><tr><td>tot_weight</td><td>Integer</td><td>The number of instances of this cell in the initial cell along the given path. Array references count as multiple instances.<br>
|
| 418 |
+
for plain cells, this value is 0.</td></tr><tr><td>instances</td><td>Integer</td><td>Equivalent to "weight", but also available for plain cells. For plain cells, the value represents
|
| 419 |
+
the number of times, the cell is used in all top cells.</td></tr><tr><td>bbox</td><td><a href="../code/class_Box.html">Box</a></td><td>The cell's bounding box.</td></tr><tr><td>dbbox</td><td><a href="../code/class_DBox.html">DBox</a></td><td>The cell's bounding box in micrometer units.</td></tr><tr><td>cell_bbox</td><td><a href="../code/class_Box.html">Box</a></td><td>Same as "bbox" (disambiguator from shape and instance bounding boxes).</td></tr><tr><td>cell_dbbox</td><td><a href="../code/class_DBox.html">DBox</a></td><td>Same as "dbbox" (disambiguator from shape and instance bounding boxes).</td></tr></table><a name="h3-623"></a><h3>Instance query context</h3><p>
|
| 420 |
+
In an instance query context, the properties of the current instance are available as variables
|
| 421 |
+
in addition to most of the ones provided by the cell query context. These variables are not available
|
| 422 |
+
in instance context: "weight", "references" and "tot_weight". Apart from that these additional variable
|
| 423 |
+
are provided:
|
| 424 |
+
</p><table><tr><th>Name</th><th>Value type</th><th>Description</th></tr><tr><td>path_trans</td><td><a href="../code/class_ICplxTrans.html">ICplxTrans</a></td><td>The transformation of that instance into the top cell.
|
| 425 |
+
For a plain cell that is a unit transformation.</td></tr><tr><td>path_dtrans</td><td><a href="../code/class_DCplxTrans.html">DCplxTrans</a></td><td>The transformation of that instance into the top cell in micrometer units.
|
| 426 |
+
For a plain cell that is a unit transformation.</td></tr><tr><td>trans</td><td><a href="../code/class_ICplxTrans.html">ICplxTrans</a></td><td>The transformation of that instance (first instance if an array).</td></tr><tr><td>dtrans</td><td><a href="../code/class_DCplxTrans.html">DCplxTrans</a></td><td>The transformation of that instance (first instance if an array) in micrometer units.</td></tr><tr><td>inst_bbox</td><td><a href="../code/class_Box.html">Box</a></td><td>The instance bounding box in the initial cell.</td></tr><tr><td>inst_dbbox</td><td><a href="../code/class_DBox.html">DBox</a></td><td>The instance bounding box in the initial cell in micrometer units.</td></tr><tr><td>inst</td><td><a href="../code/class_Instance.html">Instance</a></td><td>The instance object of the current instance.</td></tr><tr><td>array_a</td><td><a href="../code/class_Vector.html">Vector</a></td><td>The a vector for an array instance or nil if the instance is not an array.</td></tr><tr><td>array_da</td><td><a href="../code/class_DVector.html">DVector</a></td><td>The a vector for an array instance in micrometer units or nil if the instance is not an array.</td></tr><tr><td>array_na</td><td>Integer</td><td>The a axis array dimension or nil if the instance is not an array.</td></tr><tr><td>array_b</td><td><a href="../code/class_Vector.html">Vector</a></td><td>The b vector for an array instance or nil if the instance is not an array.</td></tr><tr><td>array_db</td><td><a href="../code/class_DVector.html">DVector</a></td><td>The b vector for an array instance in micrometer units or nil if the instance is not an array.</td></tr><tr><td>array_nb</td><td>Integer</td><td>The b axis array dimension or nil if the instance is not an array.</td></tr><tr><td>array_ia</td><td>Integer</td><td>The a index when an array is iterated (0 to array_na). Not available with instance queries with "arrays of ...".</td></tr><tr><td>array_ib </td><td>Integer</td><td>he b index when an array is iterated (0 to array_nb). Not available with instance queries with "arrays of ...".</td></tr></table><a name="h3-717"></a><h3>Shape query context</h3><p>
|
| 427 |
+
In the context of the shape query, the following variables are available in addition to the variables
|
| 428 |
+
made available by the inner cell query. The inner cell query is either a instance query or a cell query:
|
| 429 |
+
</p><table><tr><th>Name</th><th>Value type</th><th>Description</th></tr><tr><td>bbox</td><td><a href="../code/class_DBox.html">DBox</a></td><td>The shape's bounding box</td></tr><tr><td>dbbox</td><td><a href="../code/class_DBox.html">DBox</a></td><td>The shape's bounding box in micrometer units</td></tr><tr><td>shape_bbox</td><td><a href="../code/class_Box.html">Box</a></td><td>Same as "bbox" (disambiguator for cell or instance bounding boxes)</td></tr><tr><td>shape_dbbox</td><td><a href="../code/class_DBox.html">DBox</a></td><td>Same as "dbbox" (disambiguator for cell or instance bounding boxes)</td></tr><tr><td>shape</td><td><a href="../code/class_Shape.html">Shape</a></td><td>The shape object</td></tr><tr><td>layer_info</td><td><a href="../code/class_LayerInfo.html">LayerInfo</a></td><td>The layer description of the current shape's layer</td></tr><tr><td>layer_index</td><td>Integer</td><td>The layer index of the current shape</td></tr></table></div>
|
| 430 |
+
</div>
|
| 431 |
+
</body>
|
| 432 |
+
</html>
|
| 433 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref.html
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » DRC Reference</p><h1>DRC Reference</h1><a name="k_1"></a><ul><li><a href="drc_ref_drc.html">DRC Reference: DRC expressions</a></li><li><a href="drc_ref_layer.html">DRC Reference: Layer Object</a></li><li><a href="drc_ref_netter.html">DRC Reference: Netter object</a></li><li><a href="drc_ref_source.html">DRC Reference: Source Object</a></li><li><a href="drc_ref_global.html">DRC Reference: Global Functions</a></li></ul></div>
|
| 120 |
+
</div>
|
| 121 |
+
</body>
|
| 122 |
+
</html>
|
| 123 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref_drc.html
ADDED
|
@@ -0,0 +1,642 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » <a href="drc_ref.html">DRC Reference</a> » DRC Reference: DRC expressions</p><h1>DRC Reference: DRC expressions</h1><a name="k_1"></a><p>
|
| 120 |
+
DRC expression objects represent abstract recipes for the <a href="drc_ref_layer.html#drc">Layer#drc</a> universal DRC function.
|
| 121 |
+
For example, when using a universal DRC expression like this:
|
| 122 |
+
</p><p><pre>
|
| 123 |
+
out = in.drc(width < 2.0)
|
| 124 |
+
</pre></p><p>
|
| 125 |
+
"width < 2.0" forms a DRC expression object. DRC expression objects have methods which
|
| 126 |
+
manipulate or evaluate the results of this expression. In addition, DRC expressions have a
|
| 127 |
+
result type, which is either polygon, edge or edge pair. The result type is defined by the
|
| 128 |
+
expression generating it. In the example above, "width < 2.0" is a DRC width check which
|
| 129 |
+
renders edge pairs. To obtain polygons from these edge pairs, use the "polygons" method:
|
| 130 |
+
</p><p><pre>
|
| 131 |
+
out = in.drc((width < 2.0).polygons)
|
| 132 |
+
</pre></p><p>
|
| 133 |
+
The following global functions are relevant for the DRC expressions:
|
| 134 |
+
</p><p><ul><li><a href="drc_ref_global.html#angle">angle</a></li><li><a href="drc_ref_global.html#area">area</a></li><li><a href="drc_ref_global.html#area_ratio">area_ratio</a></li><li><a href="drc_ref_global.html#bbox_aspect_ratio">bbox_aspect_ratio</a></li><li><a href="drc_ref_global.html#bbox_height">bbox_height</a></li><li><a href="drc_ref_global.html#bbox_max">bbox_max</a></li><li><a href="drc_ref_global.html#bbox_min">bbox_min</a></li><li><a href="drc_ref_global.html#bbox_width">bbox_width</a></li><li><a href="drc_ref_global.html#corners">corners</a></li><li><a href="drc_ref_global.html#covering">covering</a></li><li><a href="drc_ref_global.html#enc">enc</a></li><li><a href="drc_ref_global.html#enclosing">enclosing</a></li><li><a href="drc_ref_global.html#extent_refs">extent_refs</a></li><li><a href="drc_ref_global.html#extents">extents</a></li><li><a href="drc_ref_global.html#foreign">foreign</a></li><li><a href="drc_ref_global.html#holes">holes</a></li><li><a href="drc_ref_global.html#hulls">hulls</a></li><li><a href="drc_ref_global.html#if_all">if_all</a></li><li><a href="drc_ref_global.html#if_any">if_any</a></li><li><a href="drc_ref_global.html#if_none">if_none</a></li><li><a href="drc_ref_global.html#inside">inside</a></li><li><a href="drc_ref_global.html#interacting">interacting</a></li><li><a href="drc_ref_global.html#iso">iso</a></li><li><a href="drc_ref_global.html#length">length</a></li><li><a href="drc_ref_global.html#middle">middle</a></li><li><a href="drc_ref_global.html#notch">notch</a></li><li><a href="drc_ref_global.html#outside">outside</a></li><li><a href="drc_ref_global.html#overlap">overlap</a></li><li><a href="drc_ref_global.html#overlapping">overlapping</a></li><li><a href="drc_ref_global.html#perimeter">perimeter</a></li><li><a href="drc_ref_global.html#primary">primary</a></li><li><a href="drc_ref_global.html#rectangles">rectangles</a></li><li><a href="drc_ref_global.html#rectilinear">rectilinear</a></li><li><a href="drc_ref_global.html#relative_height">relative_height</a></li><li><a href="drc_ref_global.html#rounded_corners">rounded_corners</a></li><li><a href="drc_ref_global.html#secondary">secondary</a></li><li><a href="drc_ref_global.html#separation">separation</a></li><li><a href="drc_ref_global.html#sep">sep</a></li><li><a href="drc_ref_global.html#sized">sized</a></li><li><a href="drc_ref_global.html#smoothed">smoothed</a></li><li><a href="drc_ref_global.html#space">space</a></li><li><a href="drc_ref_global.html#squares">squares</a></li><li><a href="drc_ref_global.html#switch">switch</a></li><li><a href="drc_ref_global.html#width">width</a></li><li><a href="drc_ref_global.html#with_holes">with_holes</a></li></ul></p><p>
|
| 135 |
+
The following documentation will list the methods available for DRC expression objects.
|
| 136 |
+
</p><ul><li><a href="#h2-81">"!" - Logical not</a></li><li><a href="#h2-101">"&" - Boolean AND between the results of two expressions</a></li><li><a href="#h2-118">"+" - Boolean OR between the results of two expressions</a></li><li><a href="#h2-127">"-" - Boolean NOT between the results of two expressions</a></li><li><a href="#h2-157">"angle" - Selects edges based on their angle</a></li><li><a href="#h2-198">"area" - Selects the primary shape if the area is meeting the condition</a></li><li><a href="#h2-221">"area_ratio" - Selects the input polygon according to its area ratio (bounding box area by polygon area)</a></li><li><a href="#h2-248">"area_sum" - Selects the input polygons if the sum of all areas meets the condition</a></li><li><a href="#h2-262">"bbox_aspect_ratio" - Selects the input polygon according to the aspect ratio of the bounding box</a></li><li><a href="#h2-289">"bbox_height" - Selects the input polygon if its bounding box height is meeting the condition</a></li><li><a href="#h2-305">"bbox_max" - Selects the input polygon if its bounding box larger dimension is meeting the condition</a></li><li><a href="#h2-318">"bbox_min" - Selects the input polygon if its bounding box smaller dimension is meeting the condition</a></li><li><a href="#h2-342">"bbox_width" - Selects the input polygon if its bounding box width is meeting the condition</a></li><li><a href="#h2-358">"centers" - Returns the part at the center of each edge of the input</a></li><li><a href="#h2-369">"corners" - Selects corners of polygons</a></li><li><a href="#h2-415">"count" - Selects a expression result based on the number of (local) shapes</a></li><li><a href="#h2-442">"covering" - Selects shapes entirely covering other shapes</a></li><li><a href="#h2-470">"edges" - Converts the input shapes into edges</a></li><li><a href="#h2-511">"end_segments" - Returns the part at the end of each edge of the input</a></li><li><a href="#h2-522">"extended" - Returns polygons describing an area along the edges of the input</a></li><li><a href="#h2-536">"extended_in" - Returns polygons describing an area along the edges of the input</a></li><li><a href="#h2-550">"extended_out" - Returns polygons describing an area along the edges of the input</a></li><li><a href="#h2-564">"extent_refs" - Returns partial references to the bounding boxes of the polygons</a></li><li><a href="#h2-575">"extents" - Returns the bounding box of each input object</a></li><li><a href="#h2-589">"first_edges" - Returns the first edges of edge pairs</a></li><li><a href="#h2-602">"holes" - Selects all holes from the input polygons</a></li><li><a href="#h2-618">"hulls" - Selects all hulls from the input polygons</a></li><li><a href="#h2-637">"inside" - Selects shapes entirely inside other shapes</a></li><li><a href="#h2-649">"interacting" - Selects shapes interacting with other shapes</a></li><li><a href="#h2-668">"length" - Selects edges based on their length</a></li><li><a href="#h2-689">"length_sum" - Selects the input edges if the sum of their lengths meets the condition</a></li><li><a href="#h2-702">"merged" - Returns the merged input polygons, optionally selecting multi-overlap</a></li><li><a href="#h2-720">"middle" - Returns the centers of polygon bounding boxes</a></li><li><a href="#h2-731">"outside" - Selects shapes entirely outside other shapes</a></li><li><a href="#h2-743">"overlapping" - Selects shapes overlapping with other shapes</a></li><li><a href="#h2-762">"perimeter" - Selects the input polygon if the perimeter is meeting the condition</a></li><li><a href="#h2-785">"perimeter_sum" - Selects the input polygons if the sum of all perimeters meets the condition</a></li><li><a href="#h2-799">"polygons" - Converts the input shapes into polygons</a></li><li><a href="#h2-822">"rectangles" - Selects all polygons which are rectangles</a></li><li><a href="#h2-838">"rectilinear" - Selects all polygons which are rectilinear</a></li><li><a href="#h2-857">"relative_height" - Selects the input polygon according to the height vs. width of the bounding box</a></li><li><a href="#h2-886">"rounded_corners" - Applies corner rounding</a></li><li><a href="#h2-899">"second_edges" - Returns the second edges of edge pairs</a></li><li><a href="#h2-913">"sized" - Returns the sized version of the input</a></li><li><a href="#h2-927">"smoothed" - Applies smoothing</a></li><li><a href="#h2-941">"squares" - Selects all polygons which are squares</a></li><li><a href="#h2-957">"start_segments" - Returns the part at the beginning of each edge of the input</a></li><li><a href="#h2-968">"with_holes" - Selects all input polygons with the specified number of holes</a></li><li><a href="#h2-984">"|" - Boolean OR between the results of two expressions</a></li></ul><a name="!"></a><a name="h2-81"></a><h2>"!" - Logical not</h2><a name="k_2"></a><p>Usage:</p><ul><li><tt>! expression</tt></li></ul><p>
|
| 137 |
+
This operator will evaluate the expression after. If this expression renders
|
| 138 |
+
an empty result, the operator will return the primary shape. Otherwise it will
|
| 139 |
+
return an empty result.
|
| 140 |
+
</p><p>
|
| 141 |
+
This operator can be used together with predicates such a "rectangles" to
|
| 142 |
+
invert their meaning. For example, this code selects all primary shapes which
|
| 143 |
+
are not rectangles:
|
| 144 |
+
</p><p><pre>
|
| 145 |
+
out = in.drc(! rectangles)
|
| 146 |
+
out = in.drc(! primary.rectangles) # equivalent
|
| 147 |
+
</pre></p><a name="&"></a><a name="h2-101"></a><h2>"&" - Boolean AND between the results of two expressions</h2><a name="k_3"></a><p>Usage:</p><ul><li><tt>expression & expression</tt></li></ul><p>
|
| 148 |
+
The & operator will compute the boolean AND between the results
|
| 149 |
+
of two expressions. The expression types need to be edge or polygon.
|
| 150 |
+
</p><p>
|
| 151 |
+
The following example computes the partial edges where width is less than
|
| 152 |
+
0.3 micrometers and space is less than 0.2 micrometers:
|
| 153 |
+
</p><p><pre>
|
| 154 |
+
out = in.drc((width < 0.3).edges & (space < 0.2).edges)
|
| 155 |
+
</pre></p><a name="+"></a><a name="h2-118"></a><h2>"+" - Boolean OR between the results of two expressions</h2><a name="k_4"></a><p>Usage:</p><ul><li><tt>expression + expression</tt></li></ul><p>
|
| 156 |
+
The + operator will join the results of two expressions.
|
| 157 |
+
</p><a name="-"></a><a name="h2-127"></a><h2>"-" - Boolean NOT between the results of two expressions</h2><a name="k_5"></a><p>Usage:</p><ul><li><tt>expression - expression</tt></li></ul><p>
|
| 158 |
+
The - operator will compute the difference between the results
|
| 159 |
+
of two expressions. The NOT operation is defined for polygons,
|
| 160 |
+
edges and polygons subtracted from edges (first argument edge,
|
| 161 |
+
second argument polygon).
|
| 162 |
+
</p><p>
|
| 163 |
+
CAUTION: be careful not to take secondary input for the
|
| 164 |
+
first argument. This will not render the desired results.
|
| 165 |
+
Remember that the "drc" function will walk over all primary
|
| 166 |
+
shapes and present single primaries to the NOT operation together
|
| 167 |
+
with the secondaries of that single shape. So when you use
|
| 168 |
+
secondary shapes as the first argument, they will not see all
|
| 169 |
+
all the primaries required to compute the correct result.
|
| 170 |
+
That's also why a XOR operation cannot be provided in the
|
| 171 |
+
context of a generic DRC function.
|
| 172 |
+
</p><p>
|
| 173 |
+
The following example will produce edge markers where the
|
| 174 |
+
width of is less then 0.3 micron but not inside polygons on
|
| 175 |
+
the "waive" layer:
|
| 176 |
+
</p><p><pre>
|
| 177 |
+
out = in.drc((width < 0.3).edges - secondary(waive))
|
| 178 |
+
</pre></p><a name="angle"></a><a name="h2-157"></a><h2>"angle" - Selects edges based on their angle</h2><a name="k_6"></a><p>Usage:</p><ul><li><tt>expression.angle (in condition)</tt></li></ul><p>
|
| 179 |
+
This operation selects edges by their angle, measured against the horizontal
|
| 180 |
+
axis in the mathematical sense.
|
| 181 |
+
</p><p>
|
| 182 |
+
For this measurement edges are considered without their direction.
|
| 183 |
+
A horizontal edge has an angle of zero degree. A vertical one has
|
| 184 |
+
an angle of 90 degrees. The angle range is from -90 (exclusive) to 90 degree (inclusive).
|
| 185 |
+
</p><p>
|
| 186 |
+
If the input shapes are not polygons or edge pairs, they are converted to edges
|
| 187 |
+
before the angle test is made.
|
| 188 |
+
</p><p>
|
| 189 |
+
For example, the following code selects all edges from the primary shape which are 45 degree
|
| 190 |
+
(up) or -45 degree (down). The "+" operator will join the results:
|
| 191 |
+
</p><p><pre>
|
| 192 |
+
out = in.drc((angle == 45) + (angle == -45))
|
| 193 |
+
out = in.drc((primary.angle == 45) + (primary.angle == -45)) # equivalent
|
| 194 |
+
</pre></p><p>
|
| 195 |
+
You can avoid using both 45 and -45 degree checks with the 'absolute' option.
|
| 196 |
+
With this option, angles are not signed and the value is the absolute angle
|
| 197 |
+
the edge encloses with the x axis:
|
| 198 |
+
</p><p><pre>
|
| 199 |
+
out = in.drc(angle(absolute) == 45)
|
| 200 |
+
</pre></p><p>
|
| 201 |
+
Note that angle checks usually imply the need for rotation variant formation as cells which
|
| 202 |
+
are placed non-rotated and rotated by 90 degree cannot be considered identical. This imposes
|
| 203 |
+
a performance penalty in hierarchical mode. If possible, consider using <a href="drc_ref_drc.html#rectilinear">DRC#rectilinear</a> for
|
| 204 |
+
example to detect shapes with non-manhattan geometry instead of using angle checks.
|
| 205 |
+
</p><p>
|
| 206 |
+
The "angle" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 207 |
+
The plain function is equivalent to the method call "primary.angle".
|
| 208 |
+
</p><a name="area"></a><a name="h2-198"></a><h2>"area" - Selects the primary shape if the area is meeting the condition</h2><a name="k_7"></a><p>Usage:</p><ul><li><tt>expression.area (in condition)</tt></li></ul><p>
|
| 209 |
+
This operation is used in conditions to select shapes based on their area.
|
| 210 |
+
It is applicable on polygon expressions. The result will be the input
|
| 211 |
+
polygons if the area condition is met.
|
| 212 |
+
</p><p>
|
| 213 |
+
See <a href="drc_ref_layer.html#drc">Layer#drc</a> for more details about comparison specs.
|
| 214 |
+
</p><p>
|
| 215 |
+
The following example will select all polygons with an area less than 2.0 square micrometers:
|
| 216 |
+
</p><p><pre>
|
| 217 |
+
out = in.drc(area < 2.0)
|
| 218 |
+
out = in.drc(primary.area < 2.0) # equivalent
|
| 219 |
+
</pre></p><p>
|
| 220 |
+
The area method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 221 |
+
The plain function is equivalent to "primary.area".
|
| 222 |
+
</p><a name="area_ratio"></a><a name="h2-221"></a><h2>"area_ratio" - Selects the input polygon according to its area ratio (bounding box area by polygon area)</h2><a name="k_8"></a><p>Usage:</p><ul><li><tt>expression.area_ratio (in condition)</tt></li></ul><p>
|
| 223 |
+
This operation is used in conditions to select shapes based on their area ratio.
|
| 224 |
+
The area ratio is the ratio of bounding box vs. polygon area. It's a measure how
|
| 225 |
+
"sparse" the polygons are and how good an approximation the bounding box is.
|
| 226 |
+
The value is always larger or equal than 1. Boxes have a value of 1.
|
| 227 |
+
</p><p>
|
| 228 |
+
This filter is applicable on polygon expressions. The result will be the input
|
| 229 |
+
polygon if the condition is met.
|
| 230 |
+
</p><p>
|
| 231 |
+
See <a href="drc_ref_layer.html#drc">Layer#drc</a> for more details about comparison specs.
|
| 232 |
+
</p><p>
|
| 233 |
+
The following example will select all polygons whose area ratio is larger than 3:
|
| 234 |
+
</p><p><pre>
|
| 235 |
+
out = in.drc(area_ratio > 3)
|
| 236 |
+
out = in.drc(primary.area_ratio > 3) # equivalent
|
| 237 |
+
</pre></p><p>
|
| 238 |
+
The "area_ratio" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 239 |
+
The plain function is equivalent to "primary.area_ratio".
|
| 240 |
+
</p><a name="area_sum"></a><a name="h2-248"></a><h2>"area_sum" - Selects the input polygons if the sum of all areas meets the condition</h2><a name="k_9"></a><p>Usage:</p><ul><li><tt>expression.area_sum (in condition)</tt></li></ul><p>
|
| 241 |
+
Returns the input polygons if the sum of their areas meets the specified
|
| 242 |
+
condition. This condition is evaluated on the total of all shapes generated in one step of the
|
| 243 |
+
"drc" loop. As there is a single primary in each loop iteration, "primary.area_sum" is
|
| 244 |
+
equivalent to "primary.area".
|
| 245 |
+
</p><p>
|
| 246 |
+
See <a href="drc_ref_layer.html#drc">Layer#drc</a> for more details about comparison specs.
|
| 247 |
+
</p><a name="bbox_aspect_ratio"></a><a name="h2-262"></a><h2>"bbox_aspect_ratio" - Selects the input polygon according to the aspect ratio of the bounding box</h2><a name="k_10"></a><p>Usage:</p><ul><li><tt>expression.bbox_aspect_ratio (in condition)</tt></li></ul><p>
|
| 248 |
+
This operation is used in conditions to select shapes based on aspect ratios of their bounding boxes.
|
| 249 |
+
The aspect ratio is computed by dividing the larger of width and height by the smaller of both.
|
| 250 |
+
The aspect ratio is always larger or equal to 1. Square or square-boxed shapes have a
|
| 251 |
+
bounding box aspect ratio of 1.
|
| 252 |
+
</p><p>
|
| 253 |
+
This filter is applicable on polygon expressions. The result will be the input
|
| 254 |
+
polygon if the bounding box condition is met.
|
| 255 |
+
</p><p>
|
| 256 |
+
See <a href="drc_ref_layer.html#drc">Layer#drc</a> for more details about comparison specs.
|
| 257 |
+
</p><p>
|
| 258 |
+
The following example will select all polygons whose bounding box aspect ratio is larger than 3:
|
| 259 |
+
</p><p><pre>
|
| 260 |
+
out = in.drc(bbox_aspect_ratio > 3)
|
| 261 |
+
out = in.drc(primary.bbox_aspect_ratio > 3) # equivalent
|
| 262 |
+
</pre></p><p>
|
| 263 |
+
The "bbox_aspect_ratio" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 264 |
+
The plain function is equivalent to "primary.bbox_aspect_ratio".
|
| 265 |
+
</p><a name="bbox_height"></a><a name="h2-289"></a><h2>"bbox_height" - Selects the input polygon if its bounding box height is meeting the condition</h2><a name="k_11"></a><p>Usage:</p><ul><li><tt>expression.bbox_height (in condition)</tt></li></ul><p>
|
| 266 |
+
This operation acts similar to <a href="drc_ref_drc.html#bbox_min">DRC#bbox_min</a>, but takes the height of the shape's
|
| 267 |
+
bounding box. In general, it's more advisable to use <a href="drc_ref_drc.html#bbox_min">DRC#bbox_min</a> or <a href="drc_ref_drc.html#bbox_max">DRC#bbox_max</a>
|
| 268 |
+
because bbox_height implies a certain orientation. This can imply variant formation in
|
| 269 |
+
hierarchical contexts: cells rotated by 90 degree have to be treated differently from
|
| 270 |
+
ones not rotated. This usually results in a larger computation effort and larger result files.
|
| 271 |
+
</p><p>
|
| 272 |
+
The "bbox_height" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 273 |
+
The plain function is equivalent to "primary.bbox_height".
|
| 274 |
+
</p><a name="bbox_max"></a><a name="h2-305"></a><h2>"bbox_max" - Selects the input polygon if its bounding box larger dimension is meeting the condition</h2><a name="k_12"></a><p>Usage:</p><ul><li><tt>expression.bbox_max (in condition)</tt></li></ul><p>
|
| 275 |
+
This operation acts similar to <a href="drc_ref_drc.html#bbox_min">DRC#bbox_min</a>, but takes the larger dimension of the shape's
|
| 276 |
+
bounding box.
|
| 277 |
+
</p><p>
|
| 278 |
+
The "bbox_max" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 279 |
+
The plain function is equivalent to "primary.bbox_max".
|
| 280 |
+
</p><a name="bbox_min"></a><a name="h2-318"></a><h2>"bbox_min" - Selects the input polygon if its bounding box smaller dimension is meeting the condition</h2><a name="k_13"></a><p>Usage:</p><ul><li><tt>expression.bbox_min (in condition)</tt></li></ul><p>
|
| 281 |
+
This operation is used in conditions to select shapes based on smaller dimension of their bounding boxes.
|
| 282 |
+
It is applicable on polygon expressions. The result will be the input
|
| 283 |
+
polygons if the bounding box condition is met.
|
| 284 |
+
</p><p>
|
| 285 |
+
See <a href="drc_ref_layer.html#drc">Layer#drc</a> for more details about comparison specs.
|
| 286 |
+
</p><p>
|
| 287 |
+
The following example will select all polygons whose bounding box smaller dimension is larger
|
| 288 |
+
than 200 nm:
|
| 289 |
+
</p><p><pre>
|
| 290 |
+
out = in.drc(bbox_min > 200.nm)
|
| 291 |
+
out = in.drc(primary.bbox_min > 200.nm) # equivalent
|
| 292 |
+
</pre></p><p>
|
| 293 |
+
The "bbox_min" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 294 |
+
The plain function is equivalent to "primary.bbox_min".
|
| 295 |
+
</p><a name="bbox_width"></a><a name="h2-342"></a><h2>"bbox_width" - Selects the input polygon if its bounding box width is meeting the condition</h2><a name="k_14"></a><p>Usage:</p><ul><li><tt>expression.bbox_width (in condition)</tt></li></ul><p>
|
| 296 |
+
This operation acts similar to <a href="drc_ref_drc.html#bbox_min">DRC#bbox_min</a>, but takes the width of the shape's
|
| 297 |
+
bounding box. In general, it's more advisable to use <a href="drc_ref_drc.html#bbox_min">DRC#bbox_min</a> or <a href="drc_ref_drc.html#bbox_max">DRC#bbox_max</a>
|
| 298 |
+
because bbox_width implies a certain orientation. This can imply variant formation in
|
| 299 |
+
hierarchical contexts: cells rotated by 90 degree have to be treated differently from
|
| 300 |
+
ones not rotated. This usually results in a larger computation effort and larger result files.
|
| 301 |
+
</p><p>
|
| 302 |
+
The "bbox_width" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 303 |
+
The plain function is equivalent to "primary.bbox_width".
|
| 304 |
+
</p><a name="centers"></a><a name="h2-358"></a><h2>"centers" - Returns the part at the center of each edge of the input</h2><a name="k_15"></a><p>Usage:</p><ul><li><tt>expression.centers(length)</tt></li><li><tt>expression.end_segments(length, fraction)</tt></li></ul><p>
|
| 305 |
+
This method acts on edge expressions and delivers a specific part of each edge.
|
| 306 |
+
See <a href="drc_ref_layer.html#centers">layer#centers</a> for details about this functionality.
|
| 307 |
+
</p><a name="corners"></a><a name="h2-369"></a><h2>"corners" - Selects corners of polygons</h2><a name="k_16"></a><p>Usage:</p><ul><li><tt>expression.corners</tt></li><li><tt>expression.corners([ options ])</tt></li></ul><p>
|
| 308 |
+
This operation acts on polygons and selects the corners of the polygons.
|
| 309 |
+
It can be put into a condition to select corners by their angles. The angle of
|
| 310 |
+
a corner is positive for a turn to the left if walking a polygon clockwise
|
| 311 |
+
and negative for the turn to the right. Hence positive angles indicate concave
|
| 312 |
+
(inner) corners, negative ones indicate convex (outer) corners.
|
| 313 |
+
Angles take values between -180 and 180 degree.
|
| 314 |
+
</p><p>
|
| 315 |
+
When using "as_dots" for an option, the operation will return single-point edges at
|
| 316 |
+
the selected corners. With "as_boxes" (the default), small (2x2 DBU) rectangles will be
|
| 317 |
+
produced at each selected corner.
|
| 318 |
+
</p><p>
|
| 319 |
+
Another option is "absolute" which selects the corners by absolute angle - i.e left
|
| 320 |
+
and right turns will both be considered positive angles.
|
| 321 |
+
</p><p>
|
| 322 |
+
Examples for use of the options are:
|
| 323 |
+
</p><p><pre>
|
| 324 |
+
corners(as_dots)
|
| 325 |
+
corners(as_boxes, absolute)
|
| 326 |
+
</pre></p><p>
|
| 327 |
+
The following example selects all corners:
|
| 328 |
+
</p><p><pre>
|
| 329 |
+
out = in.drc(corners)
|
| 330 |
+
out = in.drc(primary.corners) # equivalent
|
| 331 |
+
</pre></p><p>
|
| 332 |
+
The following example selects all inner corners:
|
| 333 |
+
</p><p><pre>
|
| 334 |
+
out = in.drc(corners > 0)
|
| 335 |
+
out = in.drc(primary.corners > 0) # equivalent
|
| 336 |
+
</pre></p><p>
|
| 337 |
+
The "corners" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 338 |
+
The plain function is equivalent to "primary.corners".
|
| 339 |
+
</p><a name="count"></a><a name="h2-415"></a><h2>"count" - Selects a expression result based on the number of (local) shapes</h2><a name="k_17"></a><p>Usage:</p><ul><li><tt>expression.count (in condition)</tt></li></ul><p>
|
| 340 |
+
This operation is used in conditions to select expression results based on their
|
| 341 |
+
count. "count" is used as a method on a expression. It will evaluate the expression locally
|
| 342 |
+
and return the original result if the shape count in the result is matching the condition.
|
| 343 |
+
</p><p>
|
| 344 |
+
See <a href="drc_ref_layer.html#drc">Layer#drc</a> for more details about comparison specs.
|
| 345 |
+
</p><p>
|
| 346 |
+
Note that the expression is evaluated locally: for each primary shape, the expression is
|
| 347 |
+
evaluated and the count of the resulting edge, edge pair or polygon set is taken.
|
| 348 |
+
As the primary input will always have a single item (the local shape), using "count" on
|
| 349 |
+
primary does not really make sense. It can be used on derived expressions however.
|
| 350 |
+
</p><p>
|
| 351 |
+
The following example selects triangles:
|
| 352 |
+
</p><p><pre>
|
| 353 |
+
out = in.drc(if_any(corners.count == 3))
|
| 354 |
+
</pre></p><p>
|
| 355 |
+
Note "if_any" which selects the primary shape if the argument evaluates to a non-empty
|
| 356 |
+
result. Without "if_any" three corners are returned for each triangle.
|
| 357 |
+
</p><a name="covering"></a><a name="h2-442"></a><h2>"covering" - Selects shapes entirely covering other shapes</h2><a name="k_18"></a><p>Usage:</p><ul><li><tt>expression.covering(other) (optionally in conditions)</tt></li><li><tt>covering(other) (optionally in conditions)</tt></li></ul><p>
|
| 358 |
+
This method represents the selector of primary shapes
|
| 359 |
+
which entirely cover shapes from the other layer. This version can be put into
|
| 360 |
+
a condition indicating how many shapes of the other layer need to be covered.
|
| 361 |
+
Use this variant within <a href="drc_ref_drc.html">DRC</a> expressions (also see <a href="drc_ref_layer.html#drc">Layer#drc</a>).
|
| 362 |
+
</p><p>
|
| 363 |
+
For example, the following statement selects all input shapes which entirely
|
| 364 |
+
cover shapes from the "other" layer:
|
| 365 |
+
</p><p><pre>
|
| 366 |
+
out = in.drc(covering(other))
|
| 367 |
+
</pre></p><p>
|
| 368 |
+
This example selects all input shapes which entire cover shapes from
|
| 369 |
+
the other layer and there are more than two shapes from "other" inside
|
| 370 |
+
primary shapes:
|
| 371 |
+
</p><p><pre>
|
| 372 |
+
out = in.drc(covering(other) > 2)
|
| 373 |
+
</pre></p><a name="edges"></a><a name="h2-470"></a><h2>"edges" - Converts the input shapes into edges</h2><a name="k_19"></a><p>Usage:</p><ul><li><tt>expression.edges</tt></li><li><tt>expression.edges(mode)</tt></li></ul><p>
|
| 374 |
+
Polygons will be separated into edges forming their contours. Edge pairs will be
|
| 375 |
+
decomposed into individual edges.
|
| 376 |
+
</p><p>
|
| 377 |
+
Contrary most other operations, "edges" does not have a plain function equivalent
|
| 378 |
+
as this is reserved for the function generating an edges layer.
|
| 379 |
+
To generate the edges of the primary shapes, use "primary" explicit as the source
|
| 380 |
+
for the edges:
|
| 381 |
+
</p><p><pre>
|
| 382 |
+
out = in.drc(primary.edges)
|
| 383 |
+
</pre></p><p>
|
| 384 |
+
The "mode" argument allows selecting specific edges from polygons.
|
| 385 |
+
Allowed values are: "convex", "concave", "step", "step_in" and "step_out".
|
| 386 |
+
"step" generates edges only if they provide a step between two other
|
| 387 |
+
edges. "step_in" creates edges that make a step towards the inside of
|
| 388 |
+
the polygon and "step_out" creates edges that make a step towards the
|
| 389 |
+
outside:
|
| 390 |
+
</p><p><pre>
|
| 391 |
+
out = in.drc(primary.edges(convex))
|
| 392 |
+
</pre></p><p>
|
| 393 |
+
In addition, "not_.." variants are available which selects edges
|
| 394 |
+
not qualifying for the specific mode:
|
| 395 |
+
</p><p><pre>
|
| 396 |
+
out = in.drc(primary.edges(not_convex))
|
| 397 |
+
</pre></p><p>
|
| 398 |
+
The mode argument is ignored when translating other objects than
|
| 399 |
+
polygons.
|
| 400 |
+
</p><a name="end_segments"></a><a name="h2-511"></a><h2>"end_segments" - Returns the part at the end of each edge of the input</h2><a name="k_20"></a><p>Usage:</p><ul><li><tt>expression.end_segments(length)</tt></li><li><tt>expression.end_segments(length, fraction)</tt></li></ul><p>
|
| 401 |
+
This method acts on edge expressions and delivers a specific part of each edge.
|
| 402 |
+
See <a href="drc_ref_layer.html#end_segments">layer#end_segments</a> for details about this functionality.
|
| 403 |
+
</p><a name="extended"></a><a name="h2-522"></a><h2>"extended" - Returns polygons describing an area along the edges of the input</h2><a name="k_21"></a><p>Usage:</p><ul><li><tt>expression.extended([:begin => b,] [:end => e,] [:out => o,] [:in => i], [:joined => true])</tt></li><li><tt>expression.extended(b, e, o, i)</tt></li></ul><p>
|
| 404 |
+
This method acts on edge expressions.
|
| 405 |
+
It will create a polygon for each edge
|
| 406 |
+
tracing the edge with certain offsets to the edge. "o" is the offset applied to the
|
| 407 |
+
outer side of the edge, "i" is the offset applied to the inner side of the edge.
|
| 408 |
+
"b" is the offset applied at the beginning and "e" is the offset applied at the end.
|
| 409 |
+
</p><a name="extended_in"></a><a name="h2-536"></a><h2>"extended_in" - Returns polygons describing an area along the edges of the input</h2><a name="k_22"></a><p>Usage:</p><ul><li><tt>expression.extended_in(d)</tt></li></ul><p>
|
| 410 |
+
This method acts on edge expressions. Polygons are generated for
|
| 411 |
+
each edge describing the edge drawn with a certain width extending into
|
| 412 |
+
the "inside" (the right side when looking from start to end).
|
| 413 |
+
This method is basically equivalent to the <a href="#extended">extended</a> method:
|
| 414 |
+
"extended(0, 0, 0, dist)".
|
| 415 |
+
A version extending to the outside is <a href="#extended_out">extended_out</a>.
|
| 416 |
+
</p><a name="extended_out"></a><a name="h2-550"></a><h2>"extended_out" - Returns polygons describing an area along the edges of the input</h2><a name="k_23"></a><p>Usage:</p><ul><li><tt>expression.extended_out(d)</tt></li></ul><p>
|
| 417 |
+
This method acts on edge expressions. Polygons are generated for
|
| 418 |
+
each edge describing the edge drawn with a certain width extending into
|
| 419 |
+
the "outside" (the left side when looking from start to end).
|
| 420 |
+
This method is basically equivalent to the <a href="#extended">extended</a> method:
|
| 421 |
+
"extended(0, 0, dist, 0)".
|
| 422 |
+
A version extending to the inside is <a href="#extended_in">extended_in</a>.
|
| 423 |
+
</p><a name="extent_refs"></a><a name="h2-564"></a><h2>"extent_refs" - Returns partial references to the bounding boxes of the polygons</h2><a name="k_24"></a><p>Usage:</p><ul><li><tt>expression.extent_refs([ options ])</tt></li></ul><p>
|
| 424 |
+
The extent_refs operation acts on polygons and has the same effect than <a href="drc_ref_layer.html#extent_refs">Layer#extent_refs</a>.
|
| 425 |
+
It takes the same arguments. It is available as a method on <a href="drc_ref_drc.html">DRC</a> expressions or
|
| 426 |
+
as plain function, in which case it acts on the primary shapes.
|
| 427 |
+
</p><a name="extents"></a><a name="h2-575"></a><h2>"extents" - Returns the bounding box of each input object</h2><a name="k_25"></a><p>Usage:</p><ul><li><tt>expression.extents([ enlargement ])</tt></li></ul><p>
|
| 428 |
+
This method provides the same functionality as <a href="drc_ref_layer.html#extents">Layer#extents</a> and takes the same
|
| 429 |
+
arguments. It returns the bounding boxes of the input objects. It acts on edge
|
| 430 |
+
edge pair and polygon expressions.
|
| 431 |
+
</p><p>
|
| 432 |
+
The "extents" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 433 |
+
The plain function is equivalent to "primary.extents".
|
| 434 |
+
</p><a name="first_edges"></a><a name="h2-589"></a><h2>"first_edges" - Returns the first edges of edge pairs</h2><a name="k_26"></a><p>Usage:</p><ul><li><tt>expression.first_edges</tt></li></ul><p>
|
| 435 |
+
This method acts on edge pair expressions and returns the first edges of the
|
| 436 |
+
edge pairs delivered by the expression.
|
| 437 |
+
</p><p>
|
| 438 |
+
Some checks deliver symmetric edge pairs (e.g. space, width, etc.) for which the
|
| 439 |
+
edges are commutable. "first_edges" will deliver both edges for such edge pairs.
|
| 440 |
+
</p><a name="holes"></a><a name="h2-602"></a><h2>"holes" - Selects all holes from the input polygons</h2><a name="k_27"></a><p>Usage:</p><ul><li><tt>expression.holes</tt></li></ul><p>
|
| 441 |
+
This operation can be used as a plain function in which case it acts on primary
|
| 442 |
+
shapes or can be used as method on another DRC expression.
|
| 443 |
+
The following example selects all holes with an area larger than 2 square micrometers:
|
| 444 |
+
</p><p><pre>
|
| 445 |
+
out = in.drc(holes.area > 2.um)
|
| 446 |
+
out = in.drc(primary.holes.area > 2.um) # equivalent
|
| 447 |
+
</pre></p><a name="hulls"></a><a name="h2-618"></a><h2>"hulls" - Selects all hulls from the input polygons</h2><a name="k_28"></a><p>Usage:</p><ul><li><tt>expression.hulls</tt></li></ul><p>
|
| 448 |
+
The hulls are the outer contours of the input polygons. By selecting hulls only,
|
| 449 |
+
all holes will be closed.
|
| 450 |
+
</p><p>
|
| 451 |
+
This operation can be used as a plain function in which case it acts on primary
|
| 452 |
+
shapes or can be used as method on another DRC expression.
|
| 453 |
+
The following example closes all holes:
|
| 454 |
+
</p><p><pre>
|
| 455 |
+
out = in.drc(hulls)
|
| 456 |
+
out = in.drc(primary.hulls) # equivalent
|
| 457 |
+
</pre></p><a name="inside"></a><a name="h2-637"></a><h2>"inside" - Selects shapes entirely inside other shapes</h2><a name="k_29"></a><p>Usage:</p><ul><li><tt>expression.inside(other)</tt></li><li><tt>inside(other)</tt></li></ul><p>
|
| 458 |
+
This method represents the selector of primary shapes
|
| 459 |
+
which are entirely inside shapes from the other layer.
|
| 460 |
+
Use this variant within <a href="drc_ref_drc.html">DRC</a> expressions (also see <a href="drc_ref_layer.html#drc">Layer#drc</a>).
|
| 461 |
+
</p><a name="interacting"></a><a name="h2-649"></a><h2>"interacting" - Selects shapes interacting with other shapes</h2><a name="k_30"></a><p>Usage:</p><ul><li><tt>expression.interacting(other) (optionally in conditions)</tt></li><li><tt>interacting(other) (optionally in conditions)</tt></li></ul><p>
|
| 462 |
+
See <a href="#covering">covering</a> for a description of the use cases for this function.
|
| 463 |
+
When using "interacting", shapes are selected when the interact (overlap, touch)
|
| 464 |
+
shapes from the other layer.
|
| 465 |
+
</p><p>
|
| 466 |
+
When using this method with a count, the operation may not render
|
| 467 |
+
the correct results if the other input is not merged. By nature of the
|
| 468 |
+
generic DRC feature, only those shapes that interact with the primary shape
|
| 469 |
+
will be selected. If the other input is split into multiple polygons,
|
| 470 |
+
not all components may be captured and the computed interaction count
|
| 471 |
+
may be incorrect.
|
| 472 |
+
</p><a name="length"></a><a name="h2-668"></a><h2>"length" - Selects edges based on their length</h2><a name="k_31"></a><p>Usage:</p><ul><li><tt>expression.length (in condition)</tt></li></ul><p>
|
| 473 |
+
This operation will select those edges which are meeting the length
|
| 474 |
+
criterion. Non-edge shapes (polygons, edge pairs) will be converted to edges before.
|
| 475 |
+
</p><p>
|
| 476 |
+
For example, this code selects all edges from the primary shape which are longer or
|
| 477 |
+
equal than 1 micrometer:
|
| 478 |
+
</p><p><pre>
|
| 479 |
+
out = in.drc(length >= 1.um)
|
| 480 |
+
out = in.drc(primary.length >= 1.um) # equivalent
|
| 481 |
+
</pre></p><p>
|
| 482 |
+
The "length" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 483 |
+
The plain function is equivalent to "primary.length".
|
| 484 |
+
</p><a name="length_sum"></a><a name="h2-689"></a><h2>"length_sum" - Selects the input edges if the sum of their lengths meets the condition</h2><a name="k_32"></a><p>Usage:</p><ul><li><tt>expression.length_sum (in condition)</tt></li></ul><p>
|
| 485 |
+
Returns the input edges if the sum of their lengths meets the specified
|
| 486 |
+
condition. This condition is evaluated on the total of all edges generated in one step of the
|
| 487 |
+
"drc" loop.
|
| 488 |
+
</p><p>
|
| 489 |
+
See <a href="drc_ref_layer.html#drc">Layer#drc</a> for more details about comparison specs.
|
| 490 |
+
</p><a name="merged"></a><a name="h2-702"></a><h2>"merged" - Returns the merged input polygons, optionally selecting multi-overlap</h2><a name="k_33"></a><p>Usage:</p><ul><li><tt>expression.merged</tt></li><li><tt>expression.merged(min_count)</tt></li></ul><p>
|
| 491 |
+
This operation will act on polygons. Without a min_count argument, the merged
|
| 492 |
+
polygons will be returned.
|
| 493 |
+
</p><p>
|
| 494 |
+
With a min_count argument, the result will include only those parts where more
|
| 495 |
+
than the given number of polygons overlap. As the primary input is merged already,
|
| 496 |
+
it will always contribute as one.
|
| 497 |
+
</p><p>
|
| 498 |
+
The "merged" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 499 |
+
The plain function is equivalent to "primary.merged".
|
| 500 |
+
</p><a name="middle"></a><a name="h2-720"></a><h2>"middle" - Returns the centers of polygon bounding boxes</h2><a name="k_34"></a><p>Usage:</p><ul><li><tt>expression.middle([ options ])</tt></li></ul><p>
|
| 501 |
+
The middle operation acts on polygons and has the same effect than <a href="drc_ref_layer.html#middle">Layer#middle</a>.
|
| 502 |
+
It takes the same arguments. It is available as a method on <a href="drc_ref_drc.html">DRC</a> expressions or
|
| 503 |
+
as plain function, in which case it acts on the primary shapes.
|
| 504 |
+
</p><a name="outside"></a><a name="h2-731"></a><h2>"outside" - Selects shapes entirely outside other shapes</h2><a name="k_35"></a><p>Usage:</p><ul><li><tt>expression.outside(other)</tt></li><li><tt>outside(other)</tt></li></ul><p>
|
| 505 |
+
This method represents the selector of primary shapes
|
| 506 |
+
which are entirely outside shapes from the other layer.
|
| 507 |
+
Use this variant within <a href="drc_ref_drc.html">DRC</a> expressions (also see <a href="drc_ref_layer.html#drc">Layer#drc</a>).
|
| 508 |
+
</p><a name="overlapping"></a><a name="h2-743"></a><h2>"overlapping" - Selects shapes overlapping with other shapes</h2><a name="k_36"></a><p>Usage:</p><ul><li><tt>expression.overlapping(other) (optionally in conditions)</tt></li><li><tt>overlapping(other) (optionally in conditions)</tt></li></ul><p>
|
| 509 |
+
See <a href="#covering">covering</a> for a description of the use cases for this function.
|
| 510 |
+
When using "overlapping", shapes are selected when the overlap
|
| 511 |
+
shapes from the other layer.
|
| 512 |
+
</p><p>
|
| 513 |
+
When using this method with a count, the operation may not render
|
| 514 |
+
the correct results if the other input is not merged. By nature of the
|
| 515 |
+
generic DRC feature, only those shapes that interact with the primary shape
|
| 516 |
+
will be selected. If the other input is split into multiple polygons,
|
| 517 |
+
not all components may be captured and the computed interaction count
|
| 518 |
+
may be incorrect.
|
| 519 |
+
</p><a name="perimeter"></a><a name="h2-762"></a><h2>"perimeter" - Selects the input polygon if the perimeter is meeting the condition</h2><a name="k_37"></a><p>Usage:</p><ul><li><tt>expression.perimeter (in condition)</tt></li></ul><p>
|
| 520 |
+
This operation is used in conditions to select shapes based on their perimeter.
|
| 521 |
+
It is applicable on polygon expressions. The result will be the input
|
| 522 |
+
polygons if the perimeter condition is met.
|
| 523 |
+
</p><p>
|
| 524 |
+
See <a href="drc_ref_layer.html#drc">Layer#drc</a> for more details about comparison specs.
|
| 525 |
+
</p><p>
|
| 526 |
+
The following example will select all polygons with a perimeter less than 10 micrometers:
|
| 527 |
+
</p><p><pre>
|
| 528 |
+
out = in.drc(perimeter < 10.0)
|
| 529 |
+
out = in.drc(primary.perimeter < 10.0) # equivalent
|
| 530 |
+
</pre></p><p>
|
| 531 |
+
The perimeter method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 532 |
+
The plain function is equivalent to "primary.perimeter".
|
| 533 |
+
</p><a name="perimeter_sum"></a><a name="h2-785"></a><h2>"perimeter_sum" - Selects the input polygons if the sum of all perimeters meets the condition</h2><a name="k_38"></a><p>Usage:</p><ul><li><tt>expression.perimeter_sum (in condition)</tt></li></ul><p>
|
| 534 |
+
Returns the input polygons if the sum of their perimeters meets the specified
|
| 535 |
+
condition. This condition is evaluated on the total of all shapes generated in one step of the
|
| 536 |
+
"drc" loop. As there is a single primary in each loop iteration, "primary.perimeter_sum" is
|
| 537 |
+
equivalent to "primary.perimeter".
|
| 538 |
+
</p><p>
|
| 539 |
+
See <a href="drc_ref_layer.html#drc">Layer#drc</a> for more details about comparison specs.
|
| 540 |
+
</p><a name="polygons"></a><a name="h2-799"></a><h2>"polygons" - Converts the input shapes into polygons</h2><a name="k_39"></a><p>Usage:</p><ul><li><tt>expression.polygons([ enlargement ])</tt></li></ul><p>
|
| 541 |
+
Generates polygons from the input shapes. Polygons stay polygons. Edges and edge pairs
|
| 542 |
+
are converted to polygons. For this, the enlargement parameter will specify the
|
| 543 |
+
edge thickness or augmentation applied to edge pairs. With the default enlargement
|
| 544 |
+
of zero edges will not be converted to valid polygons and degenerated edge pairs
|
| 545 |
+
will not become valid polygons as well.
|
| 546 |
+
</p><p>
|
| 547 |
+
Contrary most other operations, "polygons" does not have a plain function equivalent
|
| 548 |
+
as this is reserved for the function generating a polygon layer.
|
| 549 |
+
</p><p>
|
| 550 |
+
This method is useful for generating polygons from DRC violation markers as shown in
|
| 551 |
+
the following example:
|
| 552 |
+
</p><p><pre>
|
| 553 |
+
out = in.drc((width < 0.5.um).polygons)
|
| 554 |
+
</pre></p><a name="rectangles"></a><a name="h2-822"></a><h2>"rectangles" - Selects all polygons which are rectangles</h2><a name="k_40"></a><p>Usage:</p><ul><li><tt>expression.rectangles</tt></li></ul><p>
|
| 555 |
+
This operation can be used as a plain function in which case it acts on primary
|
| 556 |
+
shapes or can be used as method on another DRC expression.
|
| 557 |
+
The following example selects all rectangles:
|
| 558 |
+
</p><p><pre>
|
| 559 |
+
out = in.drc(rectangles)
|
| 560 |
+
out = in.drc(primary.rectangles) # equivalent
|
| 561 |
+
</pre></p><a name="rectilinear"></a><a name="h2-838"></a><h2>"rectilinear" - Selects all polygons which are rectilinear</h2><a name="k_41"></a><p>Usage:</p><ul><li><tt>expression.rectilinear</tt></li></ul><p>
|
| 562 |
+
Rectilinear polygons only have vertical and horizontal edges. Such polygons are also
|
| 563 |
+
called manhattan polygons.
|
| 564 |
+
</p><p>
|
| 565 |
+
This operation can be used as a plain function in which case it acts on primary
|
| 566 |
+
shapes or can be used as method on another DRC expression.
|
| 567 |
+
The following example selects all manhattan polygons:
|
| 568 |
+
</p><p><pre>
|
| 569 |
+
out = in.drc(rectilinear)
|
| 570 |
+
out = in.drc(primary.rectilinear) # equivalent
|
| 571 |
+
</pre></p><a name="relative_height"></a><a name="h2-857"></a><h2>"relative_height" - Selects the input polygon according to the height vs. width of the bounding box</h2><a name="k_42"></a><p>Usage:</p><ul><li><tt>expression.relative_height (in condition)</tt></li></ul><p>
|
| 572 |
+
This operation is used in conditions to select shapes based on the ratio of bounding box
|
| 573 |
+
height vs. width. The taller the shape, the larger the value. Wide polygons have a value
|
| 574 |
+
below 1. A square has a relative height of 1.
|
| 575 |
+
</p><p>
|
| 576 |
+
This filter is applicable on polygon expressions. The result will be the input
|
| 577 |
+
polygon if the condition is met.
|
| 578 |
+
</p><p>
|
| 579 |
+
Don't use this method if you can use <a href="#bbox_aspect_ratio">bbox_aspect_ratio</a>, because the latter is
|
| 580 |
+
isotropic and can be used hierarchically without generating rotation variants.
|
| 581 |
+
</p><p>
|
| 582 |
+
See <a href="drc_ref_layer.html#drc">Layer#drc</a> for more details about comparison specs.
|
| 583 |
+
</p><p>
|
| 584 |
+
The following example will select all polygons whose relative height is larger than 3:
|
| 585 |
+
</p><p><pre>
|
| 586 |
+
out = in.drc(relative_height > 3)
|
| 587 |
+
out = in.drc(primary.relative_height > 3) # equivalent
|
| 588 |
+
</pre></p><p>
|
| 589 |
+
The "relative_height" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 590 |
+
The plain function is equivalent to "primary.bbox_aspect_ratio".
|
| 591 |
+
</p><a name="rounded_corners"></a><a name="h2-886"></a><h2>"rounded_corners" - Applies corner rounding</h2><a name="k_43"></a><p>Usage:</p><ul><li><tt>expression.rounded_corners(inner, outer, n)</tt></li></ul><p>
|
| 592 |
+
This operation acts on polygons and applies corner rounding to the given inner
|
| 593 |
+
and outer corner radius and the number of points n per full circle. See <a href="drc_ref_layer.html#rounded_corners">Layer#rounded_corners</a> for more details.
|
| 594 |
+
</p><p>
|
| 595 |
+
The "rounded_corners" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 596 |
+
The plain function is equivalent to "primary.rounded_corners".
|
| 597 |
+
</p><a name="second_edges"></a><a name="h2-899"></a><h2>"second_edges" - Returns the second edges of edge pairs</h2><a name="k_44"></a><p>Usage:</p><ul><li><tt>expression.second_edges</tt></li></ul><p>
|
| 598 |
+
This method acts on edge pair expressions and returns the second edges of the
|
| 599 |
+
edge pairs delivered by the expression.
|
| 600 |
+
</p><p>
|
| 601 |
+
Some checks deliver symmetric edge pairs (e.g. space, width, etc.) for which the
|
| 602 |
+
edges are commutable. "second_edges" will not deliver edges for such edge pairs.
|
| 603 |
+
Instead, "first_edges" will deliver both.
|
| 604 |
+
</p><a name="sized"></a><a name="h2-913"></a><h2>"sized" - Returns the sized version of the input</h2><a name="k_45"></a><p>Usage:</p><ul><li><tt>expression.sized(d [, mode])</tt></li><li><tt>expression.sized(dx, dy [, mode]))</tt></li></ul><p>
|
| 605 |
+
This method provides the same functionality as <a href="drc_ref_layer.html#sized">Layer#sized</a> and takes the same
|
| 606 |
+
arguments. It acts on polygon expressions.
|
| 607 |
+
</p><p>
|
| 608 |
+
The "sized" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 609 |
+
The plain function is equivalent to "primary.sized".
|
| 610 |
+
</p><a name="smoothed"></a><a name="h2-927"></a><h2>"smoothed" - Applies smoothing</h2><a name="k_46"></a><p>Usage:</p><ul><li><tt>expression.smoothed(d [, keep_hv ])</tt></li></ul><p>
|
| 611 |
+
This operation acts on polygons and applies polygon smoothing with the tolerance d. 'keep_hv' indicates
|
| 612 |
+
whether horizontal and vertical edges are maintained. Default is 'no' which means such edges may be distorted.
|
| 613 |
+
See <a href="drc_ref_layer.html#smoothed">Layer#smoothed</a> for more details.
|
| 614 |
+
</p><p>
|
| 615 |
+
The "smoothed" method is available as a plain function or as a method on <a href="drc_ref_drc.html">DRC</a> expressions.
|
| 616 |
+
The plain function is equivalent to "primary.smoothed".
|
| 617 |
+
</p><a name="squares"></a><a name="h2-941"></a><h2>"squares" - Selects all polygons which are squares</h2><a name="k_47"></a><p>Usage:</p><ul><li><tt>expression.squares</tt></li></ul><p>
|
| 618 |
+
This operation can be used as a plain function in which case it acts on primary
|
| 619 |
+
shapes or can be used as method on another DRC expression.
|
| 620 |
+
The following example selects all squares:
|
| 621 |
+
</p><p><pre>
|
| 622 |
+
out = in.drc(squares)
|
| 623 |
+
out = in.drc(primary.squares) # equivalent
|
| 624 |
+
</pre></p><a name="start_segments"></a><a name="h2-957"></a><h2>"start_segments" - Returns the part at the beginning of each edge of the input</h2><a name="k_48"></a><p>Usage:</p><ul><li><tt>expression.start_segments(length)</tt></li><li><tt>expression.start_segments(length, fraction)</tt></li></ul><p>
|
| 625 |
+
This method acts on edge expressions and delivers a specific part of each edge.
|
| 626 |
+
See <a href="drc_ref_layer.html#start_segments">layer#start_segments</a> for details about this functionality.
|
| 627 |
+
</p><a name="with_holes"></a><a name="h2-968"></a><h2>"with_holes" - Selects all input polygons with the specified number of holes</h2><a name="k_49"></a><p>Usage:</p><ul><li><tt>expression.with_holes (in condition)</tt></li></ul><p>
|
| 628 |
+
This operation can be used as a plain function in which case it acts on primary
|
| 629 |
+
shapes or can be used as method on another DRC expression.
|
| 630 |
+
The following example selects all polygons with more than 2 holes:
|
| 631 |
+
</p><p><pre>
|
| 632 |
+
out = in.drc(with_holes > 2)
|
| 633 |
+
out = in.drc(primary.with_holes > 2) # equivalent
|
| 634 |
+
</pre></p><a name="|"></a><a name="h2-984"></a><h2>"|" - Boolean OR between the results of two expressions</h2><a name="k_50"></a><p>Usage:</p><ul><li><tt>expression | expression</tt></li></ul><p>
|
| 635 |
+
The | operator will compute the boolean OR between the results of
|
| 636 |
+
two expressions. '+' is basically a synonym. Both expressions
|
| 637 |
+
must render the same type.
|
| 638 |
+
</p></div>
|
| 639 |
+
</div>
|
| 640 |
+
</body>
|
| 641 |
+
</html>
|
| 642 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref_global.html
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref_layer.html
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref_netter.html
ADDED
|
@@ -0,0 +1,496 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » <a href="drc_ref.html">DRC Reference</a> » DRC Reference: Netter object</p><h1>DRC Reference: Netter object</h1><a name="k_1"></a><p>
|
| 120 |
+
The Netter object provides services related to network extraction
|
| 121 |
+
from a layout. The relevant methods of this object are available
|
| 122 |
+
as global functions too where they act on a default incarnation
|
| 123 |
+
of the netter. Usually it's not required to instantiate a Netter
|
| 124 |
+
object, but it serves as a container for this functionality.
|
| 125 |
+
</p><p><pre>
|
| 126 |
+
# create a new Netter object:
|
| 127 |
+
nx = netter
|
| 128 |
+
nx.connect(poly, contact)
|
| 129 |
+
...
|
| 130 |
+
</pre></p><p>
|
| 131 |
+
Network formation:
|
| 132 |
+
</p><p>
|
| 133 |
+
A basic service the Netter object provides is the formation of
|
| 134 |
+
connected networks of conductive shapes (netting). To do so, the Netter
|
| 135 |
+
must be given a connection specification. This happens by calling
|
| 136 |
+
"connect" with two polygon layers. The Netter will then regard all
|
| 137 |
+
overlaps of shapes on these layers as connections between the
|
| 138 |
+
respective materials. Networks are the basis for netlist extraction,
|
| 139 |
+
network geometry deduction and the antenna check.
|
| 140 |
+
</p><p>
|
| 141 |
+
Connections can be cleared with "clear_connections". If not,
|
| 142 |
+
connections add atop of the already defined ones. Here is an
|
| 143 |
+
example for the antenna check:
|
| 144 |
+
</p><p><pre>
|
| 145 |
+
# build connction of poly+gate to metal1
|
| 146 |
+
connect(gate, poly)
|
| 147 |
+
connect(poly, contact)
|
| 148 |
+
connect(contact, metal1)
|
| 149 |
+
|
| 150 |
+
# runs an antenna check for metal1 with a ratio of 50
|
| 151 |
+
m1_antenna_errors = antenna_check(gate, metal1, 50.0)
|
| 152 |
+
|
| 153 |
+
# add connections to metal2
|
| 154 |
+
connect(metal1, via1)
|
| 155 |
+
connect(via1, metal2)
|
| 156 |
+
|
| 157 |
+
# runs an antenna check for metal2 with a ratio of 70.0
|
| 158 |
+
m2_antenna_errors = antenna_check(gate, metal2, 70.0)
|
| 159 |
+
|
| 160 |
+
# this will remove all connections made
|
| 161 |
+
clear_connections
|
| 162 |
+
...
|
| 163 |
+
</pre></p><p>
|
| 164 |
+
Further functionality of the Netter object:
|
| 165 |
+
</p><p>
|
| 166 |
+
More methods will be added in the future to support network-related features.
|
| 167 |
+
</p><ul><li><a href="#h2-64">"antenna_check" - Performs an antenna check</a></li><li><a href="#h2-209">"clear_connections" - Clears all connections stored so far</a></li><li><a href="#h2-218">"connect" - Specifies a connection between two layers</a></li><li><a href="#h2-245">"connect_explicit" - Specifies a list of net names for nets to connect ("must connect" nets)</a></li><li><a href="#h2-291">"connect_global" - Connects a layer with a global net</a></li><li><a href="#h2-303">"connect_implicit" - Specifies a search pattern for implicit net connections ("must connect" nets)</a></li><li><a href="#h2-334">"device_scaling" - Specifies a dimension scale factor for the geometrical device properties</a></li><li><a href="#h2-345">"extract_devices" - Extracts devices based on the given extractor class, name and device layer selection</a></li><li><a href="#h2-404">"ignore_extraction_errors" - Specifies whether to ignore extraction errors</a></li><li><a href="#h2-415">"l2n_data" - Gets the internal LayoutToNetlist object</a></li><li><a href="#h2-425">"name" - Assigns a name to a layer</a></li><li><a href="#h2-467">"name_prefix" - Specifies the name prefix for auto-generated layer names</a></li><li><a href="#h2-476">"netlist" - Gets the extracted netlist or triggers extraction if not done yet</a></li><li><a href="#h2-488">"soft_connect" - Specifies a soft connection between two layers</a></li><li><a href="#h2-516">"soft_connect_global" - Soft-connects a layer with a global net</a></li><li><a href="#h2-531">"top_level" - Specifies top level mode</a></li></ul><a name="antenna_check"></a><a name="h2-64"></a><h2>"antenna_check" - Performs an antenna check</h2><a name="k_2"></a><p>Usage:</p><ul><li><tt>antenna_check(gate, metal, ratio, [ diode_specs ... ] [, texts ])</tt></li></ul><p>
|
| 168 |
+
The antenna check is used to avoid plasma induced damage. Physically,
|
| 169 |
+
the damage happes if during the manufacturing of a metal layer with
|
| 170 |
+
plasma etching charge accumulates on the metal islands. On reaching a
|
| 171 |
+
certain threshold, this charge may discarge over gate oxide attached of
|
| 172 |
+
devices attached to such metal areas hence damaging it.
|
| 173 |
+
</p><p>
|
| 174 |
+
Antenna checks are performed by collecting all connected nets up to
|
| 175 |
+
a certain metal layer and then computing the area of all metal shapes
|
| 176 |
+
and all connected gates of a certain kind (e.g. thin and thick oxide gates).
|
| 177 |
+
The ratio of metal area divided by the gate area must not exceed a certain
|
| 178 |
+
threshold.
|
| 179 |
+
</p><p>
|
| 180 |
+
A simple antenna check is this:
|
| 181 |
+
</p><p><pre>
|
| 182 |
+
poly = ... # poly layer
|
| 183 |
+
diff = ... # diffusion layer
|
| 184 |
+
contact = ... # contact layer
|
| 185 |
+
metal1 = ... # metal layer
|
| 186 |
+
|
| 187 |
+
# compute gate area
|
| 188 |
+
gate = poly & diff
|
| 189 |
+
|
| 190 |
+
# note that gate and poly have to be included - gate is
|
| 191 |
+
# a subset of poly, but forms the sensitive area
|
| 192 |
+
connect(gate, poly)
|
| 193 |
+
connect(poly, contact)
|
| 194 |
+
connect(contact, metal1)
|
| 195 |
+
errors = antenna_check(gate, metal1, 50.0)
|
| 196 |
+
</pre></p><p>
|
| 197 |
+
Usually antenna checks apply to multiple metal layers. In this case,
|
| 198 |
+
the connectivity needs to be extended after the first check to include
|
| 199 |
+
the next metal layers. This can be achieved with incremental connects:
|
| 200 |
+
</p><p><pre>
|
| 201 |
+
# provide connections up to metal1
|
| 202 |
+
connect(gate, poly)
|
| 203 |
+
connect(poly, contact)
|
| 204 |
+
connect(contact, metal1)
|
| 205 |
+
metal1_errors = antenna_check(gate, metal1, 50.0)
|
| 206 |
+
|
| 207 |
+
# now *add* connections up to metal2
|
| 208 |
+
connect(metal1, via1)
|
| 209 |
+
connect(via1, metal2)
|
| 210 |
+
metal2_errors = antenna_check(gate, metal2, 50.0)
|
| 211 |
+
|
| 212 |
+
... continue this scheme with further metal layers ...
|
| 213 |
+
</pre></p><p>
|
| 214 |
+
Plasma induced damage can be rectified by including diodes
|
| 215 |
+
which create a safe current path for discharging the metal
|
| 216 |
+
islands. Such diodes can be identified with a recognition layer
|
| 217 |
+
(usually the diffusion area of a certain kind). You can include
|
| 218 |
+
such diode recognition layers in the antenna check. If a connection
|
| 219 |
+
is detected to a diode, the respective network is skipped:
|
| 220 |
+
</p><p><pre>
|
| 221 |
+
...
|
| 222 |
+
diode = ... # diode recognition layer
|
| 223 |
+
|
| 224 |
+
connect(diode, contact)
|
| 225 |
+
errors = antenna_check(gate, metal1, 50.0, diode)
|
| 226 |
+
</pre></p><p>
|
| 227 |
+
You can also make diode connections decreases the
|
| 228 |
+
sensitivity of the antenna check depending on the size
|
| 229 |
+
of the diode. The following specification makes
|
| 230 |
+
diode connections increase the ratio threshold by
|
| 231 |
+
10 per square micrometer of diode area:
|
| 232 |
+
</p><p><pre>
|
| 233 |
+
...
|
| 234 |
+
diode = ... # diode recognition layer
|
| 235 |
+
|
| 236 |
+
connect(diode, contact)
|
| 237 |
+
# each square micrometer of diode area connected to a network
|
| 238 |
+
# will add 10 to the ratio:
|
| 239 |
+
errors = antenna_check(gate, metal1, 50.0, [ diode, 10.0 ])
|
| 240 |
+
</pre></p><p>
|
| 241 |
+
Multiple diode specifications are allowed. Just add them
|
| 242 |
+
to the antenna_check call.
|
| 243 |
+
</p><p>
|
| 244 |
+
You can include the perimeter into the area computation for
|
| 245 |
+
the gate or metal layer or both. The physical picture
|
| 246 |
+
is this: the side walls of the material contribute to the
|
| 247 |
+
surface too. As the side wall area can be estimated by taking
|
| 248 |
+
the perimeter times some material thickness, the effective
|
| 249 |
+
area is:
|
| 250 |
+
</p><p><pre>
|
| 251 |
+
A(eff) = A + P * t
|
| 252 |
+
</pre></p><p>
|
| 253 |
+
Here A is the area of the polygons and P is their perimeter.
|
| 254 |
+
t is the "thickness" in micrometer units. To specify such
|
| 255 |
+
a condition, use the following notation:
|
| 256 |
+
</p><p><pre>
|
| 257 |
+
errors = antenna_check(area_and_perimeter(gate, 0.5), ...)
|
| 258 |
+
</pre></p><p>
|
| 259 |
+
"area_and_perimeter" takes the polygon layer and the
|
| 260 |
+
thickness (0.5 micrometers in this case).
|
| 261 |
+
This notation can be applied to both gate and
|
| 262 |
+
metal layers. A detailed notation for the usual,
|
| 263 |
+
area-only case is available as well for completeness:
|
| 264 |
+
</p><p><pre>
|
| 265 |
+
errors = antenna_check(area_only(gate), ...)
|
| 266 |
+
|
| 267 |
+
# this is equivalent to a zero thickness:
|
| 268 |
+
errors = antenna_check(area_and_perimeter(gate, 0.0), ...)
|
| 269 |
+
# or the standard case:
|
| 270 |
+
errors = antenna_check(gate, ...)
|
| 271 |
+
</pre></p><p>
|
| 272 |
+
Finally there is also "perimeter_only". When using this
|
| 273 |
+
specification with a thickness value, the area is computed
|
| 274 |
+
from the perimeter alone:
|
| 275 |
+
</p><p><pre>
|
| 276 |
+
A(eff) = P * t
|
| 277 |
+
</pre></p><p><pre>
|
| 278 |
+
errors = antenna_check(perimeter_only(gate, 0.5), ...)
|
| 279 |
+
</pre></p><p>
|
| 280 |
+
The error shapes produced by the antenna check are copies
|
| 281 |
+
of the metal shapes on the metal layers of each network
|
| 282 |
+
violating the antenna rule.
|
| 283 |
+
</p><p>
|
| 284 |
+
You can specify a text layer (use "labels" to create one). It will receive
|
| 285 |
+
error labels describing the measured values and computation parameters for debugging
|
| 286 |
+
the layout. This option has been introduced in version 0.27.11.
|
| 287 |
+
</p><a name="clear_connections"></a><a name="h2-209"></a><h2>"clear_connections" - Clears all connections stored so far</h2><a name="k_3"></a><p>Usage:</p><ul><li><tt>clear_connections</tt></li></ul><p>
|
| 288 |
+
See <a href="#connect">connect</a> for more details.
|
| 289 |
+
</p><a name="connect"></a><a name="h2-218"></a><h2>"connect" - Specifies a connection between two layers</h2><a name="k_4"></a><p>Usage:</p><ul><li><tt>connect(a, b)</tt></li></ul><p>
|
| 290 |
+
a and b must be polygon or text layers. After calling this function, the
|
| 291 |
+
Netter regards all overlapping or touching shapes on these layers
|
| 292 |
+
to form an electrical connection between the materials formed by
|
| 293 |
+
these layers. This also implies intra-layer connections: shapes
|
| 294 |
+
on these layers touching or overlapping other shapes on these
|
| 295 |
+
layers will form bigger, electrically connected areas.
|
| 296 |
+
</p><p>
|
| 297 |
+
Texts will be used to assign net names to the nets. The preferred
|
| 298 |
+
method is to use <a href="drc_ref_global.html#labels">labels</a> to create a text layer from a design
|
| 299 |
+
layer. When using <a href="drc_ref_global.html#input">input</a>, text labels are carried implicitly
|
| 300 |
+
with the polygons but at the cost of small dummy shapes (2x2 DBU
|
| 301 |
+
marker polygons) and limited functionality.
|
| 302 |
+
</p><p>
|
| 303 |
+
Multiple connect calls must be made to form larger connectivity
|
| 304 |
+
stacks across multiple layers. Such stacks may include forks and
|
| 305 |
+
joins.
|
| 306 |
+
</p><p>
|
| 307 |
+
Connections are accumulated. The connections defined so far
|
| 308 |
+
can be cleared with <a href="#clear_connections">clear_connections</a>.
|
| 309 |
+
</p><a name="connect_explicit"></a><a name="h2-245"></a><h2>"connect_explicit" - Specifies a list of net names for nets to connect ("must connect" nets)</h2><a name="k_5"></a><p>Usage:</p><ul><li><tt>connect_explicit(net_names)</tt></li><li><tt>connect_explicit(cell_pattern, net_names)</tt></li></ul><p>
|
| 310 |
+
Use this method to explicitly connect nets even if there is no physical connection.
|
| 311 |
+
The concept is similar to implicit connection (see <a href="#connect_implicit">connect_implicit</a>). The method gets
|
| 312 |
+
a list of nets which are connected virtually, even if there is no physical connection.
|
| 313 |
+
The first version applies this scheme to all cells, the second version to cells matching
|
| 314 |
+
the cell name pattern. The cell name pattern follows the usual glob style form (e.g. "A*"
|
| 315 |
+
applies the connection in all cells whose name starts with "A").
|
| 316 |
+
</p><p>
|
| 317 |
+
This method is useful to establish a logical connection which is made later up on the
|
| 318 |
+
next level of hierarchy. For example, a standard cell my not contain substrate or well
|
| 319 |
+
taps as these may be made by tap or spare cells. Logically however, the cell only has
|
| 320 |
+
one power or ground pin for the devices and substrate or well. In order to match both
|
| 321 |
+
representations - for example for the purpose of LVS - the dual power or ground pins have
|
| 322 |
+
to be connected. Assuming that there is a global net "BULK" for the substrate and a
|
| 323 |
+
net "VSS" for the sources of the NMOS devices, the following statement will create this
|
| 324 |
+
connection for all cell names beginning with "INV":
|
| 325 |
+
</p><p><pre>
|
| 326 |
+
connect_global(bulk, "BULK")
|
| 327 |
+
...
|
| 328 |
+
connect_explicit("INV*", [ "BULK", "VSS" ])
|
| 329 |
+
</pre></p><p>
|
| 330 |
+
The resulting net and pin will carry a name made from the combination of the connected
|
| 331 |
+
nets. In this case it will be "BULK,VSS".
|
| 332 |
+
</p><p>
|
| 333 |
+
The virtual connection in general bears the risk of missing a physical connection.
|
| 334 |
+
The "connect_explicit" feature therefore checks whether the connection is made physically
|
| 335 |
+
on the next hierarchy level ("must connect" nets), except for top-level cells for which
|
| 336 |
+
it is assumed that this connection is made later.
|
| 337 |
+
A warning is raised instead for top level cells.
|
| 338 |
+
</p><p>
|
| 339 |
+
Explicit connections also imply implicit connections between different parts of
|
| 340 |
+
one of the nets. In the example before, "VSS" pieces without a physical connection
|
| 341 |
+
will also be connected.
|
| 342 |
+
</p><p>
|
| 343 |
+
The explicit connections are applied on the next net extraction and cleared
|
| 344 |
+
on "clear_connections".
|
| 345 |
+
</p><a name="connect_global"></a><a name="h2-291"></a><h2>"connect_global" - Connects a layer with a global net</h2><a name="k_6"></a><p>Usage:</p><ul><li><tt>connect_global(l, name)</tt></li></ul><p>
|
| 346 |
+
Connects the shapes from the given layer l to a global net with the given name.
|
| 347 |
+
Global nets are common to all cells. Global nets automatically connect to parent
|
| 348 |
+
cells throughs implied pins. An example is the substrate (bulk) net which connects
|
| 349 |
+
to shapes belonging to tie-down diodes. "l" can be a polygon or text layer.
|
| 350 |
+
</p><a name="connect_implicit"></a><a name="h2-303"></a><h2>"connect_implicit" - Specifies a search pattern for implicit net connections ("must connect" nets)</h2><a name="k_7"></a><p>Usage:</p><ul><li><tt>connect_implicit(label_pattern)</tt></li><li><tt>connect_implicit(cell_pattern, label_pattern)</tt></li></ul><p>
|
| 351 |
+
This method specifies a net name search pattern, either for all cells or for
|
| 352 |
+
certain cells, given by a name search pattern. Search pattern follow the usual glob
|
| 353 |
+
form (e.g. "A*" for all cells or nets with names starting with "A").
|
| 354 |
+
</p><p>
|
| 355 |
+
Then, for nets matching the net name pattern and for which there is more than
|
| 356 |
+
one subnet, the subnets are connected. "Subnets" are physically disconnected parts
|
| 357 |
+
of a net which carry the same name.
|
| 358 |
+
</p><p>
|
| 359 |
+
This feature is useful for example for power nets which are complete in a cell,
|
| 360 |
+
but are supposed to be connected upwards in the hierarchy ("must connect" nets).
|
| 361 |
+
Physically there are multiple nets, logically - and specifically in the schematic for
|
| 362 |
+
the purpose of LVS - there is only one net.
|
| 363 |
+
"connect_implicit" now creates a virtual, combined physical net that matches the logical net.
|
| 364 |
+
</p><p>
|
| 365 |
+
This is general bears the risk of missing a physical connection. The "connect_implicit"
|
| 366 |
+
feature therefore checks whether the connection is made physically on the next hierarchy
|
| 367 |
+
level, except for top-level cells for which it is assumed that this connection is made
|
| 368 |
+
later. A warning is raised instead for top level cells.
|
| 369 |
+
</p><p>
|
| 370 |
+
The implicit connections are applied on the next net extraction and cleared
|
| 371 |
+
on "clear_connections". Another feature is <a href="#connect_explicit">connect_explicit</a> which allows connecting
|
| 372 |
+
differently named subnets in a similar fashion.
|
| 373 |
+
</p><a name="device_scaling"></a><a name="h2-334"></a><h2>"device_scaling" - Specifies a dimension scale factor for the geometrical device properties</h2><a name="k_8"></a><p>Usage:</p><ul><li><tt>device_scaling(factor)</tt></li></ul><p>
|
| 374 |
+
Specifying a factor of 2 will make all devices being extracted as if the
|
| 375 |
+
geometries were two times larger. This feature is useful when the drawn layout
|
| 376 |
+
does not correspond to the physical dimensions.
|
| 377 |
+
</p><a name="extract_devices"></a><a name="h2-345"></a><h2>"extract_devices" - Extracts devices based on the given extractor class, name and device layer selection</h2><a name="k_9"></a><p>Usage:</p><ul><li><tt>extract_devices(extractor, layer_hash)</tt></li><li><tt>extract_devices(extractor_class, name, layer_hash)</tt></li></ul><p>
|
| 378 |
+
Runs the device extraction for given device extractor class. In the first
|
| 379 |
+
form, the extractor object is given. In the second form, the extractor's
|
| 380 |
+
class object and the new extractor's name is given.
|
| 381 |
+
</p><p>
|
| 382 |
+
The device extractor is either an instance of one of the predefined extractor
|
| 383 |
+
classes (e.g. obtained from the utility methods such as <a href="drc_ref_global.html#mos4">mos4</a>) or a custom class.
|
| 384 |
+
It provides the
|
| 385 |
+
algorithms for deriving the device parameters from the device geometry. It needs
|
| 386 |
+
several device recognition layers which are passed in the layer hash.
|
| 387 |
+
</p><p>
|
| 388 |
+
Predefined device extractors are:
|
| 389 |
+
</p><p><ul><li><a href="drc_ref_global.html#mos3">mos3</a> - A three-terminal MOS transistor </li><li><a href="drc_ref_global.html#mos4">mos4</a> - A four-terminal MOS transistor </li><li><a href="drc_ref_global.html#dmos3">dmos3</a> - A three-terminal MOS asymmetric transistor </li><li><a href="drc_ref_global.html#dmos4">dmos4</a> - A four-terminal MOS asymmetric transistor </li><li><a href="drc_ref_global.html#bjt3">bjt3</a> - A three-terminal bipolar transistor </li><li><a href="drc_ref_global.html#bjt4">bjt4</a> - A four-terminal bipolar transistor </li><li><a href="drc_ref_global.html#diode">diode</a> - A planar diode </li><li><a href="drc_ref_global.html#resistor">resistor</a> - A resistor </li><li><a href="drc_ref_global.html#resistor_with_bulk">resistor_with_bulk</a> - A resistor with a separate bulk terminal </li><li><a href="drc_ref_global.html#capacitor">capacitor</a> - A capacitor </li><li><a href="drc_ref_global.html#capacitor_with_bulk">capacitor_with_bulk</a> - A capacitor with a separate bulk terminal </li></ul></p><p>
|
| 390 |
+
Each device class (e.g. n-MOS/p-MOS or high Vt/low Vt) needs its own instance
|
| 391 |
+
of device extractor. The device extractor beside the algorithm and specific
|
| 392 |
+
extraction settings defines the name of the device to be built.
|
| 393 |
+
</p><p>
|
| 394 |
+
The layer hash is a map of device type specific functional names (key) and
|
| 395 |
+
polygon layers (value). Here is an example:
|
| 396 |
+
</p><p><pre>
|
| 397 |
+
deep
|
| 398 |
+
|
| 399 |
+
nwell = input(1, 0)
|
| 400 |
+
active = input(2, 0)
|
| 401 |
+
poly = input(3, 0)
|
| 402 |
+
bulk = make_layer # renders an empty layer used for putting the terminals on
|
| 403 |
+
|
| 404 |
+
nactive = active - nwell # active area of NMOS
|
| 405 |
+
nsd = nactive - poly # source/drain area
|
| 406 |
+
gate = nactive & poly # gate area
|
| 407 |
+
|
| 408 |
+
extract_devices(mos4("NMOS4"), { :SD => nsd, :G => gate, :P => poly, :W => bulk })
|
| 409 |
+
</pre></p><p>
|
| 410 |
+
The return value of this method will be the device class of the devices
|
| 411 |
+
generated in the extraction step (see <a href="../code/class_DeviceClass.html">DeviceClass</a>).
|
| 412 |
+
</p><a name="ignore_extraction_errors"></a><a name="h2-404"></a><h2>"ignore_extraction_errors" - Specifies whether to ignore extraction errors</h2><a name="k_10"></a><p>Usage:</p><ul><li><tt>ignore_extraction_errors(value)</tt></li></ul><p>
|
| 413 |
+
With this value set to false (the default), "extract_netlist" will raise
|
| 414 |
+
an exception upon extraction errors. Otherwise, extraction errors will be logged
|
| 415 |
+
but no error is raised.
|
| 416 |
+
</p><a name="l2n_data"></a><a name="h2-415"></a><h2>"l2n_data" - Gets the internal <a href="../code/class_LayoutToNetlist.html">LayoutToNetlist</a> object</h2><a name="k_11"></a><p>Usage:</p><ul><li><tt>l2n_data</tt></li></ul><p>
|
| 417 |
+
The <a href="../code/class_LayoutToNetlist.html">LayoutToNetlist</a> object provides access to the internal details of
|
| 418 |
+
the netter object.
|
| 419 |
+
</p><a name="name"></a><a name="h2-425"></a><h2>"name" - Assigns a name to a layer</h2><a name="k_12"></a><p>Usage:</p><ul><li><tt>name(layer, name)</tt></li><li><tt>name(layer, name, layer_number, datatype_number)</tt></li><li><tt>name(layer, name, layer_info)</tt></li></ul><p>
|
| 420 |
+
Layer names are listed in the LayoutToNetlist (L2N) or LVS database. They
|
| 421 |
+
are used to identify the layers, the net or device terminal geometries are
|
| 422 |
+
on. It is usual to have computed layers, so it is necessary to indicate the
|
| 423 |
+
purpose of the layer for later reuse of the geometries.
|
| 424 |
+
</p><p>
|
| 425 |
+
It is a good practice to assign names to computed and original layers,
|
| 426 |
+
for example:
|
| 427 |
+
</p><p><pre>
|
| 428 |
+
poly = input(...)
|
| 429 |
+
poly_resistor = input(...)
|
| 430 |
+
|
| 431 |
+
poly_wiring = poly - poly_resistor
|
| 432 |
+
name(poly_wiring, "poly_wiring")
|
| 433 |
+
</pre></p><p>
|
| 434 |
+
Names must be assigned before the layers are used for the first time
|
| 435 |
+
in <a href="#connect">connect</a>, <a href="#soft_connect">soft_connect</a>, <a href="#connect_global">connect_global</a>, <a href="#soft_connect_global">soft_connect_global</a> and
|
| 436 |
+
<a href="#extract_devices">extract_devices</a> statements.
|
| 437 |
+
</p><p>
|
| 438 |
+
If layers are not named, they will be given a name made from the
|
| 439 |
+
<a href="#name_prefix">name_prefix</a> and an incremental number when the layer is used for the
|
| 440 |
+
first time.
|
| 441 |
+
</p><p><a href="#name">name</a> can only be used once on a layer and the layer names must be
|
| 442 |
+
unique (not taken by another layer).
|
| 443 |
+
</p><p>
|
| 444 |
+
The layer/datatype or LayerInfo specification is optional and will
|
| 445 |
+
be used to configure the internal layout. This information is also
|
| 446 |
+
persisted inside database files. Specifying a layer/datatype information
|
| 447 |
+
is useful, if a layer is not an original layer, but is to be restored
|
| 448 |
+
to an actual layout layer later.
|
| 449 |
+
</p><a name="name_prefix"></a><a name="h2-467"></a><h2>"name_prefix" - Specifies the name prefix for auto-generated layer names</h2><a name="k_13"></a><p>Usage:</p><ul><li><tt>name_prefix(prefix)</tt></li></ul><p>
|
| 450 |
+
See <a href="#name"></a> for details. The default prefix is "l".
|
| 451 |
+
</p><a name="netlist"></a><a name="h2-476"></a><h2>"netlist" - Gets the extracted netlist or triggers extraction if not done yet</h2><a name="k_14"></a><p>Usage:</p><ul><li><tt>netlist</tt></li></ul><p>
|
| 452 |
+
If no extraction has been performed yet, this method will start the
|
| 453 |
+
layout analysis. Hence, all <a href="#connect">connect</a>, <a href="#connect_global">connect_global</a> and <a href="#connect_implicit">connect_implicit</a>
|
| 454 |
+
calls must have been made before this method is used. Further <a href="#connect">connect</a>
|
| 455 |
+
statements will clear the netlist and re-extract it again.
|
| 456 |
+
</p><a name="soft_connect"></a><a name="h2-488"></a><h2>"soft_connect" - Specifies a soft connection between two layers</h2><a name="k_15"></a><p>Usage:</p><ul><li><tt>soft_connect(a, b)</tt></li></ul><p>
|
| 457 |
+
a and b must be polygon or text layers. After calling this function, the
|
| 458 |
+
Netter considers shapes from layer a and b connected in "soft mode".
|
| 459 |
+
Typically, b is a high-ohmic layer such as diffusion, implant for substate
|
| 460 |
+
material, also called the "lower" layer.
|
| 461 |
+
</p><p>
|
| 462 |
+
A soft connection between shapes from layer a and b forms a directional
|
| 463 |
+
connection like an ideal diode: current can flow down, but now up
|
| 464 |
+
(not meant in the physical sense, this is a concept).
|
| 465 |
+
</p><p>
|
| 466 |
+
Hence, two nets are disconnected, if they both connect to the same lower layer,
|
| 467 |
+
but do not have a connection between them.
|
| 468 |
+
</p><p>
|
| 469 |
+
The netlist extractor will use this scheme to identify nets that are
|
| 470 |
+
connected only via such a high-ohmic region. Such a case is typically
|
| 471 |
+
bad for the functionality of a device and reported as an error.
|
| 472 |
+
Once, the check has been made and no error is found, soft-connected
|
| 473 |
+
nets are joined the same way than hard connections are made.
|
| 474 |
+
</p><p>
|
| 475 |
+
Beside this, soft connections follow the same rules than hard connections
|
| 476 |
+
(see <a href="#connect">connect</a>).
|
| 477 |
+
</p><a name="soft_connect_global"></a><a name="h2-516"></a><h2>"soft_connect_global" - Soft-connects a layer with a global net</h2><a name="k_16"></a><p>Usage:</p><ul><li><tt>soft-connect_global(l, name)</tt></li></ul><p>
|
| 478 |
+
Connects the shapes from the given layer l to a global net with the given name
|
| 479 |
+
in "soft mode".
|
| 480 |
+
</p><p>
|
| 481 |
+
See <a href="#connect_global">connect_global</a> for details about the concepts of global nets.
|
| 482 |
+
See <a href="#soft_connect">soft_connect</a> for details about the concept of soft connections.
|
| 483 |
+
In global net soft connections, the global net (typically a substrate)
|
| 484 |
+
is always the "lower" layer.
|
| 485 |
+
</p><a name="top_level"></a><a name="h2-531"></a><h2>"top_level" - Specifies top level mode</h2><a name="k_17"></a><p>Usage:</p><ul><li><tt>top_level(value)</tt></li></ul><p>
|
| 486 |
+
With this value set to false (the default), it is assumed that the
|
| 487 |
+
circuit is not used as a top level chip circuit. In that case, for
|
| 488 |
+
example must-connect nets which are not connected are reported as
|
| 489 |
+
as warnings. If top level mode is set to true, such disconnected
|
| 490 |
+
nets are reported as errors as this indicates a missing physical
|
| 491 |
+
connection.
|
| 492 |
+
</p></div>
|
| 493 |
+
</div>
|
| 494 |
+
</body>
|
| 495 |
+
</html>
|
| 496 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/drc_ref_source.html
ADDED
|
@@ -0,0 +1,335 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » <a href="drc_ref.html">DRC Reference</a> » DRC Reference: Source Object</p><h1>DRC Reference: Source Object</h1><a name="k_1"></a><p>
|
| 120 |
+
The layer object represents a collection of polygons, edges or edge pairs.
|
| 121 |
+
A source specifies where to take layout from. That includes the actual layout,
|
| 122 |
+
the top cell and options such as clip/query boxes, cell filters etc.
|
| 123 |
+
</p><ul><li><a href="#h2-16">"cell" - Specifies input from a specific cell</a></li><li><a href="#h2-26">"cell_name" - Returns the name of the currently selected cell</a></li><li><a href="#h2-32">"cell_obj" - Returns the Cell object of the currently selected cell</a></li><li><a href="#h2-38">"clip" - Specifies clipped input</a></li><li><a href="#h2-57">"edge_pairs" - Gets the edge pairs from an input layer</a></li><li><a href="#h2-81">"edges" - Gets the edge shapes (or shapes that can be converted edges) from an input layer</a></li><li><a href="#h2-105">"extent" - Returns a layer with the bounding box of the selected layout or cells</a></li><li><a href="#h2-131">"global_transform" - Gets or sets a global transformation</a></li><li><a href="#h2-165">"input" - Specifies input from a source</a></li><li><a href="#h2-230">"labels" - Gets the labels (texts) from an input layer</a></li><li><a href="#h2-252">"layers" - Gets the layers the source contains</a></li><li><a href="#h2-276">"layout" - Returns the Layout object associated with this source</a></li><li><a href="#h2-282">"make_layer" - Creates an empty polygon layer based on the hierarchy of the layout</a></li><li><a href="#h2-292">"overlapping" - Specifies input selected from a region in overlapping mode</a></li><li><a href="#h2-308">"path" - Gets the path of the corresponding layout file or nil if there is no path</a></li><li><a href="#h2-314">"polygons" - Gets the polygon shapes (or shapes that can be converted polygons) from an input layer</a></li><li><a href="#h2-335">"select" - Adds cell name expressions to the cell filters</a></li><li><a href="#h2-397">"touching" - Specifies input selected from a region in touching mode</a></li></ul><a name="cell"></a><a name="h2-16"></a><h2>"cell" - Specifies input from a specific cell</h2><a name="k_2"></a><p>Usage:</p><ul><li><tt>source.cell(name)</tt></li></ul><p>
|
| 124 |
+
This method will create a new source that delivers shapes from the
|
| 125 |
+
specified cell.
|
| 126 |
+
</p><a name="cell_name"></a><a name="h2-26"></a><h2>"cell_name" - Returns the name of the currently selected cell</h2><a name="k_3"></a><p>Usage:</p><ul><li><tt>cell_name</tt></li></ul><a name="cell_obj"></a><a name="h2-32"></a><h2>"cell_obj" - Returns the <a href="../code/class_Cell.html">Cell</a> object of the currently selected cell</h2><a name="k_4"></a><p>Usage:</p><ul><li><tt>cell_obj</tt></li></ul><a name="clip"></a><a name="h2-38"></a><h2>"clip" - Specifies clipped input</h2><a name="k_5"></a><p>Usage:</p><ul><li><tt>source.clip(box)</tt></li><li><tt>source.clip(p1, p2)</tt></li><li><tt>source.clip(l, b, r, t)</tt></li></ul><p>
|
| 127 |
+
Creates a source which represents a rectangular part of the
|
| 128 |
+
original input. Three ways are provided to specify the rectangular
|
| 129 |
+
region: a single <a href="../code/class_DBox.html">DBox</a> object (micron units), two <a href="../code/class_DPoint.html">DPoint</a>
|
| 130 |
+
objects (lower/left and upper/right coordinate in micron units)
|
| 131 |
+
or four coordinates: left, bottom, right and top coordinate.
|
| 132 |
+
</p><p>
|
| 133 |
+
This method will create a new source which delivers the shapes
|
| 134 |
+
from that region clipped to the rectangle. A method doing the
|
| 135 |
+
same but without clipping is <a href="#touching">touching</a> or <a href="#overlapping">overlapping</a>.
|
| 136 |
+
</p><a name="edge_pairs"></a><a name="h2-57"></a><h2>"edge_pairs" - Gets the edge pairs from an input layer</h2><a name="k_6"></a><p>Usage:</p><ul><li><tt>source.edge_pairs</tt></li><li><tt>source.edge_pairs(layer)</tt></li><li><tt>source.edge_pairs(layer, datatype)</tt></li><li><tt>source.edge_pairs(layer_info)</tt></li><li><tt>source.edge_pairs(filter, ...)</tt></li></ul><p>
|
| 137 |
+
Creates a layer with the edge_pairs from the given layer of the source.
|
| 138 |
+
Edge pairs are not supported by layout formats so far. So except if the source is
|
| 139 |
+
a custom-built layout object, this method has little use. It is provided for future
|
| 140 |
+
extensions which may include edge pairs in file streams.
|
| 141 |
+
</p><p>
|
| 142 |
+
This method is identical to <a href="#input">input</a> with respect to the options supported.
|
| 143 |
+
</p><p>
|
| 144 |
+
Use the global version of "edge_pairs" without a source object to address the default source.
|
| 145 |
+
</p><p>
|
| 146 |
+
"edge_pairs" without any arguments will create a new, empty original layer.
|
| 147 |
+
</p><p>
|
| 148 |
+
This method has been introduced in version 0.27.
|
| 149 |
+
</p><a name="edges"></a><a name="h2-81"></a><h2>"edges" - Gets the edge shapes (or shapes that can be converted edges) from an input layer</h2><a name="k_7"></a><p>Usage:</p><ul><li><tt>source.edges</tt></li><li><tt>source.edges(layer)</tt></li><li><tt>source.edges(layer, datatype)</tt></li><li><tt>source.edges(layer_info)</tt></li><li><tt>source.edges(filter, ...)</tt></li></ul><p>
|
| 150 |
+
Creates a layer with the edges from the given layer of the source.
|
| 151 |
+
Edge layers are formed from shapes by decomposing the shapes into edges: polygons
|
| 152 |
+
for example are decomposed into their outline edges. Some file formats support egdes
|
| 153 |
+
as native objects.
|
| 154 |
+
</p><p>
|
| 155 |
+
This method is identical to <a href="#input">input</a> with respect to the options supported.
|
| 156 |
+
</p><p>
|
| 157 |
+
Use the global version of "edges" without a source object to address the default source.
|
| 158 |
+
</p><p>
|
| 159 |
+
"edges" without any arguments will create a new, empty original layer.
|
| 160 |
+
</p><p>
|
| 161 |
+
This method has been introduced in version 0.27.
|
| 162 |
+
</p><a name="extent"></a><a name="h2-105"></a><h2>"extent" - Returns a layer with the bounding box of the selected layout or cells</h2><a name="k_8"></a><p>Usage:</p><ul><li><tt>source.extent</tt></li><li><tt>source.extent(cell_filter)</tt></li></ul><p>
|
| 163 |
+
Without an argument, the extent method returns a layer with the bounding box
|
| 164 |
+
of the top cell. With a cell filter argument, the method returns a layer
|
| 165 |
+
with the bounding boxes of the selected cells. The cell filter is a glob
|
| 166 |
+
pattern.
|
| 167 |
+
</p><p>
|
| 168 |
+
The extent function is useful to invert a layer:
|
| 169 |
+
</p><p><pre>
|
| 170 |
+
inverse_1 = extent.sized(100.0) - input(1, 0)
|
| 171 |
+
</pre></p><p>
|
| 172 |
+
The following example returns the bounding boxes of all cells whose
|
| 173 |
+
names start with "A":
|
| 174 |
+
</p><p><pre>
|
| 175 |
+
a_cells = extent("A*")
|
| 176 |
+
</pre></p><a name="global_transform"></a><a name="h2-131"></a><h2>"global_transform" - Gets or sets a global transformation</h2><a name="k_9"></a><p>Usage:</p><ul><li><tt>global_transform</tt></li><li><tt>global_transform([ transformations ])</tt></li></ul><p>
|
| 177 |
+
This method returns a new source representing the transformed layout. It is provided in the spritit of
|
| 178 |
+
<a href="drc_ref_source.html#clip">Source#clip</a> and similar methods.
|
| 179 |
+
</p><p>
|
| 180 |
+
The transformation
|
| 181 |
+
is either given as a <a href="../code/class_DTrans.html">DTrans</a>, <a href="../code/class_DVector.html">DVector</a> or <a href="../code/class_DCplxTrans.html">DCplxTrans</a> object or as one of the
|
| 182 |
+
following specifications:
|
| 183 |
+
</p><p><ul><li>"shift(x, y)": shifts the input layout horizontally by x and vertically by y micrometers </li><li>"rotate(a)": rotates the input layout by a degree counter-clockwise </li><li>"magnify(m)": magnifies the input layout by the factor m (NOTE: using fractional scale factors may result in small gaps due to grid snapping) </li><li>"mirror_x": mirrors the input layout at the x axis </li><li>"mirror_y": mirrors the input layout at the y axis </li></ul></p><p>
|
| 184 |
+
Multiple transformation specs can be given. In that case the transformations are applied right to left.
|
| 185 |
+
Using "global_transform" will reset any global transformation present already.
|
| 186 |
+
Without an argument, the global transformation is reset.
|
| 187 |
+
</p><p>
|
| 188 |
+
The following example rotates the layout by 90 degree at the origin (0, 0) and then shifts it up by
|
| 189 |
+
100 micrometers:
|
| 190 |
+
</p><p><pre>
|
| 191 |
+
source.global_transform(shift(0, 100.um), rotate(90.0))
|
| 192 |
+
</pre></p><a name="input"></a><a name="h2-165"></a><h2>"input" - Specifies input from a source</h2><a name="k_10"></a><p>Usage:</p><ul><li><tt>source.input</tt></li><li><tt>source.input(layer)</tt></li><li><tt>source.input(layer, datatype)</tt></li><li><tt>source.input(layer_info)</tt></li><li><tt>source.input(filter, ...)</tt></li><li><tt>source.input(props_spec, ...)</tt></li></ul><p>
|
| 193 |
+
Creates a layer with the shapes from the given layer of the source.
|
| 194 |
+
The layer can be specified by layer and optionally datatype, by a <a href="../code/class_LayerInfo.html">LayerInfo</a>
|
| 195 |
+
object or by a sequence of filters.
|
| 196 |
+
Filters are expressions describing ranges
|
| 197 |
+
of layers and/or datatype numbers or layer names. Multiple filters
|
| 198 |
+
can be given and all layers matching at least one of these filter
|
| 199 |
+
expressions are joined to render the input layer for the DRC engine.
|
| 200 |
+
</p><p>
|
| 201 |
+
Some filter expressions are:
|
| 202 |
+
</p><p><ul><li><tt>1/0-255 </tt>: Datatypes 0 to 255 for layer 1 </li><li><tt>1-10 </tt>: Layers 1 to 10, datatype 0 </li><li><tt>METAL </tt>: A layer named "METAL" </li><li><tt>METAL (17/0) </tt>: A layer named "METAL" or layer 17, datatype 0 (for GDS, which does
|
| 203 |
+
not have names)</li></ul></p><p>
|
| 204 |
+
Layers created with "input" may contain both texts (labels) and polygons. There is a subtle
|
| 205 |
+
difference between flat and deep mode: in flat mode, texts are not visible in polygon
|
| 206 |
+
operations. In deep mode, texts appear as small 2x2 DBU rectangles. In flat mode,
|
| 207 |
+
some operations such as clipping are not fully supported for texts. Also, texts will
|
| 208 |
+
vanish in most polygon operations such as booleans etc.
|
| 209 |
+
</p><p>
|
| 210 |
+
Texts can later be selected on the layer returned by "input" with the <a href="drc_ref_layer.html#texts">Layer#texts</a> method.
|
| 211 |
+
</p><p>
|
| 212 |
+
If you don't want to see texts, use <a href="#polygons">polygons</a> to create an input layer with polygon data
|
| 213 |
+
only. If you only want to see texts, use <a href="#labels">labels</a> to create an input layer with texts only.
|
| 214 |
+
</p><p><a href="#labels">labels</a> also produces a true "text layer" which contains text objects. A variety of
|
| 215 |
+
operations is available for these objects, such as boolean "and" and "not" with a polygon layer.
|
| 216 |
+
True text layers should be preferred over mixed polygon/text layers if text object processing
|
| 217 |
+
is required.
|
| 218 |
+
</p><p>
|
| 219 |
+
"input" without any arguments will create a new, empty original layer.
|
| 220 |
+
</p><p>
|
| 221 |
+
If you want to use user properties - for example with properties constraints in DRC checks -
|
| 222 |
+
you need to enable properties on input:
|
| 223 |
+
</p><p><pre>
|
| 224 |
+
input1_with_props = input(1, 0, enable_props)
|
| 225 |
+
</pre></p><p>
|
| 226 |
+
You can also filter or map property keys, similar to the functions available on
|
| 227 |
+
layers (<a href="drc_ref_drclayer.html#map_props">DRCLayer#map_props</a>, <a href="drc_ref_drclayer.html#select_props">DRCLayer#select_props</a>). For example to select
|
| 228 |
+
property values with key 17 (numerical) only, use:
|
| 229 |
+
</p><p><pre>
|
| 230 |
+
input1_with_props = input(1, 0, select_props(17))
|
| 231 |
+
</pre></p><p>
|
| 232 |
+
Use the global version of "input" without a source object to address the default source.
|
| 233 |
+
</p><a name="labels"></a><a name="h2-230"></a><h2>"labels" - Gets the labels (texts) from an input layer</h2><a name="k_11"></a><p>Usage:</p><ul><li><tt>source.labels</tt></li><li><tt>source.labels(layer)</tt></li><li><tt>source.labels(layer, datatype)</tt></li><li><tt>source.labels(layer_info)</tt></li><li><tt>source.labels(filter, ...)</tt></li></ul><p>
|
| 234 |
+
Creates a true text layer with the labels from the given layer of the source.
|
| 235 |
+
</p><p>
|
| 236 |
+
This method is identical to <a href="#input">input</a>, but takes only texts from the given input
|
| 237 |
+
layer. Starting with version 0.27, the result is no longer a polygon layer that tries
|
| 238 |
+
to provide text support but a layer type which is provided for carrying text objects
|
| 239 |
+
explicitly.
|
| 240 |
+
</p><p>
|
| 241 |
+
"labels" without any arguments will create a new, empty original layer.
|
| 242 |
+
</p><p>
|
| 243 |
+
Use the global version of "labels" without a source object to address the default source.
|
| 244 |
+
</p><a name="layers"></a><a name="h2-252"></a><h2>"layers" - Gets the layers the source contains</h2><a name="k_12"></a><p>Usage:</p><ul><li><tt>source.layers</tt></li></ul><p>
|
| 245 |
+
Delivers a list of <a href="../code/class_LayerInfo.html">LayerInfo</a> objects representing the layers
|
| 246 |
+
inside the source.
|
| 247 |
+
</p><p>
|
| 248 |
+
One application is to read all layers from a source. In the following
|
| 249 |
+
example, the "and" operation is used to perform a clip with the given
|
| 250 |
+
rectangle. Note that this solution is not efficient - it's provided
|
| 251 |
+
as an example only:
|
| 252 |
+
</p><p><pre>
|
| 253 |
+
output_cell("Clipped")
|
| 254 |
+
|
| 255 |
+
clip_box = polygon_layer
|
| 256 |
+
clip_box.insert(box(0.um, -4.um, 4.um, 0.um))
|
| 257 |
+
|
| 258 |
+
layers.each { |l| (input(l) & clip_box).output(l) }
|
| 259 |
+
</pre></p><a name="layout"></a><a name="h2-276"></a><h2>"layout" - Returns the <a href="../code/class_Layout.html">Layout</a> object associated with this source</h2><a name="k_13"></a><p>Usage:</p><ul><li><tt>layout</tt></li></ul><a name="make_layer"></a><a name="h2-282"></a><h2>"make_layer" - Creates an empty polygon layer based on the hierarchy of the layout</h2><a name="k_14"></a><p>Usage:</p><ul><li><tt>make_layer</tt></li></ul><p>
|
| 260 |
+
This method delivers a new empty original layer. It is provided to keep old code working.
|
| 261 |
+
Use "input" without arguments instead.
|
| 262 |
+
</p><a name="overlapping"></a><a name="h2-292"></a><h2>"overlapping" - Specifies input selected from a region in overlapping mode</h2><a name="k_15"></a><p>Usage:</p><ul><li><tt>source.overlapping(...)</tt></li></ul><p>
|
| 263 |
+
Like <a href="#clip">clip</a>, this method will create a new source delivering shapes
|
| 264 |
+
from a specified rectangular region. In contrast to clip, all shapes
|
| 265 |
+
overlapping the region with their bounding boxes are delivered as a whole
|
| 266 |
+
and are not clipped. Hence shapes may extent beyond the limits of
|
| 267 |
+
the specified rectangle.
|
| 268 |
+
</p><p><a href="#touching">touching</a> is a similar method which delivers shapes touching
|
| 269 |
+
the search region with their bounding box (without the requirement to overlap)
|
| 270 |
+
</p><a name="path"></a><a name="h2-308"></a><h2>"path" - Gets the path of the corresponding layout file or nil if there is no path</h2><a name="k_16"></a><p>Usage:</p><ul><li><tt>path</tt></li></ul><a name="polygons"></a><a name="h2-314"></a><h2>"polygons" - Gets the polygon shapes (or shapes that can be converted polygons) from an input layer</h2><a name="k_17"></a><p>Usage:</p><ul><li><tt>source.polygons</tt></li><li><tt>source.polygons(layer)</tt></li><li><tt>source.polygons(layer, datatype)</tt></li><li><tt>source.polygons(layer_info)</tt></li><li><tt>source.polygons(filter, ...)</tt></li></ul><p>
|
| 271 |
+
Creates a layer with the polygon shapes from the given layer of the source.
|
| 272 |
+
With "polygon shapes" we mean all kind of shapes that can be converted to polygons.
|
| 273 |
+
Those are boxes, paths and real polygons.
|
| 274 |
+
</p><p>
|
| 275 |
+
This method is identical to <a href="#input">input</a> with respect to the options supported.
|
| 276 |
+
</p><p>
|
| 277 |
+
"polygons" without any arguments will create a new, empty original layer.
|
| 278 |
+
</p><p>
|
| 279 |
+
Use the global version of "polygons" without a source object to address the default source.
|
| 280 |
+
</p><a name="select"></a><a name="h2-335"></a><h2>"select" - Adds cell name expressions to the cell filters</h2><a name="k_18"></a><p>Usage:</p><ul><li><tt>new_source = source.select(filter1, filter2, ...)</tt></li></ul><p>
|
| 281 |
+
This method will construct a new source object with the given cell filters
|
| 282 |
+
applied. Note that there is a global version of "select" which does not
|
| 283 |
+
create a new source, but acts on the default source.
|
| 284 |
+
</p><p>
|
| 285 |
+
Cell filters will enable or disable cells plus their subtree.
|
| 286 |
+
Cells can be switched on and off, which makes the hierarchy traversal
|
| 287 |
+
stop or begin delivering shapes at the given cell. The arguments of
|
| 288 |
+
the select method form a sequence of enabling or disabling instructions
|
| 289 |
+
using cell name pattern in the glob notation ("*" as the wildcard, like shell).
|
| 290 |
+
Disabling instructions start with a "-", enabling instructions with a "+" or
|
| 291 |
+
no specification.
|
| 292 |
+
</p><p>
|
| 293 |
+
The following options are available:
|
| 294 |
+
</p><p><ul><li><tt>+</tt><i>name_filter </i>: Cells matching the name filter will be enabled </li><li><i>name_filter </i>: Same as "+name_filter" </li><li><tt>-</tt><i>name_filter </i>: Cells matching the name filter will be disabled </li></ul></p><p>
|
| 295 |
+
To disable the TOP cell but enabled a hypothetical cell B below the top cell, use that
|
| 296 |
+
code:
|
| 297 |
+
</p><p><pre>
|
| 298 |
+
source_with_selection = source.select("-TOP", "+B")
|
| 299 |
+
l1 = source_with_selection.input(1, 0)
|
| 300 |
+
...
|
| 301 |
+
</pre></p><p>
|
| 302 |
+
Please note that the sample above will deliver the children of "B" because there is
|
| 303 |
+
nothing said about how to proceed with cells other than "TOP" or "B". Conceptually,
|
| 304 |
+
the instantiation path of a cell will be matched against the different filters in the
|
| 305 |
+
order they are given.
|
| 306 |
+
A matching negative expression will disable the cell, a matching positive expression
|
| 307 |
+
will enable the cell. Hence, every cell that has a "B" in the instantiation path
|
| 308 |
+
is enabled.
|
| 309 |
+
</p><p>
|
| 310 |
+
The following code will just select "B" without its children, because in the
|
| 311 |
+
first "-*" selection, all cells including the children of "B" are disabled:
|
| 312 |
+
</p><p><pre>
|
| 313 |
+
source_with_selection = source.select("-*", "+B")
|
| 314 |
+
l1 = source_with_selection.input(1, 0)
|
| 315 |
+
...
|
| 316 |
+
</pre></p><p>
|
| 317 |
+
The short form "-" will disable the top cell. This code is identical to the first example
|
| 318 |
+
and will start with a disabled top cell regardless of its name:
|
| 319 |
+
</p><p><pre>
|
| 320 |
+
source_with_selection = source.select("-", "+B")
|
| 321 |
+
l1 = source_with_selection.input(1, 0)
|
| 322 |
+
...
|
| 323 |
+
</pre></p><a name="touching"></a><a name="h2-397"></a><h2>"touching" - Specifies input selected from a region in touching mode</h2><a name="k_19"></a><p>Usage:</p><ul><li><tt>source.touching(box)</tt></li><li><tt>source.touching(p1, p2)</tt></li><li><tt>source.touching(l, b, r, t)</tt></li></ul><p>
|
| 324 |
+
Like <a href="#clip">clip</a>, this method will create a new source delivering shapes
|
| 325 |
+
from a specified rectangular region. In contrast to clip, all shapes
|
| 326 |
+
touching the region with their bounding boxes are delivered as a whole
|
| 327 |
+
and are not clipped. Hence shapes may extent beyond the limits of
|
| 328 |
+
the specified rectangle.
|
| 329 |
+
</p><p><a href="#overlapping">overlapping</a> is a similar method which delivers shapes overlapping
|
| 330 |
+
the search region with their bounding box (and not just touching)
|
| 331 |
+
</p></div>
|
| 332 |
+
</div>
|
| 333 |
+
</body>
|
| 334 |
+
</html>
|
| 335 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/expressions.html
ADDED
|
@@ -0,0 +1,210 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About Expressions</p><h1>About Expressions</h1><a name="k_1"></a><a name="k_2"></a><p>
|
| 120 |
+
Beside a ruby and Python programming API, KLayout provides support for simple expressions in some places.
|
| 121 |
+
In particular this feature is employed to generate dynamic strings, for example when deriving the
|
| 122 |
+
label text for a ruler.
|
| 123 |
+
</p><a name="h2-16"></a><h2>String interpolation</h2><p>
|
| 124 |
+
The feature of inserting dynamic content into a string is called interpolation.
|
| 125 |
+
The Syntax KLayout uses for string interpolation is a dollar character followed by
|
| 126 |
+
the expression which is evaluated. Simple expressions can be put directly after the dollar character.
|
| 127 |
+
Others must be put into brackets.
|
| 128 |
+
</p><p>
|
| 129 |
+
Every dollar expression is evaluated and the expression is substituted by the result string.
|
| 130 |
+
For example:
|
| 131 |
+
</p><p><table><tr><th>String</th><th>Evaluates to</th></tr><tr><td><tt>An irrational number: $sqrt(2).</tt></td><td><tt>An irrational number: 1.4142136</tt></td></tr><tr><td><tt>1+2 is $(1+2).</tt></td><td><tt>1+2 is 3.</tt></td></tr></table></p><p>
|
| 132 |
+
String interpolation plays a role where expressions are used to generate dynamic strings.
|
| 133 |
+
When expressions are used as standalone features (i.e. as parts of a custom layout query - see <a href="custom_queries.html">About Custom Layout Queries</a>),
|
| 134 |
+
string interpolation is not supported inside string constants, but strings can be built dynamically using the "+" operator.
|
| 135 |
+
</p><a name="h2-44"></a><h2>Basic data types</h2><p>
|
| 136 |
+
Expressions use different data types to represent strings or numeric values.
|
| 137 |
+
The following data types are supported currently:
|
| 138 |
+
</p><p><table><tr><th>Type</th><th>Examples</th></tr><tr><td>Numeric</td><td><tt>1.2<br>-0.5e-6</tt></td></tr><tr><td>String</td><td><tt>"abc"<br>'x'</tt></td></tr><tr><td>Boolean</td><td><tt>true<br>false</tt></td></tr><tr><td>Array</td><td><tt>[1,5,4]</tt></td></tr><tr><td>Undefined (no value)</td><td><tt>nil</tt></td></tr></table></p><p>
|
| 139 |
+
Apart from that, all RBA objects are supported with their methods (see <a href="../code/index.html">Class Index</a>). For example, that is
|
| 140 |
+
a valid expression which gives a value of 100:
|
| 141 |
+
</p><pre>
|
| 142 |
+
Box.new(-10, 0, 90, 60).width
|
| 143 |
+
</pre><p>
|
| 144 |
+
In a boolean context (i.e. the conditional evaluation "condition ? expr1 : expr2"), "nil"
|
| 145 |
+
and the boolean "false" will render false, while all other values render true. This follows
|
| 146 |
+
the Ruby convention and in effect, unlike some other languages, a numeric value if 0 is not treated
|
| 147 |
+
as "false" but as "true"!
|
| 148 |
+
</p><a name="h2-78"></a><h2>Constants</h2><p>
|
| 149 |
+
The following constants are defined currently:
|
| 150 |
+
</p><p><table><tr><th>Constant</th><th>Description</th></tr><tr><td><tt>M_PI</tt></td><td>The mathematical constant 'pi'</td></tr><tr><td><tt>M_E</tt></td><td>The mathematical constant 'e'</td></tr><tr><td><tt>false</tt></td><td>'false' boolean value</td></tr><tr><td><tt>true</tt></td><td>'true' boolean value</td></tr><tr><td><tt>nil</tt></td><td>The 'undefined' value</td></tr></table></p><a name="h2-95"></a><h2>Operators and precedence</h2><p>
|
| 151 |
+
KLayout's expressions support the following operators with the given precedence:
|
| 152 |
+
</p><p><table><tr><th>Prec.</th><th>Operator</th><th>Data types</th><th>Result type</th><th>Description</th></tr><tr><td>1</td><td><tt>(</tt>...<tt>)</tt></td><td>Any</td><td></td><td>Grouping of sub-expressions</td></tr><tr><td>2</td><td><tt>[</tt>...<tt>,</tt>...<tt>]</tt></td><td>Any</td><td>Array</td><td>Array formation</td></tr><tr><td>3</td><td><tt>!</tt>...</td><td>Boolean</td><td>Boolean</td><td>Logical 'not'</td></tr><tr><td>3</td><td><tt>~</tt>...</td><td>Numeric</td><td>Numeric</td><td>Bitwise 'not' (evaluated as 32 bit integers)</td></tr><tr><td>3</td><td><tt>-</tt>...</td><td>Numeric</td><td>Numeric</td><td>Negation</td></tr><tr><td>4</td><td>...<tt>^</tt>...</td><td>Numeric</td><td>Numeric</td><td>Bitwise 'xor' (evaluated as 32 bit integers)</td></tr><tr><td>4</td><td>...<tt>&</tt>...</td><td>Numeric</td><td>Numeric</td><td>Bitwise 'and' (evaluated as 32 bit integers)</td></tr><tr><td>4</td><td>...<tt>|</tt>...</td><td>Numeric</td><td>Numeric</td><td>Bitwise 'or' (evaluated as 32 bit integers)</td></tr><tr><td>5</td><td>...<tt>%</tt>...</td><td>Numeric</td><td>Numeric</td><td>Modulo</td></tr><tr><td>5</td><td>...<tt>/</tt>...</td><td>Numeric</td><td>Numeric</td><td>Division</td></tr><tr><td>5</td><td>...<tt>*</tt>...</td><td>Numeric</td><td>Numeric</td><td>Product</td></tr><tr><td></td><td></td><td>Numeric*String</td><td>String</td><td>String multiplication (n times the same string)</td></tr><tr><td>6</td><td>...<tt>-</tt>...</td><td>Numeric</td><td>Numeric</td><td>Subtraction</td></tr><tr><td>6</td><td>...<tt>+</tt>...</td><td>Numeric</td><td>Numeric</td><td>Addition</td></tr><tr><td></td><td></td><td>String</td><td>string</td><td>Concatenation</td></tr><tr><td>7</td><td>...<tt><<</tt>...</td><td>Numeric</td><td>Numeric</td><td>Bit shift to left</td></tr><tr><td>7</td><td>...<tt>>></tt>...</td><td>Numeric</td><td>Numeric</td><td>Bit shift to right</td></tr><tr><td>8</td><td>...<tt>==</tt>...</td><td>Any</td><td>Boolean</td><td>Equality</td></tr><tr><td>8</td><td>...<tt>!=</tt>...</td><td>Any</td><td>Boolean</td><td>Inequality</td></tr><tr><td>8</td><td>...<tt><=</tt>...</td><td>Any</td><td>Boolean</td><td>Less or equal</td></tr><tr><td>8</td><td>...<tt><</tt>...</td><td>Any</td><td>Boolean</td><td>Less</td></tr><tr><td>8</td><td>...<tt>>=</tt>...</td><td>Any</td><td>Boolean</td><td>Greater or equal</td></tr><tr><td>8</td><td>...<tt>></tt>...</td><td>Any</td><td>Boolean</td><td>Greater</td></tr><tr><td>8</td><td>...<tt>~</tt>...</td><td>String</td><td>Boolean</td><td>Match with a glob expression</td></tr><tr><td>8</td><td>...<tt>!~</tt>...</td><td>String</td><td>Boolean</td><td>Non-match with a glob expression</td></tr><tr><td>9</td><td>...<tt>&&</tt>...</td><td>Boolean</td><td>Boolean</td><td>Logical 'and'</td></tr><tr><td>9</td><td>...<tt>||</tt>...</td><td>Boolean</td><td>Boolean</td><td>Logical 'or'</td></tr><tr><td>10</td><td>...<tt>?</tt>...<tt>:</tt>...</td><td>Boolean?Any:Any</td><td>Any</td><td>Conditional evaluation</td></tr></table></p><p>
|
| 153 |
+
The match operators work on strings. They use the glob pattern notation (as used in the shell for example) and support substring matching with the usual bracket notation. Substrings can be referred to by "$n" later, where
|
| 154 |
+
n is the nth bracket. For example:
|
| 155 |
+
</p><table><tr><th>Expression</th><th>Result</th></tr><tr><td><tt>"foo" ~ "f*"</tt></td><td>true</td></tr><tr><td><tt>"foo" ~ "bar"</tt></td><td>false</td></tr><tr><td><tt>"foo" !~ "bar"</tt></td><td>true</td></tr><tr><td><tt>"foo" ~ "f(*)"; $1</tt></td><td>"oo"</td></tr></table><a name="h2-148"></a><h2>Method calls</h2><p>
|
| 156 |
+
Expressions support all the objects provided by KLayout for the Ruby API. Objects are values inside
|
| 157 |
+
expressions like integers or strings are. Sometimes, objects can be manipulated with the operators
|
| 158 |
+
as well (like "box1 + box2"). The most important way to work with objects however are methods.
|
| 159 |
+
</p><p>
|
| 160 |
+
The dot calls a method on an object. Before the dot an expression must be given which results in an object, or
|
| 161 |
+
a class name must be given. In the latter case, static methods will be called. After the dot, a valid method name
|
| 162 |
+
is expected.
|
| 163 |
+
</p><p><b>Important note:</b> the method names used inside expressions usually is equivalent to the names
|
| 164 |
+
mentioned in the class documentation. Setter methods like "box_with=" can be used as targets in assignments, i.e.
|
| 165 |
+
</p><pre>shape.box_width = 20</pre><p>
|
| 166 |
+
Boolean predicates (like "is_box?") are used <b>without</b> the question mark because that is reserved
|
| 167 |
+
for the decision operator (".. ? .. : .."):
|
| 168 |
+
</p><pre>shape.is_box</pre><a name="h2-175"></a><h2>Concatenation of expressions</h2><p>
|
| 169 |
+
The semicolon separates two expressions. The value of that compound expression is the value of the last one.
|
| 170 |
+
</p><a name="h2-181"></a><h2>Keyword arguments</h2><p>
|
| 171 |
+
Most methods support keyword arguments similar to Python. For example you can write:
|
| 172 |
+
</p><pre>CplxTrans.new(rot = 45.0)</pre><p>
|
| 173 |
+
This is more explicit than writing the individual arguments and allows giving
|
| 174 |
+
one argument without having to insert the default values for the previous ones.
|
| 175 |
+
</p><p>
|
| 176 |
+
Keyword arguments are not supported for the built-in functions such as "sqrt" and
|
| 177 |
+
a few built-in methods.
|
| 178 |
+
</p><a name="h2-199"></a><h2>Variables</h2><p>
|
| 179 |
+
Depending on the context, some variables may be already defined. For example, when used for generating ruler
|
| 180 |
+
dimension labels, "D" is a predefined variable that is the length of the ruler. See the specific documentation
|
| 181 |
+
on these variables.
|
| 182 |
+
</p><p>
|
| 183 |
+
Inside expressions, variables can be defined to store intermediate results for example.
|
| 184 |
+
To define a variable use the "var" keyword followed by the variable name and an optional initialisation.
|
| 185 |
+
Assignment of values can be done with the "=" operator.
|
| 186 |
+
For example, the following expression gives the result 4:
|
| 187 |
+
</p><pre>
|
| 188 |
+
var x = 3; x = x + 1; x
|
| 189 |
+
</pre><a name="h2-218"></a><h2>Special variables</h2><p>
|
| 190 |
+
Special variables start with a dollar character. Currently the only special variables available are
|
| 191 |
+
"$1..9" which is the 1 to 9nth substring match of the last match expression.
|
| 192 |
+
</p><a name="h2-225"></a><h2>Special constants</h2><p>
|
| 193 |
+
In the context of a layout, various additional constant expressions are supported:
|
| 194 |
+
</p><a name="h3-231"></a><h3>Distance and area units</h3><p>
|
| 195 |
+
A value with a unit is automatically converted to database units. For example, "<tt>0.15 um</tt>" will give
|
| 196 |
+
150 if the database unit of the layout is 1 nm. See below for a list of units available.
|
| 197 |
+
Supported units are:
|
| 198 |
+
</p><table><tr><th>Unit</th><th>Description</th></tr><tr><td><tt>nm</tt></td><td>Nanometers</td></tr><tr><td><tt>um</tt>, <tt>mic</tt>, <tt>micron</tt></td><td>Micrometers</td></tr><tr><td><tt>mm</tt></td><td>Millimeters</td></tr><tr><td><tt>m</tt></td><td>Meters</td></tr><tr><td><tt>nm2</tt></td><td>Square nanometers</td></tr><tr><td><tt>um2</tt>, <tt>mic2</tt>, <tt>micron2</tt></td><td>Square micrometers</td></tr><tr><td><tt>mm2</tt></td><td>Square millimeters</td></tr><tr><td><tt>m2</tt></td><td>Square meters (for very big chips)</td></tr></table><a name="h3-251"></a><h3>Layer index constants</h3><p>
|
| 199 |
+
A layer given in the common notation and enclosed in angle brackets is converted to
|
| 200 |
+
a layer index. For example: "<tt><16/0></tt>" will be converted to the layer index of the layer with layer number 16 and datatype 0.
|
| 201 |
+
</p><a name="h3-258"></a><h3>Cell index constants</h3><p>
|
| 202 |
+
A cell name enclosed in double angle brackets will be converted to the index
|
| 203 |
+
of that cell, for example "<tt><<TOP>></tt>".
|
| 204 |
+
</p><a name="h2-265"></a><h2>Functions</h2><p>
|
| 205 |
+
KLayout's expressions support the following functions:
|
| 206 |
+
</p><table><tr><th>Function</th><th>Data types</th><th>Result type</th><th>Description</th></tr><tr><td><tt>absolute_file_path(</tt>x<tt>)</tt></td><td>String</td><td>String</td><td>Convert a relative file path to an absolute one</td></tr><tr><td><tt>absolute_path(</tt>x<tt>)</tt></td><td>String</td><td>String</td><td>Returns the absolute path component of a file specification</td></tr><tr><td><tt>abs(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Returns the absolute value of a number</td></tr><tr><td><tt>acos(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Inverse cosine function</td></tr><tr><td><tt>asin(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Inverse sine function</td></tr><tr><td><tt>atan2(</tt>x<tt>,</tt>y<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Inverse tangent of x/y</td></tr><tr><td><tt>atan(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Inverse tangent function</td></tr><tr><td><tt>basename(</tt>x<tt>)</tt></td><td>String</td><td>String</td><td>Returns the basename component of a file specification</td></tr><tr><td><tt>ceil(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Round up</td></tr><tr><td><tt>combine(</tt>x<tt>,</tt>y<tt>)</tt></td><td>String</td><td>String</td><td>Combines the path components x and y using the system specific separator</td></tr><tr><td><tt>cosh(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Hyperbolic cosine function</td></tr><tr><td><tt>cos(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Cosine function</td></tr><tr><td><tt>downcase(</tt>x<tt>)</tt></td><td>String</td><td>String</td><td>Converts the given string to lower case</td></tr><tr><td><tt>env(</tt>x<tt>)</tt></td><td>String</td><td>String</td><td>Access an environment variable</td></tr><tr><td><tt>error(</tt>x<tt>)</tt></td><td>String</td><td></td><td>Raise an error</td></tr><tr><td><tt>exp(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Exponential function</td></tr><tr><td><tt>extension(</tt>x<tt>)</tt></td><td>String</td><td>String</td><td>Returns the extension component of a file specification</td></tr><tr><td><tt>file_exists(</tt>x<tt>)</tt></td><td>String</td><td>Boolean</td><td>Returns true if the given file exists</td></tr><tr><td><tt>find(</tt>s<tt>,</tt>t<tt>)</tt></td><td>String</td><td>Numeric</td><td>Finds the first occurrence of a t in s and returns the position (where 0 is the first character)</td></tr><tr><td><tt>floor(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Round down</td></tr><tr><td><tt>gsub(</tt>s<tt>,</tt>x<tt>,<tt>y</tt>)</tt></td><td>String</td><td>String</td><td>Substitute all occurrences of a x in s by y</td></tr><tr><td><tt>is_array(</tt>x<tt>)</tt></td><td>Any</td><td>Boolean</td><td>True if the argument is an array</td></tr><tr><td><tt>is_dir(</tt>x<tt>)</tt></td><td>String</td><td>Boolean</td><td>Returns true if the given path is a directory</td></tr><tr><td><tt>is_nil(</tt>x<tt>)</tt></td><td>Any</td><td>Boolean</td><td>True if the argument is undefined</td></tr><tr><td><tt>is_numeric(</tt>x<tt>)</tt></td><td>Any</td><td>Boolean</td><td>True if the argument is numeric</td></tr><tr><td><tt>is_string(</tt>x<tt>)</tt></td><td>Any</td><td>Boolean</td><td>True if the argument is a string</td></tr><tr><td><tt>item(</tt>a<tt>,</tt>i<tt>)</tt></td><td>Array</td><td>Any</td><td>Access a certain item of an array</td></tr><tr><td><tt>join(</tt>a<tt>,</tt>s<tt>)</tt></td><td>Array, String</td><td>String</td><td>Join all array members in a into a string using the separator s</td></tr><tr><td><tt>len(</tt>x<tt>)</tt></td><td>String</td><td>Numeric</td><td>Return the length of a string</td></tr><tr><td><tt>log10(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Base 10 logarithm function</td></tr><tr><td><tt>log(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Natural logarithm function</td></tr><tr><td><tt>max(</tt>a<tt>,</tt>b ...<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Maximum of the given arguments</td></tr><tr><td><tt>min(</tt>a<tt>,</tt>b ...<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Minimum of the given arguments</td></tr><tr><td><tt>path(</tt>x<tt>)</tt></td><td>String</td><td>String</td><td>Returns the path component of a file specification</td></tr><tr><td><tt>pow(</tt>x<tt>,</tt>y<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Power function (x to the power of y)</td></tr><tr><td><tt>rfind(</tt>s<tt>,</tt>t<tt>)</tt></td><td>String</td><td>Numeric</td><td>Finds the last occurrence of a t in s and returns the position (where 0 is the first character)</td></tr><tr><td><tt>round(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Round up or down</td></tr><tr><td><tt>sinh(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Hyperbolic sine function</td></tr><tr><td><tt>sin(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Sine function</td></tr><tr><td><tt>split(</tt>t<tt>,</tt>s<tt>)</tt></td><td>String</td><td>Array</td><td>Splits t into elements using the separator s</td></tr><tr><td><tt>sprintf(</tt>f<tt>,</tt>a ...<tt>)</tt></td><td>String, Any</td><td>String</td><td>Implement of 'C' sprintf. Provides not all features but the most commonly used ones (precision, field width, alignment, zero padding, 'e', 'g', 'f', 'd', 'x', 'u' and 's' formats)</td></tr><tr><td><tt>sqrt(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Square root</td></tr><tr><td><tt>substr(</tt>t<tt>,</tt>f[<tt>,</tt>l]<tt>)</tt></td><td>String</td><td>String</td><td>Return a substring of t (starting from position f with length l). 'l' is optional. If omitted, the tail of the string is returned.</td></tr><tr><td><tt>sub(</tt>s<tt>,</tt>x<tt>,</tt>y<tt>)</tt></td><td>String</td><td>String</td><td>Substitute the first occurrence of a x in s by y</td></tr><tr><td><tt>tanh(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Hyperbolic tangent function</td></tr><tr><td><tt>tan(</tt>x<tt>)</tt></td><td>Numeric</td><td>Numeric</td><td>Tangent function</td></tr><tr><td><tt>to_f(</tt>x<tt>)</tt></td><td>Any</td><td>Numeric</td><td>Convert argument to numeric if possible</td></tr><tr><td><tt>to_i(</tt>x<tt>)</tt></td><td>Any</td><td>Numeric (integer)</td><td>Convert argument to numeric (32 bit integer)</td></tr><tr><td><tt>to_s(</tt>x<tt>)</tt></td><td>Any</td><td>String</td><td>Convert argument to string</td></tr><tr><td><tt>upcase(</tt>x<tt>)</tt></td><td>String</td><td>String</td><td>Converts the given string to upper case</td></tr></table></div>
|
| 207 |
+
</div>
|
| 208 |
+
</body>
|
| 209 |
+
</html>
|
| 210 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/index.html
ADDED
|
@@ -0,0 +1,126 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » Various Topics</p><h1>Various Topics</h1><p>
|
| 120 |
+
This category covers various special topics and provides additional information
|
| 121 |
+
for certain features in KLayout. The following topics are available:
|
| 122 |
+
</p><ul><li><a href="layer_mapping.html">Layer Mapping Tables</a></li><li><a href="layer_specs.html">About Layer Specifications</a></li><li><a href="transformations.html">Transformations in KLayout</a></li><li><a href="expressions.html">About Expressions</a></li><li><a href="variant_notation.html">About Variant Notation</a></li><li><a href="lef_def_import.html">About LEF/DEF Import</a></li><li><a href="connectivity.html">Connectivity</a></li><li><a href="25d_view.html">The 2.5d View</a></li><li><a href="symbolic_layers.html">Symbolic Connectivity Layers</a></li><li><a href="layer_sources.html">About Layer Sources</a></li><li><a href="macro_editor.html">About Macro Development</a></li><li><a href="macro_in_menu.html">Macros in Menus</a></li><li><a href="about_libraries.html">About Libraries</a></li><li><a href="about_pcells.html">About PCells</a></li><li><a href="basic_lib.html">About The Basic Library</a></li><li><a href="packages.html">About Packages</a></li><li><a href="technology_manager.html">About Technology Management</a></li><li><a href="custom_queries.html">About Custom Layout Queries</a></li><li><a href="rba_notation.html">Notation used in Ruby API documentation</a></li><li><a href="drc_ref.html">DRC Reference</a></li><li><a href="lvs_ref.html">LVS Reference</a></li></ul></div>
|
| 123 |
+
</div>
|
| 124 |
+
</body>
|
| 125 |
+
</html>
|
| 126 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/layer_mapping.html
ADDED
|
@@ -0,0 +1,213 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » Layer Mapping Tables</p><h1>Layer Mapping Tables</h1><p>
|
| 120 |
+
Layer mapping tables are used to specify the behavior of the layout reader. Specifically,
|
| 121 |
+
they define what actions are taken when a shape on a certain layer is encountered.
|
| 122 |
+
They can be used to
|
| 123 |
+
</p><ul><li>Filter layers</li><li>Supply layer names for GDS layer and datatype combinations</li><li>Map layers to different ones</li><li>Combine different layers into the same layer</li></ul><p>
|
| 124 |
+
A layer mapping table consists of two specifications: a match expression and an optional target expression.
|
| 125 |
+
If a shape is encountered, the reader looks up the shape's layer in the mapping table. If an
|
| 126 |
+
entry is found whose match expression matches the layer of the shape, the shape is assigned
|
| 127 |
+
a new layer given by the target expression if present. By assigning different match expressions the
|
| 128 |
+
same target expressions, multiple input layers can be combined into a single one.
|
| 129 |
+
</p><p>
|
| 130 |
+
If no matching entry is found, the reader can be configured to either store the shape
|
| 131 |
+
under the original layer or discard it. This option can be found in the reader options
|
| 132 |
+
dialog as the "Read all layers" option. If that box is checked, the shapes are stored under
|
| 133 |
+
their original layer and discarded if not.
|
| 134 |
+
</p><p>
|
| 135 |
+
A target expression can be used also to add information, specifically a layer name. In GDS there
|
| 136 |
+
is no layer name but just a layer and datatype number. In OASIS, there is a layer name in addition.
|
| 137 |
+
Other formats just use named layers and don't have the concept of layer number or datatype number.
|
| 138 |
+
When the target expression specifies a layer name that name is used. That allows adding of OASIS
|
| 139 |
+
layer names to GDS files for example. Layers with names are usually more useful than
|
| 140 |
+
layers that just have a number.
|
| 141 |
+
</p><p>
|
| 142 |
+
The layer mapping table consists of lines, each specifying the match expression and optional target
|
| 143 |
+
expression. The match and target expressions are separated by a colon.
|
| 144 |
+
Each expression has the form "layer" (numeric), "layer/datatype" (both numberic), "name" (a string)
|
| 145 |
+
or "name(layer)" or "name(layer/datatype)" (all specifications). When name and layer/datatype
|
| 146 |
+
are specified in a match string, KLayout will first look for a matching layer/datatype and then for
|
| 147 |
+
a matching layer name. The name match is case sensitive.
|
| 148 |
+
For the numerical specifications, ranges are allowed using a hyphen for an interval and
|
| 149 |
+
the comma for enumerations (see second example below).
|
| 150 |
+
</p><p>
|
| 151 |
+
Here are some examples:
|
| 152 |
+
</p><table border="0" cellpadding="0" cellspacing="2"><tr><td><b>1/0</b> or <b>1</b></td><td>Matching layer 1, datatype 0</td></tr><tr><td><b>17/1-5,10</b></td><td>Matching layer 17, datatypes 1 to 5 and 10</td></tr><tr><td><b>1/0:22</b></td><td>Matching Layer 1, datatype 0. Shapes are shifted to layer 22, datatype 0</td></tr><tr><td><b>1/0:A</b></td><td>Matching layer 1, datatype 0. The name "A" is added to that layer</td></tr><tr><td><b>1/0:A(2/0)</b></td><td>Matching Layer 1, datatype 0 mapped. Shapes are shifted to layer 2, datatype 0 and name "A"</td></tr><tr><td><b>A</b></td><td>Matching named layer "A"</td></tr><tr><td><b>A:1/0</b></td><td>Matching named layer "A". Shapes are shifted to layer 1, datatype 0</td></tr></table><p>
|
| 153 |
+
When the layer mapping is read from a file, each line corresponds to one entry. Blanks are ignored as
|
| 154 |
+
are empty lines. Comments can be inserted using the "#" character in front of the comment.
|
| 155 |
+
</p><a name="h2-96"></a><h2>Wildcards</h2><p>
|
| 156 |
+
Source layers can be specified using wildcards. A wildcard is a "*" character
|
| 157 |
+
matching "any layer".
|
| 158 |
+
Examples for such expressions are:
|
| 159 |
+
</p><table border="0" cellpadding="0" cellspacing="2"><tr><td><b>10-*/0</b></td><td>Matching layer 10 and above, datatype 0</td></tr><tr><td><b>*/10</b></td><td>Matching datatype 10 of every layer</td></tr><tr><td><b>0-5,10-*/*</b></td><td>Matching layer 0 to 5 (inclusive) and above 10, all datatypes.</td></tr></table><p>
|
| 160 |
+
When ranges or wildcards are used as match expressions, the specified
|
| 161 |
+
layers will be lumped together into a single layer. This layer will have
|
| 162 |
+
the least permitted layer and datatype number. For example, with a
|
| 163 |
+
match expression of "1-10/*", all these layers will be mapped to "1/0".
|
| 164 |
+
This behavior can be modified using a target layer specification with
|
| 165 |
+
wildcards.
|
| 166 |
+
</p><a name="h2-128"></a><h2>Wildcard expansion and relative layer mapping</h2><p>
|
| 167 |
+
If the match expression includes a numerical range or wildcards
|
| 168 |
+
for the layer or datatype number, by default all these layers
|
| 169 |
+
will be combined into a single one, where its layer or datatype number is derived
|
| 170 |
+
from the least permitted number.
|
| 171 |
+
</p><p>
|
| 172 |
+
This behavior can be modified using wildcard expansion. This is a target layer
|
| 173 |
+
which includes a "*" wildcard. This wildcard is substituted by the actual
|
| 174 |
+
layer or datatype number:
|
| 175 |
+
</p><table border="0" cellpadding="0" cellspacing="2"><tr><td><b>10-*/0 : */10</b></td><td>Maintain layers for layer 10 and above and map datatype to 10</td></tr><tr><td><b>10-*/0 : */*</b></td><td>Select layers 10 and above, datatype 0 and maintain these as individual layers</td></tr><tr><td><b>1/* : 2/*</b></td><td>Map layer number 1 to 2, maintain all datatypes</td></tr></table><p>
|
| 176 |
+
Relative layer mapping allows adding an offset to the layer or datatype numbers.
|
| 177 |
+
This offset can be negative with undefined behavior when the resulting number goes below
|
| 178 |
+
zero:
|
| 179 |
+
</p><table border="0" cellpadding="0" cellspacing="2"><tr><td><b>10-20/*: *+1000/*</b></td><td>Selects all layers between 10 and 20, all datatypes. These layers will be
|
| 180 |
+
read into the original layers plus 1000 for the layer number.</td></tr><tr><td><b>10/10-*: */*-10</b></td><td>Selects layer 10, datatypes 10 plus. The resulting datatypes will be 10 less starting from 0.</td></tr></table><a name="h2-176"></a><h2>Multi-mapping and unmapping</h2><p>
|
| 181 |
+
Layer mapping table support an advanced feature which is to duplicate input layers to
|
| 182 |
+
a number of output layers (1:n) mapping.
|
| 183 |
+
The feature is enabled by prepending a "+" to the mapping statement. The following
|
| 184 |
+
statement will first select layer 5/0 and additionally copy it to layer 1000/0:
|
| 185 |
+
</p><pre>5/0
|
| 186 |
+
+5/0: 1000/0
|
| 187 |
+
</pre><p>
|
| 188 |
+
Unmapping removes the mapping for a specific layer or range. It is specified by prepending "-"
|
| 189 |
+
to the mapping expression. The following statement will map all datatypes of layer 5 to 0 except
|
| 190 |
+
for datatype 10 which is not considered.
|
| 191 |
+
</p><pre>5/*: 5/0
|
| 192 |
+
-5/10
|
| 193 |
+
</pre><p>
|
| 194 |
+
Unmapping cancels the mappings specified previously, so the order of statements becomes important
|
| 195 |
+
when using unmapping and multi-mapping.
|
| 196 |
+
</p><a name="h2-204"></a><h2>Brackets</h2><p>
|
| 197 |
+
Square brackets can be used to imply mapping to the original layer. When putting square brackets
|
| 198 |
+
around a mapping expression, the default target is "*/*", which means expansion to the original layer.
|
| 199 |
+
Hence the following statements are identical:
|
| 200 |
+
</p><pre>[1-10/*]
|
| 201 |
+
1-10/* : */*
|
| 202 |
+
</pre><p>
|
| 203 |
+
When combining this with "+" for multi-mapping, put "+" in front of the bracket.
|
| 204 |
+
</p><p>
|
| 205 |
+
You can put round brackets around mapping expressions for visual clarity, specifically when
|
| 206 |
+
combining them with "-" (unmapping) or "+" (multi-mapping):
|
| 207 |
+
</p><pre>-(1-10/*)
|
| 208 |
+
+(17/0 : 1017/0)
|
| 209 |
+
</pre></div>
|
| 210 |
+
</div>
|
| 211 |
+
</body>
|
| 212 |
+
</html>
|
| 213 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/layer_sources.html
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About Layer Sources</p><h1>About Layer Sources</h1><p>
|
| 120 |
+
KLayout implements a concept of "layer views". The layer list is made up of such layer views.
|
| 121 |
+
A "view" is basically a specification of what is shown how.
|
| 122 |
+
The "how" part is given by the colors, stipples, styles etc.
|
| 123 |
+
The "what" part is given by the source specification.
|
| 124 |
+
</p><p>
|
| 125 |
+
The most important part of the source specification is the layer number or name.
|
| 126 |
+
But the source specification is much more powerful.
|
| 127 |
+
Basically the source specification offers the following capabilities:
|
| 128 |
+
</p><ul><li>Specify the layer where the shapes are taken from, either by layer and datatype or name</li><li>Transform the layout before it is drawn</li><li>Property filter: draw only shapes whose user properties match a given expression</li><li>Override the hierarchy levels on which the shapes are drawn</li></ul><a name="h2-28"></a><h2>Specifying the source layer</h2><p>
|
| 129 |
+
The source layer specifies from which actual data
|
| 130 |
+
layer to take the drawn shapes from. The most simple form of a source
|
| 131 |
+
specification is "layer/datatype" (i.e. "5/0") or the layer name, if an OASIS
|
| 132 |
+
layer name (or a named layer in general) is present.
|
| 133 |
+
This specification can be enhanced by a layout index.
|
| 134 |
+
The first layout loaded in the panel is referred to which "@1" or by omitting
|
| 135 |
+
this specification. The source specification "10/5@2" therefore refers to layer
|
| 136 |
+
10, datatype 5 of the second layout loaded in the panel.
|
| 137 |
+
</p><p>
|
| 138 |
+
Source specifications can be wildcarded. That means, either layer, datatype
|
| 139 |
+
or layout index can be specified by "*". In this case, such a layer view must
|
| 140 |
+
be contained in a group and the group parent must provide the missing specifications.
|
| 141 |
+
For example, if a layer is specified "10/*" and the parent is specified "*/5", the
|
| 142 |
+
effective layer looked for will be "10/5". Unlike the behaviour for the display
|
| 143 |
+
styles, the children override (or specialize) the parent's definition in the
|
| 144 |
+
case of the source specification.
|
| 145 |
+
</p><p>
|
| 146 |
+
For more information refer to <a href="../manual/layer_source.html">Removing And Adding Layers To The Layer Set</a>.
|
| 147 |
+
</p><a name="h2-55"></a><h2>Transforming the layout</h2><p>
|
| 148 |
+
A geometrical transformation is specified by appending a transformation in
|
| 149 |
+
round brackets to the layer/datatype source specification.
|
| 150 |
+
</p><p>
|
| 151 |
+
For example, "(r90)" specifies a rotation by 90 degree counter-clockwise.
|
| 152 |
+
"(0,100.0 m45 *0.5)" will shrink the layout to half the size, flip at the
|
| 153 |
+
45 degree-axis (swap x and y axes) and finally shift the layout by 100 micron
|
| 154 |
+
upwards.
|
| 155 |
+
</p><p>
|
| 156 |
+
Transformations accumulate over the layer hierarchy. This means, that if a layer is transformed
|
| 157 |
+
and the layer is inside a group whose representative specifies a transformation as well, the
|
| 158 |
+
resulting transformation is the combination of the layer's transformation (first applied) and
|
| 159 |
+
the group representative's transformation.
|
| 160 |
+
</p><p>
|
| 161 |
+
Multiple transformations can be present. In this case, the layout is shown in multiple
|
| 162 |
+
instances.
|
| 163 |
+
</p><p>
|
| 164 |
+
For more information refer to <a href="../manual/layer_source_expert.html">Transforming Views And Property Selectors</a>.
|
| 165 |
+
</p><a name="h2-85"></a><h2>Property filters</h2><p>
|
| 166 |
+
It is possible to specify a property filter. A property filter specifies an expression and only shapes
|
| 167 |
+
for which that expression applies are shown. The expression operates on user properties and the syntax
|
| 168 |
+
allows comparison of properties with a given key against a given value. Boolean operators are available. That
|
| 169 |
+
way, complex expressions can be created.
|
| 170 |
+
</p><p>
|
| 171 |
+
The property filter is specified in square brackets. For example:</p><p><tt>10/5 [#43==X]</tt></p><p>
|
| 172 |
+
With this source specification, the layer will show all shapes from layer 10, datatype 5
|
| 173 |
+
which have a user property with number 43 and value string "X".
|
| 174 |
+
</p><p>
|
| 175 |
+
For more information refer to <a href="../manual/layer_source_expert.html">Transforming Views And Property Selectors</a>.
|
| 176 |
+
</p><a name="h2-110"></a><h2>Overriding the hierarchy levels</h2><p>
|
| 177 |
+
By default, only the hierarchy levels that are selected in the hierarchy level
|
| 178 |
+
selection boxes are shown, i.e. if levels 0 to 1 are selected, just the top level
|
| 179 |
+
shapes and instances are shown. This selection can be modified for certain layers or layer groups.
|
| 180 |
+
To specify a different hierarchy selection for a certain layer, use an optional source specification
|
| 181 |
+
element, the hierarchy level selector.
|
| 182 |
+
</p><p>
|
| 183 |
+
For example:
|
| 184 |
+
</p><table><tr><td><tt>#*</tt></td><td>Display all hierarchy levels</td></tr><tr><td><tt>#0..1</tt></td><td>Display top level only</td></tr><tr><td><tt>#..5</tt></td><td>Override upper level with 5</td></tr><tr><td><tt>#2..</tt></td><td>Override lower level with 2</td></tr><tr><td><tt>#..*</tt></td><td>Override upper level setting by "all levels"</td></tr></table><p>
|
| 185 |
+
For more information refer to <a href="../manual/explicit_hier_levels.html">Specifying Explicit Hierarchy Levels For One Layer Or A Layer Group</a>.
|
| 186 |
+
</p></div>
|
| 187 |
+
</div>
|
| 188 |
+
</body>
|
| 189 |
+
</html>
|
| 190 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/layer_specs.html
ADDED
|
@@ -0,0 +1,170 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About Layer Specifications</p><h1>About Layer Specifications</h1><p>
|
| 120 |
+
Layer specifications are used in various places, for example in layer mapping
|
| 121 |
+
files (<a href="layer_mapping.html">Layer Mapping Tables</a>).
|
| 122 |
+
Layer specifications are used inside the database to give a layer a name or
|
| 123 |
+
a number/datatype pair or both. Layer specifications are the text representation
|
| 124 |
+
of <a href="../code/class_LayerInfo.html">LayerInfo</a> objects.
|
| 125 |
+
</p><p>
|
| 126 |
+
Blanks within layer specifications are ignored and can be put between
|
| 127 |
+
the different components of the specification.
|
| 128 |
+
</p><p>
|
| 129 |
+
A simple number for the specification will indicate a layer with this layer number and a
|
| 130 |
+
datatype of zero:
|
| 131 |
+
</p><pre>17</pre><p>will give layer 17, datatype 0.
|
| 132 |
+
</p><p>
|
| 133 |
+
A number followed by a slash and another number will indicate a layer number
|
| 134 |
+
and datatype:
|
| 135 |
+
</p><pre>17/5</pre><p>
|
| 136 |
+
will give layer 17, datatype 5.
|
| 137 |
+
</p><p>
|
| 138 |
+
Layers can be named. Named layers are present in DXF, CIF or other formats
|
| 139 |
+
which don't use the GDS layer/datatype number scheme. Just giving a name
|
| 140 |
+
will indicate such a layer:
|
| 141 |
+
</p><pre>METAL1</pre><p>
|
| 142 |
+
will give a named layer called "METAL1".
|
| 143 |
+
</p><p>
|
| 144 |
+
If you want to use a name that is a number, use quotes:
|
| 145 |
+
</p><pre>"17"</pre><p>
|
| 146 |
+
will give a named layer called "17".
|
| 147 |
+
</p><p>
|
| 148 |
+
If you want to use a name that includes blanks, put it into quotes
|
| 149 |
+
as well:
|
| 150 |
+
</p><pre>"METAL 1"</pre><p>
|
| 151 |
+
will give a named layer called "METAL 1" (however, such layer names are usually illegal).
|
| 152 |
+
</p><p>
|
| 153 |
+
Finally, a layer can have both a name and layer/datatype numbers.
|
| 154 |
+
In this case, add the layer/datatype number to the name in round
|
| 155 |
+
brackets:
|
| 156 |
+
</p><pre>METAL1 (17)</pre><p>
|
| 157 |
+
will give a layer named "METAL1" with layer 17 and datatype 0 and
|
| 158 |
+
</p><pre>METAL1 (17/5)</pre><p>
|
| 159 |
+
will give a layer named "METAL1" with layer 17 and datatype 5.
|
| 160 |
+
</p><h4>Layer specifications as targets</h4><p>
|
| 161 |
+
When used in a target context (e.g. for layer mapping), a layer specification
|
| 162 |
+
can use wildcards and relative layer/datatype specifications.
|
| 163 |
+
Using "*" instead of a layer or datatype number means to reuse the source
|
| 164 |
+
layer or datatype number. Using "+x" or "-x" for layer or datatype number means
|
| 165 |
+
to add or subtract "x" from the source layer or datatype number.
|
| 166 |
+
</p></div>
|
| 167 |
+
</div>
|
| 168 |
+
</body>
|
| 169 |
+
</html>
|
| 170 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/lef_def_import.html
ADDED
|
@@ -0,0 +1,234 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About LEF/DEF Import</p><h1>About LEF/DEF Import</h1><a name="k_1"></a><a name="k_2"></a><p>
|
| 120 |
+
KLayout supports import of LEF and DEF files. Because LEF and DEF import is substantially different from
|
| 121 |
+
a single-file reader, this functionality is wrapped in an import feature rather than a standard file
|
| 122 |
+
format reader. For example, reading a DEF file without accessing the library LEF files does not make
|
| 123 |
+
much sense. Therefore the import feature requires additional information beyond the simple file name,
|
| 124 |
+
specifically the list of LEF files to load additionally and the order in which to do so.
|
| 125 |
+
</p><p>
|
| 126 |
+
You can find the import feature in the "File/Import" submenu. Choose "LEF" to import a single LEF file
|
| 127 |
+
(plus potentially more LEF files from the technology specific settings) or "DEF/LEF" to import a DEF file
|
| 128 |
+
plus additional LEF files.
|
| 129 |
+
</p><p>
|
| 130 |
+
In the import dialog, the files to import are selected. The top edit box specifies the main file to
|
| 131 |
+
import (the LEF file in the LEF import case or the DEF file in the DEF import case. Use the "..."
|
| 132 |
+
button to browse for the file. In the DEF import case, additional LEF file can be specified which are
|
| 133 |
+
imported before the DEF file is read. You can add LEF files to the list using the "+" button and
|
| 134 |
+
remove the selected LEF files using the "x" button. The order of LEF files matters - the technology
|
| 135 |
+
LEF file (if there is one) should be read first. The LEF files are read in the order they appear
|
| 136 |
+
in the list. You can move entries up using the "up" button and down using the "down" button.
|
| 137 |
+
</p><p>
|
| 138 |
+
If you browse for a DEF file, KLayout will automatically fill the list of LEF files with the
|
| 139 |
+
LEF files found at the location of the DEF file. LEF files are searched for relative to the
|
| 140 |
+
DEF file path. Unless an absolute path is specified for the LEF file, KLayout will look relative
|
| 141 |
+
to the path of the DEF file.
|
| 142 |
+
</p><p>
|
| 143 |
+
In both LEF or DEF import case you have the choice to read the layout into the existing
|
| 144 |
+
view (add to the current layout or overwrite the current one) or open a new view using the
|
| 145 |
+
"Import Mode" options.
|
| 146 |
+
</p><p>
|
| 147 |
+
The following image shows the LEF import dialog:
|
| 148 |
+
</p><p><img src="lef_import_snapshot.png"></p><p>
|
| 149 |
+
And this one is the DEF import dialog:
|
| 150 |
+
</p><p><img src="def_import_snapshot.png"></p><p>
|
| 151 |
+
LEF and DEF import can be configured in many ways. The configuration of the LEF/DEF import
|
| 152 |
+
feature is attached to a technology, so there can be individual configurations per technology.
|
| 153 |
+
For a description of the technology feature, see <a href="technology_manager.html">About Technology Management</a>.
|
| 154 |
+
The import feature uses the current technology. The current technology can be selected from
|
| 155 |
+
the main toolbar's technology selector if specific technology settings exist. Otherwise, the
|
| 156 |
+
default technology will be used.
|
| 157 |
+
</p><p>
|
| 158 |
+
You can edit the import settings using the "Options" button from the import dialogs.
|
| 159 |
+
This will open a dialog for editing the settings attached to the selected technology.
|
| 160 |
+
The settings basically consist of three parts: the layer mapping, the LEF files which are
|
| 161 |
+
always read before the LEF files specified per DEF file and
|
| 162 |
+
various import settings. The following image shows the LEF/DEF import options dialog:
|
| 163 |
+
</p><p><img src="lefdef_options_snapshot.png"></p><a name="h2-84"></a><h2>Layer Mapping</h2><p>
|
| 164 |
+
By default, no layer mapping is specified. Layer mapping can be employed to confine input to
|
| 165 |
+
certain layers or layer/purpose pairs and to specify mapping of LEF layers/purposes to GDS
|
| 166 |
+
layer/datatypes.
|
| 167 |
+
</p><p>
|
| 168 |
+
In the Options part you will learn how the DEF/LEF importer generates layers. Basically, layers
|
| 169 |
+
are generated from the LEF/DEF layer name plus some suffix describing the purpose. For example,
|
| 170 |
+
pin geometry will be put to "Metal1.PIN" for "Metal1" geometry if the suffix for the "pin"
|
| 171 |
+
purpose is set to ".PIN".
|
| 172 |
+
In addition, the LEF/DEF reader will already assign some GDS layer/datatype, the layer is either
|
| 173 |
+
the position of the layer in the layer list if there is a technology LEF file or a consecutive
|
| 174 |
+
number based on the alphabetic order of the layer names. The datatype can be specified for each
|
| 175 |
+
purpose.
|
| 176 |
+
</p><p>
|
| 177 |
+
However, that may not be sufficient to convert a DEF file to a certain GDS representation.
|
| 178 |
+
Usually there is a layer mapping table, for example "Metal1.PIN" should be put to GDS layer
|
| 179 |
+
17, datatype 6. In order to facilitate such a use case, KLayout allows specification of a layer
|
| 180 |
+
mapping table. The basis for the table is the layer name plus the suffix defined for the
|
| 181 |
+
particular purpose. In the previous example, the mapping would be:
|
| 182 |
+
</p><p><tt>Metal1.OBS : 100/22</tt></p><p>
|
| 183 |
+
You can disable all other layer/purpose pairs by unchecking the "Read all layers" option
|
| 184 |
+
at the top of the layer mapping table. If this option is enabled, KLayout will generate
|
| 185 |
+
the GDS layers using the scheme described above for all layers it does not find in the
|
| 186 |
+
mapping table.
|
| 187 |
+
</p><a name="h2-120"></a><h2>LEF Files</h2><p>
|
| 188 |
+
You can specify a list of LEF files to load before any other LEF files. This feature
|
| 189 |
+
is intended to allow specification of a technology LEF file containing the layer definitions
|
| 190 |
+
or any standard library which should be present for every macro built on that technology.
|
| 191 |
+
You can add and delete LEF files using the "+" and "x" button respectively. You can move
|
| 192 |
+
files up and down using the "up" and "down" arrow buttons. The LEF files are read in the
|
| 193 |
+
given order, so the technology LEF file must be the first in the list.
|
| 194 |
+
</p><a name="h2-131"></a><h2>Options</h2><p>
|
| 195 |
+
On the left side of the option panel, two basic options are provided:
|
| 196 |
+
</p><ul><li><b>Produce net names:</b> Check this option to assign user properties with the
|
| 197 |
+
net name to the net shapes in DEF files. The user property name used for that
|
| 198 |
+
purpose can be specified in the edit box below the check box. Use KLayout's
|
| 199 |
+
variant notation (see <a href="variant_notation.html">About Variant Notation</a>) to specify
|
| 200 |
+
value and type of the property name.
|
| 201 |
+
</li><li><b>Produce inst names:</b> Check this option to assign user properties with the
|
| 202 |
+
instance name to the component instances created by DEF import.
|
| 203 |
+
The user property name used for the instance name
|
| 204 |
+
can be specified in the edit box below the check box. Use KLayout's
|
| 205 |
+
variant notation (see <a href="variant_notation.html">About Variant Notation</a>) to specify
|
| 206 |
+
value and type of the property name.
|
| 207 |
+
</li><li><b>Produce cell outlines:</b> If this option is checked, outline shapes are
|
| 208 |
+
produced for the macros and the design (for DEF import). The layer to be used can
|
| 209 |
+
be specified in the edit box below. You can use KLayout's usual layer specification
|
| 210 |
+
notation, i.e. "OUTLINE" for a named layer without GDS layer/datatype value,
|
| 211 |
+
"10/0" for GDS layer 10, datatype 0 without a name or "OUTLINE (10/0)" for a
|
| 212 |
+
combination of both. The outline layer is subject to layer mapping as well, so
|
| 213 |
+
the layer map can be used alternatively to assign GDS layer/datatype numbers.
|
| 214 |
+
</li><li><b>Produce blockages:</b> If this option is checked, placement blockages
|
| 215 |
+
are produced as polygons on the layer given right of the check box. Use KLayout's layer
|
| 216 |
+
notation to specify the layer (see "Produce cell outlines").
|
| 217 |
+
</li><li><b>Produce regions:</b> If this option is checked, regions
|
| 218 |
+
are produced as polygons on the layer given right of the check box. Use KLayout's layer
|
| 219 |
+
notation to specify the layer (see "Produce cell outlines").
|
| 220 |
+
</li></ul><p>
|
| 221 |
+
On the right side, the default layer generation for various purposes can be configured.
|
| 222 |
+
In all cases, a layer suffix can be set which is just added to the layer name and
|
| 223 |
+
a default GDS datatype can be set. Please note, that the GDS datatype may be overruled
|
| 224 |
+
by a layer map if one is set. All contributions can be disabled individually.
|
| 225 |
+
</p><p>
|
| 226 |
+
The purposes available are:
|
| 227 |
+
</p><ul><li><b>Via geometry:</b> generated for shapes making up a via.</li><li><b>Pins:</b> generated for shapes making up a pin.</li><li><b>Obstructions:</b> generated for obstruction area markers.</li><li><b>Routing:</b> generated for routing geometry.</li><li><b>Pin labels:</b> generated for pin labels.</li><li><b>Blockages:</b> generated for (component) blockages.</li></ul><p><b>Note:</b> if the suffix of two purposes is identical, the default GDS datatype should
|
| 228 |
+
be identical as well. Otherwise it is not defined which layer will be generated.
|
| 229 |
+
Vice versa, the GDS datatypes should be different for different layer suffixes.
|
| 230 |
+
</p></div>
|
| 231 |
+
</div>
|
| 232 |
+
</body>
|
| 233 |
+
</html>
|
| 234 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/lvs_ref.html
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » LVS Reference</p><h1>LVS Reference</h1><a name="k_1"></a><ul><li><a href="lvs_ref_netter.html">LVS Reference: Netter object</a></li><li><a href="lvs_ref_global.html">LVS Reference: Global Functions</a></li></ul></div>
|
| 120 |
+
</div>
|
| 121 |
+
</body>
|
| 122 |
+
</html>
|
| 123 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/lvs_ref_global.html
ADDED
|
@@ -0,0 +1,193 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » <a href="lvs_ref.html">LVS Reference</a> » LVS Reference: Global Functions</p><h1>LVS Reference: Global Functions</h1><a name="k_1"></a><p>
|
| 120 |
+
Some functions are available on global level and can be used without any object.
|
| 121 |
+
Most of them are convenience functions that basically act on some default object
|
| 122 |
+
or provide function-like alternatives for the methods.
|
| 123 |
+
</p><p>
|
| 124 |
+
LVS is built upon DRC. So all functions available in DRC are also available
|
| 125 |
+
in LVS. In LVS, DRC functions are used to derive functional layers from original
|
| 126 |
+
layers or specification of the layout source.
|
| 127 |
+
</p><p>
|
| 128 |
+
For more details about the DRC functions see <a href="drc_ref_global.html">DRC::global</a>.
|
| 129 |
+
</p><ul><li><a href="#h2-22">"align" - Aligns the extracted netlist vs. the schematic by flattening circuits where required</a></li><li><a href="#h2-31">"blank_circuit" - Removes the content from the given circuits (blackboxing)</a></li><li><a href="#h2-40">"compare" - Compares the extracted netlist vs. the schematic netlist</a></li><li><a href="#h2-49">"consider_net_names" - Indicates whether the netlist comparer shall use net names</a></li><li><a href="#h2-58">"disable_parameter" - Specifies whether to disable a parameter from a given device class for netlisting and default compare</a></li><li><a href="#h2-67">"enable_parameter" - Specifies whether to enable a parameter from a given device class for netlisting and default compare</a></li><li><a href="#h2-76">"equivalent_pins" - Marks pins as equivalent</a></li><li><a href="#h2-85">"ignore_parameter" - Specifies whether to ignore a parameter from a given device class for the compare</a></li><li><a href="#h2-94">"join_symmetric_nets" - Joins symmetric nets of selected circuits on the extracted netlist</a></li><li><a href="#h2-103">"lvs_data" - Gets the LayoutVsSchematic object after compare was used</a></li><li><a href="#h2-112">"max_branch_complexity" - Configures the maximum branch complexity for ambiguous net matching</a></li><li><a href="#h2-121">"max_depth" - Configures the maximum search depth for net match deduction</a></li><li><a href="#h2-130">"max_res" - Ignores resistors with a resistance above a certain value</a></li><li><a href="#h2-139">"min_caps" - Ignores capacitors with a capacitance below a certain value</a></li><li><a href="#h2-148">"netter" - Creates a new netter object</a></li><li><a href="#h2-157">"no_lvs_hints" - Disables LVS hints</a></li><li><a href="#h2-166">"report_lvs" - Specifies an LVS report for output</a></li><li><a href="#h2-187">"same_circuits" - Establishes an equivalence between the circuits</a></li><li><a href="#h2-196">"same_device_classes" - Establishes an equivalence between the device_classes</a></li><li><a href="#h2-205">"same_nets" - Establishes an equivalence between the nets</a></li><li><a href="#h2-216">"same_nets!" - Establishes an equivalence between the nets (must match)</a></li><li><a href="#h2-227">"schematic" - Reads the reference netlist</a></li><li><a href="#h2-238">"split_gates" - Implements the "split gates" feature for the given device and circuits</a></li><li><a href="#h2-248">"tolerance" - Specifies compare tolerances for certain device parameters</a></li></ul><a name="align"></a><a name="h2-22"></a><h2>"align" - Aligns the extracted netlist vs. the schematic by flattening circuits where required</h2><a name="k_2"></a><p>Usage:</p><ul><li><tt>align</tt></li></ul><p>
|
| 130 |
+
See <a href="lvs_ref_netter.html#align">Netter#align</a> for a description of that function.
|
| 131 |
+
</p><a name="blank_circuit"></a><a name="h2-31"></a><h2>"blank_circuit" - Removes the content from the given circuits (blackboxing)</h2><a name="k_3"></a><p>Usage:</p><ul><li><tt>blank_circuit(circuit_filter)</tt></li></ul><p>
|
| 132 |
+
See <a href="lvs_ref_netter.html#blank_circuit">Netter#blank_circuit</a> for a description of that function.
|
| 133 |
+
</p><a name="compare"></a><a name="h2-40"></a><h2>"compare" - Compares the extracted netlist vs. the schematic netlist</h2><a name="k_4"></a><p>Usage:</p><ul><li><tt>compare</tt></li></ul><p>
|
| 134 |
+
See <a href="lvs_ref_netter.html#compare">Netter#compare</a> for a description of that function.
|
| 135 |
+
</p><a name="consider_net_names"></a><a name="h2-49"></a><h2>"consider_net_names" - Indicates whether the netlist comparer shall use net names</h2><a name="k_5"></a><p>Usage:</p><ul><li><tt>consider_net_names(f)</tt></li></ul><p>
|
| 136 |
+
See <a href="lvs_ref_netter.html#consider_net_names">Netter#consider_net_names</a> for a description of that function.
|
| 137 |
+
</p><a name="disable_parameter"></a><a name="h2-58"></a><h2>"disable_parameter" - Specifies whether to disable a parameter from a given device class for netlisting and default compare</h2><a name="k_6"></a><p>Usage:</p><ul><li><tt>disable_parameter(device_class_name, parameter_name)</tt></li></ul><p>
|
| 138 |
+
See <a href="lvs_ref_netter.html#disable_parameter">Netter#disable_parameter</a> for a description of that function.
|
| 139 |
+
</p><a name="enable_parameter"></a><a name="h2-67"></a><h2>"enable_parameter" - Specifies whether to enable a parameter from a given device class for netlisting and default compare</h2><a name="k_7"></a><p>Usage:</p><ul><li><tt>enable_parameter(device_class_name, parameter_name)</tt></li></ul><p>
|
| 140 |
+
See <a href="lvs_ref_netter.html#enable_parameter">Netter#enable_parameter</a> for a description of that function.
|
| 141 |
+
</p><a name="equivalent_pins"></a><a name="h2-76"></a><h2>"equivalent_pins" - Marks pins as equivalent</h2><a name="k_8"></a><p>Usage:</p><ul><li><tt>equivalent_pins(circuit, pins ...)</tt></li></ul><p>
|
| 142 |
+
See <a href="lvs_ref_netter.html#equivalent_pins">Netter#equivalent_pins</a> for a description of that function.
|
| 143 |
+
</p><a name="ignore_parameter"></a><a name="h2-85"></a><h2>"ignore_parameter" - Specifies whether to ignore a parameter from a given device class for the compare</h2><a name="k_9"></a><p>Usage:</p><ul><li><tt>ignore_parameter(device_class_name, parameter_name)</tt></li></ul><p>
|
| 144 |
+
See <a href="lvs_ref_netter.html#ignore_parameter">Netter#ignore_parameter</a> for a description of that function.
|
| 145 |
+
</p><a name="join_symmetric_nets"></a><a name="h2-94"></a><h2>"join_symmetric_nets" - Joins symmetric nets of selected circuits on the extracted netlist</h2><a name="k_10"></a><p>Usage:</p><ul><li><tt>join_symmetric_nets(circuit_filter)</tt></li></ul><p>
|
| 146 |
+
See <a href="lvs_ref_netter.html#join_symmetric_nets">Netter#join_symmetric_nets</a> for a description of that function.
|
| 147 |
+
</p><a name="lvs_data"></a><a name="h2-103"></a><h2>"lvs_data" - Gets the <a href="../code/class_LayoutVsSchematic.html">LayoutVsSchematic</a> object after compare was used</h2><a name="k_11"></a><p>Usage:</p><ul><li><tt>lvs_data</tt></li></ul><p>
|
| 148 |
+
See <a href="lvs_ref_netter.html#lvs_data">Netter#lvs_data</a> for a description of that function.
|
| 149 |
+
</p><a name="max_branch_complexity"></a><a name="h2-112"></a><h2>"max_branch_complexity" - Configures the maximum branch complexity for ambiguous net matching</h2><a name="k_12"></a><p>Usage:</p><ul><li><tt>max_branch_complexity(n)</tt></li></ul><p>
|
| 150 |
+
See <a href="lvs_ref_netter.html#max_branch_complexity">Netter#max_branch_complexity</a> for a description of that function.
|
| 151 |
+
</p><a name="max_depth"></a><a name="h2-121"></a><h2>"max_depth" - Configures the maximum search depth for net match deduction</h2><a name="k_13"></a><p>Usage:</p><ul><li><tt>max_depth(n)</tt></li></ul><p>
|
| 152 |
+
See <a href="lvs_ref_netter.html#max_depth">Netter#max_depth</a> for a description of that function.
|
| 153 |
+
</p><a name="max_res"></a><a name="h2-130"></a><h2>"max_res" - Ignores resistors with a resistance above a certain value</h2><a name="k_14"></a><p>Usage:</p><ul><li><tt>max_res(threshold)</tt></li></ul><p>
|
| 154 |
+
See <a href="lvs_ref_netter.html#max_res">Netter#max_res</a> for a description of that function.
|
| 155 |
+
</p><a name="min_caps"></a><a name="h2-139"></a><h2>"min_caps" - Ignores capacitors with a capacitance below a certain value</h2><a name="k_15"></a><p>Usage:</p><ul><li><tt>min_caps(threshold)</tt></li></ul><p>
|
| 156 |
+
See <a href="lvs_ref_netter.html#min_caps">Netter#min_caps</a> for a description of that function.
|
| 157 |
+
</p><a name="netter"></a><a name="h2-148"></a><h2>"netter" - Creates a new netter object</h2><a name="k_16"></a><p>Usage:</p><ul><li><tt>netter</tt></li></ul><p>
|
| 158 |
+
See <a href="lvs_ref_netter.html">Netter</a> for more details
|
| 159 |
+
</p><a name="no_lvs_hints"></a><a name="h2-157"></a><h2>"no_lvs_hints" - Disables LVS hints</h2><a name="k_17"></a><p>Usage:</p><ul><li><tt>no_lvs_hints</tt></li></ul><p>
|
| 160 |
+
See <a href="lvs_ref_netter.html#no_lvs_hints">Netter#no_lvs_hints</a> for a description of that feature.
|
| 161 |
+
</p><a name="report_lvs"></a><a name="h2-166"></a><h2>"report_lvs" - Specifies an LVS report for output</h2><a name="k_18"></a><p>Usage:</p><ul><li><tt>report_lvs([ filename [, long ] ])</tt></li></ul><p>
|
| 162 |
+
After the comparison step, the LVS database will be shown
|
| 163 |
+
in the netlist database browser in a cross-reference view.
|
| 164 |
+
If a filename is given, the LVS database is also written to
|
| 165 |
+
this file. If a file name is given and "long" is true, a
|
| 166 |
+
verbose version of the LVS DB format will be used.
|
| 167 |
+
</p><p>
|
| 168 |
+
If this method is called together with report_netlist and two files each, two
|
| 169 |
+
files can be generated - one for the extracted netlist (L2N database) and one for the
|
| 170 |
+
LVS database. However, report_netlist will only write the extracted netlist
|
| 171 |
+
while report_lvs will write the LVS database which also includes the
|
| 172 |
+
extracted netlist.
|
| 173 |
+
</p><p>
|
| 174 |
+
report_lvs is only effective if a comparison step is included.
|
| 175 |
+
</p><a name="same_circuits"></a><a name="h2-187"></a><h2>"same_circuits" - Establishes an equivalence between the circuits</h2><a name="k_19"></a><p>Usage:</p><ul><li><tt>same_circuits(circuit_a, circuit_b)</tt></li></ul><p>
|
| 176 |
+
See <a href="lvs_ref_netter.html#same_circuits">Netter#same_circuits</a> for a description of that function.
|
| 177 |
+
</p><a name="same_device_classes"></a><a name="h2-196"></a><h2>"same_device_classes" - Establishes an equivalence between the device_classes</h2><a name="k_20"></a><p>Usage:</p><ul><li><tt>same_device_classes(class_a, class_b)</tt></li></ul><p>
|
| 178 |
+
See <a href="lvs_ref_netter.html#same_device_classes">Netter#same_device_classes</a> for a description of that function.
|
| 179 |
+
</p><a name="same_nets"></a><a name="h2-205"></a><h2>"same_nets" - Establishes an equivalence between the nets</h2><a name="k_21"></a><p>Usage:</p><ul><li><tt>same_nets(circuit_pattern, net_pattern)</tt></li><li><tt>same_nets(circuit_pattern, net_a, net_b)</tt></li><li><tt>same_nets(circuit_a, net_a, circuit_b, net_b)</tt></li></ul><p>
|
| 180 |
+
See <a href="lvs_ref_netter.html#same_nets">Netter#same_nets</a> for a description of that function.
|
| 181 |
+
</p><a name="same_nets!"></a><a name="h2-216"></a><h2>"same_nets!" - Establishes an equivalence between the nets (must match)</h2><a name="k_22"></a><p>Usage:</p><ul><li><tt>same_nets!(circuit_pattern, net_pattern)</tt></li><li><tt>same_nets!(circuit_pattern, net_a, net_b)</tt></li><li><tt>same_nets!(circuit_a, net_a, circuit_b, net_b)</tt></li></ul><p>
|
| 182 |
+
See <a href="lvs_ref_netter.html#same_nets">Netter#same_nets</a>! for a description of that function.
|
| 183 |
+
</p><a name="schematic"></a><a name="h2-227"></a><h2>"schematic" - Reads the reference netlist</h2><a name="k_23"></a><p>Usage:</p><ul><li><tt>schematic(filename)</tt></li><li><tt>schematic(filename, reader)</tt></li><li><tt>schematic(netlist)</tt></li></ul><p>
|
| 184 |
+
See <a href="lvs_ref_netter.html#schematic">Netter#schematic</a> for a description of that function.
|
| 185 |
+
</p><a name="split_gates"></a><a name="h2-238"></a><h2>"split_gates" - Implements the "split gates" feature for the given device and circuits</h2><a name="k_24"></a><p>Usage:</p><ul><li><tt>split_gates(device_name)</tt></li><li><tt>split_gates(device_name, circuit_filter)</tt></li></ul><p>
|
| 186 |
+
See <a href="lvs_ref_netter.html#split_gates">Netter#split_gates</a> for a description of that function.
|
| 187 |
+
</p><a name="tolerance"></a><a name="h2-248"></a><h2>"tolerance" - Specifies compare tolerances for certain device parameters</h2><a name="k_25"></a><p>Usage:</p><ul><li><tt>tolerance(device_class_name, parameter_name, absolute_tolerance [, relative_tolerance])</tt></li><li><tt>tolerance(device_class_name, parameter_name [, :absolute => absolute_tolerance] [, :relative => relative_tolerance])</tt></li></ul><p>
|
| 188 |
+
See <a href="lvs_ref_netter.html#tolerance">Netter#tolerance</a> for a description of that function.
|
| 189 |
+
</p></div>
|
| 190 |
+
</div>
|
| 191 |
+
</body>
|
| 192 |
+
</html>
|
| 193 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/lvs_ref_netter.html
ADDED
|
@@ -0,0 +1,440 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » <a href="lvs_ref.html">LVS Reference</a> » LVS Reference: Netter object</p><h1>LVS Reference: Netter object</h1><a name="k_1"></a><p>
|
| 120 |
+
The Netter object provides services related to network extraction
|
| 121 |
+
from a layout plus comparison against a reference netlist.
|
| 122 |
+
Similar to the DRC <a href="drc_ref_netter.html">DRC::Netter</a> (which lacks the compare ability), the
|
| 123 |
+
relevant method of this object are available as global functions too
|
| 124 |
+
where they act on a default incarnation. Usually it's not required
|
| 125 |
+
to instantiate a Netter object explicitly.
|
| 126 |
+
</p><p>
|
| 127 |
+
The LVS Netter object inherits all methods of the <a href="drc_ref_netter.html">DRC::Netter</a>.
|
| 128 |
+
</p><p>
|
| 129 |
+
An individual netter object can be created, if the netter results
|
| 130 |
+
need to be kept for multiple extractions. If you really need
|
| 131 |
+
a Netter object, use the global <a href="lvs_ref_global.html#netter">netter</a> function:
|
| 132 |
+
</p><p><pre>
|
| 133 |
+
# create a new Netter object:
|
| 134 |
+
nx = netter
|
| 135 |
+
|
| 136 |
+
# build connectivity
|
| 137 |
+
nx.connect(poly, contact)
|
| 138 |
+
...
|
| 139 |
+
|
| 140 |
+
# read the reference netlist
|
| 141 |
+
nx.schematic("reference.cir")
|
| 142 |
+
|
| 143 |
+
# configure the netlist compare
|
| 144 |
+
nx.same_circuits("A", "B")
|
| 145 |
+
...
|
| 146 |
+
|
| 147 |
+
# runs the compare
|
| 148 |
+
if ! nx.compare
|
| 149 |
+
puts("no equivalence!")
|
| 150 |
+
end
|
| 151 |
+
</pre></p><ul><li><a href="#h2-46">"align" - Aligns the extracted netlist vs. the schematic</a></li><li><a href="#h2-71">"blank_circuit" - Removes the content from the given circuits (blackboxing)</a></li><li><a href="#h2-101">"compare" - Compares the extracted netlist vs. the schematic</a></li><li><a href="#h2-118">"consider_net_names" - Indicates whether the netlist comparer shall use net names</a></li><li><a href="#h2-130">"disable_parameter" - Indicates whether to disable a specific parameter for a given device</a></li><li><a href="#h2-146">"enable_parameter" - Indicates whether to enable a specific parameter for a given device</a></li><li><a href="#h2-162">"equivalent_pins" - Marks pins as equivalent</a></li><li><a href="#h2-189">"ignore_parameter" - Skip a specific parameter for a given device class name during device compare</a></li><li><a href="#h2-203">"join_symmetric_nets" - Joins symmetric nets of selected circuits on the extracted netlist</a></li><li><a href="#h2-226">"lvs_data" - Gets the internal LayoutVsSchematic object</a></li><li><a href="#h2-236">"max_branch_complexity" - Configures the maximum branch complexity for ambiguous net matching</a></li><li><a href="#h2-262">"max_depth" - Configures the maximum search depth for net match deduction</a></li><li><a href="#h2-285">"max_res" - Ignores resistors with a resistance above a certain value</a></li><li><a href="#h2-295">"min_caps" - Ignores capacitors with a capacitance below a certain value</a></li><li><a href="#h2-305">"no_lvs_hints" - Disables LVS hints</a></li><li><a href="#h2-315">"same_circuits" - Establishes an equivalence between the circuits</a></li><li><a href="#h2-334">"same_device_classes" - Establishes an equivalence between the device classes</a></li><li><a href="#h2-374">"same_nets" - Establishes an equivalence between the nets</a></li><li><a href="#h2-421">"same_nets!" - Establishes an equivalence between the nets with matching requirement</a></li><li><a href="#h2-449">"schematic" - Gets, sets or reads the reference netlist</a></li><li><a href="#h2-469">"split_gates" - Implements the "split gates" feature</a></li><li><a href="#h2-491">"tolerance" - Specifies compare tolerances for certain device parameters</a></li></ul><a name="align"></a><a name="h2-46"></a><h2>"align" - Aligns the extracted netlist vs. the schematic</h2><a name="k_2"></a><p>Usage:</p><ul><li><tt>align</tt></li></ul><p>
|
| 152 |
+
The align method will modify the netlists in case of missing
|
| 153 |
+
corresponding circuits. It will flatten these circuits, thus
|
| 154 |
+
improving the equivalence between the netlists. Top level circuits
|
| 155 |
+
are not flattened.
|
| 156 |
+
</p><p>
|
| 157 |
+
This feature is in particular useful to remove structural cells
|
| 158 |
+
like device PCells, reuse blocks etc.
|
| 159 |
+
</p><p>
|
| 160 |
+
This method will also remove schematic circuits for which there is
|
| 161 |
+
no corresponding layout cell. In the extreme case of flat layout this
|
| 162 |
+
will result in a flat vs. flat compare.
|
| 163 |
+
</p><p>
|
| 164 |
+
"netlist.flatten_circuit(...)" or "schematic.flatten_circuit(...)"
|
| 165 |
+
are other (explicit) ways to flatten circuits.
|
| 166 |
+
</p><p>
|
| 167 |
+
Please note that flattening circuits has some side effects such
|
| 168 |
+
as loss of details in the cross reference and net layout.
|
| 169 |
+
</p><a name="blank_circuit"></a><a name="h2-71"></a><h2>"blank_circuit" - Removes the content from the given circuits (blackboxing)</h2><a name="k_3"></a><p>Usage:</p><ul><li><tt>blank_circuit(circuit_filter)</tt></li></ul><p>
|
| 170 |
+
This method will erase all content from the circuits matching the filter.
|
| 171 |
+
The filter is a glob expression.
|
| 172 |
+
</p><p>
|
| 173 |
+
This has the following effects:
|
| 174 |
+
</p><p><ul><li>The circuits are no longer compared (netlist vs. schematic) </li><li>Named pins are required to match (use labels on the nets to name pins in the layout) </li><li>Unnamed pins are treated as equivalent and can be swapped </li><li>The selected circuits will not be purged on netlist simplification </li></ul></p><p>
|
| 175 |
+
Using this method can be useful to reduce the verification overhead for
|
| 176 |
+
blocks which are already verifified by other ways or for which no schematic
|
| 177 |
+
is available - e.g. hard macros.
|
| 178 |
+
</p><p>
|
| 179 |
+
Example:
|
| 180 |
+
</p><p><pre>
|
| 181 |
+
# skips all MEMORY* circuits from compare
|
| 182 |
+
blank_circuit("MEMORY*")
|
| 183 |
+
</pre></p><a name="compare"></a><a name="h2-101"></a><h2>"compare" - Compares the extracted netlist vs. the schematic</h2><a name="k_4"></a><p>Usage:</p><ul><li><tt>compare</tt></li></ul><p>
|
| 184 |
+
Before using this method, a schematic netlist has to be loaded with <a href="#schematic">schematic</a>.
|
| 185 |
+
The compare can be configured in more details using <a href="#same_nets">same_nets</a>, <a href="#same_circuits">same_circuits</a>,
|
| 186 |
+
<a href="#same_device_classes">same_device_classes</a> and <a href="#equivalent_pins">equivalent_pins</a>.
|
| 187 |
+
</p><p>
|
| 188 |
+
The compare method will also modify the netlists in case of missing
|
| 189 |
+
corresponding circuits: the unpaired circuit will be flattened then.
|
| 190 |
+
</p><p>
|
| 191 |
+
This method will return true, if the netlists are equivalent and false
|
| 192 |
+
otherwise.
|
| 193 |
+
</p><a name="consider_net_names"></a><a name="h2-118"></a><h2>"consider_net_names" - Indicates whether the netlist comparer shall use net names</h2><a name="k_5"></a><p>Usage:</p><ul><li><tt>consider_net_names(f)</tt></li></ul><p>
|
| 194 |
+
If this value is set to true (the default), the netlist comparer
|
| 195 |
+
will employ net names to resolve ambiguities. If set to false,
|
| 196 |
+
ambiguities will be resolved based on the topology alone. Topology
|
| 197 |
+
resolution is more expensive.
|
| 198 |
+
</p><a name="disable_parameter"></a><a name="h2-130"></a><h2>"disable_parameter" - Indicates whether to disable a specific parameter for a given device</h2><a name="k_6"></a><p>Usage:</p><ul><li><tt>disable_parameter(device_class_name, parameter_name)</tt></li></ul><p>
|
| 199 |
+
Disabling a parameter is the inverse of <a href="#enable_parameter">enable_parameter</a>. Disabling a parameter will
|
| 200 |
+
reset the "primary" flag of the parameter. This has several effects - e.g. the parameter will not be
|
| 201 |
+
used in device compare during netlist matching by default.
|
| 202 |
+
</p><p>
|
| 203 |
+
This is not a strong concept but rather
|
| 204 |
+
a hint for the system. Disabling a parameter for netlist compare without side effects
|
| 205 |
+
is possible with the <a href="#ignore_parameter">ignore_parameter</a> function. In the same way, <a href="#tolerance">tolerance</a> will enable a parameter for
|
| 206 |
+
netlist compare regardless of the "primary" status of the parameter.
|
| 207 |
+
</p><a name="enable_parameter"></a><a name="h2-146"></a><h2>"enable_parameter" - Indicates whether to enable a specific parameter for a given device</h2><a name="k_7"></a><p>Usage:</p><ul><li><tt>enable_parameter(device_class_name, parameter_name)</tt></li></ul><p>
|
| 208 |
+
The parameter is made "primary" which enables further applications - e.g. it is netlisted
|
| 209 |
+
for some elements which normally would not print that parameter, and the parameter
|
| 210 |
+
is compared in the default device compare scheme during netlist matching.
|
| 211 |
+
</p><p>
|
| 212 |
+
Enabling a parameter is rather a hint for the system and the effects can be controlled
|
| 213 |
+
by other means, so this is not a strong concept. For example, once a <a href="#tolerance">tolerance</a> is
|
| 214 |
+
specified for a parameter, the "primary" flag of the parameter is not considered anymore.
|
| 215 |
+
The inverse the this function is <a href="#disable_parameter">disable_parameter</a>.
|
| 216 |
+
</p><a name="equivalent_pins"></a><a name="h2-162"></a><h2>"equivalent_pins" - Marks pins as equivalent</h2><a name="k_8"></a><p>Usage:</p><ul><li><tt>equivalent_pins(circuit, pin ...)</tt></li></ul><p>
|
| 217 |
+
This method will mark the given pins as equivalent. This gives the compare algorithm
|
| 218 |
+
more degrees of freedom when establishing net correspondence. Typically this method
|
| 219 |
+
is used to declare inputs from gates are equivalent where are are logically, but not
|
| 220 |
+
physically (e.g. in a CMOS NAND gate):
|
| 221 |
+
</p><p><pre>
|
| 222 |
+
netter.equivalent_pins("NAND2", 0, 1)
|
| 223 |
+
</pre></p><p>
|
| 224 |
+
The circuit argument is either a circuit name (a string) or a Circuit object
|
| 225 |
+
from the schematic netlist.
|
| 226 |
+
</p><p>
|
| 227 |
+
Names are case sensitive for layout-derived netlists and case-insensitive for SPICE schematic netlists.
|
| 228 |
+
</p><p>
|
| 229 |
+
The pin arguments are zero-based pin numbers, where 0 is the first number, 1 the second etc.
|
| 230 |
+
If the netlist provides named pins, names can be used instead of numbers. Again, use upper
|
| 231 |
+
case pin names for SPICE netlists.
|
| 232 |
+
</p><p>
|
| 233 |
+
Use this method andwhere in the script before the <a href="#compare">compare</a> call.
|
| 234 |
+
</p><a name="ignore_parameter"></a><a name="h2-189"></a><h2>"ignore_parameter" - Skip a specific parameter for a given device class name during device compare</h2><a name="k_9"></a><p>Usage:</p><ul><li><tt>ignore_parameter(device_class_name, parameter_name)</tt></li></ul><p>
|
| 235 |
+
Use this function is ignore a parameter for a particular device class during the netlist compare.
|
| 236 |
+
Some parameters - for example "L" and "W" parameters of the resistor device - are "secondary" parameters
|
| 237 |
+
which are not ignored by default. Using "ignore_parameter" on such devices does not have an effect.
|
| 238 |
+
</p><p>
|
| 239 |
+
"ignore_parameter" and "tolerance" only have an effect with the default device comparer. Using a custom device comparer
|
| 240 |
+
will override the definitions by "ignore_parameter" or "tolerance".
|
| 241 |
+
</p><a name="join_symmetric_nets"></a><a name="h2-203"></a><h2>"join_symmetric_nets" - Joins symmetric nets of selected circuits on the extracted netlist</h2><a name="k_10"></a><p>Usage:</p><ul><li><tt>join_symmetric_nets(circuit_filter)</tt></li></ul><p>
|
| 242 |
+
Nets are symmetrical if swapping them would not modify the circuit.
|
| 243 |
+
Hence they will carry the same potential and can be connected (joined).
|
| 244 |
+
This will simplify the circuit and can be applied before device combination
|
| 245 |
+
(e.g. through "netlist.simplify") to render a schematic-equivalent netlist in some
|
| 246 |
+
cases where symmetric nodes are split (i.e. "split gate" configuration).
|
| 247 |
+
</p><p>
|
| 248 |
+
This method operates on the extracted netlist (layout). The circuit filter
|
| 249 |
+
specifies the circuits to which to apply this operation. The filter is a
|
| 250 |
+
glob-style pattern. Using "*" for all circuits is possible, but it's
|
| 251 |
+
discouraged currenty until the reliability of the symmetry detection
|
| 252 |
+
algorithm is established. Currently it is recommended to apply it only to
|
| 253 |
+
those circuits for which this feature is required.
|
| 254 |
+
</p><p>
|
| 255 |
+
For the symmetry detection, the specified constraints (e.g. tolerances,
|
| 256 |
+
device filters etc.) apply.
|
| 257 |
+
</p><a name="lvs_data"></a><a name="h2-226"></a><h2>"lvs_data" - Gets the internal <a href="../code/class_LayoutVsSchematic.html">LayoutVsSchematic</a> object</h2><a name="k_11"></a><p>Usage:</p><ul><li><tt>lvs_data</tt></li></ul><p>
|
| 258 |
+
The <a href="../code/class_LayoutVsSchematic.html">LayoutVsSchematic</a> object provides access to the internal details of
|
| 259 |
+
the netter object.
|
| 260 |
+
</p><a name="max_branch_complexity"></a><a name="h2-236"></a><h2>"max_branch_complexity" - Configures the maximum branch complexity for ambiguous net matching</h2><a name="k_12"></a><p>Usage:</p><ul><li><tt>max_branch_complexity(n)</tt></li></ul><p>
|
| 261 |
+
The netlist compare algorithm is basically a backtracing algorithm.
|
| 262 |
+
With ambiguous nets, the algorithm picks possible net pairs and
|
| 263 |
+
tries whether they will make a good match. Following the deduction
|
| 264 |
+
path for this nets may lead to further branches if more ambiguous
|
| 265 |
+
nets are encountered. To avoid combinational explosion, the maximum
|
| 266 |
+
branch complexity is limited to the value configured with this
|
| 267 |
+
function. The default value is 500 which means not more than
|
| 268 |
+
500 combinations are tried for a single seed pair. For networks
|
| 269 |
+
with inherent ambiguity such as decoders, the complexity
|
| 270 |
+
can be increased at the expense of potentially larger runtimes.
|
| 271 |
+
The runtime penality is roughly proportional to the branch
|
| 272 |
+
complexity.
|
| 273 |
+
</p><p>
|
| 274 |
+
By default, the branch complexity is unlimited, but it may
|
| 275 |
+
be reduced in order to limit the compare runtimes at the cost
|
| 276 |
+
of a less elaborate compare attempt. The preferred solution
|
| 277 |
+
however is to use labels for net name hints which also reduces
|
| 278 |
+
the depth.
|
| 279 |
+
</p><a name="max_depth"></a><a name="h2-262"></a><h2>"max_depth" - Configures the maximum search depth for net match deduction</h2><a name="k_13"></a><p>Usage:</p><ul><li><tt>max_depth(n)</tt></li></ul><p>
|
| 280 |
+
The netlist compare algorithm works recursively: once a net
|
| 281 |
+
equivalence is established, additional matches are derived from
|
| 282 |
+
this equivalence. Such equivalences in turn are used to derive
|
| 283 |
+
new equivalences and so on. The maximum depth parameter configures
|
| 284 |
+
the number of recursions the algorithm performs before picking
|
| 285 |
+
the next net. With higher values for the depth, the algorithm
|
| 286 |
+
pursues this "deduction path" in greater depth while with
|
| 287 |
+
smaller values, the algorithm prefers picking nets in a random fashion
|
| 288 |
+
as the seeds for this deduction path. The default value is 8.
|
| 289 |
+
</p><p>
|
| 290 |
+
By default, the depth is unlimited, but it may
|
| 291 |
+
be reduced in order to limit the compare runtimes at the cost
|
| 292 |
+
of a less elaborate compare attempt. The preferred solution
|
| 293 |
+
however is to use labels for net name hints which also reduces
|
| 294 |
+
the branch complexity.
|
| 295 |
+
</p><a name="max_res"></a><a name="h2-285"></a><h2>"max_res" - Ignores resistors with a resistance above a certain value</h2><a name="k_14"></a><p>Usage:</p><ul><li><tt>max_res(threshold)</tt></li></ul><p>
|
| 296 |
+
After using this method, the netlist compare will ignore resistor devices
|
| 297 |
+
with a resistance value above the given threshold (in Farad).
|
| 298 |
+
</p><a name="min_caps"></a><a name="h2-295"></a><h2>"min_caps" - Ignores capacitors with a capacitance below a certain value</h2><a name="k_15"></a><p>Usage:</p><ul><li><tt>min_caps(threshold)</tt></li></ul><p>
|
| 299 |
+
After using this method, the netlist compare will ignore capacitance devices
|
| 300 |
+
with a capacitance values below the given threshold (in Farad).
|
| 301 |
+
</p><a name="no_lvs_hints"></a><a name="h2-305"></a><h2>"no_lvs_hints" - Disables LVS hints</h2><a name="k_16"></a><p>Usage:</p><ul><li><tt>no_lvs_hints</tt></li></ul><p>
|
| 302 |
+
LVS hints may be expensive to compute. Use this function to disable
|
| 303 |
+
generation of LVS hints
|
| 304 |
+
</p><a name="same_circuits"></a><a name="h2-315"></a><h2>"same_circuits" - Establishes an equivalence between the circuits</h2><a name="k_17"></a><p>Usage:</p><ul><li><tt>same_circuits(circuit_a, circuit_b)</tt></li></ul><p>
|
| 305 |
+
This method will force an equivalence between the two circuits.
|
| 306 |
+
By default, circuits are identified by name. If names are different, this
|
| 307 |
+
method allows establishing an explicit correspondence.
|
| 308 |
+
</p><p>
|
| 309 |
+
circuit_a is for the layout netlist, circuit_b for the schematic netlist.
|
| 310 |
+
Names are case sensitive for layout-derived netlists and case-insensitive for SPICE schematic netlists.
|
| 311 |
+
</p><p>
|
| 312 |
+
One of the circuits may be nil. In this case, the corresponding
|
| 313 |
+
other circuit is mapped to "nothing", i.e. ignored.
|
| 314 |
+
</p><p>
|
| 315 |
+
Use this method andwhere in the script before the <a href="#compare">compare</a> call.
|
| 316 |
+
</p><a name="same_device_classes"></a><a name="h2-334"></a><h2>"same_device_classes" - Establishes an equivalence between the device classes</h2><a name="k_18"></a><p>Usage:</p><ul><li><tt>same_device_classes(class_a, class_b)</tt></li></ul><p>
|
| 317 |
+
This method will force an equivalence between the two device classes.
|
| 318 |
+
Device classes are also known as "models".
|
| 319 |
+
By default, device classes are identified by name. If names are different, this
|
| 320 |
+
method allows establishing an explicit correspondence.
|
| 321 |
+
</p><p>
|
| 322 |
+
Before this method can be used, a schematic netlist needs to be loaded with
|
| 323 |
+
<a href="#schematic">schematic</a>.
|
| 324 |
+
</p><p>
|
| 325 |
+
class_a is for the layout netlist, class_b for the schematic netlist.
|
| 326 |
+
Names are case sensitive for layout-derived netlists and case-insensitive for SPICE schematic netlists.
|
| 327 |
+
</p><p>
|
| 328 |
+
One of the device classes may be "nil". In this case, the corresponding
|
| 329 |
+
other device class is mapped to "nothing", i.e. ignored.
|
| 330 |
+
</p><p>
|
| 331 |
+
A device class on one side can be mapped to multiple other device
|
| 332 |
+
classes on the other side by using this function multiple times, e.g.
|
| 333 |
+
</p><p><pre>
|
| 334 |
+
same_device_classes("POLYRES", "RES")
|
| 335 |
+
same_device_classes("WELLRES", "RES")
|
| 336 |
+
</pre></p><p>
|
| 337 |
+
will match both "POLYRES" and "WELLRES" on the layout side to "RES" on the
|
| 338 |
+
schematic side.
|
| 339 |
+
</p><p>
|
| 340 |
+
Once a device class is mentioned with "same_device_classes", matching by
|
| 341 |
+
name is disabled for this class. So after using 'same_device_classes("A", "B")'
|
| 342 |
+
"A" is no longer equivalent to "A" on the other side. If you want "A" to
|
| 343 |
+
stay equivalent to "A" too, you need to use 'same_device_classes("A", "A")'
|
| 344 |
+
in addition.
|
| 345 |
+
</p><p>
|
| 346 |
+
Use this method andwhere in the script before the <a href="#compare">compare</a> call.
|
| 347 |
+
</p><a name="same_nets"></a><a name="h2-374"></a><h2>"same_nets" - Establishes an equivalence between the nets</h2><a name="k_19"></a><p>Usage:</p><ul><li><tt>same_nets(circuit_pattern, net_pattern)</tt></li><li><tt>same_nets(circuit_pattern, net_a, net_b)</tt></li><li><tt>same_nets(circuit_a, net_a, circuit_b, net_b)</tt></li></ul><p>
|
| 348 |
+
This method will force an equivalence between the net_a and net_b from circuit_a
|
| 349 |
+
and circuit_b (circuit in the three-argument form is for both circuit_a and circuit_b).
|
| 350 |
+
</p><p>
|
| 351 |
+
In the four-argument form, the circuits can be either given by name or as Circuit
|
| 352 |
+
objects. In the three-argument form, the circuits have to be given by name pattern.
|
| 353 |
+
Nets can be either given by name or as Net objects.
|
| 354 |
+
In the two-argument form, the circuits and nets have to be given as name pattern.
|
| 355 |
+
</p><p>
|
| 356 |
+
"name pattern" are glob-style pattern - e.g. the following will identify the
|
| 357 |
+
all nets starting with "A" from the extracted netlist with the same net from
|
| 358 |
+
the schematic netlist for all circuits starting with "INV":
|
| 359 |
+
</p><p><pre>
|
| 360 |
+
same_nets("INV*", "A*")
|
| 361 |
+
</pre></p><p>
|
| 362 |
+
A plain "*" for the net pattern forces all (named) nets to be equivalent between layout and schematic.
|
| 363 |
+
Unnamed nets from the extracted netlist are not considered - i.e. nets without a label.
|
| 364 |
+
</p><p>
|
| 365 |
+
After using this function, the compare algorithm will consider these nets equivalent.
|
| 366 |
+
Use this method to provide hints for the comparer in cases which are difficult to
|
| 367 |
+
resolve otherwise.
|
| 368 |
+
</p><p>
|
| 369 |
+
circuit_a and net_a are for the layout netlist, circuit_b and net_b for the schematic netlist.
|
| 370 |
+
Names are case sensitive for layout-derived netlists and case-insensitive for SPICE schematic netlists.
|
| 371 |
+
</p><p>
|
| 372 |
+
Use this method andwhere in the script before the <a href="#compare">compare</a> call.
|
| 373 |
+
</p><p>
|
| 374 |
+
Multiple calls of "same_nets" can be used. The calls are effective in the order
|
| 375 |
+
the are given. For example, the following sequence specifies equivalence of all
|
| 376 |
+
equally named nets, with the exception of "A" and "B" which are equivalent to each other
|
| 377 |
+
inside cell "ND2", despite their different name:
|
| 378 |
+
</p><p><pre>
|
| 379 |
+
same_nets("*", "*")
|
| 380 |
+
same_nets("ND2", "A", "B")
|
| 381 |
+
</pre></p><a name="same_nets!"></a><a name="h2-421"></a><h2>"same_nets!" - Establishes an equivalence between the nets with matching requirement</h2><a name="k_20"></a><p>Usage:</p><ul><li><tt>same_nets!(circuit_pattern, net_pattern)</tt></li><li><tt>same_nets!(circuit_pattern, net_a, net_b)</tt></li><li><tt>same_nets!(circuit_a, net_a, circuit_b, net_b)</tt></li></ul><p>
|
| 382 |
+
This method is equivalent to <a href="#same_nets">same_nets</a>, but requires identity of the given nets.
|
| 383 |
+
If the specified nets do not match, an error is reported.
|
| 384 |
+
</p><p>
|
| 385 |
+
For example, this global specification requires all named nets from the
|
| 386 |
+
layout to have an equivalent net in the schematic and those nets need to be
|
| 387 |
+
identical for all circuits:
|
| 388 |
+
</p><p><pre>
|
| 389 |
+
same_nets!("*", "*")
|
| 390 |
+
</pre></p><p>
|
| 391 |
+
The following specification requires "A" and "B" to be identical in
|
| 392 |
+
circuit "ND2". It is not an error if either "A" does not exist in the
|
| 393 |
+
layout or "B" does not exist in the schematic:
|
| 394 |
+
</p><p><pre>
|
| 395 |
+
same_nets!("ND2", "A", "B")
|
| 396 |
+
</pre></p><a name="schematic"></a><a name="h2-449"></a><h2>"schematic" - Gets, sets or reads the reference netlist</h2><a name="k_21"></a><p>Usage:</p><ul><li><tt>schematic(filename)</tt></li><li><tt>schematic(filename, reader)</tt></li><li><tt>schematic(netlist)</tt></li><li><tt>schematic</tt></li></ul><p>
|
| 397 |
+
If no argument is given, the current schematic netlist is returned. nil is
|
| 398 |
+
returned if no schematic netlist is set yet.
|
| 399 |
+
</p><p>
|
| 400 |
+
If a filename is given (first two forms), the netlist is read from the given file.
|
| 401 |
+
If no reader is provided, Spice format will be assumed. The reader object is a
|
| 402 |
+
<a href="../code/class_NetlistReader.html">NetlistReader</a> object and allows detailed customization of the reader process.
|
| 403 |
+
</p><p>
|
| 404 |
+
Alternatively, a <a href="../code/class_Netlist.html">Netlist</a> object can be given which is obtained from any other
|
| 405 |
+
source.
|
| 406 |
+
</p><a name="split_gates"></a><a name="h2-469"></a><h2>"split_gates" - Implements the "split gates" feature</h2><a name="k_22"></a><p>Usage:</p><ul><li><tt>split_gates(device_name)</tt></li><li><tt>split_gates(device_name, circuit_filter)</tt></li></ul><p>
|
| 407 |
+
Multi-fingered, multi-gate MOS transistors can be built without connecting
|
| 408 |
+
the source/drain internal nets between the fingers. This will prevent
|
| 409 |
+
"combine_devices" from combining the single gate transistors of the
|
| 410 |
+
different fingers into single ones.
|
| 411 |
+
</p><p>
|
| 412 |
+
"split_gates" now marks the devices of the given class so that they will
|
| 413 |
+
receive a special treatment which joins the internl source/drain nodes.
|
| 414 |
+
</p><p>
|
| 415 |
+
By default, this method is applied to all circuits. You can specify
|
| 416 |
+
a circuit pattern to apply it to certain circuits only.
|
| 417 |
+
</p><p>
|
| 418 |
+
"device_name" must be a valid device name and denote a MOS3, MOS4, DMOS3
|
| 419 |
+
or DMOS4 device.
|
| 420 |
+
</p><a name="tolerance"></a><a name="h2-491"></a><h2>"tolerance" - Specifies compare tolerances for certain device parameters</h2><a name="k_23"></a><p>Usage:</p><ul><li><tt>tolerance(device_class_name, parameter_name, absolute_tolerance [, relative_tolerance])</tt></li><li><tt>tolerance(device_class_name, parameter_name [, :absolute => absolute_tolerance] [, :relative => relative_tolerance])</tt></li></ul><p>
|
| 421 |
+
Specifies a compare tolerance for a specific parameter on a given device class.
|
| 422 |
+
The device class is the name of a device class in the extracted netlist.
|
| 423 |
+
Tolerances can be given in absolute units or relative or both.
|
| 424 |
+
The relative tolerance is given as a factor, so 0.1 is a 10% tolerance.
|
| 425 |
+
Absolute and relative tolerances add, so specifying both allows for a larger
|
| 426 |
+
deviation.
|
| 427 |
+
</p><p>
|
| 428 |
+
Some device parameters - like the resistor's "L" and "W" parameters - are not compared by default.
|
| 429 |
+
These are "secondary" device parameters. Using a tolerance on such parameters will make these parameters
|
| 430 |
+
being compared even if they are secondary ones.
|
| 431 |
+
</p><p>
|
| 432 |
+
A function is skip a parameter during the device compare is "ignore_parameter".
|
| 433 |
+
</p><p>
|
| 434 |
+
"tolerance" and "ignore_parameter" only have an effect with the default device comparer. Using a custom device comparer
|
| 435 |
+
will override the definitions by "ignore_parameter" or "tolerance".
|
| 436 |
+
</p></div>
|
| 437 |
+
</div>
|
| 438 |
+
</body>
|
| 439 |
+
</html>
|
| 440 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/macro_editor.html
ADDED
|
@@ -0,0 +1,372 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About Macro Development</p><h1>About Macro Development</h1><ul><li><a href="#h2-10">Basics</a></li><li><a href="#h2-152">The macro development IDE</a></li><li><a href="#h2-225">Basic tasks</a></li><li><a href="#h2-375">Migrating code</a></li><li><a href="#h2-402">Hints</a></li></ul><a name="h2-10"></a><h2>Basics</h2><p>
|
| 120 |
+
KLayout supports macro programming with the Ruby or Python language. Macros are basically Ruby or Python scripts that
|
| 121 |
+
are executed by the integrated interpreter. In order to enable macro programming, the program has to be built
|
| 122 |
+
with support by either one of those languages.
|
| 123 |
+
</p><p>
|
| 124 |
+
As a special kind of macros, DRC and LVS scripts are available for editing
|
| 125 |
+
and debugging too. These scripts are basically Ruby scripts but run in a
|
| 126 |
+
customized environment so that specific functions are provided.
|
| 127 |
+
For more details on these kind of scripts see <a href="../manual/drc.html">Design Rule Check (DRC)</a>
|
| 128 |
+
and <a href="../manual/lvs.html">Layout vs. Schematic (LVS)</a>.
|
| 129 |
+
</p><p>
|
| 130 |
+
In a simple scenario, scripts can be stored in simple text files and loaded by KLayout using the "-rm" or "-r" command-line option.
|
| 131 |
+
"-rm" will run a script and then execute the normal application. "-r" will run a script and then exit the
|
| 132 |
+
application.
|
| 133 |
+
</p><p>
|
| 134 |
+
In addition, KLayout supports special macro files with the suffix ".lym". Those files
|
| 135 |
+
are XML files that store the macro code along with additional information, for example the description text,
|
| 136 |
+
the interpreter language and certain flags.
|
| 137 |
+
These flags tell KLayout to run the macro automatically when starting up for example.
|
| 138 |
+
In addition, KLayout can present such macros in the "Macros" menu without having to register a specific
|
| 139 |
+
menu extension.
|
| 140 |
+
</p><p>
|
| 141 |
+
Macros can be technology specific. This means, they are packaged with a technology and are associated
|
| 142 |
+
with the technology in the user interface: if they provide a menu item, this item will only become
|
| 143 |
+
visible when the respective technology is active.
|
| 144 |
+
</p><p>
|
| 145 |
+
KLayout also offers an integrated development environment (IDE) that allows editing
|
| 146 |
+
and debugging of Ruby and Python scripts. It offers a simple debugger with the ability to set breakpoints and
|
| 147 |
+
to interact with the current context while in a breakpoint. An interactive "console" allows entering and
|
| 148 |
+
evaluating of expressions. This feature is available also when execution has stopped in a breakpoint,
|
| 149 |
+
so the console can be used to evaluate or modify variables in the current context.
|
| 150 |
+
Watch expressions are supported as well: a
|
| 151 |
+
series of expressions can be configured which is evaluated and displayed in a breakpoint.
|
| 152 |
+
With Python scripts, the local context can be inspected in the "Inspector" window: the variables
|
| 153 |
+
available in the local context are listed with their values.
|
| 154 |
+
</p><p>
|
| 155 |
+
While the debugger is open, execution will slow down somewhat and undesired interactions may happen -
|
| 156 |
+
specifically when developing UI components. To mitigate this problem, debugging can
|
| 157 |
+
be disabled in the macro IDE.
|
| 158 |
+
</p><p>
|
| 159 |
+
KLayout defines certain folders which it scans for macro files. Each directory is scanned recursively. It can
|
| 160 |
+
contain subdirectories with more macros and can also contain support files such as images or additional Ruby or
|
| 161 |
+
Python modules. That allows organizing macros in modules where each module contains the root module files and supporting
|
| 162 |
+
files.
|
| 163 |
+
</p><p>
|
| 164 |
+
KLayout looks for macros in the following places:
|
| 165 |
+
</p><ul><li>
|
| 166 |
+
The "macros" or "pymacros" folders in the installation path. The installation path is where the KLayout binary resides.
|
| 167 |
+
KLayout cannot modify macros that are stored in that path. This is the "global" repository.
|
| 168 |
+
Usually that repository is shared between all users. An administrator can use this location to install
|
| 169 |
+
macros globally.
|
| 170 |
+
</li><li>
|
| 171 |
+
The "macros" or "pymacros" folders in KLayout's user specific application folder. On Unix that is "~/.klayout/macros".
|
| 172 |
+
This is the "local" repository. Any user can store his or her own macros here.
|
| 173 |
+
</li><li>
|
| 174 |
+
Plain Ruby or Python files can be kept inside "ruby" and "python" directories next to "macros" and "pymacros". In
|
| 175 |
+
contrast to "macros" and "pymacros", the locations of "ruby" and "python" paths are added to the Ruby or Python
|
| 176 |
+
search paths. This makes those folders useful for keeping plain Ruby or Python libraries. Generic ".lym" files cannot
|
| 177 |
+
reside there and those locations are not scanned for autorun macros.
|
| 178 |
+
</li><li>
|
| 179 |
+
DRC and LVS scripts are kept inside "drc" and "lvs" folders respectively.
|
| 180 |
+
</li><li>
|
| 181 |
+
In addition, further repositories can be given on the command line with the "-j" option. This allows
|
| 182 |
+
adding development repositories which are under configuration management and contain the latest code
|
| 183 |
+
for the macros. Those repositories are called "project" repositories.
|
| 184 |
+
</li><li>
|
| 185 |
+
Technology folders: each technology folder can carry a "macros" or "pymacros" subfolder where technology-specific
|
| 186 |
+
macros are kept. See <a href="technology_manager.html">About Technology Management</a> for details about technologies.
|
| 187 |
+
</li><li>
|
| 188 |
+
Macros can be kept in packages and installed from a remote repository. See <a href="packages.html">About Packages</a> for
|
| 189 |
+
details about packages.
|
| 190 |
+
</li></ul><p>
|
| 191 |
+
The macro IDE will store Python and Ruby macros separately in "macros" and "pymacros" for easier management,
|
| 192 |
+
but technically these folders are equivalent. KLayout will automatically derive the interpreter
|
| 193 |
+
from the context stored in ".lym" files or the file extension (".rb" or ".py").
|
| 194 |
+
</p><p>
|
| 195 |
+
You can also add custom places using the "Add Location" entry from the repository browser's context menu
|
| 196 |
+
(right mouse click). These locations will be added to the tree. That setting is stored in the setup, so
|
| 197 |
+
it will be available when KLayout is started again. You can remove places again by using
|
| 198 |
+
"Remove Location" from the macro tree's context menu.
|
| 199 |
+
</p><p>
|
| 200 |
+
KLayout will scan these places for files and present them in the macro development IDE's repository browser.
|
| 201 |
+
You can edit the files and their properties and run the macros from the IDE. KLayout's IDE supports these file
|
| 202 |
+
types:
|
| 203 |
+
</p><ul><li>
|
| 204 |
+
".lym": generic KLayout macros.
|
| 205 |
+
</li><li>
|
| 206 |
+
".rb": plain Ruby files. Such files can be imported into KLayout macros by Ruby's "require" or "load"
|
| 207 |
+
method.
|
| 208 |
+
</li><li>
|
| 209 |
+
".py": plain Python files. Such files can be imported into KLayout macros by Pythons's "import"
|
| 210 |
+
method.
|
| 211 |
+
</li><li>
|
| 212 |
+
".txt": text files for documentation for example.
|
| 213 |
+
</li></ul><p>
|
| 214 |
+
Other files can be stored inside the folders (for example Qt ".ui" files), but they won't be shown in
|
| 215 |
+
the IDE.
|
| 216 |
+
</p><a name="h2-152"></a><h2>The macro development IDE</h2><p>
|
| 217 |
+
The macro development IDE consists of three parts: the repository browser, the editor panel and the console.
|
| 218 |
+
The repository browser allows browsing of the macro repositories and to add new files, to move files, to delete
|
| 219 |
+
files, to import plain ruby files as KLayout macros and to rename files. In the editor panel, the macro or other
|
| 220 |
+
files can be edited, breakpoints can be set and the macro can be run. In the console, Ruby expressions can be
|
| 221 |
+
entered and evaluated. This also works while KLayout is in a breakpoint. That feature evaluating of
|
| 222 |
+
expressions in the current context and to modify variables. The console also shows the output of the Ruby
|
| 223 |
+
scripts when they are run in the context of the IDE.
|
| 224 |
+
</p><p>
|
| 225 |
+
The following image shows the IDE with the three main parts:
|
| 226 |
+
</p><p><img src="ide_snapshot.png"></p><p>
|
| 227 |
+
When the debugger enters a breakpoint, the IDE also shows the call stack. By clicking on an entry in
|
| 228 |
+
the call stack panel, the editor will open the respective file and position the cursor at that line.
|
| 229 |
+
A watch window shows the watch expressions with their evaluated values. Watch expressions are evaluated
|
| 230 |
+
every time a breakpoint it hit. They can be managed using the "Add", "Edit", "Delete" and "Clear" functions
|
| 231 |
+
from the context menu (right click on the watch list). For Python scripts, the local variables of the
|
| 232 |
+
currently selected stack context can be browsed in the "Inspector" window in the middle.
|
| 233 |
+
Currently this feature is not available for Ruby scripts.
|
| 234 |
+
</p><p>
|
| 235 |
+
The following image shows the IDE in breakpoint mode for Ruby scripts:
|
| 236 |
+
</p><p><img src="ide_debugging_snapshot.png"></p><p>
|
| 237 |
+
The following image shows the IDE in breakpoint mode for Python scripts:
|
| 238 |
+
</p><p><img src="ide_py_debugging_snapshot.png"></p><p>
|
| 239 |
+
The editor panel features a toolbar with several tool buttons. The following image shows the
|
| 240 |
+
toolbar and the buttons with their function:
|
| 241 |
+
</p><p><img src="ide_editor_toolbar.png"></p><p>
|
| 242 |
+
Also the repository browser features a toolbar with more tool buttons. The following image shows
|
| 243 |
+
that toolbar and the buttons with their function:
|
| 244 |
+
</p><p><img src="ide_browser_toolbar.png"></p><p>
|
| 245 |
+
Finally the console panel allows interactive executing of Ruby or Python expressions. The following image
|
| 246 |
+
shows the console elements and their function:
|
| 247 |
+
</p><p><img src="ide_console.png"></p><a name="h2-225"></a><h2>Basic tasks</h2><a name="h3-227"></a><h3>Creating a new macro</h3><p>
|
| 248 |
+
To create a new macro, first open the tab to select a language you want to use.
|
| 249 |
+
Choose the branch in the repository browser where you want to create the macro.
|
| 250 |
+
Press the "+" button above the repository browser. A dialog will come up in which you can select a template.
|
| 251 |
+
A template is basically the initial content of the macro plus some default settings. After the macro is
|
| 252 |
+
created, the new entry is highlighted and the name can be changed to the desired new name.
|
| 253 |
+
</p><a name="h3-237"></a><h3>Editing the macro</h3><p>
|
| 254 |
+
After the macro has been created, it is shown in the editor window. Other macros or files can be opened
|
| 255 |
+
in the editor by double-clicking at their name. Depending on the type of file, the editor provides some
|
| 256 |
+
basic syntax highlighting. Each file is opened in a separate tab. The tabs can be closed by clicking at
|
| 257 |
+
the "x" button in the tab.
|
| 258 |
+
</p><p>
|
| 259 |
+
To save the current edits to the files, press the "Save all files" or the "Save current file" button
|
| 260 |
+
in the repository browser.
|
| 261 |
+
</p><p>
|
| 262 |
+
Search and search & replace is available in the editor panel in the search box. The search a text,
|
| 263 |
+
enter the text in the search box and hit Return. Use the "Find next" button to find the next occurrence
|
| 264 |
+
of the text. Click on the "RE" button to enable regular expressions in the search function.
|
| 265 |
+
To enable "Replace" mode, open the replace text edit box by clicking on the little arrow right to the
|
| 266 |
+
search tools. Enter the text to replace the search text into the edit box and use "Replace all" to
|
| 267 |
+
replace all occurrences or use "Replace and search" to replace the current occurrence and highlight the
|
| 268 |
+
next one.
|
| 269 |
+
</p><a name="h3-261"></a><h3>Running the macro</h3><p>
|
| 270 |
+
To run the macro, press the "Run current script" or the "Run script from the current tab" button in the
|
| 271 |
+
editor panel. "Run current" will run the script that was run the last time, irregardless if the script
|
| 272 |
+
is the one currently shown in the editor panel. That way, it is possible to run the same script while
|
| 273 |
+
editing support files for example. "Run script from the current tab" will always run the script from the
|
| 274 |
+
current tab.
|
| 275 |
+
</p><p>
|
| 276 |
+
When the macro runs, output will be sent to the console below the editor panel. Breakpoints can be set or reset with
|
| 277 |
+
the "Set breakpoint" button or the F9 key in the editor panel. Go to the line where you want to change the breakpoint and
|
| 278 |
+
use "Set breakpoint" to set or reset the breakpoint on the current line.
|
| 279 |
+
All breakpoints can be cleared with the "Clear all breakpoints" button.
|
| 280 |
+
</p><p>
|
| 281 |
+
While the macro is running or in a breakpoint, the execution can be aborted with the "Stop script" button.
|
| 282 |
+
Execution can be interrupted with the "Pause script" button. In that case, KLayout will interrupt the script
|
| 283 |
+
execution at the current position.
|
| 284 |
+
</p><p>
|
| 285 |
+
When in a breakpoint, single-line step-by-step is supported with the "Step into" button or the F11 key. Stepping over a block or
|
| 286 |
+
procedure call is supported with the "Step over" button or the F10 key. Please note that "Step over" will also
|
| 287 |
+
step over blocks.
|
| 288 |
+
</p><p>
|
| 289 |
+
While KLayout has stopped the execution of the script, the console can be used to examine variables in the current
|
| 290 |
+
context or to modify their values. Ruby expressions entered into the console are simply executed in the current context.
|
| 291 |
+
</p><p>
|
| 292 |
+
When the macro editor window is open, macros will be run under debugger control. This will considerably slow down macro
|
| 293 |
+
execution and create issues when you develop macros that integrate deeply into the system (for example
|
| 294 |
+
macros filtering Qt events from the application). To avoid issues, debugging can be disabled by selecting
|
| 295 |
+
or unselecting the "Enable debugging" button in the editor's toolbar. If the button is checked (shown pressed),
|
| 296 |
+
debuggin is enabled and breakpoints can be used. If debugging is disabled, breakpoints will be ignored.
|
| 297 |
+
</p><a name="h3-303"></a><h3>Working with the repository browser</h3><p>
|
| 298 |
+
The repository browser provides a tab for each category of macros. "DRC" is a special category which
|
| 299 |
+
provides macros that perform a DRC. Such macros are basically Ruby scripts that are executed in the
|
| 300 |
+
context of a DRC engine and hence supply different functionality. Still, they execute in the usual
|
| 301 |
+
context and breakpoints, watch expressions and similar can be used. The other categories are macros
|
| 302 |
+
executing either in a Ruby or in a Python interpreter.
|
| 303 |
+
</p><p>
|
| 304 |
+
Within the repository browser, you can add new folders using the "New folder" button. Before you do so, select the
|
| 305 |
+
branch of the repository where you want to create the new folder. The new folder will be highlighted and the name
|
| 306 |
+
can be edited.
|
| 307 |
+
</p><p>
|
| 308 |
+
To delete files and folders, select the file or folder in the browser and click the "Delete" button (the "x").
|
| 309 |
+
Caution: deleting a file or folder cannot be undone currently.
|
| 310 |
+
</p><p>
|
| 311 |
+
To rename a file or folder, select the entry in the browser and click on the "Rename" button and enter the new
|
| 312 |
+
name. To move files or folder, simply drag and drop them to the desired target location.
|
| 313 |
+
</p><p>
|
| 314 |
+
Pain ruby scripts can be imported into the repository as KLayout macro files. Select the branch where you want to
|
| 315 |
+
import the files in the repository browser, click on the "Import" button and
|
| 316 |
+
select the file to import. ".rbm" files will automatically be set to "auto-run".
|
| 317 |
+
</p><a name="h3-335"></a><h3>Configuring macros</h3><p>
|
| 318 |
+
A macro can be configured in several ways:
|
| 319 |
+
</p><ul><li>
|
| 320 |
+
Description: a macro can be given a description text. This text is shown in the repository browser and
|
| 321 |
+
in the menu if a macro a configured to be shown in the menu.
|
| 322 |
+
</li><li>
|
| 323 |
+
Version: the version will be used in a later stage to check dependencies between packages. Currently the
|
| 324 |
+
version is not used. When used, enter a string of the form "v0.v1.v2" where v0 is the major version, v1
|
| 325 |
+
the minor version and v2 the patch. For example: "1.7.1".
|
| 326 |
+
</li><li>
|
| 327 |
+
Prolog and Epilog: these are statements which are executed before the script is started and after the
|
| 328 |
+
script has been run respectively.
|
| 329 |
+
</li><li>
|
| 330 |
+
Run on start-up: if this flag is set, the macro is automatically run when KLayout starts. This feature
|
| 331 |
+
is required for macros defining libraries for example. "Run early on startup" is a special option which
|
| 332 |
+
makes sure the macro is run at the very beginning of the process. Such macros can be use to supply
|
| 333 |
+
classes and features for other macros that use the normal "run on start-up" mode.
|
| 334 |
+
</li><li>
|
| 335 |
+
Show in menu: with this flag, KLayout will show the macro in the "Macros" menu.
|
| 336 |
+
That is a simple way to run macros outside the IDE.
|
| 337 |
+
</li><li>
|
| 338 |
+
Bind to a key: with key binding, a macro can be run when a certain key combination is pressed.
|
| 339 |
+
That is another way to run a macro outside the IDE.
|
| 340 |
+
</li></ul><p>
|
| 341 |
+
The macro properties can be edited using the "Edit properties" button in the editor panel.
|
| 342 |
+
</p><a name="h2-375"></a><h2>Migrating code</h2><p>
|
| 343 |
+
Before version 0.22, KLayout did not have a concept of macro IDE, macro folders, interpreters and
|
| 344 |
+
generic macros.
|
| 345 |
+
Ruby code written for the pre-0.22 system can be imported into the macro management system of
|
| 346 |
+
KLayout using the "Import" function from the repository browser toolbar. ".rbm" files are marked as "autorun" in order to emulate the behavior of KLayout 0.21 and
|
| 347 |
+
previous versions. ".rb" files are converted into KLayout macros without any further assumption.
|
| 348 |
+
".rb" files can also simply be copied into the macro directories. However, such files are regarded as
|
| 349 |
+
secondary sources in KLayout. Typically those are files that are loaded by other macros. Importing
|
| 350 |
+
a file makes code a generic source (".lym" file) with enhanced capabilities.
|
| 351 |
+
</p><p>
|
| 352 |
+
After importing the code the macro can be attached to a menu entry by setting "Show in menu" on the
|
| 353 |
+
properties page. It is also possible to assign keyboard shortcuts. If either the menu item is selected
|
| 354 |
+
or the key specified in the shortcut is pressed, the macro is executed.
|
| 355 |
+
</p><p>
|
| 356 |
+
This feature is more convenient to use than the scheme used previously. Until KLayout 0.22 it was only
|
| 357 |
+
possible to register a macro with a specific menu entry by performing the registration in the code.
|
| 358 |
+
The disadvantage of this approach is that when the macro code is re-executed, the menu item is registered
|
| 359 |
+
again and appears in the menu twice. It is therefore more convenient to remove the menu registration code
|
| 360 |
+
and let KLayout register the macro in the menu by setting the menu binding properties accordingly.
|
| 361 |
+
</p><a name="h2-402"></a><h2>Hints</h2><p>
|
| 362 |
+
The editor and IDE can be configured using the "Setup" button in the editor panel. That dialog allows
|
| 363 |
+
configuring fonts and colors to be used in the editor and the behavior of the debugger
|
| 364 |
+
in some respects.
|
| 365 |
+
</p><p>
|
| 366 |
+
The documentation of the Ruby and Python classes exposed by KLayout is available in KLayout's online help
|
| 367 |
+
system <a href="../programming/index.html">here</a>.
|
| 368 |
+
</p></div>
|
| 369 |
+
</div>
|
| 370 |
+
</body>
|
| 371 |
+
</html>
|
| 372 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/macro_in_menu.html
ADDED
|
@@ -0,0 +1,169 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » Macros in Menus</p><h1>Macros in Menus</h1><p>
|
| 120 |
+
KLayout allows installing macros as menu entries. Each time that menu entry is selected,
|
| 121 |
+
the macro will be executed.
|
| 122 |
+
To configure a macro for installation in the menu, open the macro in the macro development environment
|
| 123 |
+
and open the macro properties dialog.
|
| 124 |
+
</p><p>
|
| 125 |
+
The macro is configured to be shown in the menu by checking the "Show in menu" check box.
|
| 126 |
+
That also enables two other fields: the menu path and the group name.
|
| 127 |
+
</p><p>
|
| 128 |
+
The menu path specifies the position where the macro shall be put. A macro path is a
|
| 129 |
+
sequence of symbolic names separated by a dot. For example:
|
| 130 |
+
</p><ul><li><tt>edit_menu.end</tt> is the end of the "Edit" menu </li><li><tt>edit_menu.undo</tt> is the "Undo" entry in the "Edit" menu</li></ul><p>To obtain
|
| 131 |
+
a list of the paths available, have a look at the "Key Bindings" page in the "Application"
|
| 132 |
+
section of the setup dialog ("File/Setup").
|
| 133 |
+
</p><p>
|
| 134 |
+
The pseudo element "end" denotes the position
|
| 135 |
+
after the last entry. The same way "begin" indicates the first entry in the menu.
|
| 136 |
+
The macro will be inserted before the entry indicated by the path. Hence:
|
| 137 |
+
</p><ul><li><tt>edit_menu.end</tt>: the macro will be inserted at the end of the "Edit" menu</li><li><tt>edit_menu.undo</tt>: the macro will be inserted before the "Undo" entry.</li></ul><p>
|
| 138 |
+
If a plus sign follows the macro path element, the new element is inserted <b>after</b>
|
| 139 |
+
this element. For example:
|
| 140 |
+
</p><ul><li><tt>edit_menu.undo+</tt>: the macro will be inserted after the "Undo" menu item.</li></ul><p>
|
| 141 |
+
A special form can be used to generate new groups: if the given element does not exist,
|
| 142 |
+
the menu generator can be instructed to create it by appending the insert point plus
|
| 143 |
+
the new text string to the element after a ">" character. For example:
|
| 144 |
+
</p><ul><li><tt>edit_menu.my_group>end("My Edit Functions").end</tt>: will look for "my_group" and add the new element at the end of this group. If no such
|
| 145 |
+
group exists, it will be created at the end of the "Edit" menu with the title "My Edit Functions".</li></ul><p>
|
| 146 |
+
If no macro path is specified, the macro is inserted in the "Macros" menu.
|
| 147 |
+
The description of the macro is used as the menu title. If a shortcut is specified, that
|
| 148 |
+
shortcut is used for the macro entry as well.
|
| 149 |
+
</p><p>
|
| 150 |
+
The group name can be used to group together all menu entries with the same group name.
|
| 151 |
+
Any text is allowed here.
|
| 152 |
+
A group is separated from the other entries in the menu by a separator line. It is recommended to
|
| 153 |
+
use the group feature in conjunction with a "end"-terminated menu path which is identical
|
| 154 |
+
for all entries of the same group. Other uses cases are possible, but the result is
|
| 155 |
+
not defined.
|
| 156 |
+
</p><a name="h2-81"></a><h2>A Note for MacOS Users</h2><p>
|
| 157 |
+
The Qt/MacOS combination does not allow for dynamically configuring
|
| 158 |
+
the main menu. On MacOS the behavior is as follows:
|
| 159 |
+
</p><p>
|
| 160 |
+
Every top-level menu entry that is generated either by code or by configuring
|
| 161 |
+
a macro correspondingly, will be shown in a separate entry in the main toolbar.
|
| 162 |
+
This entry is labelled "..." and is shown only when it is populated. All
|
| 163 |
+
non-standard main menu entries are placed there in the same order they would
|
| 164 |
+
appear in the main menu.
|
| 165 |
+
</p></div>
|
| 166 |
+
</div>
|
| 167 |
+
</body>
|
| 168 |
+
</html>
|
| 169 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/packages.html
ADDED
|
@@ -0,0 +1,295 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About Packages</p><h1>About Packages</h1><a name="k_1"></a><a name="k_2"></a><a name="k_3"></a><p>
|
| 120 |
+
"Salt" is KLayout's package manager which allows selecting and installing packages from a global repository.
|
| 121 |
+
Packages make KLayout more tasty. Packages (the "grains") may cover a variety of features:
|
| 122 |
+
</p><ul><li>Ruby or Python macros</li><li>DRC runsets</li><li>Technologies</li><li>Fonts for the Basic.TEXT PCell</li><li>Static layout libraries</li><li>PCell libraries</li><li>Code libraries for Ruby and Python</li><li>Binary extensions</li></ul><p>
|
| 123 |
+
Packages can depend on other packages - these are installed automatically if a package requires them and they are not installed yet.
|
| 124 |
+
</p><p>
|
| 125 |
+
Packages are identified by name. A package name needs to be unique in the package universe.
|
| 126 |
+
You can use a prefixed name like <tt>www.mydomain.org/nameofpackage</tt> to create a non-ambiguous name.
|
| 127 |
+
Use a slash to separate the prefix from the actual package name.
|
| 128 |
+
The choice of the prefix is entirely up to you as long as it contains letters, digits, underscores, hypthens or dots.
|
| 129 |
+
You can use a domain name that is owned by
|
| 130 |
+
yourself for example. You can use multiple prefixes to further differentiate the packages
|
| 131 |
+
inside your namespace.
|
| 132 |
+
</p><p>
|
| 133 |
+
Packages also come with version information, so KLayout can check for updates and install
|
| 134 |
+
them if required. KLayout will assume strict upward compatibility. This specifically
|
| 135 |
+
applies to packages that other packages are depending on (such as code libraries).
|
| 136 |
+
If you need to change them in a non-backward compatible way, you'd need to provide
|
| 137 |
+
a new package with a different name.
|
| 138 |
+
</p><p>
|
| 139 |
+
Packages come with some meta data such as authoring information, an optional icon and
|
| 140 |
+
screen shot image, license information and more. The more information you provide, the
|
| 141 |
+
more useful a package will become.
|
| 142 |
+
</p><p>
|
| 143 |
+
The key component for public package deployment is the "Salt.Mine" package repository
|
| 144 |
+
service. This is a web service that maintains a package index. It
|
| 145 |
+
does not host the packages, but stores links to the actual hosting site. In order
|
| 146 |
+
to author a package, you need to upload the package to one of the supported host
|
| 147 |
+
sites and register your package on the Salt.Mine page. Registration is a simple
|
| 148 |
+
process and the only information required is the link to your host site and a mail
|
| 149 |
+
account for confirmation.
|
| 150 |
+
</p><a name="h2-65"></a><h2>Installing Packages</h2><p>
|
| 151 |
+
To install external packages, open the package manager with "Tools/Manage Packages".
|
| 152 |
+
On the "Install New Packages" page, a list of available packages is shown. Select
|
| 153 |
+
the desired packages and mark them using the check mark button. Marked packages will
|
| 154 |
+
be downloaded and installed with the "Apply" button.
|
| 155 |
+
</p><p>
|
| 156 |
+
A filter above the package list allows selecting packages by name.
|
| 157 |
+
The right panel shows details about the package currently selected.
|
| 158 |
+
</p><a name="h2-79"></a><h2>Updating Packages</h2><p>
|
| 159 |
+
To check for updates, use the "Update Packages" tab of the package manager.
|
| 160 |
+
In the list, those packages for which updates are available are shown.
|
| 161 |
+
Mark packages for update using the check mark button. Click "Apply" to
|
| 162 |
+
apply the selected updates.
|
| 163 |
+
</p><a name="h2-88"></a><h2>Uninstalling Packages</h2><p>
|
| 164 |
+
To uninstall packages, open the package manager using "Tools/Manage Packages".
|
| 165 |
+
Go to the "Current Packages" tab. Select a package and use the "Remove Package"
|
| 166 |
+
button to uninstall the package.
|
| 167 |
+
</p><a name="h2-96"></a><h2>Creating Packages</h2><p>
|
| 168 |
+
For package development you can utilize KLayout to initialize and edit the files inside
|
| 169 |
+
the package folder or populate the folder manually.
|
| 170 |
+
</p><p>
|
| 171 |
+
KLayout offers initialization of new packages from templates. You can modify that package
|
| 172 |
+
according to your requirements afterwards.
|
| 173 |
+
To create a package from a template, open the package manager using "Tools/Manage Packages",
|
| 174 |
+
go to the "Current Packages" tab and push the "Create (Edit) Package" button.
|
| 175 |
+
Chose a template from the list that opens and enter a package name (with prefix, if
|
| 176 |
+
desired). Select "Ok" to let KLayout create a new package based on the template you
|
| 177 |
+
selected.
|
| 178 |
+
</p><p>
|
| 179 |
+
The package details can be edited with the "pen" button at the top right of the
|
| 180 |
+
right details panel. Please specify at least some author information, a license
|
| 181 |
+
model and a version. If the package needs other packages, the dependencies can be
|
| 182 |
+
listed in the "Depends on" table. Those packages will be automatically installed
|
| 183 |
+
together with the new package. The showcase image can be a screen shot that gives
|
| 184 |
+
some idea what the package will do.
|
| 185 |
+
The package details are kept in a file called "grain.xml" inside the package
|
| 186 |
+
folder. You can also edit this file manually. The "grain.xml" is the basic description
|
| 187 |
+
file for the package.
|
| 188 |
+
</p><p>
|
| 189 |
+
If the package is a macro or static library package, the macro editor can be used
|
| 190 |
+
to edit the package files. If the package is a tech package, the technology manager
|
| 191 |
+
can be used to edit the technology inside the package. To populate the package
|
| 192 |
+
folder with other files use your favorite editor of KLayout itself for layout files.
|
| 193 |
+
</p><a name="h2-132"></a><h2>Deployment inside your organisation</h2><p>
|
| 194 |
+
Once a package is finished, it needs to be deployed to make it available to other
|
| 195 |
+
users. Deployment basically means to put it on some public place where others
|
| 196 |
+
can download the package. For local deployment inside an organisation,
|
| 197 |
+
this can be a web server or a folder on
|
| 198 |
+
a file server. KLayout talks WebDAV, so the web server needs to offer WebDAV
|
| 199 |
+
access. A subversion (SVN) server provides WebDAV by default, so this is a good
|
| 200 |
+
choice. For the packages themselves, Git or WebDAV/Subversion can be used. You
|
| 201 |
+
need to specify the protocol in the package URL (see below).
|
| 202 |
+
</p><p>
|
| 203 |
+
After a package has been made available for download, it needs to be entered
|
| 204 |
+
in the package index. For local deployment, the index can be a file hosted
|
| 205 |
+
on a web server or on the file system. The package index location needs to be
|
| 206 |
+
specified by the <tt>KLAYOUT_SALT_MINE</tt> environment variable which contains the
|
| 207 |
+
download URL of the package index file.
|
| 208 |
+
</p><p>
|
| 209 |
+
For public deployment, the Salt.Mine service (<tt>http://sami.klayout.org</tt>) is used to register
|
| 210 |
+
new packages in the package index. By default, KLayout loads the package index from that service, so
|
| 211 |
+
once your package is registered there, everyone using KLayout will see it.
|
| 212 |
+
</p><a name="h2-159"></a><h2>The Package Index</h2><p>
|
| 213 |
+
Public Packages are published on the Salt.Mine server. This is a web service that delivers a
|
| 214 |
+
packages index with some meta data such as current version, the icon
|
| 215 |
+
and a brief description. KLayout uses this list to inform users of packages available
|
| 216 |
+
for installation and available updates. For local deployment, the package index can be served by other
|
| 217 |
+
ways too. The only requirement is to be accessible by a http, https or file URL.
|
| 218 |
+
</p><p>
|
| 219 |
+
The basic format of the index is XML with this structure:
|
| 220 |
+
</p><pre><salt-mine>
|
| 221 |
+
<salt-grain>
|
| 222 |
+
<name>name</name>
|
| 223 |
+
<version>Version</version>
|
| 224 |
+
<title>Title of the package</title>
|
| 225 |
+
<doc>A brief description</doc>
|
| 226 |
+
<doc-url>Documentation URL</doc-url>
|
| 227 |
+
<url>Download URL</url>
|
| 228 |
+
<license>License model</license>
|
| 229 |
+
<icon>Icon image: base64-encoded, 64x64 max, PNG preferred</icon>
|
| 230 |
+
</salt-grain>
|
| 231 |
+
...
|
| 232 |
+
<include>URL to include other index files into this one</include>
|
| 233 |
+
...
|
| 234 |
+
</salt-mine></pre><p>
|
| 235 |
+
You can include other repositories - specifically the default one - into a
|
| 236 |
+
custom XML file. This allows extending the public index with local packages.
|
| 237 |
+
</p><p>
|
| 238 |
+
When the package manager is opened, KLayout will download the index from
|
| 239 |
+
<tt>http://sami.klayout.org/repository.xml</tt>. You can set the <tt>KLAYOUT_SALT_MINE</tt>
|
| 240 |
+
environment variable to a different URL which makes KLayout use another dictionary
|
| 241 |
+
service, i.e. one inside your own organisation. This service can be any HTTP server
|
| 242 |
+
that delivers a package list in the same format than the Salt.Mine package service.
|
| 243 |
+
The URL can also be a "file:" scheme URL. In this case, KLayout will download the
|
| 244 |
+
list from the given file location.
|
| 245 |
+
</p><p>
|
| 246 |
+
When installing a package, KLayout will simply download the files from the URL given
|
| 247 |
+
in the package list. KLayout employs the WebDAV protocol to download the files.
|
| 248 |
+
This protocol is spoken by Subversion and GitHub with the subversion bridge. The
|
| 249 |
+
latter requires a simple translation of the original Git URL's to obtain the
|
| 250 |
+
subversion equivalent.
|
| 251 |
+
</p><a name="h2-212"></a><h2>Generic package URLs</h2><p>
|
| 252 |
+
Package URLs are the locations from where KLayout will download the package
|
| 253 |
+
files. The package data is a hierarchy of files. The package description file
|
| 254 |
+
("grain.xml") needs to be located at the root of this hierarchy.
|
| 255 |
+
</p><p>
|
| 256 |
+
A plain package URL will instruct KLayout to download the package file from
|
| 257 |
+
the given hierarchy using the WebDAV protocol. You can add "svn+" at the front
|
| 258 |
+
of the URL to make this specification a little more explicit. These are
|
| 259 |
+
WebDAV/Subversion URLs:
|
| 260 |
+
</p><pre>https://www.klayout.org/example-package
|
| 261 |
+
svn+https://www.klayout.org/example-package</pre><p>
|
| 262 |
+
Git is another option to host packages. In order to use the Git protocol,
|
| 263 |
+
add "git+" at the front of the URL:
|
| 264 |
+
</p><pre>git+https://github.com/klayout/example-package.git</pre><p>
|
| 265 |
+
This will make KLayout clone the "example-package" repository and use the default
|
| 266 |
+
branch for checking out the files. It will expect a file named "grain.xml" at the
|
| 267 |
+
root of the package file hierarchy.
|
| 268 |
+
</p><p>
|
| 269 |
+
To use a different branch or tag, specify the tag or branch name in square
|
| 270 |
+
brackes. For example:
|
| 271 |
+
</p><pre>git+https://github.com/klayout/example-package.git[v1.0]</pre><p>
|
| 272 |
+
This will use the "v1.0" tag or branch for checking out the files.
|
| 273 |
+
</p><p>
|
| 274 |
+
It is also possible to have packages in the a subfolder of the repository.
|
| 275 |
+
To specify the subfolder, separate the subfolder path from the repository
|
| 276 |
+
URL using "+", like this:
|
| 277 |
+
</p><pre>git+https://github.com/klayout/repository.git+klayout/package-data[v1.0]</pre><p>
|
| 278 |
+
This will clone the "repository" project and in this project, KLayout will checkout
|
| 279 |
+
files from "klayout/package-data" and below. This is also the place, where KLayout expects
|
| 280 |
+
the "grain.xml" file.
|
| 281 |
+
</p><a name="h2-268"></a><h2>Installation Hooks</h2><p>
|
| 282 |
+
Scripts can register an event through <a href="../code/class_Application.html#m_on_salt_changed">Application#on_salt_changed</a> which
|
| 283 |
+
indicates that packages have been installed or uninstalled.
|
| 284 |
+
</p><p>
|
| 285 |
+
Packages itself can supply special scripts which are executed after a package was installed
|
| 286 |
+
or before a package is uninstalled:
|
| 287 |
+
</p><ul><li><tt>_install.lym</tt>: if present, this script is executed after the package is installed.</li><li><tt>_uninstall.lym</tt>: if present, this script is executed before the package is uninstalled.</li></ul><p>
|
| 288 |
+
Both scripts need to be stored in the same location as "grain.xml" and have to use
|
| 289 |
+
"lym" format. This is the generic XML script format KLayout employs as an interpreter-agnostic
|
| 290 |
+
script representation.
|
| 291 |
+
</p></div>
|
| 292 |
+
</div>
|
| 293 |
+
</body>
|
| 294 |
+
</html>
|
| 295 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/rba_notation.html
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » Notation used in Ruby API documentation</p><h1>Notation used in Ruby API documentation</h1><ul><li><a href="#h2-10">Introduction</a></li><li><a href="#h2-68">General layout of the documentatation</a></li><li><a href="#h2-83">Examples</a></li></ul><a name="h2-10"></a><h2>Introduction</h2><p>
|
| 120 |
+
The documentation of the Ruby API is derived from the C++ declaration of the specific methods.
|
| 121 |
+
Hence the notation deviates somewhat from the usual documentation of Ruby methods.
|
| 122 |
+
In particular the following differences are noteworthy:
|
| 123 |
+
</p><ul><li><p><b>"Static" methods are "class methods":</b></p><p>The C++ term "static" refers to methods available within a class
|
| 124 |
+
without requiring an object. In Ruby, the term "class method" is commonly used to refer to such methods.
|
| 125 |
+
</p></li><li><p><b>Different flavors of object arguments:</b></p><p>In C++ there are references, pointers and objects passed by
|
| 126 |
+
value. In Ruby there are only references. RBA maps the C++ concepts to ruby by allowing the "nil" value only
|
| 127 |
+
for pointer arguments. Pointer arguments are specially marked in the documentation.
|
| 128 |
+
</p></li><li><p><b>There is "constness":</b></p><p>C++ has the concept of "const" methods and arguments. In C++, an object reference
|
| 129 |
+
can be "const", which means that the object behind such a reference cannot be modified. A "const" method
|
| 130 |
+
is a method which can be called on "const" object reference and such a method may not alter the state of the
|
| 131 |
+
object.</p><p>A method can have "const" reference arguments which means that objects passed through such arguments
|
| 132 |
+
are not modified by the method. Such arguments are also said to have "in" semantics. Hence, "const" references
|
| 133 |
+
can be passed to such arguments. In Ruby there is no concept of "constness" or "in" parameters. Every method is
|
| 134 |
+
allowed to alter the state of the object it is called on and pf the objects it gets as arguments. In that sense,
|
| 135 |
+
C++ allows specification of a more constraint "contract" between caller and method that is called. RBA emulates constness
|
| 136 |
+
in Ruby to some extent and it may disallow calling non-const methods on const references or passing const reference
|
| 137 |
+
to non-const arguments. Return value can also be const pointers which means that the object returned
|
| 138 |
+
cannot be modified.
|
| 139 |
+
</p></li><li><p><b>Strong typing:</b></p><p>In C++, arguments and return values are strongly typed. RBA will check the arguments passed
|
| 140 |
+
to a method and convert them properly. Hence the type of argument is important. "int" type arguments may not be passed
|
| 141 |
+
strings for example.</p><p>The type system if C++ is also somewhat more restricted: the value range of an integer argument is
|
| 142 |
+
limited and for example there are unsigned types which cannot be passed negative values. Hence the type of an
|
| 143 |
+
argument is noted in the documentation. A particular return type is "void" which basically means "no value returned".
|
| 144 |
+
Strong typing extends to object references and RBA checks if an argument can be converted to the object required.
|
| 145 |
+
</p></li><li><p><b>Virtual methods:</b></p><p>In C++, a method must be virtual before it can be reimplemented by a derived class. In Ruby
|
| 146 |
+
all methods are virtual. Since reimplementing a non-virtual method does not have any effect in RBA, virtual methods
|
| 147 |
+
are marked as such.
|
| 148 |
+
</p></li></ul><a name="h2-68"></a><h2>General layout of the documentatation</h2><p>The documentation states the following methods (in that order):</p><ul><li>Public constructors</li><li>Public methods</li><li>Public static methods and constants</li><li>Protected methods (static, non-static and constructors)</li><li>Deprecated methods (protected, public, static, non-static and constructors)</li></ul><p>Deprecated methods are listed for reference only. Use of such methods or constants is not recommended because
|
| 149 |
+
they might be removed in the future.</p><a name="h2-83"></a><h2>Examples</h2><p>Here are some examples for method documentations (signatures):</p><ul><li><p><b><i>[virtual]</i> bool event(QEvent ptr ev)</b>:</p><p>A virtual method called "event" returning a boolean value
|
| 150 |
+
(Ruby "true" or "false") and expecting one argument (a pointer to a QEvent object).
|
| 151 |
+
"ptr" indicates that the argument is a pointer, "arg1" is the argument name.
|
| 152 |
+
</p></li><li><p><b>void add_reference(const RdbReference rdb_ref)</b>:</p><p>A method without return value which expects one parameter.
|
| 153 |
+
The parameter must be a reference to the RdbReference object. The reference must not be nil since it is not a pointer,
|
| 154 |
+
but can be a reference to a const object. The name of the argument is "rdb_ref".</p></li><li><p><b><i>[const]</i> unsigned int num_items</b>:</p><p>A parameterless const method called "num_items" that delivers the number of items as an unsigned
|
| 155 |
+
integer value.</p></li><li><p><b><i>[iter]</i> RdbReference each_reference</b>:</p><p>An iterator called "each_reference" delivering RdbReference objects.</p></li><li><p><b><i>[signal]</i> void layoutAboutToBeChanged</b>:</p><p>A parameterless signal (event) called "layoutAboutToBeChanged" (see <a href="../programming/events.html">Events And Callbacks</a> for details about events or signals).</p></li><li><p><b><i>[signal]</i> void objectNameChanged(string objectName)</b>:</p><p>A signal (event) called "objectNameChanged" with one string argument.</p></li></ul></div>
|
| 156 |
+
</div>
|
| 157 |
+
</body>
|
| 158 |
+
</html>
|
| 159 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/symbolic_layers.html
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » Symbolic Connectivity Layers</p><h1>Symbolic Connectivity Layers</h1><p>
|
| 120 |
+
Use the symbol table to specify derived layers and to assign names to layer/datatype combinations.
|
| 121 |
+
A symbolic layer must have a name which can be used in the connectivity table instead of the
|
| 122 |
+
original layers. In addition, an expression must be specified that defines the contents of the
|
| 123 |
+
layer.
|
| 124 |
+
</p><p>
|
| 125 |
+
Inside the expressions
|
| 126 |
+
</p><ul><li>
|
| 127 |
+
Use "layer/datatype" notation to specify an original layer with explicit GDS layers and datatypes.
|
| 128 |
+
</li><li>
|
| 129 |
+
Use the name to specify a named original layer or to refer to a symbolic layer defined in another entry.
|
| 130 |
+
</li><li>
|
| 131 |
+
Use the operators '+', '*', '-' and '^' to specify logical OR, AND, NOT and XOR respectively.
|
| 132 |
+
The precedence of evaluation is '^' and '*' before '+' and '-'.
|
| 133 |
+
</li><li>
|
| 134 |
+
Use round brackets to group expressions.
|
| 135 |
+
</li></ul><p>
|
| 136 |
+
Examples:
|
| 137 |
+
</p><table><tr><td><b>17</b></td><td>Abbreviation for GDS layer 17, datatype 0</td></tr><tr><td><b>2/0*17/0</b></td><td>Logical AND between layer 2 and 17, both datatype 0</td></tr><tr><td><b>2*(5+7)</b></td><td>Logical AND between layer 2 and the logical OR combination of 5 and 7</td></tr><tr><td><b>ACTIVE-POLY</b></td><td>Logical NOT between the symbolic layer ACTIVE (defined in another entry) and POLY (also defined in another entry).</td></tr></table></div>
|
| 138 |
+
</div>
|
| 139 |
+
</body>
|
| 140 |
+
</html>
|
| 141 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/technology_manager.html
ADDED
|
@@ -0,0 +1,211 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About Technology Management</p><h1>About Technology Management</h1><p>
|
| 120 |
+
Technology management summarizes features which require a certain interpretation of a layout.
|
| 121 |
+
In particular, layout layers are assigned a physical meaning, for example via layers or active area
|
| 122 |
+
layers in CMOS technologies. Since that interpretation often is depending on the technology
|
| 123 |
+
the product will be fabricated with, the ability to provide multiple setups is summarized
|
| 124 |
+
as "technology management".
|
| 125 |
+
</p><p>
|
| 126 |
+
A technology setup implements the following aspects:
|
| 127 |
+
</p><ul><li>Layer mapping: when the layout reader loads a file that for a certain technology, it can
|
| 128 |
+
apply a layer mapping, i.e. apply layer names to GDS layers, filter layer etc.
|
| 129 |
+
</li><li>Layer properties: depending on the technology, the layer display can be configured by
|
| 130 |
+
providing a technology specific layer properties file.
|
| 131 |
+
</li><li>Connectivity: the layer stack and the connections made by layers for the net tracer
|
| 132 |
+
feature.
|
| 133 |
+
</li><li>Macros: macros associated with the technology. When the corresponding technology is
|
| 134 |
+
selected (is the one of the current layout), such macros will show up in the menu if they
|
| 135 |
+
are bound to a menu entry. Otherwise they will be invisible.
|
| 136 |
+
</li><li>DRC scripts: in the same way, DRC scripts can be associated with a technology.</li><li>Libraries: if a library is associated with a technology, it is shown in the list
|
| 137 |
+
of available libraries when an instance is created. Library association cannot be
|
| 138 |
+
edited. Instead, a library installed in the system comes with a technology
|
| 139 |
+
association itself.</li><li>File format options: technology specific file reader or writer options can be
|
| 140 |
+
given. When a layout is saved, it will use the writer options from its technology.
|
| 141 |
+
When loading a layout, the reader options from the active technology will be used.</li></ul><p>
|
| 142 |
+
In the future, more aspects may be added to the technology definition.
|
| 143 |
+
</p><p>
|
| 144 |
+
There is always one "Default" technology that is used when no technology is
|
| 145 |
+
specified.
|
| 146 |
+
</p><a name="h2-53"></a><h2>Setting up technologies</h2><p>
|
| 147 |
+
Technologies can be set up using the "Technology Manager" in the "Tools" menu.
|
| 148 |
+
There is always a "Default" technology which provides the settings when no
|
| 149 |
+
technology is selected. New technologies can be added or technologies can be
|
| 150 |
+
deleted using the "+" or "x" buttons below the technology tree.
|
| 151 |
+
</p><p>
|
| 152 |
+
A technology has a name (a short string) and a description. The name is used
|
| 153 |
+
to identify the technology in various places. The description is the human-readable
|
| 154 |
+
text that is displayed in the technology selection boxes for example. The short name can
|
| 155 |
+
be changed by selecting the technology and pressing the "Rename" button or using "Rename"
|
| 156 |
+
from the technology tree's context menu (right mouse click). The description can be
|
| 157 |
+
edited on the "General" page.
|
| 158 |
+
</p><p>
|
| 159 |
+
In the technology manager, below each technology, the components are shown that define
|
| 160 |
+
the various aspects of a technology. Beside the "General" aspect (names, descriptions) there
|
| 161 |
+
is a "Layers" component which defines the layer mapping table and layer properties file and
|
| 162 |
+
the "Connectivity" component which defines the settings for the net tracer.
|
| 163 |
+
</p><a name="h2-78"></a><h2>Using technologies</h2><p>
|
| 164 |
+
When more than the default technology is defined, KLayout provides a drop-down menu in
|
| 165 |
+
the tool bar to select the current technology. The current technology is the technology
|
| 166 |
+
used when new files are loaded. It is also possible to define the technology to be used
|
| 167 |
+
on the command line using the "-n" switch (applies to following files and specifies the
|
| 168 |
+
technology to use by their short name).
|
| 169 |
+
</p><p>
|
| 170 |
+
The technology of the currently selected layout is shown in the status bar of the main
|
| 171 |
+
window in the left section. It is possible to switch the technology of a layout already
|
| 172 |
+
loaded by using the "Layout Properties" dialog from the "File" menu. After switching the
|
| 173 |
+
technology, the layer properties defined in the technology can be applied and the associated
|
| 174 |
+
macros or DRC scripts are shown in the menu if they are associated bound to a menu entry or
|
| 175 |
+
the key binding becomes active if a shortcut is defined for that macro.
|
| 176 |
+
</p><a name="h2-97"></a><h2>Technologies and macros or DRC scripts</h2><p>
|
| 177 |
+
Macros or DRC scripts are stored in sub-folders relative to the technology's base path. When
|
| 178 |
+
no base path is specified or the base path is invalid, macros or DRC scripts cannot be associated.
|
| 179 |
+
KLayout will look search for macros, if a directory called "macros" is present in the
|
| 180 |
+
base path. If it finds files with a valid macro suffix there it will associate them with
|
| 181 |
+
this technology. The same way, KLayout will look for DRC scripts, if a directory called "drc"
|
| 182 |
+
is present in the base path.
|
| 183 |
+
</p><p>
|
| 184 |
+
Macros and DRC scripts associated with a technology are shown in the technology manager. To edit
|
| 185 |
+
or debug scripts of macros, use the macro development environment ("Macros/Macro Development").
|
| 186 |
+
If a technology has a macros or DRC scripts folder, the macro or DRC scripts tree in the
|
| 187 |
+
development environment will show a corresponding top-level branch for that technology.
|
| 188 |
+
</p><p>
|
| 189 |
+
Multiple technologies can share the same base path - hence it is possible to share macros
|
| 190 |
+
or DRC scripts between technologies.
|
| 191 |
+
</p><a name="h2-120"></a><h2>Managing technologies</h2><p>
|
| 192 |
+
Technologies can be imported and exported to technology files (suffix ".lyt"). This is mainly
|
| 193 |
+
useful to exchange technology settings between users or technologies.
|
| 194 |
+
</p><p>
|
| 195 |
+
Except for the default technology, technologies are kept in
|
| 196 |
+
technology folders in KLayout's application path. They are read from
|
| 197 |
+
subfolders from the "tech" directories. The technology definition itself
|
| 198 |
+
is held in a file with extension ".lyt". The technology folder may have
|
| 199 |
+
subfolders to hold library files, macros, DRC runsets, LEF files and
|
| 200 |
+
other pieces of the technology package.
|
| 201 |
+
</p><p>
|
| 202 |
+
Technologies can be managed using packages. Packages are a convenient way to share
|
| 203 |
+
add-ons between users. Packages can be installed from a common repository
|
| 204 |
+
and allow easy addition and removal of components. Technologies are one aspect
|
| 205 |
+
of packages, so it's possible to create packages that contribute one or more
|
| 206 |
+
technologies. See <a href="packages.html">About Packages</a> for more details.
|
| 207 |
+
</p></div>
|
| 208 |
+
</div>
|
| 209 |
+
</body>
|
| 210 |
+
</html>
|
| 211 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/transformations.html
ADDED
|
@@ -0,0 +1,219 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » Transformations in KLayout</p><h1>Transformations in KLayout</h1><a name="k_1"></a><p>
|
| 120 |
+
KLayout supports a subset of affine transformations with the following contributions:
|
| 121 |
+
</p><ul><li><b>Rotation and/or mirroring:</b> rotation by a given angle or mirroring at a given axis.</li><li><b>Scaling:</b> magnification by the given factor.</li><li><b>Translation:</b> a displacement by the given vector.</li></ul><p>
|
| 122 |
+
The execution order is "displacement after rotation, mirroring and scaling".
|
| 123 |
+
Transformations are used for example to describe the instantiation of a cell. The content of
|
| 124 |
+
a cell appears in the parent cell after the given transformation has been applied to the
|
| 125 |
+
content of the cell.
|
| 126 |
+
</p><p>
|
| 127 |
+
The transformations supported by KLayout cover the transformations employed within GDS2, OASIS and
|
| 128 |
+
other layout formats. KLayout does not support shearing currently.
|
| 129 |
+
</p><p>
|
| 130 |
+
The following figure illustrates the effect of the transformation "r90 *2 7,9". This notation
|
| 131 |
+
specifies a transformation composed of a rotation by 90 degree, a scaling with factor 2 and
|
| 132 |
+
a displacement by 7 units in x- and 9 units in y-direction. In that example, the "F" shape is
|
| 133 |
+
first rotated by 90 degree around the origin. Because the "F" is already displaced from the origin,
|
| 134 |
+
this will also move the "F" shape. The shape then is scaled. Again it will move because
|
| 135 |
+
every point of the polygon moves away from the origin. Finally it is displaced by the
|
| 136 |
+
given displacement vector.
|
| 137 |
+
</p><p><img src="transformation_overview.png"></p><p>
|
| 138 |
+
The notation shown here is used in many places within KLayout. It is basically composed of the following parts
|
| 139 |
+
which are combined putting one or more blanks in between. The order the parts are specified
|
| 140 |
+
is arbitrary: the displacement is always applied after the rotation.
|
| 141 |
+
</p><ul><li><x><b>,</b><y>: A displacement (applied after rotation and scaling) in micron units. If no displacement is specified, "0,0" is assumed.</li><li><b>r</b><a> or <b>m</b><a>: A rotation by angle "a" (in degrees) or mirroring at the "a" axis (the x axis rotated by "a" degree). If no rotation or mirroring is specified, no rotation is assumed.</li><li><b>*</b><s>: A scaling by the factor "s". If no scaling is specified, no scaling is assumed.</li></ul><p>
|
| 142 |
+
Here are some examples:
|
| 143 |
+
</p><ul><li><b>0,100</b>: shift 100 units up.</li><li><b>r90</b>: rotation by 90 degree counterclockwise (positive in the mathematical sense).</li><li><b>m0</b>: mirroring at the x-axis.</li><li><b>m45 100,-200</b>: swap x and y (mirror at 45 degree axis), shift 100 units to the right and 200 units down.</li><li><b>r22.5 *1.25</b>: rotate by 22.5 degree and scale by factor 1.25.</li></ul><p>
|
| 144 |
+
The distance units are usually micron. In some cases (i.e. transformations inside a database),
|
| 145 |
+
the unit is database units and dx and dy are integer values.
|
| 146 |
+
</p><p>
|
| 147 |
+
Mirroring and rotation are exclusive and mirroring includes a rotation. In fact, a mirror operation at a certain axis is
|
| 148 |
+
identical to a mirror operation at the x-axis, followed by a rotation by twice the angle "a".
|
| 149 |
+
The following figure illustrates rotation and mirroring with the eight basic transformations involving rotations by
|
| 150 |
+
multiples of 90 degree:
|
| 151 |
+
</p><p><img src="transformation_basic.png"></p><p>
|
| 152 |
+
KLayout is not restricted to these basic operations. Arbitrary angles are supported (i.e. "r45" or "m22.5"). Usually however,
|
| 153 |
+
this implies grid snapping and other issues. This also is true for arbitrary scaling values. KLayout is also more effective when using
|
| 154 |
+
simple transformations involving only rotations by multiples of 90 degree and do not use scaling.
|
| 155 |
+
</p><a name="h2-91"></a><h2>Coding transformations</h2><a name="k_2"></a><p>
|
| 156 |
+
Note that mirroring at an axis with a given angle "a" is equivalent to mirroring at the x axis followed by a rotation
|
| 157 |
+
by twice the angle "a". For example:
|
| 158 |
+
</p><pre>m45 == m0 followed by r90</pre><p>
|
| 159 |
+
When coding transformations, two parameters are used to represent the rotation/mirror part:
|
| 160 |
+
a rotation angle and a flag indicating mirroring at the x axis. The mirroring is applied before
|
| 161 |
+
the rotation. In terms of these parameters, the basic transformations are:
|
| 162 |
+
</p><table><tr><th>Rotation angle<br>(degree)</th><th>Mirror flag <br>= False</th><th>Mirror flag <br>= True</th></tr><tr><td>0</td><td>r0</td><td>m0</td></tr><tr><td>90</td><td>r90</td><td>m45</td></tr><tr><td>180</td><td>r180</td><td>m90</td></tr><tr><td>270</td><td>r270</td><td>m135</td></tr></table><a name="h3-115"></a><h3>Transformation objects</h3><p>
|
| 163 |
+
Transformation objects are convenient objects to operate with. They represent a
|
| 164 |
+
transformation (technically a matrix) consisting of an angle/mirror and a displacement
|
| 165 |
+
part. They support some basic operations:
|
| 166 |
+
</p><ul><li>Concatenation: <tt>T = T1 * T2</tt><br><tt>T</tt> is transformation <tt>T2</tt> applied, then <tt>T1</tt> (note this order)</li><li>Inversion: <tt>TI = T.inverted()</tt><br><tt>TI</tt> is the inverse of <tt>T</tt>, i.e. <tt>TI * T = T * TI = 1</tt> where <tt>1</tt> is the neutral transformation which does not modify coordinates</li><li>Application to geometrical objects: <tt>q = T * p</tt><br>where <tt>p</tt> is a box, polygon, path, text, point, vector etc. and <tt>q</tt> is the transformed object</li></ul><a name="h3-129"></a><h3>Vectors and Points</h3><a name="k_3"></a><a name="k_4"></a><p>
|
| 167 |
+
In KLayout there are two two-dimensional coordinate objects: the vector and the point.
|
| 168 |
+
Basically, the vector is the difference between two points:
|
| 169 |
+
</p><pre>v = p2 - p1</pre><p>Here <tt>v</tt> is a vector object while <tt>p1</tt> and <tt>p2</tt> are points.</p><p>
|
| 170 |
+
Regarding transformations, vectors and points behave differently. While for a point, the
|
| 171 |
+
displacement is applied, it is not for vectors. So
|
| 172 |
+
</p><pre>p' = T * p = M * p + d
|
| 173 |
+
v' = T * v = M * v</pre><p>
|
| 174 |
+
Here <tt>M</tt> is the 2x2 rotation/mirror matrix part of the transformation and <tt>d</tt> is the
|
| 175 |
+
displacement vector
|
| 176 |
+
</p><p>
|
| 177 |
+
The reason why the displacement is not applied to a vector is seen here:
|
| 178 |
+
</p><pre>
|
| 179 |
+
v' = T * v
|
| 180 |
+
= T * (p2 - p1)
|
| 181 |
+
= T * p2 - T * p1
|
| 182 |
+
= (M * p2 + d) - (M * p1 + d)
|
| 183 |
+
= M * p2 + d - M * p1 - d
|
| 184 |
+
= M * p2 - M * p1
|
| 185 |
+
= M * (p2 - p1)</pre><p>where the latter simply is:</p><pre>v' = M * v</pre><a name="h3-172"></a><h3>Simple transformations</h3><a name="k_5"></a><a name="k_6"></a><a name="k_7"></a><p>
|
| 186 |
+
Simple transformations are represented by <a href="../code/class_DTrans.html">DTrans</a> or <a href="../code/class_Trans.html">Trans</a> objects.
|
| 187 |
+
The first operates with floating-point displacements in units of micrometers while the second one with integer displacements
|
| 188 |
+
in database units. "DTrans" objects act on "D" type floating-point coordinate shapes (e.g. <a href="../code/class_DBox.html">DBox</a>) while "Trans" objects act
|
| 189 |
+
on the integer coordinate shapes (e.g. <a href="../code/class_Box.html">Box</a>).
|
| 190 |
+
</p><p>
|
| 191 |
+
The basic construction parameters of "DTrans" and "Trans" are:
|
| 192 |
+
</p><pre>Trans(angle, mirror, displacement)
|
| 193 |
+
DTrans(angle, mirror, displacement)</pre><p>"displacement" is a <a href="../code/class_DVector.html">DVector</a> (for DTrans) or a <a href="../code/class_Vector.html">Vector</a> (for Trans).</p><p>"angle" is the rotation angle in units of 90 degree and "mirror" is the mirror flag:</p><table><tr><th>angle</th><th>mirror <br>= False</th><th>mirror <br>= True</th></tr><tr><td>0</td><td>r0</td><td>m0</td></tr><tr><td>1</td><td>r90</td><td>m45</td></tr><tr><td>2</td><td>r180</td><td>m90</td></tr><tr><td>3</td><td>r270</td><td>m135</td></tr></table><a name="h3-203"></a><h3>Complex transformations</h3><a name="k_8"></a><a name="k_9"></a><a name="k_10"></a><a name="k_11"></a><a name="k_12"></a><p>
|
| 194 |
+
Complex transformations in addition to the simple transformations feature
|
| 195 |
+
scaling (magnification) and arbitrary rotation angles. Other than simple transformations
|
| 196 |
+
they do not necessarily preserve a grid and rounding is implied. Furthermore they imply a shift is physical scale
|
| 197 |
+
which renders them difficult to use in physical frameworks (e.g. DRC). Hence their
|
| 198 |
+
use is discouraged for certain applications.
|
| 199 |
+
</p><p>
|
| 200 |
+
The basic classes are <a href="../code/class_DCplxTrans.html">DCplxTrans</a> for the micrometer-unit (floating-point) version
|
| 201 |
+
and <a href="../code/class_ICplxTrans.html">ICplxTrans</a> for the database-unit (integer) version. The
|
| 202 |
+
construction parameters are:
|
| 203 |
+
</p><pre>ICplxTrans(angle, mirror, magnification, displacement)
|
| 204 |
+
DCplxTrans(angle, mirror, magnification, displacement)</pre><p>
|
| 205 |
+
Here, "angle" is the rotation angle in degree (note the difference to "Trans" and "DTrans" where the
|
| 206 |
+
rotation angle is in units for 90 degree. "magnification" is a factor (1.0 for "no change in scale").
|
| 207 |
+
</p><p>
|
| 208 |
+
There are two other variants useful for transforming coordinate systems: <a href="../code/class_CplxTrans.html">CplxTrans</a> takes
|
| 209 |
+
integer-unit objects and converts them to floating-point unit objects. It can be used to convert
|
| 210 |
+
from database units to micrometer units when configured with a magnification equal to the database unit value:
|
| 211 |
+
</p><pre>T = CplxTrans(magnification: dbu)
|
| 212 |
+
q = T * p</pre><p>
|
| 213 |
+
The other variant is <a href="../code/class_VCplxTrans.html">VCplxTrans</a> which converts floating-point unit objects
|
| 214 |
+
to integer-unit ones. These objects are generated when inverting "CplxTrans" objects.
|
| 215 |
+
</p></div>
|
| 216 |
+
</div>
|
| 217 |
+
</body>
|
| 218 |
+
</html>
|
| 219 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/about/variant_notation.html
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About Variant Notation</p><h1>About Variant Notation</h1><p>
|
| 120 |
+
KLayout employs a certain notation to enter variant types. Variant types are data items which
|
| 121 |
+
are either numerical or text information and are used specifically for property names and values.
|
| 122 |
+
In that case, the type of information is important, and a simple edit box won't be sufficient to
|
| 123 |
+
enter the information. For example, "1" could either be a text "1" or the number 1. To solve that
|
| 124 |
+
issue, KLayout uses the following notation:
|
| 125 |
+
</p><table><tr><th width="20%">Notation</th><th width="50%">Description</th><th>Example</th></tr><tr><td><tt>#</tt>...</td><td>An integer value</td><td><tt>#17</tt></td></tr><tr><td><tt>##</tt>...</td><td>A floating-point value</td><td><tt>##0.5</tt></td></tr><tr><td><tt>'</tt>...<tt>'</tt> or <tt>"</tt>...<tt>"</tt></td><td>A text string which can contain any character.
|
| 126 |
+
You can use the backslash character to escape quotes if you want to use quotes in your text string.
|
| 127 |
+
To use the backslash character inside the text, use a double backslash (\\).</td><td><tt>'A text'</tt><br><tt>'A \'quoted text\''</tt><br><tt>'A single \\ character'</tt></td></tr><tr><td>A word (letters, digits and the underscore)</td><td>Taken as a text string</td><td><tt>NAME</tt></td></tr></table></div>
|
| 128 |
+
</div>
|
| 129 |
+
</body>
|
| 130 |
+
</html>
|
| 131 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_AbsoluteProgress.html
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class AbsoluteProgress</p><h1>API reference - Class AbsoluteProgress</h1><property name="module" value="tl"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_tl.html">tl</a></p><p><b>Description</b>: A progress reporter counting progress in absolute units</p><p><b>Class hierarchy</b>: AbsoluteProgress » <a href="class_Progress.html">Progress</a></p><ul><li><a href="#h2-26">Public constructors</a></li><li><a href="#h2-33">Public methods</a></li><li><a href="#h2-66">Detailed description</a></li></ul><p></p><p>An absolute progress reporter counts from 0 upwards without a known limit. A unit value is used to convert the value to a bar value. One unit corresponds to 1% on the bar.
|
| 120 |
+
For formatted output, a format string can be specified as well as a unit value by which the current value is divided before it is formatted.</p><p>The progress can be configured to have a description text, a title and a format.
|
| 121 |
+
The "inc" method increments the value, the "set" or "value=" methods set the value to a specific value.</p><p>While one of these three methods is called, they will run the event loop in regular intervals. That makes the application respond to mouse clicks, specifically the Cancel button on the progress bar. If that button is clicked, an exception will be raised by these methods.</p><p>The progress object must be destroyed explicitly in order to remove the progress status bar.</p><p>The following sample code creates a progress bar which displays the current count as "Megabytes".
|
| 122 |
+
For the progress bar, one percent corresponds to 16 kByte:</p><p><pre>
|
| 123 |
+
p = RBA::AbsoluteProgress::new("test")
|
| 124 |
+
p.format = "%.2f MBytes"
|
| 125 |
+
p.unit = 1024*16
|
| 126 |
+
p.format_unit = 1024*1024
|
| 127 |
+
begin
|
| 128 |
+
10000000.times { p.inc }
|
| 129 |
+
ensure
|
| 130 |
+
p.destroy
|
| 131 |
+
end
|
| 132 |
+
</pre></p><p>This class has been introduced in version 0.23.
|
| 133 |
+
</p><a name="h2-26"></a><h2>Public constructors</h2><table><tr class="row0"><td>new AbsoluteProgress ptr</td><td><b><a href="#method12">new</a></b></td><td>(string desc)</td><td>Creates an absolute progress reporter with the given description</td></tr><tr class="row1"><td>new AbsoluteProgress ptr</td><td><b><a href="#method13">new</a></b></td><td>(string desc,<br>unsigned long yield_interval)</td><td>Creates an absolute progress reporter with the given description</td></tr></table><a name="h2-33"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>AbsoluteProgress ptr</td><td><b><a href="#method0">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method1">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method2">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method3">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method4">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method5">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method6">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method7">assign</a></b></td><td>(const AbsoluteProgress other)</td><td>Assigns another object to self</td></tr><tr class="row0"><td><i>[const]</i></td><td>new AbsoluteProgress ptr</td><td><b><a href="#method8">dup</a></b></td><td></td><td>Creates a copy of self</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method9">format=</a></b></td><td>(string format)</td><td>sets the output format (sprintf notation) for the progress text</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method10">format_unit=</a></b></td><td>(double unit)</td><td>Sets the format unit</td></tr><tr class="row1"><td></td><td>AbsoluteProgress</td><td><b><a href="#method11">inc</a></b></td><td></td><td>Increments the progress value</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method14">set</a></b></td><td>(unsigned long value,<br>bool force_yield)</td><td>Sets the progress value</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method15">unit=</a></b></td><td>(double unit)</td><td>Sets the unit</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method16">value=</a></b></td><td>(unsigned long value)</td><td>Sets the progress value</td></tr></table><a name="detailed"></a><a name="h2-66"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-67"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m__const_cast"></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i><a href="class_AbsoluteProgress.html">AbsoluteProgress</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 134 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-73"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m__create"></a><a name="k_3"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 135 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-79"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m__destroy"></a><a name="k_4"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 136 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 137 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-86"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__destroyed?"></a><a name="k_5"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 138 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 139 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-93"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__is_const_object?"></a><a name="k_6"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 140 |
+
This method returns true, if self is a const reference.
|
| 141 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-100"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__manage"></a><a name="k_7"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 142 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-106"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__unmanage"></a><a name="k_8"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 143 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-112"></a><h3>assign</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m_assign"></a><a name="k_9"></a><p><b>Signature</b>: void <b> assign </b> (const <a href="class_AbsoluteProgress.html">AbsoluteProgress</a> other)</p><p><b>Description</b>: Assigns another object to self</p></td></tr><tr class="bigrow0"><td><a name="h3-116"></a><h3>dup</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_dup"></a><a name="k_10"></a><p><b>Signature</b>: <i>[const] </i>new <a href="class_AbsoluteProgress.html">AbsoluteProgress</a> ptr <b> dup </b></p><p><b>Description</b>: Creates a copy of self</p><p><b>Python specific notes: </b><br>This method also implements '__copy__' and '__deepcopy__'.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-121"></a><h3>format=</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_format="></a><a name="k_11"></a><p><b>Signature</b>: void <b> format= </b> (string format)</p><p><b>Description</b>: sets the output format (sprintf notation) for the progress text</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'format'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-126"></a><h3>format_unit=</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_format_unit="></a><a name="k_12"></a><p><b>Signature</b>: void <b> format_unit= </b> (double unit)</p><p><b>Description</b>: Sets the format unit</p><p><p></p><p>This is the unit used for formatted output.
|
| 144 |
+
The current count is divided by the format unit to render
|
| 145 |
+
the value passed to the format string.
|
| 146 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'format_unit'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-135"></a><h3>inc</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_inc"></a><a name="k_13"></a><p><b>Signature</b>: <a href="class_AbsoluteProgress.html">AbsoluteProgress</a><b> inc </b></p><p><b>Description</b>: Increments the progress value</p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-139"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_new"></a><a name="k_14"></a><p><b>(1) Signature</b>: <i>[static] </i>new <a href="class_AbsoluteProgress.html">AbsoluteProgress</a> ptr <b> new </b> (string desc)</p><p><b>Description</b>: Creates an absolute progress reporter with the given description</p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_new"></a><a name="k_15"></a><p><b>(2) Signature</b>: <i>[static] </i>new <a href="class_AbsoluteProgress.html">AbsoluteProgress</a> ptr <b> new </b> (string desc, unsigned long yield_interval)</p><p><b>Description</b>: Creates an absolute progress reporter with the given description</p><p><p></p><p>The yield interval specifies, how often the event loop will be triggered. When the yield interval is 10 for example, the event loop will be executed every tenth call of <a href="#m_inc">inc</a> or <a href="#m_set">set</a>.
|
| 147 |
+
</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-150"></a><h3>set</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_set"></a><a name="k_16"></a><p><b>Signature</b>: void <b> set </b> (unsigned long value, bool force_yield)</p><p><b>Description</b>: Sets the progress value</p><p><p></p><p>This method is equivalent to <a href="#m_value=">value=</a>, but it allows forcing the event loop to be triggered.
|
| 148 |
+
If "force_yield" is true, the event loop will be triggered always, irregardless of the yield interval specified in the constructor.
|
| 149 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-157"></a><h3>unit=</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_unit="></a><a name="k_17"></a><p><b>Signature</b>: void <b> unit= </b> (double unit)</p><p><b>Description</b>: Sets the unit</p><p><p></p><p>Specifies the count value corresponding to 1 percent on the progress bar. By default, the current value divided by the unit is used to create the formatted value from the output string. Another attribute is provided (<a href="#m_format_unit=">format_unit=</a>) to specify a separate unit for that purpose.
|
| 150 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'unit'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-164"></a><h3>value=</h3></td><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_value="></a><a name="k_18"></a><p><b>Signature</b>: void <b> value= </b> (unsigned long value)</p><p><b>Description</b>: Sets the progress value</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'value'. This is the setter.<br></p></td></tr></table></div>
|
| 151 |
+
</div>
|
| 152 |
+
</body>
|
| 153 |
+
</html>
|
| 154 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_AbstractMenu.html
ADDED
|
@@ -0,0 +1,156 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class AbstractMenu</p><h1>API reference - Class AbstractMenu</h1><property name="module" value="lay"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_lay.html">lay</a></p><p><b>Description</b>: An abstraction for the application menus</p><ul><li><a href="#h2-25">Public methods</a></li><li><a href="#h2-66">Public static methods and constants</a></li><li><a href="#h2-77">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-88">Detailed description</a></li></ul><p></p><p>The abstract menu is a class that stores a main menu and several popup menus
|
| 120 |
+
in a generic form such that they can be manipulated and converted into GUI objects.</p><p>Each item can be associated with a Action, which delivers a title, enabled/disable state etc.
|
| 121 |
+
The Action is either provided when new entries are inserted or created upon initialisation.</p><p>The abstract menu class provides methods to manipulate the menu structure (the state of the
|
| 122 |
+
menu items, their title and shortcut key is provided and manipulated through the Action object). </p><p>Menu items and submenus are referred to by a "path". The path is a string with this interpretation:</p><p><table><tr><td>"" </td><td>is the root</td></tr><tr><td>"[<path>.]<name>" </td><td>is an element of the submenu given by <path>. If <path> is omitted, this refers to an element in the root</td></tr><tr><td>"[<path>.]end" </td><td>refers to the item past the last item of the submenu given by <path> or root</td></tr><tr><td>"[<path>.]begin" </td><td>refers to the first item of the submenu given by <path> or root</td></tr><tr><td>"[<path>.]#<n>" </td><td>refers to the nth item of the submenu given by <path> or root (n is an integer number)</td></tr></table></p><p>Menu items can be put into groups. The path strings of each group can be obtained with the
|
| 123 |
+
"group" method. An item is put into a group by appending ":<group-name>" to the item's name.
|
| 124 |
+
This specification can be used several times.</p><p>Detached menus (i.e. for use in context menus) can be created as virtual top-level submenus
|
| 125 |
+
with a name of the form "@<name>". A special detached menu is "@toolbar" which represents the tool bar of the main window.
|
| 126 |
+
Menus are closely related to the <a href="class_Action.html">Action</a> class. Actions are used to represent selectable items inside menus, provide the title and other configuration settings. Actions also link the menu items with code. See the <a href="class_Action.html">Action</a> class description for further details.
|
| 127 |
+
</p><a name="h2-25"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>AbstractMenu ptr</td><td><b><a href="#method0">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method1">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method2">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method3">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method4">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method5">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method6">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>Action ptr</td><td><b><a href="#method7">action</a></b></td><td>(string path)</td><td>Gets the reference to a Action object associated with the given path</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method8">clear_menu</a></b></td><td>(string path)</td><td>Deletes the children of the item given by the path</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method10">delete_item</a></b></td><td>(string path)</td><td>Deletes the item given by the path</td></tr><tr class="row0"><td><i>[const]</i></td><td>string[]</td><td><b><a href="#method13">group</a></b></td><td>(string group)</td><td>Gets the group members</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method14">insert_item</a></b></td><td>(string path,<br>string name,<br>const Action ptr action)</td><td>Inserts a new item before the one given by the path</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method15">insert_menu</a></b></td><td>(string path,<br>string name,<br>string title)</td><td>Inserts a new submenu before the item given by the path</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method16">insert_menu</a></b></td><td>(string path,<br>string name,<br>Action ptr action)</td><td>Inserts a new submenu before the item given by the path</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method17">insert_separator</a></b></td><td>(string path,<br>string name)</td><td>Inserts a new separator before the item given by the path</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method19">is_menu?</a></b></td><td>(string path)</td><td>Returns true if the item is a menu</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method20">is_separator?</a></b></td><td>(string path)</td><td>Returns true if the item is a separator</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method21">is_valid?</a></b></td><td>(string path)</td><td>Returns true if the path is a valid one</td></tr><tr class="row0"><td><i>[const]</i></td><td>string[]</td><td><b><a href="#method22">items</a></b></td><td>(string path)</td><td>Gets the subitems for a given submenu</td></tr></table><a name="h2-66"></a><h2>Public static methods and constants</h2><table><tr class="row0"><td></td><td>string</td><td><b><a href="#method23">pack_key_binding</a></b></td><td>(map<string,string> path_to_keys)</td><td>Serializes a key binding definition into a single string</td></tr><tr class="row1"><td></td><td>string</td><td><b><a href="#method24">pack_menu_items_hidden</a></b></td><td>(map<string,bool> path_to_visibility)</td><td>Serializes a menu item visibility definition into a single string</td></tr><tr class="row0"><td></td><td>map<string,string></td><td><b><a href="#method25">unpack_key_binding</a></b></td><td>(string s)</td><td>Deserializes a key binding definition</td></tr><tr class="row1"><td></td><td>map<string,bool></td><td><b><a href="#method26">unpack_menu_items_hidden</a></b></td><td>(string s)</td><td>Deserializes a menu item visibility definition</td></tr></table><a name="h2-77"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td></td><td>void</td><td><b><a href="#method9">create</a></b></td><td></td><td>Use of this method is deprecated. Use _create instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method11">destroy</a></b></td><td></td><td>Use of this method is deprecated. Use _destroy instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method12">destroyed?</a></b></td><td></td><td>Use of this method is deprecated. Use _destroyed? instead</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method18">is_const_object?</a></b></td><td></td><td>Use of this method is deprecated. Use _is_const_object? instead</td></tr></table><a name="detailed"></a><a name="h2-88"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-89"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m__const_cast"></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i><a href="class_AbstractMenu.html">AbstractMenu</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 128 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-95"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m__create"></a><a name="k_3"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 129 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-101"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m__destroy"></a><a name="k_4"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 130 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 131 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-108"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__destroyed?"></a><a name="k_5"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 132 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 133 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-115"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__is_const_object?"></a><a name="k_6"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 134 |
+
This method returns true, if self is a const reference.
|
| 135 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-122"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__manage"></a><a name="k_7"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 136 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-128"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__unmanage"></a><a name="k_8"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 137 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-134"></a><h3>action</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m_action"></a><a name="k_9"></a><p><b>Signature</b>: <a href="class_Action.html">Action</a> ptr <b> action </b> (string path)</p><p><b>Description</b>: Gets the reference to a Action object associated with the given path</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to the item.</td></tr><tr><td><b>Returns</b>:</td><td>A reference to a Action object associated with this path or nil if the path is not valid</td></tr></table></td></tr><tr class="bigrow0"><td><a name="h3-142"></a><h3>clear_menu</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_clear_menu"></a><a name="k_10"></a><p><b>Signature</b>: void <b> clear_menu </b> (string path)</p><p><b>Description</b>: Deletes the children of the item given by the path</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to the item whose children to delete</td></tr></table><p><p></p><p>This method has been introduced in version 0.28.
|
| 138 |
+
</p></p></td></tr><tr class="bigrow1"><td><a name="h3-151"></a><h3>create</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_create"></a><a name="k_11"></a><p><b>Signature</b>: void <b> create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p>Use of this method is deprecated. Use _create instead</p><p><p>
|
| 139 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-158"></a><h3>delete_item</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_delete_item"></a><a name="k_12"></a><p><b>Signature</b>: void <b> delete_item </b> (string path)</p><p><b>Description</b>: Deletes the item given by the path</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to the item to delete</td></tr></table><p><p></p><p>This method will also delete all children of the given item. To clear the children only, use <a href="#m_clear_menu">clear_menu</a>.
|
| 140 |
+
</p></p></td></tr><tr class="bigrow1"><td><a name="h3-167"></a><h3>destroy</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_destroy"></a><a name="k_13"></a><p><b>Signature</b>: void <b> destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p>Use of this method is deprecated. Use _destroy instead</p><p><p>
|
| 141 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 142 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-175"></a><h3>destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_destroyed?"></a><a name="k_14"></a><p><b>Signature</b>: <i>[const] </i>bool <b> destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p>Use of this method is deprecated. Use _destroyed? instead</p><p><p>
|
| 143 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 144 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-183"></a><h3>group</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_group"></a><a name="k_15"></a><p><b>Signature</b>: <i>[const] </i>string[] <b> group </b> (string group)</p><p><b>Description</b>: Gets the group members</p><table class="layout-table"><tr><td><b>group</b>:</td><td>The group name</td></tr><tr><td><b>A</b>:</td><td>vector of all members (by path) of the group</td></tr></table></td></tr><tr class="bigrow0"><td><a name="h3-191"></a><h3>insert_item</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_insert_item"></a><a name="k_16"></a><p><b>Signature</b>: void <b> insert_item </b> (string path, string name, const <a href="class_Action.html">Action</a> ptr action)</p><p><b>Description</b>: Inserts a new item before the one given by the path</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to the item before which to insert the new item</td></tr><tr><td><b>name</b>:</td><td>The name of the item to insert </td></tr><tr><td><b>action</b>:</td><td>The Action object to insert</td></tr></table><p><p></p><p>The Action object passed as the third parameter references the handler which both implements the action to perform and the menu item's appearance such as title, icon and keyboard shortcut.</p></p></td></tr><tr class="bigrow1"><td rowspan="2"><a name="h3-201"></a><h3>insert_menu</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_insert_menu"></a><a name="k_17"></a><p><b>(1) Signature</b>: void <b> insert_menu </b> (string path, string name, string title)</p><p><b>Description</b>: Inserts a new submenu before the item given by the path</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to the item before which to insert the submenu</td></tr><tr><td><b>name</b>:</td><td>The name of the submenu to insert </td></tr><tr><td><b>title</b>:</td><td>The title of the submenu to insert</td></tr></table><p><p></p><p>The title string optionally encodes the key shortcut and icon resource
|
| 145 |
+
in the form <text>["("<shortcut>")"]["<"<icon-resource>">"].</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_insert_menu"></a><a name="k_18"></a><p><b>(2) Signature</b>: void <b> insert_menu </b> (string path, string name, <a href="class_Action.html">Action</a> ptr action)</p><p><b>Description</b>: Inserts a new submenu before the item given by the path</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to the item before which to insert the submenu</td></tr><tr><td><b>name</b>:</td><td>The name of the submenu to insert </td></tr><tr><td><b>action</b>:</td><td>The action object of the submenu to insert</td></tr></table><p><p></p><p>This method variant has been added in version 0.28.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-221"></a><h3>insert_separator</h3></td><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_insert_separator"></a><a name="k_19"></a><p><b>Signature</b>: void <b> insert_separator </b> (string path, string name)</p><p><b>Description</b>: Inserts a new separator before the item given by the path</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to the item before which to insert the separator</td></tr><tr><td><b>name</b>:</td><td>The name of the separator to insert </td></tr></table></td></tr><tr class="bigrow1"><td><a name="h3-229"></a><h3>is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_is_const_object?"></a><a name="k_20"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p>Use of this method is deprecated. Use _is_const_object? instead</p><p><p>
|
| 146 |
+
This method returns true, if self is a const reference.
|
| 147 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-237"></a><h3>is_menu?</h3></td><td style="padding-bottom: 16px"><a name="method19"></a><a name="m_is_menu?"></a><a name="k_21"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_menu? </b> (string path)</p><p><b>Description</b>: Returns true if the item is a menu</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to the item</td></tr><tr><td><b>Returns</b>:</td><td>false if the path is not valid or is not a menu</td></tr></table></td></tr><tr class="bigrow1"><td><a name="h3-245"></a><h3>is_separator?</h3></td><td style="padding-bottom: 16px"><a name="method20"></a><a name="m_is_separator?"></a><a name="k_22"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_separator? </b> (string path)</p><p><b>Description</b>: Returns true if the item is a separator</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to the item</td></tr><tr><td><b>Returns</b>:</td><td>false if the path is not valid or is not a separator</td></tr></table><p><p></p><p>This method has been introduced in version 0.19.
|
| 148 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-255"></a><h3>is_valid?</h3></td><td style="padding-bottom: 16px"><a name="method21"></a><a name="m_is_valid?"></a><a name="k_23"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_valid? </b> (string path)</p><p><b>Description</b>: Returns true if the path is a valid one</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to check</td></tr><tr><td><b>Returns</b>:</td><td>false if the path is not a valid path to an item</td></tr></table></td></tr><tr class="bigrow1"><td><a name="h3-263"></a><h3>items</h3></td><td style="padding-bottom: 16px"><a name="method22"></a><a name="m_items"></a><a name="k_24"></a><p><b>Signature</b>: <i>[const] </i>string[] <b> items </b> (string path)</p><p><b>Description</b>: Gets the subitems for a given submenu</p><table class="layout-table"><tr><td><b>path</b>:</td><td>The path to the submenu</td></tr><tr><td><b>Returns</b>:</td><td>A vector or path strings for the child items or an empty vector if the path is not valid or the item does not have children</td></tr></table></td></tr><tr class="bigrow0"><td><a name="h3-271"></a><h3>pack_key_binding</h3></td><td style="padding-bottom: 16px"><a name="method23"></a><a name="m_pack_key_binding"></a><a name="k_25"></a><p><b>Signature</b>: <i>[static] </i>string <b> pack_key_binding </b> (map<string,string> path_to_keys)</p><p><b>Description</b>: Serializes a key binding definition into a single string</p><p><p>
|
| 149 |
+
The serialized format is used by the 'key-bindings' config key. This method will take an array of path/key definitions (including the <a href="class_Action.html#m_NoKeyBound">Action#NoKeyBound</a> option) and convert it to a single string suitable for assigning to the config key.</p><p>This method has been introduced in version 0.26.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-277"></a><h3>pack_menu_items_hidden</h3></td><td style="padding-bottom: 16px"><a name="method24"></a><a name="m_pack_menu_items_hidden"></a><a name="k_26"></a><p><b>Signature</b>: <i>[static] </i>string <b> pack_menu_items_hidden </b> (map<string,bool> path_to_visibility)</p><p><b>Description</b>: Serializes a menu item visibility definition into a single string</p><p><p>
|
| 150 |
+
The serialized format is used by the 'menu-items-hidden' config key. This method will take an array of path/visibility flag definitions and convert it to a single string suitable for assigning to the config key.</p><p>This method has been introduced in version 0.26.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-283"></a><h3>unpack_key_binding</h3></td><td style="padding-bottom: 16px"><a name="method25"></a><a name="m_unpack_key_binding"></a><a name="k_27"></a><p><b>Signature</b>: <i>[static] </i>map<string,string> <b> unpack_key_binding </b> (string s)</p><p><b>Description</b>: Deserializes a key binding definition</p><p><p>
|
| 151 |
+
This method is the reverse of <a href="#m_pack_key_binding">pack_key_binding</a>.</p><p>This method has been introduced in version 0.26.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-289"></a><h3>unpack_menu_items_hidden</h3></td><td style="padding-bottom: 16px"><a name="method26"></a><a name="m_unpack_menu_items_hidden"></a><a name="k_28"></a><p><b>Signature</b>: <i>[static] </i>map<string,bool> <b> unpack_menu_items_hidden </b> (string s)</p><p><b>Description</b>: Deserializes a menu item visibility definition</p><p><p>
|
| 152 |
+
This method is the reverse of <a href="#m_pack_menu_items_hidden">pack_menu_items_hidden</a>.</p><p>This method has been introduced in version 0.26.</p></p></td></tr></table></div>
|
| 153 |
+
</div>
|
| 154 |
+
</body>
|
| 155 |
+
</html>
|
| 156 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_AbstractProgress.html
ADDED
|
@@ -0,0 +1,134 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class AbstractProgress</p><h1>API reference - Class AbstractProgress</h1><property name="module" value="tl"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_tl.html">tl</a></p><p><b>Description</b>: The abstract progress reporter</p><p><b>Class hierarchy</b>: AbstractProgress » <a href="class_Progress.html">Progress</a></p><ul><li><a href="#h2-13">Public constructors</a></li><li><a href="#h2-18">Public methods</a></li><li><a href="#h2-39">Detailed description</a></li></ul><p></p><p>The abstract progress reporter acts as a 'bracket' for a sequence of operations which are connected logically. For example, a DRC script consists of multiple operations. An abstract progress reportert is instantiated during the run time of the DRC script. This way, the application leaves the UI open while the DRC executes and log messages can be collected.</p><p>The abstract progress does not have a value.</p><p>This class has been introduced in version 0.27.
|
| 120 |
+
</p><a name="h2-13"></a><h2>Public constructors</h2><table><tr class="row0"><td>new AbstractProgress ptr</td><td><b><a href="#method9">new</a></b></td><td>(string desc)</td><td>Creates an abstract progress reporter with the given description</td></tr></table><a name="h2-18"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>AbstractProgress ptr</td><td><b><a href="#method0">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method1">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method2">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method3">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method4">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method5">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method6">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method7">assign</a></b></td><td>(const AbstractProgress other)</td><td>Assigns another object to self</td></tr><tr class="row0"><td><i>[const]</i></td><td>new AbstractProgress ptr</td><td><b><a href="#method8">dup</a></b></td><td></td><td>Creates a copy of self</td></tr></table><a name="detailed"></a><a name="h2-39"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-40"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m__const_cast"></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i><a href="class_AbstractProgress.html">AbstractProgress</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 121 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-46"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m__create"></a><a name="k_3"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 122 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-52"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m__destroy"></a><a name="k_4"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 123 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 124 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-59"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__destroyed?"></a><a name="k_5"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 125 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 126 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-66"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__is_const_object?"></a><a name="k_6"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 127 |
+
This method returns true, if self is a const reference.
|
| 128 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-73"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__manage"></a><a name="k_7"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 129 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-79"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__unmanage"></a><a name="k_8"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 130 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-85"></a><h3>assign</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m_assign"></a><a name="k_9"></a><p><b>Signature</b>: void <b> assign </b> (const <a href="class_AbstractProgress.html">AbstractProgress</a> other)</p><p><b>Description</b>: Assigns another object to self</p></td></tr><tr class="bigrow0"><td><a name="h3-89"></a><h3>dup</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_dup"></a><a name="k_10"></a><p><b>Signature</b>: <i>[const] </i>new <a href="class_AbstractProgress.html">AbstractProgress</a> ptr <b> dup </b></p><p><b>Description</b>: Creates a copy of self</p><p><b>Python specific notes: </b><br>This method also implements '__copy__' and '__deepcopy__'.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-94"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_new"></a><a name="k_11"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_AbstractProgress.html">AbstractProgress</a> ptr <b> new </b> (string desc)</p><p><b>Description</b>: Creates an abstract progress reporter with the given description</p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr></table></div>
|
| 131 |
+
</div>
|
| 132 |
+
</body>
|
| 133 |
+
</html>
|
| 134 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_Action.html
ADDED
|
@@ -0,0 +1,192 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class Action</p><h1>API reference - Class Action</h1><property name="module" value="lay"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_lay.html">lay</a></p><p><b>Description</b>: The abstraction for an action (i.e. used inside menus)</p><p><b>Class hierarchy</b>: Action</p><ul><li><a href="#h2-26">Public constructors</a></li><li><a href="#h2-31">Public methods</a></li><li><a href="#h2-118">Public static methods and constants</a></li><li><a href="#h2-123">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-134">Detailed description</a></li></ul><p></p><p>Actions act as a generalization of menu entries. The action provides the appearance of a menu entry such as title, key shortcut etc. and dispatches the menu events. The action can be manipulated to change to appearance of a menu entry and can be attached an observer that receives the events when the menu item is selected.</p><p>Multiple action objects can refer to the same action internally, in which case the information and event handler is copied between the incarnations. This way, a single implementation can be provided for multiple places where an action appears, for example inside the toolbar and in addition as a menu entry. Both actions will shared the same icon, text, shortcut etc.</p><p>Actions are mainly used for providing new menu items inside the <a href="class_AbstractMenu.html">AbstractMenu</a> class. This is some sample Ruby code for that case:</p><p><pre>
|
| 120 |
+
a = RBA::Action.new
|
| 121 |
+
a.title = "Push Me!"
|
| 122 |
+
a.on_triggered do
|
| 123 |
+
puts "I was pushed!"
|
| 124 |
+
end
|
| 125 |
+
|
| 126 |
+
app = RBA::Application.instance
|
| 127 |
+
mw = app.main_window
|
| 128 |
+
|
| 129 |
+
menu = mw.menu
|
| 130 |
+
menu.insert_separator("@toolbar.end", "name")
|
| 131 |
+
menu.insert_item("@toolbar.end", "my_action", a)
|
| 132 |
+
</pre></p><p>This code will register a custom action in the toolbar. When the toolbar button is pushed a message is printed. The toolbar is addressed by a path starting with the pseudo root "@toolbar".</p><p>In Version 0.23, the Action class has been merged with the ActionBase class.
|
| 133 |
+
</p><a name="h2-26"></a><h2>Public constructors</h2><table><tr class="row0"><td>new Action ptr</td><td><b><a href="#method33">new</a></b></td><td></td><td>Creates a new object of this class</td></tr></table><a name="h2-31"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>Action ptr</td><td><b><a href="#method1">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method2">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method3">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method4">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method5">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method6">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method7">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method8">checkable=</a></b></td><td>(bool checkable)</td><td>Makes the item(s) checkable or not</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method9">checked=</a></b></td><td>(bool checked)</td><td>Checks or unchecks the item</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method11">default_shortcut</a></b></td><td></td><td>Gets the default keyboard shortcut</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method12">default_shortcut=</a></b></td><td>(string shortcut)</td><td>Sets the default keyboard shortcut</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method15">effective_shortcut</a></b></td><td></td><td>Gets the effective keyboard shortcut</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method16">enabled=</a></b></td><td>(bool enabled)</td><td>Enables or disables the action</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method17">hidden=</a></b></td><td>(bool hidden)</td><td>Sets a value that makes the item hidden always</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method18">icon=</a></b></td><td>(string file)</td><td>Sets the icon to the given image file</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method19">icon=</a></b></td><td>(const QIcon qicon)</td><td>Sets the icon to the given <a href="class_QIcon.html">QIcon</a> object</td></tr><tr class="row0"><td><i>[const]</i></td><td>string</td><td><b><a href="#method20">icon_text</a></b></td><td></td><td>Gets the icon's text</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method21">icon_text=</a></b></td><td>(string icon_text)</td><td>Sets the icon's text</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method22">is_checkable?</a></b></td><td></td><td>Gets a value indicating whether the item is checkable</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method23">is_checked?</a></b></td><td></td><td>Gets a value indicating whether the item is checked</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method25">is_effective_enabled?</a></b></td><td></td><td>Gets a value indicating whether the item is really enabled</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method26">is_effective_visible?</a></b></td><td></td><td>Gets a value indicating whether the item is really visible</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method27">is_enabled?</a></b></td><td></td><td>Gets a value indicating whether the item is enabled</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method28">is_hidden?</a></b></td><td></td><td>Gets a value indicating whether the item is hidden</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method29">is_separator?</a></b></td><td></td><td>Gets a value indicating whether the item is a separator</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method30">is_visible?</a></b></td><td></td><td>Gets a value indicating whether the item is visible</td></tr><tr class="row0"><td><i>[const]</i></td><td>Macro ptr</td><td><b><a href="#method31">macro</a></b></td><td></td><td>Gets the macro associated with the action</td></tr><tr class="row1"><td><i>[virtual]</i></td><td>void</td><td><b><a href="#method32">menu_opening</a></b></td><td></td><td>This method is called if the menu item is a sub-menu and before the menu is opened.</td></tr><tr class="row0"><td><i>[signal]</i></td><td>void</td><td><b><a href="#method34">on_menu_opening</a></b></td><td></td><td>This event is called if the menu item is a sub-menu and before the menu is opened.</td></tr><tr class="row1"><td><i>[signal]</i></td><td>void</td><td><b><a href="#method35">on_triggered</a></b></td><td></td><td>This event is called if the menu item is selected.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method36">separator=</a></b></td><td>(bool separator)</td><td>Makes an item a separator or not</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method37">shortcut</a></b></td><td></td><td>Gets the keyboard shortcut</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method38">shortcut=</a></b></td><td>(string shortcut)</td><td>Sets the keyboard shortcut</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method39">title</a></b></td><td></td><td>Gets the title</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method40">title=</a></b></td><td>(string title)</td><td>Sets the title</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method41">tool_tip</a></b></td><td></td><td>Gets the tool tip text.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method42">tool_tip=</a></b></td><td>(string text)</td><td>Sets the tool tip text</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method43">trigger</a></b></td><td></td><td>Triggers the action programmatically</td></tr><tr class="row0"><td><i>[virtual]</i></td><td>void</td><td><b><a href="#method44">triggered</a></b></td><td></td><td>This method is called if the menu item is selected.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method45">visible=</a></b></td><td>(bool visible)</td><td>Sets the item's visibility</td></tr><tr class="row0"><td><i>[virtual,const]</i></td><td>bool</td><td><b><a href="#method46">wants_enabled</a></b></td><td></td><td>Returns a value whether the action wants to become enabled.</td></tr><tr class="row1"><td><i>[virtual,const]</i></td><td>bool</td><td><b><a href="#method47">wants_visible</a></b></td><td></td><td>Returns a value whether the action wants to become visible</td></tr></table><a name="h2-118"></a><h2>Public static methods and constants</h2><table><tr class="row0"><td><i>[static,const]</i></td><td>string</td><td><b><a href="#method0">NoKeyBound</a></b></td><td></td><td>Gets a shortcut value indicating that no shortcut shall be assigned</td></tr></table><a name="h2-123"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td></td><td>void</td><td><b><a href="#method10">create</a></b></td><td></td><td>Use of this method is deprecated. Use _create instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method13">destroy</a></b></td><td></td><td>Use of this method is deprecated. Use _destroy instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method14">destroyed?</a></b></td><td></td><td>Use of this method is deprecated. Use _destroyed? instead</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method24">is_const_object?</a></b></td><td></td><td>Use of this method is deprecated. Use _is_const_object? instead</td></tr></table><a name="detailed"></a><a name="h2-134"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-135"></a><h3>NoKeyBound</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m_NoKeyBound"></a><a name="k_2"></a><p><b>Signature</b>: <i>[static,const] </i>string <b> NoKeyBound </b></p><p><b>Description</b>: Gets a shortcut value indicating that no shortcut shall be assigned</p><p><p>
|
| 134 |
+
This method has been introduced in version 0.26.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'NoKeyBound'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-142"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m__const_cast"></a><a name="k_3"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Action.html">Action</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 135 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-148"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m__create"></a><a name="k_4"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 136 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-154"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__destroy"></a><a name="k_5"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 137 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 138 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-161"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__destroyed?"></a><a name="k_6"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 139 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 140 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-168"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__is_const_object?"></a><a name="k_7"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 141 |
+
This method returns true, if self is a const reference.
|
| 142 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-175"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__manage"></a><a name="k_8"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 143 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-181"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m__unmanage"></a><a name="k_9"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 144 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-187"></a><h3>checkable=</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_checkable="></a><a name="k_10"></a><p><b>Signature</b>: void <b> checkable= </b> (bool checkable)</p><p><b>Description</b>: Makes the item(s) checkable or not</p><table class="layout-table"><tr><td><b>checkable</b>:</td><td>true to make the item checkable</td></tr></table><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'checkable'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-195"></a><h3>checked=</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_checked="></a><a name="k_11"></a><p><b>Signature</b>: void <b> checked= </b> (bool checked)</p><p><b>Description</b>: Checks or unchecks the item</p><table class="layout-table"><tr><td><b>checked</b>:</td><td>true to make the item checked</td></tr></table><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'checked'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-203"></a><h3>create</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_create"></a><a name="k_12"></a><p><b>Signature</b>: void <b> create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p>Use of this method is deprecated. Use _create instead</p><p><p>
|
| 145 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-210"></a><h3>default_shortcut</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_default_shortcut"></a><a name="k_13"></a><p><b>Signature</b>: <i>[const] </i>string <b> default_shortcut </b></p><p><b>Description</b>: Gets the default keyboard shortcut</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The default keyboard shortcut as a string</td></tr></table><p><p></p><p>This attribute has been introduced in version 0.25.
|
| 146 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'default_shortcut'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-220"></a><h3>default_shortcut=</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_default_shortcut="></a><a name="k_14"></a><p><b>Signature</b>: void <b> default_shortcut= </b> (string shortcut)</p><p><b>Description</b>: Sets the default keyboard shortcut</p><p><p></p><p>The default shortcut is used, if shortcut is empty.</p><p>This attribute has been introduced in version 0.25.
|
| 147 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'default_shortcut'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-227"></a><h3>destroy</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_destroy"></a><a name="k_15"></a><p><b>Signature</b>: void <b> destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p>Use of this method is deprecated. Use _destroy instead</p><p><p>
|
| 148 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 149 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-235"></a><h3>destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_destroyed?"></a><a name="k_16"></a><p><b>Signature</b>: <i>[const] </i>bool <b> destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p>Use of this method is deprecated. Use _destroyed? instead</p><p><p>
|
| 150 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 151 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-243"></a><h3>effective_shortcut</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_effective_shortcut"></a><a name="k_17"></a><p><b>Signature</b>: <i>[const] </i>string <b> effective_shortcut </b></p><p><b>Description</b>: Gets the effective keyboard shortcut</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The effective keyboard shortcut as a string</td></tr></table><p><p></p><p>The effective shortcut is the one that is taken. It's either shortcut or default_shortcut.</p><p>This attribute has been introduced in version 0.25.
|
| 152 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-252"></a><h3>enabled=</h3></td><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_enabled="></a><a name="k_18"></a><p><b>Signature</b>: void <b> enabled= </b> (bool enabled)</p><p><b>Description</b>: Enables or disables the action</p><table class="layout-table"><tr><td><b>enabled</b>:</td><td>true to enable the item</td></tr></table><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'enabled'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-260"></a><h3>hidden=</h3></td><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_hidden="></a><a name="k_19"></a><p><b>Signature</b>: void <b> hidden= </b> (bool hidden)</p><p><b>Description</b>: Sets a value that makes the item hidden always</p><p><p>
|
| 153 |
+
See is_hidden? for details.</p><p>This attribute has been introduced in version 0.25
|
| 154 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'hidden'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-268"></a><h3>icon=</h3></td><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_icon="></a><a name="k_20"></a><p><b>(1) Signature</b>: void <b> icon= </b> (string file)</p><p><b>Description</b>: Sets the icon to the given image file</p><table class="layout-table"><tr><td><b>file</b>:</td><td>The image file to load for the icon</td></tr></table><p><p></p><p>Passing an empty string will reset the icon.
|
| 155 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'icon'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method19"></a><a name="m_icon="></a><a name="k_21"></a><p><b>(2) Signature</b>: void <b> icon= </b> (const <a href="class_QIcon.html">QIcon</a> qicon)</p><p><b>Description</b>: Sets the icon to the given <a href="class_QIcon.html">QIcon</a> object</p><table class="layout-table"><tr><td><b>qicon</b>:</td><td>The QIcon object</td></tr></table><p><p></p><p>This variant has been added in version 0.28.
|
| 156 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'icon'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-287"></a><h3>icon_text</h3></td><td style="padding-bottom: 16px"><a name="method20"></a><a name="m_icon_text"></a><a name="k_22"></a><p><b>Signature</b>: <i>[const] </i>string <b> icon_text </b></p><p><b>Description</b>: Gets the icon's text</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'icon_text'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-292"></a><h3>icon_text=</h3></td><td style="padding-bottom: 16px"><a name="method21"></a><a name="m_icon_text="></a><a name="k_23"></a><p><b>Signature</b>: void <b> icon_text= </b> (string icon_text)</p><p><b>Description</b>: Sets the icon's text</p><p><p></p><p>If an icon text is set, this will be used for the text below the icon.
|
| 157 |
+
If no icon text is set, the normal text will be used for the icon.
|
| 158 |
+
Passing an empty string will reset the icon's text.
|
| 159 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'icon_text'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-301"></a><h3>is_checkable?</h3></td><td style="padding-bottom: 16px"><a name="method22"></a><a name="m_is_checkable?"></a><a name="k_24"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_checkable? </b></p><p><b>Description</b>: Gets a value indicating whether the item is checkable</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'checkable'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-306"></a><h3>is_checked?</h3></td><td style="padding-bottom: 16px"><a name="method23"></a><a name="m_is_checked?"></a><a name="k_25"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_checked? </b></p><p><b>Description</b>: Gets a value indicating whether the item is checked</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'checked'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-311"></a><h3>is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method24"></a><a name="m_is_const_object?"></a><a name="k_26"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p>Use of this method is deprecated. Use _is_const_object? instead</p><p><p>
|
| 160 |
+
This method returns true, if self is a const reference.
|
| 161 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-319"></a><h3>is_effective_enabled?</h3></td><td style="padding-bottom: 16px"><a name="method25"></a><a name="m_is_effective_enabled?"></a><a name="k_27"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_effective_enabled? </b></p><p><b>Description</b>: Gets a value indicating whether the item is really enabled</p><p><p>
|
| 162 |
+
This is the combined value from is_enabled? and dynamic value (<a href="#m_wants_enabled">wants_enabled</a>).
|
| 163 |
+
This attribute has been introduced in version 0.28.
|
| 164 |
+
</p></p></td></tr><tr class="bigrow1"><td><a name="h3-327"></a><h3>is_effective_visible?</h3></td><td style="padding-bottom: 16px"><a name="method26"></a><a name="m_is_effective_visible?"></a><a name="k_28"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_effective_visible? </b></p><p><b>Description</b>: Gets a value indicating whether the item is really visible</p><p><p>
|
| 165 |
+
This is the combined visibility from is_visible? and is_hidden? and dynamic visibility (<a href="#m_wants_visible">wants_visible</a>).
|
| 166 |
+
This attribute has been introduced in version 0.25.
|
| 167 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-335"></a><h3>is_enabled?</h3></td><td style="padding-bottom: 16px"><a name="method27"></a><a name="m_is_enabled?"></a><a name="k_29"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_enabled? </b></p><p><b>Description</b>: Gets a value indicating whether the item is enabled</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'enabled'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-340"></a><h3>is_hidden?</h3></td><td style="padding-bottom: 16px"><a name="method28"></a><a name="m_is_hidden?"></a><a name="k_30"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_hidden? </b></p><p><b>Description</b>: Gets a value indicating whether the item is hidden</p><p><p>
|
| 168 |
+
If an item is hidden, it's always hidden and is_visible? does not have an effect.
|
| 169 |
+
This attribute has been introduced in version 0.25.
|
| 170 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'hidden'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-349"></a><h3>is_separator?</h3></td><td style="padding-bottom: 16px"><a name="method29"></a><a name="m_is_separator?"></a><a name="k_31"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_separator? </b></p><p><b>Description</b>: Gets a value indicating whether the item is a separator</p><p><p>
|
| 171 |
+
This method has been introduced in version 0.25.
|
| 172 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'separator'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-357"></a><h3>is_visible?</h3></td><td style="padding-bottom: 16px"><a name="method30"></a><a name="m_is_visible?"></a><a name="k_32"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_visible? </b></p><p><b>Description</b>: Gets a value indicating whether the item is visible</p><p><p>
|
| 173 |
+
The visibility combines with is_hidden?. To get the true visiblity, use is_effective_visible?.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'visible'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-364"></a><h3>macro</h3></td><td style="padding-bottom: 16px"><a name="method31"></a><a name="m_macro"></a><a name="k_33"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Macro.html">Macro</a> ptr <b> macro </b></p><p><b>Description</b>: Gets the macro associated with the action</p><p><p>
|
| 174 |
+
If the action is associated with a macro, this method returns a reference to the <a href="class_Macro.html">Macro</a> object. Otherwise, this method returns nil.</p><p>This method has been added in version 0.25.
|
| 175 |
+
</p></p></td></tr><tr class="bigrow1"><td><a name="h3-371"></a><h3>menu_opening</h3></td><td style="padding-bottom: 16px"><a name="method32"></a><a name="m_menu_opening"></a><a name="k_34"></a><p><b>Signature</b>: <i>[virtual] </i>void <b> menu_opening </b></p><p><b>Description</b>: This method is called if the menu item is a sub-menu and before the menu is opened.</p><p><p>
|
| 176 |
+
Reimplement this method is a derived class to receive this event. You can also use the on_menu_opening event instead.</p><p>This method has been added in version 0.28.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-377"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method33"></a><a name="m_new"></a><a name="k_35"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_Action.html">Action</a> ptr <b> new </b></p><p><b>Description</b>: Creates a new object of this class</p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-382"></a><h3>on_menu_opening</h3></td><td style="padding-bottom: 16px"><a name="method34"></a><a name="m_on_menu_opening"></a><a name="k_36"></a><p><b>Signature</b>: <i>[signal] </i>void <b> on_menu_opening </b></p><p><b>Description</b>: This event is called if the menu item is a sub-menu and before the menu is opened.</p><p><p></p><p>This event provides an opportunity to populate the menu before it is opened.</p><p>This event has been introduced in version 0.28.
|
| 177 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'on_menu_opening'. This is the getter.<br>The object exposes a writable attribute 'on_menu_opening'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-389"></a><h3>on_triggered</h3></td><td style="padding-bottom: 16px"><a name="method35"></a><a name="m_on_triggered"></a><a name="k_37"></a><p><b>Signature</b>: <i>[signal] </i>void <b> on_triggered </b></p><p><b>Description</b>: This event is called if the menu item is selected.</p><p><p></p><p>This event has been introduced in version 0.21 and moved to the ActionBase class in 0.28.
|
| 178 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'on_triggered'. This is the getter.<br>The object exposes a writable attribute 'on_triggered'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-396"></a><h3>separator=</h3></td><td style="padding-bottom: 16px"><a name="method36"></a><a name="m_separator="></a><a name="k_38"></a><p><b>Signature</b>: void <b> separator= </b> (bool separator)</p><p><b>Description</b>: Makes an item a separator or not</p><table class="layout-table"><tr><td><b>separator</b>:</td><td>true to make the item a separator</td></tr></table><p><p></p><p>This method has been introduced in version 0.25.
|
| 179 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'separator'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-406"></a><h3>shortcut</h3></td><td style="padding-bottom: 16px"><a name="method37"></a><a name="m_shortcut"></a><a name="k_39"></a><p><b>Signature</b>: <i>[const] </i>string <b> shortcut </b></p><p><b>Description</b>: Gets the keyboard shortcut</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The keyboard shortcut as a string</td></tr></table><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'shortcut'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-414"></a><h3>shortcut=</h3></td><td style="padding-bottom: 16px"><a name="method38"></a><a name="m_shortcut="></a><a name="k_40"></a><p><b>Signature</b>: void <b> shortcut= </b> (string shortcut)</p><p><b>Description</b>: Sets the keyboard shortcut</p><table class="layout-table"><tr><td><b>shortcut</b>:</td><td>The keyboard shortcut in Qt notation (i.e. "Ctrl+C")</td></tr></table><p><p>
|
| 180 |
+
If the shortcut string is empty, the default shortcut will be used. If the string is equal to <a href="class_Action.html#m_NoKeyBound">Action#NoKeyBound</a>, no keyboard shortcut will be assigned.</p><p>The NoKeyBound option has been added in version 0.26.</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'shortcut'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-424"></a><h3>title</h3></td><td style="padding-bottom: 16px"><a name="method39"></a><a name="m_title"></a><a name="k_41"></a><p><b>Signature</b>: <i>[const] </i>string <b> title </b></p><p><b>Description</b>: Gets the title</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The current title string</td></tr></table><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'title'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-432"></a><h3>title=</h3></td><td style="padding-bottom: 16px"><a name="method40"></a><a name="m_title="></a><a name="k_42"></a><p><b>Signature</b>: void <b> title= </b> (string title)</p><p><b>Description</b>: Sets the title</p><table class="layout-table"><tr><td><b>title</b>:</td><td>The title string to set (just the title)</td></tr></table><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'title'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-440"></a><h3>tool_tip</h3></td><td style="padding-bottom: 16px"><a name="method41"></a><a name="m_tool_tip"></a><a name="k_43"></a><p><b>Signature</b>: <i>[const] </i>string <b> tool_tip </b></p><p><b>Description</b>: Gets the tool tip text.</p><p><p></p><p>This method has been added in version 0.22.
|
| 181 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'tool_tip'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-447"></a><h3>tool_tip=</h3></td><td style="padding-bottom: 16px"><a name="method42"></a><a name="m_tool_tip="></a><a name="k_44"></a><p><b>Signature</b>: void <b> tool_tip= </b> (string text)</p><p><b>Description</b>: Sets the tool tip text</p><p><p></p><p>The tool tip text is displayed in the tool tip window of the menu entry.
|
| 182 |
+
This is in particular useful for entries in the tool bar.
|
| 183 |
+
This method has been added in version 0.22.
|
| 184 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'tool_tip'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-456"></a><h3>trigger</h3></td><td style="padding-bottom: 16px"><a name="method43"></a><a name="m_trigger"></a><a name="k_45"></a><p><b>Signature</b>: void <b> trigger </b></p><p><b>Description</b>: Triggers the action programmatically</p></td></tr><tr class="bigrow1"><td><a name="h3-460"></a><h3>triggered</h3></td><td style="padding-bottom: 16px"><a name="method44"></a><a name="m_triggered"></a><a name="k_46"></a><p><b>Signature</b>: <i>[virtual] </i>void <b> triggered </b></p><p><b>Description</b>: This method is called if the menu item is selected.</p><p><p></p><p>Reimplement this method is a derived class to receive this event. You can also use the on_triggered event instead.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-465"></a><h3>visible=</h3></td><td style="padding-bottom: 16px"><a name="method45"></a><a name="m_visible="></a><a name="k_47"></a><p><b>Signature</b>: void <b> visible= </b> (bool visible)</p><p><b>Description</b>: Sets the item's visibility</p><table class="layout-table"><tr><td><b>visible</b>:</td><td>true to make the item visible</td></tr></table><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'visible'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-473"></a><h3>wants_enabled</h3></td><td style="padding-bottom: 16px"><a name="method46"></a><a name="m_wants_enabled"></a><a name="k_48"></a><p><b>Signature</b>: <i>[virtual,const] </i>bool <b> wants_enabled </b></p><p><b>Description</b>: Returns a value whether the action wants to become enabled.</p><p><p>
|
| 185 |
+
This is a dynamic query for enabled state which the system uses to dynamically show or hide menu items. This information is evaluated in addition to is_enabled? and contributes to the effective enabled status from is_effective_enabled?.</p><p>This feature has been introduced in version 0.28.
|
| 186 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-480"></a><h3>wants_visible</h3></td><td style="padding-bottom: 16px"><a name="method47"></a><a name="m_wants_visible"></a><a name="k_49"></a><p><b>Signature</b>: <i>[virtual,const] </i>bool <b> wants_visible </b></p><p><b>Description</b>: Returns a value whether the action wants to become visible</p><p><p>
|
| 187 |
+
This is a dynamic query for visibility which the system uses to dynamically show or hide menu items, for example in the MRU lists. This visibility information is evaluated in addition to is_visible? and is_hidden? and contributes to the effective visibility status from is_effective_visible?.</p><p>This feature has been introduced in version 0.28.
|
| 188 |
+
</p></p></td></tr></table></div>
|
| 189 |
+
</div>
|
| 190 |
+
</body>
|
| 191 |
+
</html>
|
| 192 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_Annotation.html
ADDED
|
@@ -0,0 +1,256 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class Annotation</p><h1>API reference - Class Annotation</h1><property name="module" value="lay"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_lay.html">lay</a></p><p><b>Description</b>: A layout annotation (i.e. ruler)</p><p><b>Class hierarchy</b>: Annotation</p><ul><li><a href="#h2-38">Public constructors</a></li><li><a href="#h2-43">Public methods</a></li><li><a href="#h2-174">Public static methods and constants</a></li><li><a href="#h2-265">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-280">Detailed description</a></li></ul><p></p><p>Annotation objects provide a way to attach measurements or descriptive information to a layout view. Annotation objects can appear as rulers for example. Annotation objects can be configured in different ways using the styles provided. By configuring an annotation object properly, it can appear as a rectangle or a plain line for example.
|
| 120 |
+
See <a href="../manual/ruler_properties.html">Ruler properties</a> for more details about the appearance options.</p><p>Annotations are inserted into a layout view using <a href="class_LayoutView.html#m_insert_annotation">LayoutView#insert_annotation</a>. Here is some sample code in Ruby:</p><p><pre>
|
| 121 |
+
app = RBA::Application.instance
|
| 122 |
+
mw = app.main_window
|
| 123 |
+
view = mw.current_view
|
| 124 |
+
|
| 125 |
+
ant = RBA::Annotation::new
|
| 126 |
+
ant.p1 = RBA::DPoint::new(0, 0)
|
| 127 |
+
ant.p2 = RBA::DPoint::new(100, 0)
|
| 128 |
+
ant.style = RBA::Annotation::StyleRuler
|
| 129 |
+
view.insert_annotation(ant)
|
| 130 |
+
</pre></p><p>Annotations can be retrieved from a view with <a href="class_LayoutView.html#m_each_annotation">LayoutView#each_annotation</a> and all annotations can be cleared with <a href="class_LayoutView.html#m_clear_annotations">LayoutView#clear_annotations</a>.</p><p>Starting with version 0.25, annotations are 'live' objects once they are inserted into the view. Changing properties of annotations will automatically update the view (however, that is not true the other way round).</p><p>Here is some sample code of changing the style of all rulers to two-sided arrows:</p><p><pre>
|
| 131 |
+
view = RBA::LayoutView::current
|
| 132 |
+
|
| 133 |
+
begin
|
| 134 |
+
|
| 135 |
+
view.transaction("Restyle annotations")
|
| 136 |
+
|
| 137 |
+
view.each_annotation do |a|
|
| 138 |
+
a.style = RBA::Annotation::StyleArrowBoth
|
| 139 |
+
end
|
| 140 |
+
|
| 141 |
+
ensure
|
| 142 |
+
view.commit
|
| 143 |
+
end
|
| 144 |
+
</pre></p><a name="h2-38"></a><h2>Public constructors</h2><table><tr class="row0"><td>new Annotation ptr</td><td><b><a href="#method80">new</a></b></td><td></td><td>Creates a new object of this class</td></tr></table><a name="h2-43"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method0">!=</a></b></td><td>(const Annotation other)</td><td>Inequality operator</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method1">==</a></b></td><td>(const Annotation other)</td><td>Equality operator</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method43">_assign</a></b></td><td>(const Annotation other)</td><td>Assigns another object to self</td></tr><tr class="row1"><td><i>[const]</i></td><td>Annotation ptr</td><td><b><a href="#method44">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method45">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method46">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method47">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row1"><td><i>[const]</i></td><td>new Annotation ptr</td><td><b><a href="#method48">_dup</a></b></td><td></td><td>Creates a copy of self</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method49">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method50">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method51">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td><i>[const]</i></td><td>int</td><td><b><a href="#method52">angle_constraint</a></b></td><td></td><td>Returns the angle constraint attribute</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method53">angle_constraint=</a></b></td><td>(int flag)</td><td>Sets the angle constraint attribute</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method54">assign</a></b></td><td>(const Annotation other)</td><td>Assigns another object to self</td></tr><tr class="row0"><td><i>[const]</i></td><td>DBox</td><td><b><a href="#method55">box</a></b></td><td></td><td>Gets the bounding box of the object (not including text)</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method56">category</a></b></td><td></td><td>Gets the category string</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method57">category=</a></b></td><td>(string cat)</td><td>Sets the category string of the annotation</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method59">delete</a></b></td><td></td><td>Deletes this annotation from the view</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method62">detach</a></b></td><td></td><td>Detaches the annotation object from the view</td></tr><tr class="row1"><td><i>[const]</i></td><td>new Annotation ptr</td><td><b><a href="#method63">dup</a></b></td><td></td><td>Creates a copy of self</td></tr><tr class="row0"><td><i>[const]</i></td><td>string</td><td><b><a href="#method64">fmt</a></b></td><td></td><td>Returns the format used for the label</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method65">fmt=</a></b></td><td>(string format)</td><td>Sets the format used for the label</td></tr><tr class="row0"><td><i>[const]</i></td><td>string</td><td><b><a href="#method66">fmt_x</a></b></td><td></td><td>Returns the format used for the x-axis label</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method67">fmt_x=</a></b></td><td>(string format)</td><td>Sets the format used for the x-axis label</td></tr><tr class="row0"><td><i>[const]</i></td><td>string</td><td><b><a href="#method68">fmt_y</a></b></td><td></td><td>Returns the format used for the y-axis label</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method69">fmt_y=</a></b></td><td>(string format)</td><td>Sets the format used for the y-axis label</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method71">id</a></b></td><td></td><td>Returns the annotation's ID</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method73">is_valid?</a></b></td><td></td><td>Returns a value indicating whether the object is a valid reference.</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method74">main_position</a></b></td><td></td><td>Gets the position of the main label</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method75">main_position=</a></b></td><td>(int pos)</td><td>Sets the position of the main label</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method76">main_xalign</a></b></td><td></td><td>Gets the horizontal alignment type of the main label</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method77">main_xalign=</a></b></td><td>(int align)</td><td>Sets the horizontal alignment type of the main label</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method78">main_yalign</a></b></td><td></td><td>Gets the vertical alignment type of the main label</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method79">main_yalign=</a></b></td><td>(int align)</td><td>Sets the vertical alignment type of the main label</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method81">outline</a></b></td><td></td><td>Returns the outline style of the annotation object</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method82">outline=</a></b></td><td>(int outline)</td><td>Sets the outline style used for drawing the annotation object</td></tr><tr class="row0"><td><i>[const]</i></td><td>DPoint</td><td><b><a href="#method83">p1</a></b></td><td></td><td>Gets the first point of the ruler or marker</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method84">p1=</a></b></td><td>(const DPoint point)</td><td>Sets the first point of the ruler or marker</td></tr><tr class="row0"><td><i>[const]</i></td><td>DPoint</td><td><b><a href="#method85">p2</a></b></td><td></td><td>Gets the second point of the ruler or marker</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method86">p2=</a></b></td><td>(const DPoint point)</td><td>Sets the second point of the ruler or marker</td></tr><tr class="row0"><td><i>[const]</i></td><td>DPoint[]</td><td><b><a href="#method87">points</a></b></td><td></td><td>Gets the points of the ruler</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method88">points=</a></b></td><td>(DPoint[] points)</td><td>Sets the points for a (potentially) multi-segmented ruler</td></tr><tr class="row0"><td><i>[const]</i></td><td>DPoint</td><td><b><a href="#method90">seg_p1</a></b></td><td>(unsigned long segment_index)</td><td>Gets the first point of the given segment.</td></tr><tr class="row1"><td><i>[const]</i></td><td>DPoint</td><td><b><a href="#method91">seg_p2</a></b></td><td>(unsigned long segment_index)</td><td>Gets the second point of the given segment.</td></tr><tr class="row0"><td><i>[const]</i></td><td>unsigned long</td><td><b><a href="#method92">segments</a></b></td><td></td><td>Gets the number of segments.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method93">snap=</a></b></td><td>(bool flag)</td><td>Sets the 'snap to objects' attribute</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method94">snap?</a></b></td><td></td><td>Returns the 'snap to objects' attribute</td></tr><tr class="row1"><td><i>[const]</i></td><td>int</td><td><b><a href="#method95">style</a></b></td><td></td><td>Returns the style of the annotation object</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method96">style=</a></b></td><td>(int style)</td><td>Sets the style used for drawing the annotation object</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method97">text</a></b></td><td>(unsigned long index = 0)</td><td>Returns the formatted text for the main label</td></tr><tr class="row0"><td><i>[const]</i></td><td>string</td><td><b><a href="#method98">text_x</a></b></td><td>(unsigned long index = 0)</td><td>Returns the formatted text for the x-axis label</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method99">text_y</a></b></td><td>(unsigned long index = 0)</td><td>Returns the formatted text for the y-axis label</td></tr><tr class="row0"><td><i>[const]</i></td><td>string</td><td><b><a href="#method100">to_s</a></b></td><td></td><td>Returns the string representation of the ruler</td></tr><tr class="row1"><td><i>[const]</i></td><td>Annotation</td><td><b><a href="#method101">transformed</a></b></td><td>(const DTrans t)</td><td>Transforms the ruler or marker with the given simple transformation</td></tr><tr class="row0"><td><i>[const]</i></td><td>Annotation</td><td><b><a href="#method102">transformed</a></b></td><td>(const DCplxTrans t)</td><td>Transforms the ruler or marker with the given complex transformation</td></tr><tr class="row1"><td><i>[const]</i></td><td>Annotation</td><td><b><a href="#method103">transformed</a></b></td><td>(const ICplxTrans t)</td><td>Transforms the ruler or marker with the given complex transformation</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method107">xlabel_xalign</a></b></td><td></td><td>Gets the horizontal alignment type of the x axis label</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method108">xlabel_xalign=</a></b></td><td>(int align)</td><td>Sets the horizontal alignment type of the x axis label</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method109">xlabel_yalign</a></b></td><td></td><td>Gets the vertical alignment type of the x axis label</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method110">xlabel_yalign=</a></b></td><td>(int align)</td><td>Sets the vertical alignment type of the x axis label</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method111">ylabel_xalign</a></b></td><td></td><td>Gets the horizontal alignment type of the y axis label</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method112">ylabel_xalign=</a></b></td><td>(int align)</td><td>Sets the horizontal alignment type of the y axis label</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method113">ylabel_yalign</a></b></td><td></td><td>Gets the vertical alignment type of the y axis label</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method114">ylabel_yalign=</a></b></td><td>(int align)</td><td>Sets the vertical alignment type of the y axis label</td></tr></table><a name="h2-174"></a><h2>Public static methods and constants</h2><table><tr class="row0"><td></td><td>int</td><td><b><a href="#method2">AlignAuto</a></b></td><td></td><td>This code indicates automatic alignment.</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method3">AlignBottom</a></b></td><td></td><td>This code indicates bottom alignment.</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method4">AlignCenter</a></b></td><td></td><td>This code indicates automatic alignment.</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method5">AlignDown</a></b></td><td></td><td>This code indicates left or bottom alignment, depending on the context.</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method6">AlignLeft</a></b></td><td></td><td>This code indicates left alignment.</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method7">AlignRight</a></b></td><td></td><td>This code indicates right alignment.</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method8">AlignTop</a></b></td><td></td><td>This code indicates top alignment.</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method9">AlignUp</a></b></td><td></td><td>This code indicates right or top alignment, depending on the context.</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method10">AngleAny</a></b></td><td></td><td>Gets the any angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method11">AngleDiagonal</a></b></td><td></td><td>Gets the diagonal angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method12">AngleGlobal</a></b></td><td></td><td>Gets the global angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method.</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method13">AngleHorizontal</a></b></td><td></td><td>Gets the horizontal angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method14">AngleOrtho</a></b></td><td></td><td>Gets the ortho angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method15">AngleVertical</a></b></td><td></td><td>Gets the vertical angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method16">OutlineAngle</a></b></td><td></td><td>Gets the angle measurement ruler outline code for use with the <a href="#m_outline">outline</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method17">OutlineBox</a></b></td><td></td><td>Gets the box outline code for use with the <a href="#m_outline">outline</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method18">OutlineDiag</a></b></td><td></td><td>Gets the diagonal output code for use with the <a href="#m_outline">outline</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method19">OutlineDiagXY</a></b></td><td></td><td>outline_xy code used by the <a href="#m_outline">outline</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method20">OutlineDiagYX</a></b></td><td></td><td>Gets the yx plus diagonal outline code for use with the <a href="#m_outline">outline</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method21">OutlineEllipse</a></b></td><td></td><td>Gets the ellipse outline code for use with the <a href="#m_outline">outline</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method22">OutlineRadius</a></b></td><td></td><td>Gets the radius measurement ruler outline code for use with the <a href="#m_outline">outline</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method23">OutlineXY</a></b></td><td></td><td>Gets the xy outline code for use with the <a href="#m_outline">outline</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method24">OutlineYX</a></b></td><td></td><td>Gets the yx outline code for use with the <a href="#m_outline">outline</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method25">PositionAuto</a></b></td><td></td><td>This code indicates automatic positioning.</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method26">PositionCenter</a></b></td><td></td><td>This code indicates positioning of the main label at the mid point between p1 and p2.</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method27">PositionP1</a></b></td><td></td><td>This code indicates positioning of the main label at p1.</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method28">PositionP2</a></b></td><td></td><td>This code indicates positioning of the main label at p2.</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method29">RulerModeAutoMetric</a></b></td><td></td><td>Specifies auto-metric ruler mode for the <a href="#m_register_template">register_template</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method30">RulerModeAutoMetricEdge</a></b></td><td></td><td>Specifies edge-sensitive auto-metric ruler mode for the <a href="#m_register_template">register_template</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method31">RulerModeNormal</a></b></td><td></td><td>Specifies normal ruler mode for the <a href="#m_register_template">register_template</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method32">RulerModeSingleClick</a></b></td><td></td><td>Specifies single-click ruler mode for the <a href="#m_register_template">register_template</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method33">RulerMultiSegment</a></b></td><td></td><td>Specifies multi-segment mode</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method34">RulerThreeClicks</a></b></td><td></td><td>Specifies three-click ruler mode for the <a href="#m_register_template">register_template</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method35">StyleArrowBoth</a></b></td><td></td><td>Gets the both arrow ends style code for use the <a href="#m_style">style</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method36">StyleArrowEnd</a></b></td><td></td><td>Gets the end arrow style code for use the <a href="#m_style">style</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method37">StyleArrowStart</a></b></td><td></td><td>Gets the start arrow style code for use the <a href="#m_style">style</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method38">StyleCrossBoth</a></b></td><td></td><td>Gets the line style code for use with the <a href="#m_style">style</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method39">StyleCrossEnd</a></b></td><td></td><td>Gets the line style code for use with the <a href="#m_style">style</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method40">StyleCrossStart</a></b></td><td></td><td>Gets the line style code for use with the <a href="#m_style">style</a> method</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method41">StyleLine</a></b></td><td></td><td>Gets the line style code for use with the <a href="#m_style">style</a> method</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method42">StyleRuler</a></b></td><td></td><td>Gets the ruler style code for use the <a href="#m_style">style</a> method</td></tr><tr class="row1"><td></td><td>new Annotation ptr</td><td><b><a href="#method70">from_s</a></b></td><td>(string s)</td><td>Creates a ruler from a string representation</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method89">register_template</a></b></td><td>(const Annotation annotation,<br>string title,<br>int mode = <a href="#m_RulerModeNormal">RulerModeNormal</a>)</td><td>Registers the given annotation as a template globally</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method106">unregister_templates</a></b></td><td>(string category)</td><td>Unregisters the template or templates with the given category string globally</td></tr></table><a name="h2-265"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td></td><td>void</td><td><b><a href="#method58">create</a></b></td><td></td><td>Use of this method is deprecated. Use _create instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method60">destroy</a></b></td><td></td><td>Use of this method is deprecated. Use _destroy instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method61">destroyed?</a></b></td><td></td><td>Use of this method is deprecated. Use _destroyed? instead</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method72">is_const_object?</a></b></td><td></td><td>Use of this method is deprecated. Use _is_const_object? instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>Annotation</td><td><b><a href="#method104">transformed_cplx</a></b></td><td>(const DCplxTrans t)</td><td>Use of this method is deprecated. Use transformed instead</td></tr><tr class="row1"><td><i>[const]</i></td><td>Annotation</td><td><b><a href="#method105">transformed_cplx</a></b></td><td>(const ICplxTrans t)</td><td>Use of this method is deprecated. Use transformed instead</td></tr></table><a name="detailed"></a><a name="h2-280"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-281"></a><h3>!=</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m_!="></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i>bool <b> != </b> (const <a href="class_Annotation.html">Annotation</a> other)</p><p><b>Description</b>: Inequality operator</p></td></tr><tr class="bigrow1"><td><a name="h3-285"></a><h3>==</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m_=="></a><a name="k_3"></a><p><b>Signature</b>: <i>[const] </i>bool <b> == </b> (const <a href="class_Annotation.html">Annotation</a> other)</p><p><b>Description</b>: Equality operator</p></td></tr><tr class="bigrow0"><td><a name="h3-289"></a><h3>AlignAuto</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m_AlignAuto"></a><a name="k_4"></a><p><b>Signature</b>: <i>[static] </i>int <b> AlignAuto </b></p><p><b>Description</b>: This code indicates automatic alignment.</p><p><p>
|
| 145 |
+
This code makes the annotation align the label the way it thinks is best.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AlignAuto'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-296"></a><h3>AlignBottom</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m_AlignBottom"></a><a name="k_5"></a><p><b>Signature</b>: <i>[static] </i>int <b> AlignBottom </b></p><p><b>Description</b>: This code indicates bottom alignment.</p><p><p>
|
| 146 |
+
If used in a vertical context, this alignment code makes the label aligned at the bottom side - i.e. it will appear top of the reference point.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AlignBottom'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-303"></a><h3>AlignCenter</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m_AlignCenter"></a><a name="k_6"></a><p><b>Signature</b>: <i>[static] </i>int <b> AlignCenter </b></p><p><b>Description</b>: This code indicates automatic alignment.</p><p><p>
|
| 147 |
+
This code makes the annotation align the label centered. When used in a horizontal context, centering is in horizontal direction. If used in a vertical context, centering is in vertical direction.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AlignCenter'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-310"></a><h3>AlignDown</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m_AlignDown"></a><a name="k_7"></a><p><b>Signature</b>: <i>[static] </i>int <b> AlignDown </b></p><p><b>Description</b>: This code indicates left or bottom alignment, depending on the context.</p><p><p>
|
| 148 |
+
This code is equivalent to <a href="#m_AlignLeft">AlignLeft</a> and <a href="#m_AlignBottom">AlignBottom</a>.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AlignDown'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-317"></a><h3>AlignLeft</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m_AlignLeft"></a><a name="k_8"></a><p><b>Signature</b>: <i>[static] </i>int <b> AlignLeft </b></p><p><b>Description</b>: This code indicates left alignment.</p><p><p>
|
| 149 |
+
If used in a horizontal context, this alignment code makes the label aligned at the left side - i.e. it will appear right of the reference point.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AlignLeft'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-324"></a><h3>AlignRight</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m_AlignRight"></a><a name="k_9"></a><p><b>Signature</b>: <i>[static] </i>int <b> AlignRight </b></p><p><b>Description</b>: This code indicates right alignment.</p><p><p>
|
| 150 |
+
If used in a horizontal context, this alignment code makes the label aligned at the right side - i.e. it will appear left of the reference point.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AlignRight'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-331"></a><h3>AlignTop</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_AlignTop"></a><a name="k_10"></a><p><b>Signature</b>: <i>[static] </i>int <b> AlignTop </b></p><p><b>Description</b>: This code indicates top alignment.</p><p><p>
|
| 151 |
+
If used in a vertical context, this alignment code makes the label aligned at the top side - i.e. it will appear bottom of the reference point.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AlignTop'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-338"></a><h3>AlignUp</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_AlignUp"></a><a name="k_11"></a><p><b>Signature</b>: <i>[static] </i>int <b> AlignUp </b></p><p><b>Description</b>: This code indicates right or top alignment, depending on the context.</p><p><p>
|
| 152 |
+
This code is equivalent to <a href="#m_AlignRight">AlignRight</a> and <a href="#m_AlignTop">AlignTop</a>.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AlignUp'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-345"></a><h3>AngleAny</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_AngleAny"></a><a name="k_12"></a><p><b>Signature</b>: <i>[static] </i>int <b> AngleAny </b></p><p><b>Description</b>: Gets the any angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method</p><p><p>
|
| 153 |
+
If this value is specified for the angle constraint, all angles will be allowed.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AngleAny'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-352"></a><h3>AngleDiagonal</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_AngleDiagonal"></a><a name="k_13"></a><p><b>Signature</b>: <i>[static] </i>int <b> AngleDiagonal </b></p><p><b>Description</b>: Gets the diagonal angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method</p><p><p>
|
| 154 |
+
If this value is specified for the angle constraint, only multiples of 45 degree are allowed.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AngleDiagonal'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-359"></a><h3>AngleGlobal</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_AngleGlobal"></a><a name="k_14"></a><p><b>Signature</b>: <i>[static] </i>int <b> AngleGlobal </b></p><p><b>Description</b>: Gets the global angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method.</p><p><p>
|
| 155 |
+
This code will tell the ruler or marker to use the angle constraint defined globally.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AngleGlobal'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-366"></a><h3>AngleHorizontal</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_AngleHorizontal"></a><a name="k_15"></a><p><b>Signature</b>: <i>[static] </i>int <b> AngleHorizontal </b></p><p><b>Description</b>: Gets the horizontal angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method</p><p><p>
|
| 156 |
+
If this value is specified for the angle constraint, only horizontal rulers are allowed.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AngleHorizontal'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-373"></a><h3>AngleOrtho</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_AngleOrtho"></a><a name="k_16"></a><p><b>Signature</b>: <i>[static] </i>int <b> AngleOrtho </b></p><p><b>Description</b>: Gets the ortho angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method</p><p><p>
|
| 157 |
+
If this value is specified for the angle constraint, only multiples of 90 degree are allowed.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AngleOrtho'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-380"></a><h3>AngleVertical</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_AngleVertical"></a><a name="k_17"></a><p><b>Signature</b>: <i>[static] </i>int <b> AngleVertical </b></p><p><b>Description</b>: Gets the vertical angle code for use with the <a href="#m_angle_constraint">angle_constraint</a> method</p><p><p>
|
| 158 |
+
If this value is specified for the angle constraint, only vertical rulers are allowed.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AngleVertical'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-387"></a><h3>OutlineAngle</h3></td><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_OutlineAngle"></a><a name="k_18"></a><p><b>Signature</b>: <i>[static] </i>int <b> OutlineAngle </b></p><p><b>Description</b>: Gets the angle measurement ruler outline code for use with the <a href="#m_outline">outline</a> method</p><p><p>
|
| 159 |
+
When this outline style is specified, the ruler is drawn to indicate the angle between the first and last segment.</p><p>This constant has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'OutlineAngle'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-394"></a><h3>OutlineBox</h3></td><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_OutlineBox"></a><a name="k_19"></a><p><b>Signature</b>: <i>[static] </i>int <b> OutlineBox </b></p><p><b>Description</b>: Gets the box outline code for use with the <a href="#m_outline">outline</a> method</p><p><p>
|
| 160 |
+
When this outline style is specified, a box is drawn with the corners specified by the start and end point. All box edges are drawn in the style specified with the <a href="#m_style">style</a> attribute.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'OutlineBox'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-401"></a><h3>OutlineDiag</h3></td><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_OutlineDiag"></a><a name="k_20"></a><p><b>Signature</b>: <i>[static] </i>int <b> OutlineDiag </b></p><p><b>Description</b>: Gets the diagonal output code for use with the <a href="#m_outline">outline</a> method</p><p><p>
|
| 161 |
+
When this outline style is specified, a line connecting start and end points in the given style (ruler, arrow or plain line) is drawn.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'OutlineDiag'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-408"></a><h3>OutlineDiagXY</h3></td><td style="padding-bottom: 16px"><a name="method19"></a><a name="m_OutlineDiagXY"></a><a name="k_21"></a><p><b>Signature</b>: <i>[static] </i>int <b> OutlineDiagXY </b></p><p><b>Description</b>: outline_xy code used by the <a href="#m_outline">outline</a> method</p><p><p></p><p>When this outline style is specified, three lines are drawn: one horizontal from left to right and attached to the end of that a line from the bottom to the top. Another line is drawn connecting the start and end points directly. The lines are drawn in the specified style (see <a href="#m_style">style</a> method).</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'OutlineDiagXY'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-414"></a><h3>OutlineDiagYX</h3></td><td style="padding-bottom: 16px"><a name="method20"></a><a name="m_OutlineDiagYX"></a><a name="k_22"></a><p><b>Signature</b>: <i>[static] </i>int <b> OutlineDiagYX </b></p><p><b>Description</b>: Gets the yx plus diagonal outline code for use with the <a href="#m_outline">outline</a> method</p><p><p>
|
| 162 |
+
When this outline style is specified, three lines are drawn: one vertical from bottom to top and attached to the end of that a line from the left to the right. Another line is drawn connecting the start and end points directly. The lines are drawn in the specified style (see <a href="#m_style">style</a> method).</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'OutlineDiagYX'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-421"></a><h3>OutlineEllipse</h3></td><td style="padding-bottom: 16px"><a name="method21"></a><a name="m_OutlineEllipse"></a><a name="k_23"></a><p><b>Signature</b>: <i>[static] </i>int <b> OutlineEllipse </b></p><p><b>Description</b>: Gets the ellipse outline code for use with the <a href="#m_outline">outline</a> method</p><p><p>
|
| 163 |
+
When this outline style is specified, an ellipse is drawn with the extensions specified by the start and end point. The contour drawn as a line.</p><p>This constant has been introduced in version 0.26.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'OutlineEllipse'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-428"></a><h3>OutlineRadius</h3></td><td style="padding-bottom: 16px"><a name="method22"></a><a name="m_OutlineRadius"></a><a name="k_24"></a><p><b>Signature</b>: <i>[static] </i>int <b> OutlineRadius </b></p><p><b>Description</b>: Gets the radius measurement ruler outline code for use with the <a href="#m_outline">outline</a> method</p><p><p>
|
| 164 |
+
When this outline style is specified, the ruler is drawn to indicate a radius defined by at least three points of the ruler.</p><p>This constant has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'OutlineRadius'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-435"></a><h3>OutlineXY</h3></td><td style="padding-bottom: 16px"><a name="method23"></a><a name="m_OutlineXY"></a><a name="k_25"></a><p><b>Signature</b>: <i>[static] </i>int <b> OutlineXY </b></p><p><b>Description</b>: Gets the xy outline code for use with the <a href="#m_outline">outline</a> method</p><p><p>
|
| 165 |
+
When this outline style is specified, two lines are drawn: one horizontal from left to right and attached to the end of that a line from the bottom to the top. The lines are drawn in the specified style (see <a href="#m_style">style</a> method).</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'OutlineXY'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-442"></a><h3>OutlineYX</h3></td><td style="padding-bottom: 16px"><a name="method24"></a><a name="m_OutlineYX"></a><a name="k_26"></a><p><b>Signature</b>: <i>[static] </i>int <b> OutlineYX </b></p><p><b>Description</b>: Gets the yx outline code for use with the <a href="#m_outline">outline</a> method</p><p><p>
|
| 166 |
+
When this outline style is specified, two lines are drawn: one vertical from bottom to top and attached to the end of that a line from the left to the right. The lines are drawn in the specified style (see <a href="#m_style">style</a> method).</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'OutlineYX'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-449"></a><h3>PositionAuto</h3></td><td style="padding-bottom: 16px"><a name="method25"></a><a name="m_PositionAuto"></a><a name="k_27"></a><p><b>Signature</b>: <i>[static] </i>int <b> PositionAuto </b></p><p><b>Description</b>: This code indicates automatic positioning.</p><p><p>
|
| 167 |
+
The main label will be put either to p1 or p2, whichever the annotation considers best.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'PositionAuto'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-456"></a><h3>PositionCenter</h3></td><td style="padding-bottom: 16px"><a name="method26"></a><a name="m_PositionCenter"></a><a name="k_28"></a><p><b>Signature</b>: <i>[static] </i>int <b> PositionCenter </b></p><p><b>Description</b>: This code indicates positioning of the main label at the mid point between p1 and p2.</p><p><p>
|
| 168 |
+
The main label will be put to the center point.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'PositionCenter'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-463"></a><h3>PositionP1</h3></td><td style="padding-bottom: 16px"><a name="method27"></a><a name="m_PositionP1"></a><a name="k_29"></a><p><b>Signature</b>: <i>[static] </i>int <b> PositionP1 </b></p><p><b>Description</b>: This code indicates positioning of the main label at p1.</p><p><p>
|
| 169 |
+
The main label will be put to p1.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'PositionP1'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-470"></a><h3>PositionP2</h3></td><td style="padding-bottom: 16px"><a name="method28"></a><a name="m_PositionP2"></a><a name="k_30"></a><p><b>Signature</b>: <i>[static] </i>int <b> PositionP2 </b></p><p><b>Description</b>: This code indicates positioning of the main label at p2.</p><p><p>
|
| 170 |
+
The main label will be put to p2.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'PositionP2'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-477"></a><h3>RulerModeAutoMetric</h3></td><td style="padding-bottom: 16px"><a name="method29"></a><a name="m_RulerModeAutoMetric"></a><a name="k_31"></a><p><b>Signature</b>: <i>[static] </i>int <b> RulerModeAutoMetric </b></p><p><b>Description</b>: Specifies auto-metric ruler mode for the <a href="#m_register_template">register_template</a> method</p><p><p>
|
| 171 |
+
In auto-metric mode, a ruler can be placed with a single click and p1/p2 will be determined from the neighborhood.</p><p>This constant has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'RulerModeAutoMetric'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-484"></a><h3>RulerModeAutoMetricEdge</h3></td><td style="padding-bottom: 16px"><a name="method30"></a><a name="m_RulerModeAutoMetricEdge"></a><a name="k_32"></a><p><b>Signature</b>: <i>[static] </i>int <b> RulerModeAutoMetricEdge </b></p><p><b>Description</b>: Specifies edge-sensitive auto-metric ruler mode for the <a href="#m_register_template">register_template</a> method</p><p><p>
|
| 172 |
+
In auto-metric mode, a ruler can be placed with a single click and p1/p2 will be determined from the edge it is placed on.</p><p>This constant has been introduced in version 0.29</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'RulerModeAutoMetricEdge'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-491"></a><h3>RulerModeNormal</h3></td><td style="padding-bottom: 16px"><a name="method31"></a><a name="m_RulerModeNormal"></a><a name="k_33"></a><p><b>Signature</b>: <i>[static] </i>int <b> RulerModeNormal </b></p><p><b>Description</b>: Specifies normal ruler mode for the <a href="#m_register_template">register_template</a> method</p><p><p></p><p>This constant has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'RulerModeNormal'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-497"></a><h3>RulerModeSingleClick</h3></td><td style="padding-bottom: 16px"><a name="method32"></a><a name="m_RulerModeSingleClick"></a><a name="k_34"></a><p><b>Signature</b>: <i>[static] </i>int <b> RulerModeSingleClick </b></p><p><b>Description</b>: Specifies single-click ruler mode for the <a href="#m_register_template">register_template</a> method</p><p><p>
|
| 173 |
+
In single click-mode, a ruler can be placed with a single click and p1 will be == p2.</p><p>This constant has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'RulerModeSingleClick'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-504"></a><h3>RulerMultiSegment</h3></td><td style="padding-bottom: 16px"><a name="method33"></a><a name="m_RulerMultiSegment"></a><a name="k_35"></a><p><b>Signature</b>: <i>[static] </i>int <b> RulerMultiSegment </b></p><p><b>Description</b>: Specifies multi-segment mode</p><p><p>
|
| 174 |
+
In multi-segment mode, multiple segments can be created. The ruler is finished with a double click.</p><p>This constant has been introduced in version 0.28</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'RulerMultiSegment'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-511"></a><h3>RulerThreeClicks</h3></td><td style="padding-bottom: 16px"><a name="method34"></a><a name="m_RulerThreeClicks"></a><a name="k_36"></a><p><b>Signature</b>: <i>[static] </i>int <b> RulerThreeClicks </b></p><p><b>Description</b>: Specifies three-click ruler mode for the <a href="#m_register_template">register_template</a> method</p><p><p>
|
| 175 |
+
In this ruler mode, two segments are created for angle and circle radius measurements. Three mouse clicks are required.</p><p>This constant has been introduced in version 0.28</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'RulerThreeClicks'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-518"></a><h3>StyleArrowBoth</h3></td><td style="padding-bottom: 16px"><a name="method35"></a><a name="m_StyleArrowBoth"></a><a name="k_37"></a><p><b>Signature</b>: <i>[static] </i>int <b> StyleArrowBoth </b></p><p><b>Description</b>: Gets the both arrow ends style code for use the <a href="#m_style">style</a> method</p><p><p>
|
| 176 |
+
When this style is specified, a two-headed arrow is drawn.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'StyleArrowBoth'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-525"></a><h3>StyleArrowEnd</h3></td><td style="padding-bottom: 16px"><a name="method36"></a><a name="m_StyleArrowEnd"></a><a name="k_38"></a><p><b>Signature</b>: <i>[static] </i>int <b> StyleArrowEnd </b></p><p><b>Description</b>: Gets the end arrow style code for use the <a href="#m_style">style</a> method</p><p><p>
|
| 177 |
+
When this style is specified, an arrow is drawn pointing from the start to the end point.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'StyleArrowEnd'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-532"></a><h3>StyleArrowStart</h3></td><td style="padding-bottom: 16px"><a name="method37"></a><a name="m_StyleArrowStart"></a><a name="k_39"></a><p><b>Signature</b>: <i>[static] </i>int <b> StyleArrowStart </b></p><p><b>Description</b>: Gets the start arrow style code for use the <a href="#m_style">style</a> method</p><p><p>
|
| 178 |
+
When this style is specified, an arrow is drawn pointing from the end to the start point.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'StyleArrowStart'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-539"></a><h3>StyleCrossBoth</h3></td><td style="padding-bottom: 16px"><a name="method38"></a><a name="m_StyleCrossBoth"></a><a name="k_40"></a><p><b>Signature</b>: <i>[static] </i>int <b> StyleCrossBoth </b></p><p><b>Description</b>: Gets the line style code for use with the <a href="#m_style">style</a> method</p><p><p>
|
| 179 |
+
When this style is specified, a cross is drawn at both points.</p><p>This constant has been added in version 0.26.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'StyleCrossBoth'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-546"></a><h3>StyleCrossEnd</h3></td><td style="padding-bottom: 16px"><a name="method39"></a><a name="m_StyleCrossEnd"></a><a name="k_41"></a><p><b>Signature</b>: <i>[static] </i>int <b> StyleCrossEnd </b></p><p><b>Description</b>: Gets the line style code for use with the <a href="#m_style">style</a> method</p><p><p>
|
| 180 |
+
When this style is specified, a cross is drawn at the end point.</p><p>This constant has been added in version 0.26.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'StyleCrossEnd'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-553"></a><h3>StyleCrossStart</h3></td><td style="padding-bottom: 16px"><a name="method40"></a><a name="m_StyleCrossStart"></a><a name="k_42"></a><p><b>Signature</b>: <i>[static] </i>int <b> StyleCrossStart </b></p><p><b>Description</b>: Gets the line style code for use with the <a href="#m_style">style</a> method</p><p><p>
|
| 181 |
+
When this style is specified, a cross is drawn at the start point.</p><p>This constant has been added in version 0.26.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'StyleCrossStart'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-560"></a><h3>StyleLine</h3></td><td style="padding-bottom: 16px"><a name="method41"></a><a name="m_StyleLine"></a><a name="k_43"></a><p><b>Signature</b>: <i>[static] </i>int <b> StyleLine </b></p><p><b>Description</b>: Gets the line style code for use with the <a href="#m_style">style</a> method</p><p><p>
|
| 182 |
+
When this style is specified, a plain line is drawn.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'StyleLine'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-567"></a><h3>StyleRuler</h3></td><td style="padding-bottom: 16px"><a name="method42"></a><a name="m_StyleRuler"></a><a name="k_44"></a><p><b>Signature</b>: <i>[static] </i>int <b> StyleRuler </b></p><p><b>Description</b>: Gets the ruler style code for use the <a href="#m_style">style</a> method</p><p><p>
|
| 183 |
+
When this style is specified, the annotation will show a ruler with some ticks at distances indicating a decade of units and a suitable subdivision into minor ticks at intervals of 1, 2 or 5 units.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'StyleRuler'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-574"></a><h3>_assign</h3></td><td style="padding-bottom: 16px"><a name="method43"></a><a name="m__assign"></a><a name="k_45"></a><p><b>Signature</b>: void <b> _assign </b> (const <a href="class_Annotation.html">Annotation</a> other)</p><p><b>Description</b>: Assigns another object to self</p></td></tr><tr class="bigrow0"><td><a name="h3-578"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method44"></a><a name="m__const_cast"></a><a name="k_46"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Annotation.html">Annotation</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 184 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-584"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method45"></a><a name="m__create"></a><a name="k_47"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 185 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-590"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method46"></a><a name="m__destroy"></a><a name="k_48"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 186 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 187 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-597"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method47"></a><a name="m__destroyed?"></a><a name="k_49"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 188 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 189 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-604"></a><h3>_dup</h3></td><td style="padding-bottom: 16px"><a name="method48"></a><a name="m__dup"></a><a name="k_50"></a><p><b>Signature</b>: <i>[const] </i>new <a href="class_Annotation.html">Annotation</a> ptr <b> _dup </b></p><p><b>Description</b>: Creates a copy of self</p></td></tr><tr class="bigrow1"><td><a name="h3-608"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method49"></a><a name="m__is_const_object?"></a><a name="k_51"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 190 |
+
This method returns true, if self is a const reference.
|
| 191 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-615"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method50"></a><a name="m__manage"></a><a name="k_52"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 192 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-621"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method51"></a><a name="m__unmanage"></a><a name="k_53"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 193 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-627"></a><h3>angle_constraint</h3></td><td style="padding-bottom: 16px"><a name="method52"></a><a name="m_angle_constraint"></a><a name="k_54"></a><p><b>Signature</b>: <i>[const] </i>int <b> angle_constraint </b></p><p><b>Description</b>: Returns the angle constraint attribute</p><p><p>
|
| 194 |
+
See <a href="#m_angle_constraint=">angle_constraint=</a> for a more detailed description.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'angle_constraint'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-634"></a><h3>angle_constraint=</h3></td><td style="padding-bottom: 16px"><a name="method53"></a><a name="m_angle_constraint="></a><a name="k_55"></a><p><b>Signature</b>: void <b> angle_constraint= </b> (int flag)</p><p><b>Description</b>: Sets the angle constraint attribute</p><p><p>
|
| 195 |
+
This attribute controls if an angle constraint is applied when moving one of the ruler's points. The Angle... values can be used for this purpose.</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'angle_constraint'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-641"></a><h3>assign</h3></td><td style="padding-bottom: 16px"><a name="method54"></a><a name="m_assign"></a><a name="k_56"></a><p><b>Signature</b>: void <b> assign </b> (const <a href="class_Annotation.html">Annotation</a> other)</p><p><b>Description</b>: Assigns another object to self</p></td></tr><tr class="bigrow1"><td><a name="h3-645"></a><h3>box</h3></td><td style="padding-bottom: 16px"><a name="method55"></a><a name="m_box"></a><a name="k_57"></a><p><b>Signature</b>: <i>[const] </i><a href="class_DBox.html">DBox</a><b> box </b></p><p><b>Description</b>: Gets the bounding box of the object (not including text)</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The bounding box</td></tr></table></td></tr><tr class="bigrow0"><td><a name="h3-652"></a><h3>category</h3></td><td style="padding-bottom: 16px"><a name="method56"></a><a name="m_category"></a><a name="k_58"></a><p><b>Signature</b>: <i>[const] </i>string <b> category </b></p><p><b>Description</b>: Gets the category string</p><p><p>
|
| 196 |
+
See <a href="#m_category=">category=</a> for details.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'category'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-659"></a><h3>category=</h3></td><td style="padding-bottom: 16px"><a name="method57"></a><a name="m_category="></a><a name="k_59"></a><p><b>Signature</b>: void <b> category= </b> (string cat)</p><p><b>Description</b>: Sets the category string of the annotation</p><p><p>
|
| 197 |
+
The category string is an arbitrary string that can be used by various consumers or generators to mark 'their' annotation.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'category'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-666"></a><h3>create</h3></td><td style="padding-bottom: 16px"><a name="method58"></a><a name="m_create"></a><a name="k_60"></a><p><b>Signature</b>: void <b> create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p>Use of this method is deprecated. Use _create instead</p><p><p>
|
| 198 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-673"></a><h3>delete</h3></td><td style="padding-bottom: 16px"><a name="method59"></a><a name="m_delete"></a><a name="k_61"></a><p><b>Signature</b>: void <b> delete </b></p><p><b>Description</b>: Deletes this annotation from the view</p><p><p>
|
| 199 |
+
If the annotation is an "active" one, this method will remove it from the view. This object will become detached and can still be manipulated, but without having an effect on the view.
|
| 200 |
+
This method has been introduced in version 0.25.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-680"></a><h3>destroy</h3></td><td style="padding-bottom: 16px"><a name="method60"></a><a name="m_destroy"></a><a name="k_62"></a><p><b>Signature</b>: void <b> destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p>Use of this method is deprecated. Use _destroy instead</p><p><p>
|
| 201 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 202 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-688"></a><h3>destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method61"></a><a name="m_destroyed?"></a><a name="k_63"></a><p><b>Signature</b>: <i>[const] </i>bool <b> destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p>Use of this method is deprecated. Use _destroyed? instead</p><p><p>
|
| 203 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 204 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-696"></a><h3>detach</h3></td><td style="padding-bottom: 16px"><a name="method62"></a><a name="m_detach"></a><a name="k_64"></a><p><b>Signature</b>: void <b> detach </b></p><p><b>Description</b>: Detaches the annotation object from the view</p><p><p>
|
| 205 |
+
If the annotation object was inserted into the view, property changes will be reflected in the view. To disable this feature, 'detach' can be called after which the annotation object becomes inactive and changes will no longer be reflected in the view.</p><p>This method has been introduced in version 0.25.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-702"></a><h3>dup</h3></td><td style="padding-bottom: 16px"><a name="method63"></a><a name="m_dup"></a><a name="k_65"></a><p><b>Signature</b>: <i>[const] </i>new <a href="class_Annotation.html">Annotation</a> ptr <b> dup </b></p><p><b>Description</b>: Creates a copy of self</p><p><b>Python specific notes: </b><br>This method also implements '__copy__' and '__deepcopy__'.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-707"></a><h3>fmt</h3></td><td style="padding-bottom: 16px"><a name="method64"></a><a name="m_fmt"></a><a name="k_66"></a><p><b>Signature</b>: <i>[const] </i>string <b> fmt </b></p><p><b>Description</b>: Returns the format used for the label</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The format string</td></tr></table><p><p></p><p>Format strings can contain placeholders for values and formulas for computing derived values. See <a href="../manual/ruler_properties.html">Ruler properties</a> for more details.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'fmt'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-716"></a><h3>fmt=</h3></td><td style="padding-bottom: 16px"><a name="method65"></a><a name="m_fmt="></a><a name="k_67"></a><p><b>Signature</b>: void <b> fmt= </b> (string format)</p><p><b>Description</b>: Sets the format used for the label</p><table class="layout-table"><tr><td><b>format</b>:</td><td>The format string</td></tr></table><p><p></p><p>Format strings can contain placeholders for values and formulas for computing derived values. See <a href="../manual/ruler_properties.html">Ruler properties</a> for more details.</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'fmt'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-725"></a><h3>fmt_x</h3></td><td style="padding-bottom: 16px"><a name="method66"></a><a name="m_fmt_x"></a><a name="k_68"></a><p><b>Signature</b>: <i>[const] </i>string <b> fmt_x </b></p><p><b>Description</b>: Returns the format used for the x-axis label</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The format string</td></tr></table><p><p></p><p>Format strings can contain placeholders for values and formulas for computing derived values. See <a href="../manual/ruler_properties.html">Ruler properties</a> for more details.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'fmt_x'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-734"></a><h3>fmt_x=</h3></td><td style="padding-bottom: 16px"><a name="method67"></a><a name="m_fmt_x="></a><a name="k_69"></a><p><b>Signature</b>: void <b> fmt_x= </b> (string format)</p><p><b>Description</b>: Sets the format used for the x-axis label</p><table class="layout-table"><tr><td><b>format</b>:</td><td>The format string</td></tr></table><p><p>
|
| 206 |
+
X-axis labels are only used for styles that have a horizontal component.
|
| 207 |
+
Format strings can contain placeholders for values and formulas for computing derived values. See <a href="../manual/ruler_properties.html">Ruler properties</a> for more details.</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'fmt_x'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-745"></a><h3>fmt_y</h3></td><td style="padding-bottom: 16px"><a name="method68"></a><a name="m_fmt_y"></a><a name="k_70"></a><p><b>Signature</b>: <i>[const] </i>string <b> fmt_y </b></p><p><b>Description</b>: Returns the format used for the y-axis label</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The format string</td></tr></table><p><p></p><p>Format strings can contain placeholders for values and formulas for computing derived values. See <a href="../manual/ruler_properties.html">Ruler properties</a> for more details.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'fmt_y'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-754"></a><h3>fmt_y=</h3></td><td style="padding-bottom: 16px"><a name="method69"></a><a name="m_fmt_y="></a><a name="k_71"></a><p><b>Signature</b>: void <b> fmt_y= </b> (string format)</p><p><b>Description</b>: Sets the format used for the y-axis label</p><table class="layout-table"><tr><td><b>format</b>:</td><td>The format string</td></tr></table><p><p>
|
| 208 |
+
Y-axis labels are only used for styles that have a vertical component.
|
| 209 |
+
Format strings can contain placeholders for values and formulas for computing derived values. See <a href="../manual/ruler_properties.html">Ruler properties</a> for more details.</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'fmt_y'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-765"></a><h3>from_s</h3></td><td style="padding-bottom: 16px"><a name="method70"></a><a name="m_from_s"></a><a name="k_72"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_Annotation.html">Annotation</a> ptr <b> from_s </b> (string s)</p><p><b>Description</b>: Creates a ruler from a string representation</p><p><p>
|
| 210 |
+
This function creates a ruler from the string returned by <a href="#m_to_s">to_s</a>.</p><p>This method was introduced in version 0.28.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-771"></a><h3>id</h3></td><td style="padding-bottom: 16px"><a name="method71"></a><a name="m_id"></a><a name="k_73"></a><p><b>Signature</b>: <i>[const] </i>int <b> id </b></p><p><b>Description</b>: Returns the annotation's ID</p><p><p>
|
| 211 |
+
The annotation ID is an integer that uniquely identifies an annotation inside a view.
|
| 212 |
+
The ID is used for replacing an annotation (see <a href="class_LayoutView.html#m_replace_annotation">LayoutView#replace_annotation</a>).</p><p>This method was introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-778"></a><h3>is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method72"></a><a name="m_is_const_object?"></a><a name="k_74"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p>Use of this method is deprecated. Use _is_const_object? instead</p><p><p>
|
| 213 |
+
This method returns true, if self is a const reference.
|
| 214 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-786"></a><h3>is_valid?</h3></td><td style="padding-bottom: 16px"><a name="method73"></a><a name="m_is_valid?"></a><a name="k_75"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_valid? </b></p><p><b>Description</b>: Returns a value indicating whether the object is a valid reference.</p><p><p>
|
| 215 |
+
If this value is true, the object represents an annotation on the screen. Otherwise, the object is a 'detached' annotation which does not have a representation on the screen.</p><p>This method was introduced in version 0.25.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-792"></a><h3>main_position</h3></td><td style="padding-bottom: 16px"><a name="method74"></a><a name="m_main_position"></a><a name="k_76"></a><p><b>Signature</b>: <i>[const] </i>int <b> main_position </b></p><p><b>Description</b>: Gets the position of the main label</p><p><p>
|
| 216 |
+
See <a href="#m_main_position=">main_position=</a> for details.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'main_position'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-799"></a><h3>main_position=</h3></td><td style="padding-bottom: 16px"><a name="method75"></a><a name="m_main_position="></a><a name="k_77"></a><p><b>Signature</b>: void <b> main_position= </b> (int pos)</p><p><b>Description</b>: Sets the position of the main label</p><p><p>
|
| 217 |
+
This method accepts one of the Position... constants.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'main_position'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-806"></a><h3>main_xalign</h3></td><td style="padding-bottom: 16px"><a name="method76"></a><a name="m_main_xalign"></a><a name="k_78"></a><p><b>Signature</b>: <i>[const] </i>int <b> main_xalign </b></p><p><b>Description</b>: Gets the horizontal alignment type of the main label</p><p><p>
|
| 218 |
+
See <a href="#m_main_xalign=">main_xalign=</a> for details.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'main_xalign'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-813"></a><h3>main_xalign=</h3></td><td style="padding-bottom: 16px"><a name="method77"></a><a name="m_main_xalign="></a><a name="k_79"></a><p><b>Signature</b>: void <b> main_xalign= </b> (int align)</p><p><b>Description</b>: Sets the horizontal alignment type of the main label</p><p><p>
|
| 219 |
+
This method accepts one of the Align... constants.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'main_xalign'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-820"></a><h3>main_yalign</h3></td><td style="padding-bottom: 16px"><a name="method78"></a><a name="m_main_yalign"></a><a name="k_80"></a><p><b>Signature</b>: <i>[const] </i>int <b> main_yalign </b></p><p><b>Description</b>: Gets the vertical alignment type of the main label</p><p><p>
|
| 220 |
+
See <a href="#m_main_yalign=">main_yalign=</a> for details.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'main_yalign'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-827"></a><h3>main_yalign=</h3></td><td style="padding-bottom: 16px"><a name="method79"></a><a name="m_main_yalign="></a><a name="k_81"></a><p><b>Signature</b>: void <b> main_yalign= </b> (int align)</p><p><b>Description</b>: Sets the vertical alignment type of the main label</p><p><p>
|
| 221 |
+
This method accepts one of the Align... constants.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'main_yalign'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-834"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method80"></a><a name="m_new"></a><a name="k_82"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_Annotation.html">Annotation</a> ptr <b> new </b></p><p><b>Description</b>: Creates a new object of this class</p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-839"></a><h3>outline</h3></td><td style="padding-bottom: 16px"><a name="method81"></a><a name="m_outline"></a><a name="k_83"></a><p><b>Signature</b>: <i>[const] </i>int <b> outline </b></p><p><b>Description</b>: Returns the outline style of the annotation object</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'outline'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-844"></a><h3>outline=</h3></td><td style="padding-bottom: 16px"><a name="method82"></a><a name="m_outline="></a><a name="k_84"></a><p><b>Signature</b>: void <b> outline= </b> (int outline)</p><p><b>Description</b>: Sets the outline style used for drawing the annotation object</p><p><p>
|
| 222 |
+
The Outline... values can be used for defining the annotation object's outline. The outline style determines what components are drawn. </p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'outline'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-851"></a><h3>p1</h3></td><td style="padding-bottom: 16px"><a name="method83"></a><a name="m_p1"></a><a name="k_85"></a><p><b>Signature</b>: <i>[const] </i><a href="class_DPoint.html">DPoint</a><b> p1 </b></p><p><b>Description</b>: Gets the first point of the ruler or marker</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The first point</td></tr></table><p><p>
|
| 223 |
+
The points of the ruler or marker are always given in micron units in floating-point coordinates.</p><p>This method is provided for backward compatibility. Starting with version 0.28, rulers can be multi-segmented. Use <a href="#m_points">points</a> or <a href="#m_seg_p1">seg_p1</a> to retrieve the points of the ruler segments.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'p1'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-861"></a><h3>p1=</h3></td><td style="padding-bottom: 16px"><a name="method84"></a><a name="m_p1="></a><a name="k_86"></a><p><b>Signature</b>: void <b> p1= </b> (const <a href="class_DPoint.html">DPoint</a> point)</p><p><b>Description</b>: Sets the first point of the ruler or marker</p><p><p>
|
| 224 |
+
The points of the ruler or marker are always given in micron units in floating-point coordinates.</p><p>This method is provided for backward compatibility. Starting with version 0.28, rulers can be multi-segmented. Use <a href="#m_points=">points=</a> to specify the ruler segments.
|
| 225 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'p1'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-869"></a><h3>p2</h3></td><td style="padding-bottom: 16px"><a name="method85"></a><a name="m_p2"></a><a name="k_87"></a><p><b>Signature</b>: <i>[const] </i><a href="class_DPoint.html">DPoint</a><b> p2 </b></p><p><b>Description</b>: Gets the second point of the ruler or marker</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The second point</td></tr></table><p><p>
|
| 226 |
+
The points of the ruler or marker are always given in micron units in floating-point coordinates.</p><p>This method is provided for backward compatibility. Starting with version 0.28, rulers can be multi-segmented. Use <a href="#m_points">points</a> or <a href="#m_seg_p1">seg_p1</a> to retrieve the points of the ruler segments.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'p2'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-879"></a><h3>p2=</h3></td><td style="padding-bottom: 16px"><a name="method86"></a><a name="m_p2="></a><a name="k_88"></a><p><b>Signature</b>: void <b> p2= </b> (const <a href="class_DPoint.html">DPoint</a> point)</p><p><b>Description</b>: Sets the second point of the ruler or marker</p><p><p>
|
| 227 |
+
The points of the ruler or marker are always given in micron units in floating-point coordinates.</p><p>This method is provided for backward compatibility. Starting with version 0.28, rulers can be multi-segmented. Use <a href="#m_points=">points=</a> to specify the ruler segments.
|
| 228 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'p2'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-887"></a><h3>points</h3></td><td style="padding-bottom: 16px"><a name="method87"></a><a name="m_points"></a><a name="k_89"></a><p><b>Signature</b>: <i>[const] </i><a href="class_DPoint.html">DPoint</a>[] <b> points </b></p><p><b>Description</b>: Gets the points of the ruler</p><p><p>
|
| 229 |
+
A single-segmented ruler has two points. Rulers with more points have more segments correspondingly. Note that the point list may have one point only (single-point ruler) or may even be empty.</p><p>Use <a href="#m_points=">points=</a> to set the segment points. Use <a href="#m_segments">segments</a> to get the number of segments and <a href="#m_seg_p1">seg_p1</a> and <a href="#m_seg_p2">seg_p2</a> to get the first and second point of one segment.</p><p>Multi-segmented rulers have been introduced in version 0.28</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'points'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-894"></a><h3>points=</h3></td><td style="padding-bottom: 16px"><a name="method88"></a><a name="m_points="></a><a name="k_90"></a><p><b>Signature</b>: void <b> points= </b> (<a href="class_DPoint.html">DPoint</a>[] points)</p><p><b>Description</b>: Sets the points for a (potentially) multi-segmented ruler</p><p><p>
|
| 230 |
+
See <a href="#m_points">points</a> for a description of multi-segmented rulers. The list of points passed to this method is cleaned from duplicates before being stored inside the ruler.</p><p>This method has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'points'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-901"></a><h3>register_template</h3></td><td style="padding-bottom: 16px"><a name="method89"></a><a name="m_register_template"></a><a name="k_91"></a><p><b>Signature</b>: <i>[static] </i>void <b> register_template </b> (const <a href="class_Annotation.html">Annotation</a> annotation, string title, int mode = <a href="#m_RulerModeNormal">RulerModeNormal</a>)</p><p><b>Description</b>: Registers the given annotation as a template globally</p><table class="layout-table"><tr><td><b>title</b>:</td><td>The title to use for the ruler template</td></tr><tr><td><b>mode</b>:</td><td>The mode the ruler will be created in (see Ruler... constants)</td></tr></table><p><p>
|
| 231 |
+
@annotation The annotation to use for the template (positions are ignored)</p><p>In order to register a system template, the category string of the annotation has to be a unique and non-empty string. The annotation is added to the list of annotation templates and becomes available as a new template in the ruler drop-down menu.</p><p>The new annotation template is registered on all views.</p><p>NOTE: this setting is persisted and the the application configuration is updated.</p><p>This method has been added in version 0.25.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-911"></a><h3>seg_p1</h3></td><td style="padding-bottom: 16px"><a name="method90"></a><a name="m_seg_p1"></a><a name="k_92"></a><p><b>Signature</b>: <i>[const] </i><a href="class_DPoint.html">DPoint</a><b> seg_p1 </b> (unsigned long segment_index)</p><p><b>Description</b>: Gets the first point of the given segment.</p><p><p>
|
| 232 |
+
The segment is indicated by the segment index which is a number between 0 and <a href="#m_segments">segments</a>-1.</p><p>This method has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-917"></a><h3>seg_p2</h3></td><td style="padding-bottom: 16px"><a name="method91"></a><a name="m_seg_p2"></a><a name="k_93"></a><p><b>Signature</b>: <i>[const] </i><a href="class_DPoint.html">DPoint</a><b> seg_p2 </b> (unsigned long segment_index)</p><p><b>Description</b>: Gets the second point of the given segment.</p><p><p>
|
| 233 |
+
The segment is indicated by the segment index which is a number between 0 and <a href="#m_segments">segments</a>-1.
|
| 234 |
+
The second point of a segment is also the first point of the following segment if there is one.</p><p>This method has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-924"></a><h3>segments</h3></td><td style="padding-bottom: 16px"><a name="method92"></a><a name="m_segments"></a><a name="k_94"></a><p><b>Signature</b>: <i>[const] </i>unsigned long <b> segments </b></p><p><b>Description</b>: Gets the number of segments.</p><p><p>
|
| 235 |
+
This method returns the number of segments the ruler is made up. Even though the ruler can be one or even zero points, the number of segments is at least 1.</p><p>This method has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-930"></a><h3>snap=</h3></td><td style="padding-bottom: 16px"><a name="method93"></a><a name="m_snap="></a><a name="k_95"></a><p><b>Signature</b>: void <b> snap= </b> (bool flag)</p><p><b>Description</b>: Sets the 'snap to objects' attribute</p><p><p>
|
| 236 |
+
If this attribute is set to true, the ruler or marker snaps to other objects when moved. </p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'snap'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-937"></a><h3>snap?</h3></td><td style="padding-bottom: 16px"><a name="method94"></a><a name="m_snap?"></a><a name="k_96"></a><p><b>Signature</b>: <i>[const] </i>bool <b> snap? </b></p><p><b>Description</b>: Returns the 'snap to objects' attribute</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'snap'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-942"></a><h3>style</h3></td><td style="padding-bottom: 16px"><a name="method95"></a><a name="m_style"></a><a name="k_97"></a><p><b>Signature</b>: <i>[const] </i>int <b> style </b></p><p><b>Description</b>: Returns the style of the annotation object</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'style'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-947"></a><h3>style=</h3></td><td style="padding-bottom: 16px"><a name="method96"></a><a name="m_style="></a><a name="k_98"></a><p><b>Signature</b>: void <b> style= </b> (int style)</p><p><b>Description</b>: Sets the style used for drawing the annotation object</p><p><p>
|
| 237 |
+
The Style... values can be used for defining the annotation object's style. The style determines if ticks or arrows are drawn.</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'style'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-954"></a><h3>text</h3></td><td style="padding-bottom: 16px"><a name="method97"></a><a name="m_text"></a><a name="k_99"></a><p><b>Signature</b>: <i>[const] </i>string <b> text </b> (unsigned long index = 0)</p><p><b>Description</b>: Returns the formatted text for the main label</p><p><p>
|
| 238 |
+
The index parameter indicates which segment to use (0 is the first one). It has been added in version 0.28.
|
| 239 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-961"></a><h3>text_x</h3></td><td style="padding-bottom: 16px"><a name="method98"></a><a name="m_text_x"></a><a name="k_100"></a><p><b>Signature</b>: <i>[const] </i>string <b> text_x </b> (unsigned long index = 0)</p><p><b>Description</b>: Returns the formatted text for the x-axis label</p><p><p>
|
| 240 |
+
The index parameter indicates which segment to use (0 is the first one). It has been added in version 0.28.
|
| 241 |
+
</p></p></td></tr><tr class="bigrow1"><td><a name="h3-968"></a><h3>text_y</h3></td><td style="padding-bottom: 16px"><a name="method99"></a><a name="m_text_y"></a><a name="k_101"></a><p><b>Signature</b>: <i>[const] </i>string <b> text_y </b> (unsigned long index = 0)</p><p><b>Description</b>: Returns the formatted text for the y-axis label</p><p><p>
|
| 242 |
+
The index parameter indicates which segment to use (0 is the first one). It has been added in version 0.28.
|
| 243 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-975"></a><h3>to_s</h3></td><td style="padding-bottom: 16px"><a name="method100"></a><a name="m_to_s"></a><a name="k_102"></a><p><b>Signature</b>: <i>[const] </i>string <b> to_s </b></p><p><b>Description</b>: Returns the string representation of the ruler</p><p><p>
|
| 244 |
+
This method was introduced in version 0.19.</p></p><p><b>Python specific notes: </b><br>This method is also available as 'str(object)'.<br></p></td></tr><tr class="bigrow1"><td rowspan="3"><a name="h3-982"></a><h3>transformed</h3></td><td style="padding-bottom: 16px"><a name="method101"></a><a name="m_transformed"></a><a name="k_103"></a><p><b>(1) Signature</b>: <i>[const] </i><a href="class_Annotation.html">Annotation</a><b> transformed </b> (const <a href="class_DTrans.html">DTrans</a> t)</p><p><b>Description</b>: Transforms the ruler or marker with the given simple transformation</p><table class="layout-table"><tr><td><b>t</b>:</td><td>The transformation to apply</td></tr><tr><td><b>Returns</b>:</td><td>The transformed object</td></tr></table></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method102"></a><a name="m_transformed"></a><a name="k_104"></a><p><b>(2) Signature</b>: <i>[const] </i><a href="class_Annotation.html">Annotation</a><b> transformed </b> (const <a href="class_DCplxTrans.html">DCplxTrans</a> t)</p><p><b>Description</b>: Transforms the ruler or marker with the given complex transformation</p><table class="layout-table"><tr><td><b>t</b>:</td><td>The magnifying transformation to apply</td></tr><tr><td><b>Returns</b>:</td><td>The transformed object</td></tr></table><p><p></p><p>Starting with version 0.25, all overloads all available as 'transform'.</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method103"></a><a name="m_transformed"></a><a name="k_105"></a><p><b>(3) Signature</b>: <i>[const] </i><a href="class_Annotation.html">Annotation</a><b> transformed </b> (const <a href="class_ICplxTrans.html">ICplxTrans</a> t)</p><p><b>Description</b>: Transforms the ruler or marker with the given complex transformation</p><table class="layout-table"><tr><td><b>t</b>:</td><td>The magnifying transformation to apply</td></tr><tr><td><b>Returns</b>:</td><td>The transformed object (in this case an integer coordinate object)</td></tr></table><p><p></p><p>This method has been introduced in version 0.18.</p><p>Starting with version 0.25, all overloads all available as 'transform'.</p></p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-1006"></a><h3>transformed_cplx</h3></td><td style="padding-bottom: 16px"><a name="method104"></a><a name="m_transformed_cplx"></a><a name="k_106"></a><p><b>(1) Signature</b>: <i>[const] </i><a href="class_Annotation.html">Annotation</a><b> transformed_cplx </b> (const <a href="class_DCplxTrans.html">DCplxTrans</a> t)</p><p><b>Description</b>: Transforms the ruler or marker with the given complex transformation</p><table class="layout-table"><tr><td><b>t</b>:</td><td>The magnifying transformation to apply</td></tr><tr><td><b>Returns</b>:</td><td>The transformed object</td></tr></table><p>Use of this method is deprecated. Use transformed instead</p><p><p></p><p>Starting with version 0.25, all overloads all available as 'transform'.</p></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method105"></a><a name="m_transformed_cplx"></a><a name="k_107"></a><p><b>(2) Signature</b>: <i>[const] </i><a href="class_Annotation.html">Annotation</a><b> transformed_cplx </b> (const <a href="class_ICplxTrans.html">ICplxTrans</a> t)</p><p><b>Description</b>: Transforms the ruler or marker with the given complex transformation</p><table class="layout-table"><tr><td><b>t</b>:</td><td>The magnifying transformation to apply</td></tr><tr><td><b>Returns</b>:</td><td>The transformed object (in this case an integer coordinate object)</td></tr></table><p>Use of this method is deprecated. Use transformed instead</p><p><p></p><p>This method has been introduced in version 0.18.</p><p>Starting with version 0.25, all overloads all available as 'transform'.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-1025"></a><h3>unregister_templates</h3></td><td style="padding-bottom: 16px"><a name="method106"></a><a name="m_unregister_templates"></a><a name="k_108"></a><p><b>Signature</b>: <i>[static] </i>void <b> unregister_templates </b> (string category)</p><p><b>Description</b>: Unregisters the template or templates with the given category string globally</p><p><p></p><p>This method will remove all templates with the given category string. If the category string is empty, all templates are removed.</p><p>NOTE: this setting is persisted and the the application configuration is updated.</p><p>This method has been added in version 0.28.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-1030"></a><h3>xlabel_xalign</h3></td><td style="padding-bottom: 16px"><a name="method107"></a><a name="m_xlabel_xalign"></a><a name="k_109"></a><p><b>Signature</b>: <i>[const] </i>int <b> xlabel_xalign </b></p><p><b>Description</b>: Gets the horizontal alignment type of the x axis label</p><p><p>
|
| 245 |
+
See <a href="#m_xlabel_xalign=">xlabel_xalign=</a> for details.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'xlabel_xalign'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-1037"></a><h3>xlabel_xalign=</h3></td><td style="padding-bottom: 16px"><a name="method108"></a><a name="m_xlabel_xalign="></a><a name="k_110"></a><p><b>Signature</b>: void <b> xlabel_xalign= </b> (int align)</p><p><b>Description</b>: Sets the horizontal alignment type of the x axis label</p><p><p>
|
| 246 |
+
This method accepts one of the Align... constants.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'xlabel_xalign'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-1044"></a><h3>xlabel_yalign</h3></td><td style="padding-bottom: 16px"><a name="method109"></a><a name="m_xlabel_yalign"></a><a name="k_111"></a><p><b>Signature</b>: <i>[const] </i>int <b> xlabel_yalign </b></p><p><b>Description</b>: Gets the vertical alignment type of the x axis label</p><p><p>
|
| 247 |
+
See <a href="#m_xlabel_yalign=">xlabel_yalign=</a> for details.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'xlabel_yalign'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-1051"></a><h3>xlabel_yalign=</h3></td><td style="padding-bottom: 16px"><a name="method110"></a><a name="m_xlabel_yalign="></a><a name="k_112"></a><p><b>Signature</b>: void <b> xlabel_yalign= </b> (int align)</p><p><b>Description</b>: Sets the vertical alignment type of the x axis label</p><p><p>
|
| 248 |
+
This method accepts one of the Align... constants.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'xlabel_yalign'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-1058"></a><h3>ylabel_xalign</h3></td><td style="padding-bottom: 16px"><a name="method111"></a><a name="m_ylabel_xalign"></a><a name="k_113"></a><p><b>Signature</b>: <i>[const] </i>int <b> ylabel_xalign </b></p><p><b>Description</b>: Gets the horizontal alignment type of the y axis label</p><p><p>
|
| 249 |
+
See <a href="#m_ylabel_xalign=">ylabel_xalign=</a> for details.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'ylabel_xalign'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-1065"></a><h3>ylabel_xalign=</h3></td><td style="padding-bottom: 16px"><a name="method112"></a><a name="m_ylabel_xalign="></a><a name="k_114"></a><p><b>Signature</b>: void <b> ylabel_xalign= </b> (int align)</p><p><b>Description</b>: Sets the horizontal alignment type of the y axis label</p><p><p>
|
| 250 |
+
This method accepts one of the Align... constants.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'ylabel_xalign'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-1072"></a><h3>ylabel_yalign</h3></td><td style="padding-bottom: 16px"><a name="method113"></a><a name="m_ylabel_yalign"></a><a name="k_115"></a><p><b>Signature</b>: <i>[const] </i>int <b> ylabel_yalign </b></p><p><b>Description</b>: Gets the vertical alignment type of the y axis label</p><p><p>
|
| 251 |
+
See <a href="#m_ylabel_yalign=">ylabel_yalign=</a> for details.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'ylabel_yalign'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-1079"></a><h3>ylabel_yalign=</h3></td><td style="padding-bottom: 16px"><a name="method114"></a><a name="m_ylabel_yalign="></a><a name="k_116"></a><p><b>Signature</b>: void <b> ylabel_yalign= </b> (int align)</p><p><b>Description</b>: Sets the vertical alignment type of the y axis label</p><p><p>
|
| 252 |
+
This method accepts one of the Align... constants.</p><p>This method has been introduced in version 0.25</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'ylabel_yalign'. This is the setter.<br></p></td></tr></table></div>
|
| 253 |
+
</div>
|
| 254 |
+
</body>
|
| 255 |
+
</html>
|
| 256 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_Application.html
ADDED
|
@@ -0,0 +1,144 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class Application</p><h1>API reference - Class Application</h1><property name="module" value="lay"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_lay.html">lay</a></p><p><b>Description</b>: The application object</p><p><b>Class hierarchy</b>: Application » <a href="class_QApplication.html">QApplication</a> » <a href="class_QGuiApplication.html">QGuiApplication</a> » <a href="class_QCoreApplication.html">QCoreApplication</a> » <a href="class_QObject.html">QObject</a></p><ul><li><a href="#h2-12">Public methods</a></li><li><a href="#h2-65">Public static methods and constants</a></li><li><a href="#h2-70">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-75">Detailed description</a></li></ul><p></p><p>The application object is the main port from which to access all the internals of the application, in particular the main window.</p><a name="h2-12"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>Application ptr</td><td><b><a href="#method0">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method1">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method2">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method3">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method4">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method5">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method6">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method7">add_macro_category</a></b></td><td>(string name,<br>string description,<br>string[] folders)</td><td>Creates a new macro category</td></tr><tr class="row0"><td><i>[const]</i></td><td>string</td><td><b><a href="#method8">application_data_path</a></b></td><td></td><td>Returns the application's data path (where the configuration file is stored for example)</td></tr><tr class="row1"><td></td><td>string</td><td><b><a href="#method9">arch</a></b></td><td></td><td>Returns the architecture string</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method10">commit_config</a></b></td><td></td><td>Commits the configuration settings</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method12">execute</a></b></td><td></td><td>Executes the application's main loop</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method13">exit</a></b></td><td>(int result)</td><td>Ends the application with the given exit status</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method14">get_config</a></b></td><td>(string name)</td><td>Gets the value for a configuration parameter</td></tr><tr class="row0"><td><i>[const]</i></td><td>string[]</td><td><b><a href="#method15">get_config_names</a></b></td><td></td><td>Gets the configuration parameter names</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method16">inst_path</a></b></td><td></td><td>Returns the application's installation path (where the executable is located)</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method18">is_editable?</a></b></td><td></td><td>Returns true if the application is in editable mode</td></tr><tr class="row1"><td><i>[const]</i></td><td>string[]</td><td><b><a href="#method19">klayout_path</a></b></td><td></td><td>Returns the KLayout path (search path for KLayout components)</td></tr><tr class="row0"><td><i>[const]</i></td><td>MainWindow ptr</td><td><b><a href="#method20">main_window</a></b></td><td></td><td>Returns a reference to the main window</td></tr><tr class="row1"><td><i>[signal]</i></td><td>void</td><td><b><a href="#method21">on_salt_changed</a></b></td><td></td><td>This event is triggered when the package status changes.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method22">process_events</a></b></td><td></td><td>Processes pending events</td></tr><tr class="row1"><td></td><td>bool</td><td><b><a href="#method23">read_config</a></b></td><td>(string file_name)</td><td>Reads the configuration from a file</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method24">set_config</a></b></td><td>(string name,<br>string value)</td><td>Sets a configuration parameter with the given name to the given value</td></tr><tr class="row1"><td></td><td>string</td><td><b><a href="#method25">version</a></b></td><td></td><td>Returns the application's version string</td></tr><tr class="row0"><td></td><td>bool</td><td><b><a href="#method26">write_config</a></b></td><td>(string file_name)</td><td>Writes configuration to a file</td></tr></table><a name="h2-65"></a><h2>Public static methods and constants</h2><table><tr class="row0"><td></td><td>Application ptr</td><td><b><a href="#method17">instance</a></b></td><td></td><td>Return the singleton instance of the application</td></tr></table><a name="h2-70"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td></td><td>int</td><td><b><a href="#method11">exec</a></b></td><td></td><td>Use of this method is deprecated. Use execute instead</td></tr></table><a name="detailed"></a><a name="h2-75"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-76"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m__const_cast"></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Application.html">Application</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 120 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-82"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m__create"></a><a name="k_3"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 121 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-88"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m__destroy"></a><a name="k_4"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 122 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 123 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-95"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__destroyed?"></a><a name="k_5"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 124 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 125 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-102"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__is_const_object?"></a><a name="k_6"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 126 |
+
This method returns true, if self is a const reference.
|
| 127 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-109"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__manage"></a><a name="k_7"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 128 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-115"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__unmanage"></a><a name="k_8"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 129 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-121"></a><h3>add_macro_category</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m_add_macro_category"></a><a name="k_9"></a><p><b>Signature</b>: void <b> add_macro_category </b> (string name, string description, string[] folders)</p><p><b>Description</b>: Creates a new macro category</p><p><p>
|
| 130 |
+
Creating a new macro category is only possible during the autorun_early stage. The new macro category must correspond to an interpreter registered at the same stage.
|
| 131 |
+
This method has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-128"></a><h3>application_data_path</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_application_data_path"></a><a name="k_10"></a><p><b>Signature</b>: <i>[const] </i>string <b> application_data_path </b></p><p><b>Description</b>: Returns the application's data path (where the configuration file is stored for example)</p><p><p></p><p>This method has been added in version 0.22.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-133"></a><h3>arch</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_arch"></a><a name="k_11"></a><p><b>Signature</b>: string <b> arch </b></p><p><b>Description</b>: Returns the architecture string</p><p><p>
|
| 132 |
+
This method has been introduced in version 0.25.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-139"></a><h3>commit_config</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_commit_config"></a><a name="k_12"></a><p><b>Signature</b>: void <b> commit_config </b></p><p><b>Description</b>: Commits the configuration settings</p><p><p></p><p>Some configuration options are queued for performance reasons and become active only after 'commit_config' has been called. After a sequence of <a href="#m_set_config">set_config</a> calls, this method should be called to activate the settings made by these calls.</p><p>This method has been introduced in version 0.25.
|
| 133 |
+
</p></p></td></tr><tr class="bigrow1"><td><a name="h3-145"></a><h3>exec</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_exec"></a><a name="k_13"></a><p><b>Signature</b>: int <b> exec </b></p><p><b>Description</b>: Executes the application's main loop</p><p>Use of this method is deprecated. Use execute instead</p><p><p></p><p>This method must be called in order to execute the application in the main script if a script is provided.</p></p><p><b>Python specific notes: </b><br>This attribute is available as 'exec_' in Python.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-152"></a><h3>execute</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_execute"></a><a name="k_14"></a><p><b>Signature</b>: int <b> execute </b></p><p><b>Description</b>: Executes the application's main loop</p><p><p></p><p>This method must be called in order to execute the application in the main script if a script is provided.</p></p><p><b>Python specific notes: </b><br>This attribute is available as 'exec_' in Python.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-158"></a><h3>exit</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_exit"></a><a name="k_15"></a><p><b>Signature</b>: void <b> exit </b> (int result)</p><p><b>Description</b>: Ends the application with the given exit status</p><p><p></p><p>This method should be called instead of simply shutting down the process. It performs some important cleanup without which the process might crash. If the result code is 0 (success), the configuration file will be updated unless that has been disabled by the -nc command line switch.
|
| 134 |
+
This method has been added in version 0.22.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-164"></a><h3>get_config</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_get_config"></a><a name="k_16"></a><p><b>Signature</b>: <i>[const] </i>string <b> get_config </b> (string name)</p><p><b>Description</b>: Gets the value for a configuration parameter</p><table class="layout-table"><tr><td><b>name</b>:</td><td>The name of the configuration parameter whose value shall be obtained (a string)</td></tr><tr><td><b>Returns</b>:</td><td>The value of the parameter</td></tr></table><p><p></p><p>This method returns the value of the given configuration parameter. If the parameter is not known, an exception will be thrown. Use <a href="#m_get_config_names">get_config_names</a> to obtain a list of all configuration parameter names available.</p><p>Configuration parameters are always stored as strings. The actual format of this string is specific to the configuration parameter. The values delivered by this method correspond to the values stored in the configuration file </p></p></td></tr><tr class="bigrow1"><td><a name="h3-173"></a><h3>get_config_names</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_get_config_names"></a><a name="k_17"></a><p><b>Signature</b>: <i>[const] </i>string[] <b> get_config_names </b></p><p><b>Description</b>: Gets the configuration parameter names</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>A list of configuration parameter names</td></tr></table><p><p></p><p>This method returns the names of all known configuration parameters. These names can be used to get and set configuration parameter values.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-181"></a><h3>inst_path</h3></td><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_inst_path"></a><a name="k_18"></a><p><b>Signature</b>: <i>[const] </i>string <b> inst_path </b></p><p><b>Description</b>: Returns the application's installation path (where the executable is located)</p><p><p></p><p>This method has been added in version 0.18. Version 0.22 offers the method <a href="#m_klayout_path">klayout_path</a> which delivers all components of the search path.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-186"></a><h3>instance</h3></td><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_instance"></a><a name="k_19"></a><p><b>Signature</b>: <i>[static] </i><a href="class_Application.html">Application</a> ptr <b> instance </b></p><p><b>Description</b>: Return the singleton instance of the application</p><p><p></p><p>There is exactly one instance of the application. This instance can be obtained with this method.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-191"></a><h3>is_editable?</h3></td><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_is_editable?"></a><a name="k_20"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_editable? </b></p><p><b>Description</b>: Returns true if the application is in editable mode</p></td></tr><tr class="bigrow1"><td><a name="h3-195"></a><h3>klayout_path</h3></td><td style="padding-bottom: 16px"><a name="method19"></a><a name="m_klayout_path"></a><a name="k_21"></a><p><b>Signature</b>: <i>[const] </i>string[] <b> klayout_path </b></p><p><b>Description</b>: Returns the KLayout path (search path for KLayout components)</p><p><p></p><p>The result is an array containing the components of the path.</p><p>This method has been added in version 0.22.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-200"></a><h3>main_window</h3></td><td style="padding-bottom: 16px"><a name="method20"></a><a name="m_main_window"></a><a name="k_22"></a><p><b>Signature</b>: <i>[const] </i><a href="class_MainWindow.html">MainWindow</a> ptr <b> main_window </b></p><p><b>Description</b>: Returns a reference to the main window</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>A object reference to the main window object.</td></tr></table></td></tr><tr class="bigrow1"><td><a name="h3-207"></a><h3>on_salt_changed</h3></td><td style="padding-bottom: 16px"><a name="method21"></a><a name="m_on_salt_changed"></a><a name="k_23"></a><p><b>Signature</b>: <i>[signal] </i>void <b> on_salt_changed </b></p><p><b>Description</b>: This event is triggered when the package status changes.</p><p><p></p><p>Register to this event if you are interested in package changes - i.e. installation or removal of packages or package updates.</p><p>This event has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'on_salt_changed'. This is the getter.<br>The object exposes a writable attribute 'on_salt_changed'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-213"></a><h3>process_events</h3></td><td style="padding-bottom: 16px"><a name="method22"></a><a name="m_process_events"></a><a name="k_24"></a><p><b>Signature</b>: void <b> process_events </b></p><p><b>Description</b>: Processes pending events</p><p><p></p><p>This method processes pending events and dispatches them internally. Calling this method periodically during a long operation keeps the application 'alive'</p></p></td></tr><tr class="bigrow1"><td><a name="h3-218"></a><h3>read_config</h3></td><td style="padding-bottom: 16px"><a name="method23"></a><a name="m_read_config"></a><a name="k_25"></a><p><b>Signature</b>: bool <b> read_config </b> (string file_name)</p><p><b>Description</b>: Reads the configuration from a file</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>A value indicating whether the operation was successful</td></tr></table><p><p></p><p>This method silently does nothing, if the config file does not
|
| 135 |
+
exist. If it does and an error occurred, the error message is printed
|
| 136 |
+
on stderr. In both cases, false is returned.
|
| 137 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-229"></a><h3>set_config</h3></td><td style="padding-bottom: 16px"><a name="method24"></a><a name="m_set_config"></a><a name="k_26"></a><p><b>Signature</b>: void <b> set_config </b> (string name, string value)</p><p><b>Description</b>: Sets a configuration parameter with the given name to the given value</p><table class="layout-table"><tr><td><b>name</b>:</td><td>The name of the configuration parameter to set</td></tr><tr><td><b>value</b>:</td><td>The value to which to set the configuration parameter</td></tr></table><p><p></p><p>This method sets the configuration parameter with the given name to the given value. Values can only be strings. Numerical values have to be converted into strings first. The actual format of the value depends on the configuration parameter. The name must be one of the names returned by <a href="#m_get_config_names">get_config_names</a>.
|
| 138 |
+
It is possible to write an arbitrary name/value pair into the configuration database which then is written to the configuration file.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-239"></a><h3>version</h3></td><td style="padding-bottom: 16px"><a name="method25"></a><a name="m_version"></a><a name="k_27"></a><p><b>Signature</b>: string <b> version </b></p><p><b>Description</b>: Returns the application's version string</p></td></tr><tr class="bigrow0"><td><a name="h3-243"></a><h3>write_config</h3></td><td style="padding-bottom: 16px"><a name="method26"></a><a name="m_write_config"></a><a name="k_28"></a><p><b>Signature</b>: bool <b> write_config </b> (string file_name)</p><p><b>Description</b>: Writes configuration to a file</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>A value indicating whether the operation was successful</td></tr></table><p><p></p><p>If the configuration file cannot be written,
|
| 139 |
+
is returned but no exception is thrown.
|
| 140 |
+
</p></p></td></tr></table></div>
|
| 141 |
+
</div>
|
| 142 |
+
</body>
|
| 143 |
+
</html>
|
| 144 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_BitmapBuffer.html
ADDED
|
@@ -0,0 +1,145 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class BitmapBuffer</p><h1>API reference - Class BitmapBuffer</h1><property name="module" value="lay"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_lay.html">lay</a></p><p><b>Description</b>: A simplistic pixel buffer representing monochrome image</p><ul><li><a href="#h2-12">Public constructors</a></li><li><a href="#h2-17">Public methods</a></li><li><a href="#h2-60">Public static methods and constants</a></li><li><a href="#h2-69">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-80">Detailed description</a></li></ul><p></p><p>This object is mainly provided for offline rendering of layouts in Qt-less environments.
|
| 120 |
+
It supports a rectangular pixel space with color values encoded in single bits.</p><p>This class supports basic operations such as initialization, single-pixel access and I/O to PNG.</p><p>This class has been introduced in version 0.28.</p><a name="h2-12"></a><h2>Public constructors</h2><table><tr class="row0"><td>new BitmapBuffer ptr</td><td><b><a href="#method19">new</a></b></td><td>(unsigned int width,<br>unsigned int height)</td><td>Creates a pixel buffer object</td></tr></table><a name="h2-17"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method0">!=</a></b></td><td>(const BitmapBuffer other)</td><td>Returns a value indicating whether self is not identical to the other image</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method1">==</a></b></td><td>(const BitmapBuffer other)</td><td>Returns a value indicating whether self is identical to the other image</td></tr><tr class="row0"><td><i>[const]</i></td><td>BitmapBuffer ptr</td><td><b><a href="#method2">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method3">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method4">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method5">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method6">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method7">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method8">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method9">assign</a></b></td><td>(const BitmapBuffer other)</td><td>Assigns another object to self</td></tr><tr class="row0"><td><i>[const]</i></td><td>new BitmapBuffer ptr</td><td><b><a href="#method13">dup</a></b></td><td></td><td>Creates a copy of self</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method14">fill</a></b></td><td>(bool color)</td><td>Fills the pixel buffer with the given pixel value</td></tr><tr class="row0"><td><i>[const]</i></td><td>unsigned int</td><td><b><a href="#method17">height</a></b></td><td></td><td>Gets the height of the pixel buffer in pixels</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method20">pixel</a></b></td><td>(unsigned int x,<br>unsigned int y)</td><td>Gets the value of the pixel at position x, y</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method22">set_pixel</a></b></td><td>(unsigned int x,<br>unsigned int y,<br>bool c)</td><td>Sets the value of the pixel at position x, y</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method23">swap</a></b></td><td>(BitmapBuffer other)</td><td>Swaps data with another BitmapBuffer object</td></tr><tr class="row0"><td><i>[const]</i></td><td>bytes</td><td><b><a href="#method24">to_png_data</a></b></td><td></td><td>Converts the pixel buffer to a PNG byte stream</td></tr><tr class="row1"><td><i>[const]</i></td><td>QImage</td><td><b><a href="#method25">to_qimage</a></b></td><td></td><td>Converts the pixel buffer to a <a href="class_QImage.html">QImage</a> object</td></tr><tr class="row0"><td><i>[const]</i></td><td>unsigned int</td><td><b><a href="#method26">width</a></b></td><td></td><td>Gets the width of the pixel buffer in pixels</td></tr><tr class="row1"><td><i>[const]</i></td><td>void</td><td><b><a href="#method27">write_png</a></b></td><td>(string file)</td><td>Writes the pixel buffer to a PNG file</td></tr></table><a name="h2-60"></a><h2>Public static methods and constants</h2><table><tr class="row0"><td></td><td>BitmapBuffer</td><td><b><a href="#method15">from_png_data</a></b></td><td>(bytes data)</td><td>Reads the pixel buffer from a PNG byte stream</td></tr><tr class="row1"><td></td><td>BitmapBuffer</td><td><b><a href="#method16">from_qimage</a></b></td><td>(const QImage qimage)</td><td>Creates a pixel buffer object from a QImage object</td></tr><tr class="row0"><td></td><td>BitmapBuffer</td><td><b><a href="#method21">read_png</a></b></td><td>(string file)</td><td>Reads the pixel buffer from a PNG file</td></tr></table><a name="h2-69"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td></td><td>void</td><td><b><a href="#method10">create</a></b></td><td></td><td>Use of this method is deprecated. Use _create instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method11">destroy</a></b></td><td></td><td>Use of this method is deprecated. Use _destroy instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method12">destroyed?</a></b></td><td></td><td>Use of this method is deprecated. Use _destroyed? instead</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method18">is_const_object?</a></b></td><td></td><td>Use of this method is deprecated. Use _is_const_object? instead</td></tr></table><a name="detailed"></a><a name="h2-80"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-81"></a><h3>!=</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m_!="></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i>bool <b> != </b> (const <a href="class_BitmapBuffer.html">BitmapBuffer</a> other)</p><p><b>Description</b>: Returns a value indicating whether self is not identical to the other image</p></td></tr><tr class="bigrow1"><td><a name="h3-85"></a><h3>==</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m_=="></a><a name="k_3"></a><p><b>Signature</b>: <i>[const] </i>bool <b> == </b> (const <a href="class_BitmapBuffer.html">BitmapBuffer</a> other)</p><p><b>Description</b>: Returns a value indicating whether self is identical to the other image</p></td></tr><tr class="bigrow0"><td><a name="h3-89"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m__const_cast"></a><a name="k_4"></a><p><b>Signature</b>: <i>[const] </i><a href="class_BitmapBuffer.html">BitmapBuffer</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 121 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-95"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__create"></a><a name="k_5"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 122 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-101"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__destroy"></a><a name="k_6"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 123 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 124 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-108"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__destroyed?"></a><a name="k_7"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 125 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 126 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-115"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__is_const_object?"></a><a name="k_8"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 127 |
+
This method returns true, if self is a const reference.
|
| 128 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-122"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m__manage"></a><a name="k_9"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 129 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-128"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m__unmanage"></a><a name="k_10"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 130 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-134"></a><h3>assign</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_assign"></a><a name="k_11"></a><p><b>Signature</b>: void <b> assign </b> (const <a href="class_BitmapBuffer.html">BitmapBuffer</a> other)</p><p><b>Description</b>: Assigns another object to self</p></td></tr><tr class="bigrow0"><td><a name="h3-138"></a><h3>create</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_create"></a><a name="k_12"></a><p><b>Signature</b>: void <b> create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p>Use of this method is deprecated. Use _create instead</p><p><p>
|
| 131 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-145"></a><h3>destroy</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_destroy"></a><a name="k_13"></a><p><b>Signature</b>: void <b> destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p>Use of this method is deprecated. Use _destroy instead</p><p><p>
|
| 132 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 133 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-153"></a><h3>destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_destroyed?"></a><a name="k_14"></a><p><b>Signature</b>: <i>[const] </i>bool <b> destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p>Use of this method is deprecated. Use _destroyed? instead</p><p><p>
|
| 134 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 135 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-161"></a><h3>dup</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_dup"></a><a name="k_15"></a><p><b>Signature</b>: <i>[const] </i>new <a href="class_BitmapBuffer.html">BitmapBuffer</a> ptr <b> dup </b></p><p><b>Description</b>: Creates a copy of self</p><p><b>Python specific notes: </b><br>This method also implements '__copy__' and '__deepcopy__'.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-166"></a><h3>fill</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_fill"></a><a name="k_16"></a><p><b>Signature</b>: void <b> fill </b> (bool color)</p><p><b>Description</b>: Fills the pixel buffer with the given pixel value</p></td></tr><tr class="bigrow1"><td><a name="h3-170"></a><h3>from_png_data</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_from_png_data"></a><a name="k_17"></a><p><b>Signature</b>: <i>[static] </i><a href="class_BitmapBuffer.html">BitmapBuffer</a><b> from_png_data </b> (bytes data)</p><p><b>Description</b>: Reads the pixel buffer from a PNG byte stream</p><p><p>
|
| 136 |
+
This method may not be available if PNG support is not compiled into KLayout.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-176"></a><h3>from_qimage</h3></td><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_from_qimage"></a><a name="k_18"></a><p><b>Signature</b>: <i>[static] </i><a href="class_BitmapBuffer.html">BitmapBuffer</a><b> from_qimage </b> (const <a href="class_QImage.html">QImage</a> qimage)</p><p><b>Description</b>: Creates a pixel buffer object from a QImage object</p></td></tr><tr class="bigrow1"><td><a name="h3-180"></a><h3>height</h3></td><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_height"></a><a name="k_19"></a><p><b>Signature</b>: <i>[const] </i>unsigned int <b> height </b></p><p><b>Description</b>: Gets the height of the pixel buffer in pixels</p></td></tr><tr class="bigrow0"><td><a name="h3-184"></a><h3>is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_is_const_object?"></a><a name="k_20"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p>Use of this method is deprecated. Use _is_const_object? instead</p><p><p>
|
| 137 |
+
This method returns true, if self is a const reference.
|
| 138 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-192"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method19"></a><a name="m_new"></a><a name="k_21"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_BitmapBuffer.html">BitmapBuffer</a> ptr <b> new </b> (unsigned int width, unsigned int height)</p><p><b>Description</b>: Creates a pixel buffer object</p><table class="layout-table"><tr><td><b>width</b>:</td><td>The width in pixels</td></tr><tr><td><b>height</b>:</td><td>The height in pixels</td></tr></table><p><p></p><p>The pixels are basically uninitialized. You will need to use <a href="#m_fill">fill</a> to initialize them to a certain value.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-202"></a><h3>pixel</h3></td><td style="padding-bottom: 16px"><a name="method20"></a><a name="m_pixel"></a><a name="k_22"></a><p><b>Signature</b>: <i>[const] </i>bool <b> pixel </b> (unsigned int x, unsigned int y)</p><p><b>Description</b>: Gets the value of the pixel at position x, y</p></td></tr><tr class="bigrow1"><td><a name="h3-206"></a><h3>read_png</h3></td><td style="padding-bottom: 16px"><a name="method21"></a><a name="m_read_png"></a><a name="k_23"></a><p><b>Signature</b>: <i>[static] </i><a href="class_BitmapBuffer.html">BitmapBuffer</a><b> read_png </b> (string file)</p><p><b>Description</b>: Reads the pixel buffer from a PNG file</p><p><p>
|
| 139 |
+
This method may not be available if PNG support is not compiled into KLayout.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-212"></a><h3>set_pixel</h3></td><td style="padding-bottom: 16px"><a name="method22"></a><a name="m_set_pixel"></a><a name="k_24"></a><p><b>Signature</b>: void <b> set_pixel </b> (unsigned int x, unsigned int y, bool c)</p><p><b>Description</b>: Sets the value of the pixel at position x, y</p></td></tr><tr class="bigrow1"><td><a name="h3-216"></a><h3>swap</h3></td><td style="padding-bottom: 16px"><a name="method23"></a><a name="m_swap"></a><a name="k_25"></a><p><b>Signature</b>: void <b> swap </b> (<a href="class_BitmapBuffer.html">BitmapBuffer</a> other)</p><p><b>Description</b>: Swaps data with another BitmapBuffer object</p></td></tr><tr class="bigrow0"><td><a name="h3-220"></a><h3>to_png_data</h3></td><td style="padding-bottom: 16px"><a name="method24"></a><a name="m_to_png_data"></a><a name="k_26"></a><p><b>Signature</b>: <i>[const] </i>bytes <b> to_png_data </b></p><p><b>Description</b>: Converts the pixel buffer to a PNG byte stream</p><p><p>
|
| 140 |
+
This method may not be available if PNG support is not compiled into KLayout.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-226"></a><h3>to_qimage</h3></td><td style="padding-bottom: 16px"><a name="method25"></a><a name="m_to_qimage"></a><a name="k_27"></a><p><b>Signature</b>: <i>[const] </i><a href="class_QImage.html">QImage</a><b> to_qimage </b></p><p><b>Description</b>: Converts the pixel buffer to a <a href="class_QImage.html">QImage</a> object</p></td></tr><tr class="bigrow0"><td><a name="h3-230"></a><h3>width</h3></td><td style="padding-bottom: 16px"><a name="method26"></a><a name="m_width"></a><a name="k_28"></a><p><b>Signature</b>: <i>[const] </i>unsigned int <b> width </b></p><p><b>Description</b>: Gets the width of the pixel buffer in pixels</p></td></tr><tr class="bigrow1"><td><a name="h3-234"></a><h3>write_png</h3></td><td style="padding-bottom: 16px"><a name="method27"></a><a name="m_write_png"></a><a name="k_29"></a><p><b>Signature</b>: <i>[const] </i>void <b> write_png </b> (string file)</p><p><b>Description</b>: Writes the pixel buffer to a PNG file</p><p><p>
|
| 141 |
+
This method may not be available if PNG support is not compiled into KLayout.</p></p></td></tr></table></div>
|
| 142 |
+
</div>
|
| 143 |
+
</body>
|
| 144 |
+
</html>
|
| 145 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_Box.html
ADDED
|
@@ -0,0 +1,199 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class Box</p><h1>API reference - Class Box</h1><property name="module" value="db"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_db.html">db</a></p><p><b>Description</b>: A box class with integer coordinates</p><ul><li><a href="#h2-17">Public constructors</a></li><li><a href="#h2-32">Public methods</a></li><li><a href="#h2-153">Public static methods and constants</a></li><li><a href="#h2-160">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-173">Detailed description</a></li></ul><p></p><p>This object represents a box (a rectangular shape).</p><p>The definition of the attributes is: p1 is the lower left point, p2 the
|
| 120 |
+
upper right one. If a box is constructed from two points (or four coordinates), the
|
| 121 |
+
coordinates are sorted accordingly.</p><p>A box can be empty. An empty box represents no area
|
| 122 |
+
(not even a point). Empty boxes behave neutral with respect to most operations.
|
| 123 |
+
Empty boxes return true on <a href="#m_empty?">empty?</a>.</p><p>A box can be a point or a single
|
| 124 |
+
line. In this case, the area is zero but the box still
|
| 125 |
+
can overlap other boxes for example and it is not empty. </p><p>See <a href="../programming/database_api.html">The Database API</a> for more details about the database objects.</p><a name="h2-17"></a><h2>Public constructors</h2><table><tr class="row0"><td>new Box ptr</td><td><b><a href="#method48">new</a></b></td><td>(const DBox dbox)</td><td>Creates an integer coordinate box from a floating-point coordinate box</td></tr><tr class="row1"><td>new Box ptr</td><td><b><a href="#method49">new</a></b></td><td></td><td>Creates an empty (invalid) box</td></tr><tr class="row0"><td>new Box ptr</td><td><b><a href="#method50">new</a></b></td><td>(int w)</td><td>Creates a square with the given dimensions centered around the origin</td></tr><tr class="row1"><td>new Box ptr</td><td><b><a href="#method51">new</a></b></td><td>(int w,<br>int h)</td><td>Creates a rectangle with given width and height, centered around the origin</td></tr><tr class="row0"><td>new Box ptr</td><td><b><a href="#method52">new</a></b></td><td>(int left,<br>int bottom,<br>int right,<br>int top)</td><td>Creates a box with four coordinates</td></tr><tr class="row1"><td>new Box ptr</td><td><b><a href="#method53">new</a></b></td><td>(const Point lower_left,<br>const Point upper_right)</td><td>Creates a box from two points</td></tr></table><a name="h2-32"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method0">!=</a></b></td><td>(const Box box)</td><td>Returns true if this box is not equal to the other box</td></tr><tr class="row1"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method1">&</a></b></td><td>(const Box box)</td><td>Returns the intersection of this box with another box</td></tr><tr class="row0"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method2">*</a></b></td><td>(const Box box)</td><td>Returns the convolution product from this box with another box</td></tr><tr class="row1"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method3">*</a></b></td><td>(double scale_factor)</td><td>Returns the scaled box</td></tr><tr class="row0"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method4">+</a></b></td><td>(const Point point)</td><td>Joins box with a point</td></tr><tr class="row1"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method5">+</a></b></td><td>(const Box box)</td><td>Joins two boxes</td></tr><tr class="row0"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method6">-</a></b></td><td>(const Box box)</td><td>Subtraction of boxes</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method7"><</a></b></td><td>(const Box box)</td><td>Returns true if this box is 'less' than another box</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method8">==</a></b></td><td>(const Box box)</td><td>Returns true if this box is equal to the other box</td></tr><tr class="row1"><td><i>[const]</i></td><td>Box ptr</td><td><b><a href="#method9">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method10">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method11">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method12">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method13">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method14">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method15">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row0"><td><i>[const]</i></td><td>double</td><td><b><a href="#method16">area</a></b></td><td></td><td>Computes the box area</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method17">assign</a></b></td><td>(const Box other)</td><td>Assigns another object to self</td></tr><tr class="row0"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method18">bbox</a></b></td><td></td><td>Returns the bounding box</td></tr><tr class="row1"><td><i>[const]</i></td><td>int</td><td><b><a href="#method19">bottom</a></b></td><td></td><td>Gets the bottom coordinate of the box</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method20">bottom=</a></b></td><td>(int c)</td><td>Sets the bottom coordinate of the box</td></tr><tr class="row1"><td><i>[const]</i></td><td>Point</td><td><b><a href="#method21">center</a></b></td><td></td><td>Gets the center of the box</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method22">contains?</a></b></td><td>(int x,<br>int y)</td><td>Returns true if the box contains the given point</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method23">contains?</a></b></td><td>(const Point point)</td><td>Returns true if the box contains the given point</td></tr><tr class="row0"><td><i>[const]</i></td><td>new Box ptr</td><td><b><a href="#method27">dup</a></b></td><td></td><td>Creates a copy of self</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method28">empty?</a></b></td><td></td><td>Returns a value indicating whether the box is empty</td></tr><tr class="row0"><td></td><td>Box</td><td><b><a href="#method29">enlarge</a></b></td><td>(int dx,<br>int dy)</td><td>Enlarges the box by a certain amount.</td></tr><tr class="row1"><td></td><td>Box</td><td><b><a href="#method30">enlarge</a></b></td><td>(int d)</td><td>Enlarges the box by a certain amount on all sides.</td></tr><tr class="row0"><td></td><td>Box</td><td><b><a href="#method31">enlarge</a></b></td><td>(const Vector enlargement)</td><td>Enlarges the box by a certain amount.</td></tr><tr class="row1"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method32">enlarged</a></b></td><td>(int dx,<br>int dy)</td><td>Enlarges the box by a certain amount.</td></tr><tr class="row0"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method33">enlarged</a></b></td><td>(int d)</td><td>Enlarges the box by a certain amount on all sides.</td></tr><tr class="row1"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method34">enlarged</a></b></td><td>(const Vector enlargement)</td><td>Returns the enlarged box.</td></tr><tr class="row0"><td><i>[const]</i></td><td>unsigned long</td><td><b><a href="#method37">hash</a></b></td><td></td><td>Computes a hash value</td></tr><tr class="row1"><td><i>[const]</i></td><td>unsigned int</td><td><b><a href="#method38">height</a></b></td><td></td><td>Gets the height of the box</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method39">inside?</a></b></td><td>(const Box box)</td><td>Tests if this box is inside the argument box</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method41">is_point?</a></b></td><td></td><td>Returns true, if the box is a single point</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method42">left</a></b></td><td></td><td>Gets the left coordinate of the box</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method43">left=</a></b></td><td>(int c)</td><td>Sets the left coordinate of the box</td></tr><tr class="row0"><td></td><td>Box</td><td><b><a href="#method44">move</a></b></td><td>(int dx,<br>int dy)</td><td>Moves the box by a certain distance</td></tr><tr class="row1"><td></td><td>Box</td><td><b><a href="#method45">move</a></b></td><td>(const Vector distance)</td><td>Moves the box by a certain distance</td></tr><tr class="row0"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method46">moved</a></b></td><td>(int dx,<br>int dy)</td><td>Moves the box by a certain distance</td></tr><tr class="row1"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method47">moved</a></b></td><td>(const Vector distance)</td><td>Returns the box moved by a certain distance</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method54">overlaps?</a></b></td><td>(const Box box)</td><td>Tests if this box overlaps the argument box</td></tr><tr class="row1"><td><i>[const]</i></td><td>Point</td><td><b><a href="#method55">p1</a></b></td><td></td><td>Gets the lower left point of the box</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method56">p1=</a></b></td><td>(const Point p)</td><td>Sets the lower left point of the box</td></tr><tr class="row1"><td><i>[const]</i></td><td>Point</td><td><b><a href="#method57">p2</a></b></td><td></td><td>Gets the upper right point of the box</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method58">p2=</a></b></td><td>(const Point p)</td><td>Sets the upper right point of the box</td></tr><tr class="row1"><td><i>[const]</i></td><td>unsigned long</td><td><b><a href="#method59">perimeter</a></b></td><td></td><td>Returns the perimeter of the box</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method60">right</a></b></td><td></td><td>Gets the right coordinate of the box</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method61">right=</a></b></td><td>(int c)</td><td>Sets the right coordinate of the box</td></tr><tr class="row0"><td><i>[const]</i></td><td>DBox</td><td><b><a href="#method62">to_dtype</a></b></td><td>(double dbu = 1)</td><td>Converts the box to a floating-point coordinate box</td></tr><tr class="row1"><td><i>[const]</i></td><td>string</td><td><b><a href="#method63">to_s</a></b></td><td>(double dbu = 0)</td><td>Returns a string representing this box</td></tr><tr class="row0"><td><i>[const]</i></td><td>int</td><td><b><a href="#method64">top</a></b></td><td></td><td>Gets the top coordinate of the box</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method65">top=</a></b></td><td>(int c)</td><td>Sets the top coordinate of the box</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method66">touches?</a></b></td><td>(const Box box)</td><td>Tests if this box touches the argument box</td></tr><tr class="row1"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method67">transformed</a></b></td><td>(const ICplxTrans t)</td><td>Transforms the box with the given complex transformation</td></tr><tr class="row0"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method68">transformed</a></b></td><td>(const Trans t)</td><td>Returns the box transformed with the given simple transformation</td></tr><tr class="row1"><td><i>[const]</i></td><td>DBox</td><td><b><a href="#method69">transformed</a></b></td><td>(const CplxTrans t)</td><td>Returns the box transformed with the given complex transformation</td></tr><tr class="row0"><td><i>[const]</i></td><td>unsigned int</td><td><b><a href="#method70">width</a></b></td><td></td><td>Gets the width of the box</td></tr></table><a name="h2-153"></a><h2>Public static methods and constants</h2><table><tr class="row0"><td></td><td>new Box ptr</td><td><b><a href="#method36">from_s</a></b></td><td>(string s)</td><td>Creates a box object from a string</td></tr><tr class="row1"><td></td><td>Box</td><td><b><a href="#method71">world</a></b></td><td></td><td>Gets the 'world' box</td></tr></table><a name="h2-160"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td></td><td>void</td><td><b><a href="#method24">create</a></b></td><td></td><td>Use of this method is deprecated. Use _create instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method25">destroy</a></b></td><td></td><td>Use of this method is deprecated. Use _destroy instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method26">destroyed?</a></b></td><td></td><td>Use of this method is deprecated. Use _destroyed? instead</td></tr><tr class="row1"><td><i>[static]</i></td><td>new Box ptr</td><td><b><a href="#method35">from_dbox</a></b></td><td>(const DBox dbox)</td><td>Use of this method is deprecated. Use new instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method40">is_const_object?</a></b></td><td></td><td>Use of this method is deprecated. Use _is_const_object? instead</td></tr></table><a name="detailed"></a><a name="h2-173"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-174"></a><h3>!=</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m_!="></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i>bool <b> != </b> (const <a href="class_Box.html">Box</a> box)</p><p><b>Description</b>: Returns true if this box is not equal to the other box</p><p><p>
|
| 126 |
+
Returns true, if this box and the given box are not equal </p></p></td></tr><tr class="bigrow1"><td><a name="h3-180"></a><h3>&</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m_&"></a><a name="k_3"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> & </b> (const <a href="class_Box.html">Box</a> box)</p><p><b>Description</b>: Returns the intersection of this box with another box</p><table class="layout-table"><tr><td><b>box</b>:</td><td>The box to take the intersection with</td></tr><tr><td><b>Returns</b>:</td><td>The intersection box</td></tr></table><p><p></p><p>The intersection of two boxes is the largest
|
| 127 |
+
box common to both boxes. The intersection may be
|
| 128 |
+
empty if both boxes to not touch. If the boxes do
|
| 129 |
+
not overlap but touch the result may be a single
|
| 130 |
+
line or point with an area of zero. Overwrites this box
|
| 131 |
+
with the result.</p></p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-194"></a><h3>*</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m_*"></a><a name="k_4"></a><p><b>(1) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> * </b> (const <a href="class_Box.html">Box</a> box)</p><p><b>Description</b>: Returns the convolution product from this box with another box</p><table class="layout-table"><tr><td><b>box</b>:</td><td>The box to convolve with this box.</td></tr><tr><td><b>Returns</b>:</td><td>The convolved box</td></tr></table><p><p></p><p>The * operator convolves the firstbox with the one given as
|
| 132 |
+
the second argument. The box resulting from "convolution" is the
|
| 133 |
+
outer boundary of the union set formed by placing
|
| 134 |
+
the second box at every point of the first. In other words,
|
| 135 |
+
the returned box of (p1,p2)*(q1,q2) is (p1+q1,p2+q2).</p></p><p><b>Python specific notes: </b><br>This method also implements '__rmul__'.<br></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method3"></a><a name="m_*"></a><a name="k_5"></a><p><b>(2) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> * </b> (double scale_factor)</p><p><b>Description</b>: Returns the scaled box</p><table class="layout-table"><tr><td><b>scale_factor</b>:</td><td>The scaling factor</td></tr><tr><td><b>Returns</b>:</td><td>The scaled box</td></tr></table><p><p></p><p>The * operator scales the box with the given factor and returns the result.</p><p>This method has been introduced in version 0.22.</p></p><p><b>Python specific notes: </b><br>This method also implements '__rmul__'.<br></p></td></tr><tr class="bigrow1"><td rowspan="2"><a name="h3-217"></a><h3>+</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m_+"></a><a name="k_6"></a><p><b>(1) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> + </b> (const <a href="class_Point.html">Point</a> point)</p><p><b>Description</b>: Joins box with a point</p><table class="layout-table"><tr><td><b>point</b>:</td><td>The point to join with this box.</td></tr><tr><td><b>Returns</b>:</td><td>The box joined with the point</td></tr></table><p><p></p><p>The + operator joins a point with the box. The resulting box will enclose both the original box and the point.</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method5"></a><a name="m_+"></a><a name="k_7"></a><p><b>(2) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> + </b> (const <a href="class_Box.html">Box</a> box)</p><p><b>Description</b>: Joins two boxes</p><table class="layout-table"><tr><td><b>box</b>:</td><td>The box to join with this box.</td></tr><tr><td><b>Returns</b>:</td><td>The joined box</td></tr></table><p><p></p><p>The + operator joins the first box with the one given as
|
| 136 |
+
the second argument. Joining constructs a box that encloses
|
| 137 |
+
both boxes given. Empty boxes are neutral: they do not
|
| 138 |
+
change another box when joining. Overwrites this box
|
| 139 |
+
with the result.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-238"></a><h3>-</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m_-"></a><a name="k_8"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> - </b> (const <a href="class_Box.html">Box</a> box)</p><p><b>Description</b>: Subtraction of boxes</p><table class="layout-table"><tr><td><b>box</b>:</td><td>The box to subtract from this box.</td></tr><tr><td><b>Returns</b>:</td><td>The result box</td></tr></table><p><p></p><p>The - operator subtracts the argument box from self.
|
| 140 |
+
This will return the bounding box of the are covered by self, but not by argument box. Subtracting a box from itself will render an empty box. Subtracting another box from self will modify the first box only if the argument box covers one side entirely.</p><p>This feature has been introduced in version 0.29.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-248"></a><h3><</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m_<"></a><a name="k_9"></a><p><b>Signature</b>: <i>[const] </i>bool <b> < </b> (const <a href="class_Box.html">Box</a> box)</p><p><b>Description</b>: Returns true if this box is 'less' than another box</p><p><p>
|
| 141 |
+
Returns true, if this box is 'less' with respect to first and second point (in this order)</p></p></td></tr><tr class="bigrow0"><td><a name="h3-254"></a><h3>==</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_=="></a><a name="k_10"></a><p><b>Signature</b>: <i>[const] </i>bool <b> == </b> (const <a href="class_Box.html">Box</a> box)</p><p><b>Description</b>: Returns true if this box is equal to the other box</p><p><p>
|
| 142 |
+
Returns true, if this box and the given box are equal </p></p></td></tr><tr class="bigrow1"><td><a name="h3-260"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m__const_cast"></a><a name="k_11"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 143 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-266"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m__create"></a><a name="k_12"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 144 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-272"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m__destroy"></a><a name="k_13"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 145 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 146 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-279"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m__destroyed?"></a><a name="k_14"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 147 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 148 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-286"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m__is_const_object?"></a><a name="k_15"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 149 |
+
This method returns true, if self is a const reference.
|
| 150 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-293"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m__manage"></a><a name="k_16"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 151 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-299"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m__unmanage"></a><a name="k_17"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 152 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-305"></a><h3>area</h3></td><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_area"></a><a name="k_18"></a><p><b>Signature</b>: <i>[const] </i>double <b> area </b></p><p><b>Description</b>: Computes the box area</p><p><p></p><p>Returns the box area or 0 if the box is empty</p></p></td></tr><tr class="bigrow1"><td><a name="h3-310"></a><h3>assign</h3></td><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_assign"></a><a name="k_19"></a><p><b>Signature</b>: void <b> assign </b> (const <a href="class_Box.html">Box</a> other)</p><p><b>Description</b>: Assigns another object to self</p></td></tr><tr class="bigrow0"><td><a name="h3-314"></a><h3>bbox</h3></td><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_bbox"></a><a name="k_20"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> bbox </b></p><p><b>Description</b>: Returns the bounding box</p><p><p>
|
| 153 |
+
This method is provided for consistency of the shape API is returns the box itself.</p><p>This method has been introduced in version 0.27.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-320"></a><h3>bottom</h3></td><td style="padding-bottom: 16px"><a name="method19"></a><a name="m_bottom"></a><a name="k_21"></a><p><b>Signature</b>: <i>[const] </i>int <b> bottom </b></p><p><b>Description</b>: Gets the bottom coordinate of the box</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'bottom'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-325"></a><h3>bottom=</h3></td><td style="padding-bottom: 16px"><a name="method20"></a><a name="m_bottom="></a><a name="k_22"></a><p><b>Signature</b>: void <b> bottom= </b> (int c)</p><p><b>Description</b>: Sets the bottom coordinate of the box</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'bottom'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-330"></a><h3>center</h3></td><td style="padding-bottom: 16px"><a name="method21"></a><a name="m_center"></a><a name="k_23"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Point.html">Point</a><b> center </b></p><p><b>Description</b>: Gets the center of the box</p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-334"></a><h3>contains?</h3></td><td style="padding-bottom: 16px"><a name="method22"></a><a name="m_contains?"></a><a name="k_24"></a><p><b>(1) Signature</b>: <i>[const] </i>bool <b> contains? </b> (int x, int y)</p><p><b>Description</b>: Returns true if the box contains the given point</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>true if the point is inside the box.</td></tr></table><p><p></p><p>Tests whether a point (x, y) is inside the box.
|
| 154 |
+
It also returns true if the point is exactly on the box contour.</p></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method23"></a><a name="m_contains?"></a><a name="k_25"></a><p><b>(2) Signature</b>: <i>[const] </i>bool <b> contains? </b> (const <a href="class_Point.html">Point</a> point)</p><p><b>Description</b>: Returns true if the box contains the given point</p><table class="layout-table"><tr><td><b>p</b>:</td><td>The point to test against.</td></tr><tr><td><b>Returns</b>:</td><td>true if the point is inside the box.</td></tr></table><p><p></p><p>Tests whether a point is inside the box.
|
| 155 |
+
It also returns true if the point is exactly on the box contour.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-352"></a><h3>create</h3></td><td style="padding-bottom: 16px"><a name="method24"></a><a name="m_create"></a><a name="k_26"></a><p><b>Signature</b>: void <b> create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p>Use of this method is deprecated. Use _create instead</p><p><p>
|
| 156 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-359"></a><h3>destroy</h3></td><td style="padding-bottom: 16px"><a name="method25"></a><a name="m_destroy"></a><a name="k_27"></a><p><b>Signature</b>: void <b> destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p>Use of this method is deprecated. Use _destroy instead</p><p><p>
|
| 157 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 158 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-367"></a><h3>destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method26"></a><a name="m_destroyed?"></a><a name="k_28"></a><p><b>Signature</b>: <i>[const] </i>bool <b> destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p>Use of this method is deprecated. Use _destroyed? instead</p><p><p>
|
| 159 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 160 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-375"></a><h3>dup</h3></td><td style="padding-bottom: 16px"><a name="method27"></a><a name="m_dup"></a><a name="k_29"></a><p><b>Signature</b>: <i>[const] </i>new <a href="class_Box.html">Box</a> ptr <b> dup </b></p><p><b>Description</b>: Creates a copy of self</p><p><b>Python specific notes: </b><br>This method also implements '__copy__' and '__deepcopy__'.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-380"></a><h3>empty?</h3></td><td style="padding-bottom: 16px"><a name="method28"></a><a name="m_empty?"></a><a name="k_30"></a><p><b>Signature</b>: <i>[const] </i>bool <b> empty? </b></p><p><b>Description</b>: Returns a value indicating whether the box is empty</p><p><p></p><p>An empty box may be created with the default constructor for example. Such a box is neutral when combining it with other boxes and renders empty boxes if used in box intersections and false in geometrical relationship tests. </p></p></td></tr><tr class="bigrow0"><td rowspan="3"><a name="h3-385"></a><h3>enlarge</h3></td><td style="padding-bottom: 16px"><a name="method29"></a><a name="m_enlarge"></a><a name="k_31"></a><p><b>(1) Signature</b>: <a href="class_Box.html">Box</a><b> enlarge </b> (int dx, int dy)</p><p><b>Description</b>: Enlarges the box by a certain amount.</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>A reference to this box.</td></tr></table><p><p></p><p>This is a convenience method which takes two values instead of a Vector object.
|
| 161 |
+
This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method30"></a><a name="m_enlarge"></a><a name="k_32"></a><p><b>(2) Signature</b>: <a href="class_Box.html">Box</a><b> enlarge </b> (int d)</p><p><b>Description</b>: Enlarges the box by a certain amount on all sides.</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>A reference to this box.</td></tr></table><p><p></p><p>This is a convenience method which takes one values instead of two values. It will apply the given enlargement in both directions.
|
| 162 |
+
This method has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method31"></a><a name="m_enlarge"></a><a name="k_33"></a><p><b>(3) Signature</b>: <a href="class_Box.html">Box</a><b> enlarge </b> (const <a href="class_Vector.html">Vector</a> enlargement)</p><p><b>Description</b>: Enlarges the box by a certain amount.</p><table class="layout-table"><tr><td><b>enlargement</b>:</td><td>The grow or shrink amount in x and y direction</td></tr><tr><td><b>Returns</b>:</td><td>A reference to this box.</td></tr></table><p><p></p><p>Enlarges the box by x and y value specified in the vector
|
| 163 |
+
passed. Positive values with grow the box, negative ones
|
| 164 |
+
will shrink the box. The result may be an empty box if the
|
| 165 |
+
box disappears. The amount specifies the grow or shrink
|
| 166 |
+
per edge. The width and height will change by twice the
|
| 167 |
+
amount.
|
| 168 |
+
Does not check for coordinate
|
| 169 |
+
overflows.</p></p></td></tr><tr class="bigrow1"><td rowspan="3"><a name="h3-417"></a><h3>enlarged</h3></td><td style="padding-bottom: 16px"><a name="method32"></a><a name="m_enlarged"></a><a name="k_34"></a><p><b>(1) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> enlarged </b> (int dx, int dy)</p><p><b>Description</b>: Enlarges the box by a certain amount.</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The enlarged box.</td></tr></table><p><p></p><p>This is a convenience method which takes two values instead of a Vector object.
|
| 170 |
+
This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method33"></a><a name="m_enlarged"></a><a name="k_35"></a><p><b>(2) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> enlarged </b> (int d)</p><p><b>Description</b>: Enlarges the box by a certain amount on all sides.</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The enlarged box.</td></tr></table><p><p></p><p>This is a convenience method which takes one values instead of two values. It will apply the given enlargement in both directions.
|
| 171 |
+
This method has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method34"></a><a name="m_enlarged"></a><a name="k_36"></a><p><b>(3) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> enlarged </b> (const <a href="class_Vector.html">Vector</a> enlargement)</p><p><b>Description</b>: Returns the enlarged box.</p><table class="layout-table"><tr><td><b>enlargement</b>:</td><td>The grow or shrink amount in x and y direction</td></tr><tr><td><b>Returns</b>:</td><td>The enlarged box.</td></tr></table><p><p></p><p>Enlarges the box by x and y value specified in the vector
|
| 172 |
+
passed. Positive values with grow the box, negative ones
|
| 173 |
+
will shrink the box. The result may be an empty box if the
|
| 174 |
+
box disappears. The amount specifies the grow or shrink
|
| 175 |
+
per edge. The width and height will change by twice the
|
| 176 |
+
amount.
|
| 177 |
+
Does not modify this box. Does not check for coordinate
|
| 178 |
+
overflows.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-449"></a><h3>from_dbox</h3></td><td style="padding-bottom: 16px"><a name="method35"></a><a name="m_from_dbox"></a><a name="k_37"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_Box.html">Box</a> ptr <b> from_dbox </b> (const <a href="class_DBox.html">DBox</a> dbox)</p><p><b>Description</b>: Creates an integer coordinate box from a floating-point coordinate box</p><p>Use of this method is deprecated. Use new instead</p><p><p></p><p>This constructor has been introduced in version 0.25 and replaces the previous static method 'from_dbox'.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-456"></a><h3>from_s</h3></td><td style="padding-bottom: 16px"><a name="method36"></a><a name="m_from_s"></a><a name="k_38"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_Box.html">Box</a> ptr <b> from_s </b> (string s)</p><p><b>Description</b>: Creates a box object from a string</p><p><p>
|
| 179 |
+
Creates the object from a string representation (as returned by <a href="#m_to_s">to_s</a>)</p><p>This method has been added in version 0.23.
|
| 180 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-463"></a><h3>hash</h3></td><td style="padding-bottom: 16px"><a name="method37"></a><a name="m_hash"></a><a name="k_39"></a><p><b>Signature</b>: <i>[const] </i>unsigned long <b> hash </b></p><p><b>Description</b>: Computes a hash value</p><p><p>
|
| 181 |
+
Returns a hash value for the given box. This method enables boxes as hash keys.</p><p>This method has been introduced in version 0.25.
|
| 182 |
+
</p></p><p><b>Python specific notes: </b><br>This method is also available as 'hash(object)'.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-471"></a><h3>height</h3></td><td style="padding-bottom: 16px"><a name="method38"></a><a name="m_height"></a><a name="k_40"></a><p><b>Signature</b>: <i>[const] </i>unsigned int <b> height </b></p><p><b>Description</b>: Gets the height of the box</p></td></tr><tr class="bigrow0"><td><a name="h3-475"></a><h3>inside?</h3></td><td style="padding-bottom: 16px"><a name="method39"></a><a name="m_inside?"></a><a name="k_41"></a><p><b>Signature</b>: <i>[const] </i>bool <b> inside? </b> (const <a href="class_Box.html">Box</a> box)</p><p><b>Description</b>: Tests if this box is inside the argument box</p><p><p></p><p>Returns true, if this box is inside the given box, i.e. the box intersection renders this box</p></p></td></tr><tr class="bigrow1"><td><a name="h3-480"></a><h3>is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method40"></a><a name="m_is_const_object?"></a><a name="k_42"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p>Use of this method is deprecated. Use _is_const_object? instead</p><p><p>
|
| 183 |
+
This method returns true, if self is a const reference.
|
| 184 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-488"></a><h3>is_point?</h3></td><td style="padding-bottom: 16px"><a name="method41"></a><a name="m_is_point?"></a><a name="k_43"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_point? </b></p><p><b>Description</b>: Returns true, if the box is a single point</p></td></tr><tr class="bigrow1"><td><a name="h3-492"></a><h3>left</h3></td><td style="padding-bottom: 16px"><a name="method42"></a><a name="m_left"></a><a name="k_44"></a><p><b>Signature</b>: <i>[const] </i>int <b> left </b></p><p><b>Description</b>: Gets the left coordinate of the box</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'left'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-497"></a><h3>left=</h3></td><td style="padding-bottom: 16px"><a name="method43"></a><a name="m_left="></a><a name="k_45"></a><p><b>Signature</b>: void <b> left= </b> (int c)</p><p><b>Description</b>: Sets the left coordinate of the box</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'left'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td rowspan="2"><a name="h3-502"></a><h3>move</h3></td><td style="padding-bottom: 16px"><a name="method44"></a><a name="m_move"></a><a name="k_46"></a><p><b>(1) Signature</b>: <a href="class_Box.html">Box</a><b> move </b> (int dx, int dy)</p><p><b>Description</b>: Moves the box by a certain distance</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>A reference to this box.</td></tr></table><p><p></p><p>This is a convenience method which takes two values instead of a Point object.
|
| 185 |
+
This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method45"></a><a name="m_move"></a><a name="k_47"></a><p><b>(2) Signature</b>: <a href="class_Box.html">Box</a><b> move </b> (const <a href="class_Vector.html">Vector</a> distance)</p><p><b>Description</b>: Moves the box by a certain distance</p><table class="layout-table"><tr><td><b>distance</b>:</td><td>The offset to move the box.</td></tr><tr><td><b>Returns</b>:</td><td>A reference to this box.</td></tr></table><p><p></p><p>Moves the box by a given offset and returns the moved
|
| 186 |
+
box. Does not check for coordinate overflows.</p></p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-520"></a><h3>moved</h3></td><td style="padding-bottom: 16px"><a name="method46"></a><a name="m_moved"></a><a name="k_48"></a><p><b>(1) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> moved </b> (int dx, int dy)</p><p><b>Description</b>: Moves the box by a certain distance</p><table class="layout-table"><tr><td><b>Returns</b>:</td><td>The moved box.</td></tr></table><p><p></p><p>This is a convenience method which takes two values instead of a Point object.
|
| 187 |
+
This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method47"></a><a name="m_moved"></a><a name="k_49"></a><p><b>(2) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> moved </b> (const <a href="class_Vector.html">Vector</a> distance)</p><p><b>Description</b>: Returns the box moved by a certain distance</p><table class="layout-table"><tr><td><b>distance</b>:</td><td>The offset to move the box.</td></tr><tr><td><b>Returns</b>:</td><td>The moved box.</td></tr></table><p><p></p><p>Moves the box by a given offset and returns the moved
|
| 188 |
+
box. Does not modify this box. Does not check for coordinate
|
| 189 |
+
overflows.</p></p></td></tr><tr class="bigrow1"><td rowspan="6"><a name="h3-539"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method48"></a><a name="m_new"></a><a name="k_50"></a><p><b>(1) Signature</b>: <i>[static] </i>new <a href="class_Box.html">Box</a> ptr <b> new </b> (const <a href="class_DBox.html">DBox</a> dbox)</p><p><b>Description</b>: Creates an integer coordinate box from a floating-point coordinate box</p><p><p></p><p>This constructor has been introduced in version 0.25 and replaces the previous static method 'from_dbox'.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method49"></a><a name="m_new"></a><a name="k_51"></a><p><b>(2) Signature</b>: <i>[static] </i>new <a href="class_Box.html">Box</a> ptr <b> new </b></p><p><b>Description</b>: Creates an empty (invalid) box</p><p><p></p><p>Empty boxes don't modify a box when joined with it. The intersection between an empty and any other box is also an empty box. The width, height, p1 and p2 attributes of an empty box are undefined. Use <a href="#m_empty?">empty?</a> to get a value indicating whether the box is empty.
|
| 190 |
+
</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method50"></a><a name="m_new"></a><a name="k_52"></a><p><b>(3) Signature</b>: <i>[static] </i>new <a href="class_Box.html">Box</a> ptr <b> new </b> (int w)</p><p><b>Description</b>: Creates a square with the given dimensions centered around the origin</p><p><p></p><p>Note that for integer-unit boxes, the dimension has to be an even number to avoid rounding.</p><p>This convenience constructor has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method51"></a><a name="m_new"></a><a name="k_53"></a><p><b>(4) Signature</b>: <i>[static] </i>new <a href="class_Box.html">Box</a> ptr <b> new </b> (int w, int h)</p><p><b>Description</b>: Creates a rectangle with given width and height, centered around the origin</p><p><p></p><p>Note that for integer-unit boxes, the dimensions have to be an even number to avoid rounding.</p><p>This convenience constructor has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method52"></a><a name="m_new"></a><a name="k_54"></a><p><b>(5) Signature</b>: <i>[static] </i>new <a href="class_Box.html">Box</a> ptr <b> new </b> (int left, int bottom, int right, int top)</p><p><b>Description</b>: Creates a box with four coordinates</p><p><p></p><p>Four coordinates are given to create a new box. If the coordinates are not provided in the correct order (i.e. right < left), these are swapped.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method53"></a><a name="m_new"></a><a name="k_55"></a><p><b>(6) Signature</b>: <i>[static] </i>new <a href="class_Box.html">Box</a> ptr <b> new </b> (const <a href="class_Point.html">Point</a> lower_left, const <a href="class_Point.html">Point</a> upper_right)</p><p><b>Description</b>: Creates a box from two points</p><p><p></p><p>Two points are given to create a new box. If the coordinates are not provided in the correct order (i.e. right < left), these are swapped.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-571"></a><h3>overlaps?</h3></td><td style="padding-bottom: 16px"><a name="method54"></a><a name="m_overlaps?"></a><a name="k_56"></a><p><b>Signature</b>: <i>[const] </i>bool <b> overlaps? </b> (const <a href="class_Box.html">Box</a> box)</p><p><b>Description</b>: Tests if this box overlaps the argument box</p><p><p></p><p>Returns true, if the intersection box of this box with the argument box exists and has a non-vanishing area</p></p></td></tr><tr class="bigrow1"><td><a name="h3-576"></a><h3>p1</h3></td><td style="padding-bottom: 16px"><a name="method55"></a><a name="m_p1"></a><a name="k_57"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Point.html">Point</a><b> p1 </b></p><p><b>Description</b>: Gets the lower left point of the box</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'p1'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-581"></a><h3>p1=</h3></td><td style="padding-bottom: 16px"><a name="method56"></a><a name="m_p1="></a><a name="k_58"></a><p><b>Signature</b>: void <b> p1= </b> (const <a href="class_Point.html">Point</a> p)</p><p><b>Description</b>: Sets the lower left point of the box</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'p1'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-586"></a><h3>p2</h3></td><td style="padding-bottom: 16px"><a name="method57"></a><a name="m_p2"></a><a name="k_59"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Point.html">Point</a><b> p2 </b></p><p><b>Description</b>: Gets the upper right point of the box</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'p2'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-591"></a><h3>p2=</h3></td><td style="padding-bottom: 16px"><a name="method58"></a><a name="m_p2="></a><a name="k_60"></a><p><b>Signature</b>: void <b> p2= </b> (const <a href="class_Point.html">Point</a> p)</p><p><b>Description</b>: Sets the upper right point of the box</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'p2'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-596"></a><h3>perimeter</h3></td><td style="padding-bottom: 16px"><a name="method59"></a><a name="m_perimeter"></a><a name="k_61"></a><p><b>Signature</b>: <i>[const] </i>unsigned long <b> perimeter </b></p><p><b>Description</b>: Returns the perimeter of the box</p><p><p></p><p>This method is equivalent to 2*(width+height). For empty boxes, this method returns 0.</p><p>This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-601"></a><h3>right</h3></td><td style="padding-bottom: 16px"><a name="method60"></a><a name="m_right"></a><a name="k_62"></a><p><b>Signature</b>: <i>[const] </i>int <b> right </b></p><p><b>Description</b>: Gets the right coordinate of the box</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'right'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-606"></a><h3>right=</h3></td><td style="padding-bottom: 16px"><a name="method61"></a><a name="m_right="></a><a name="k_63"></a><p><b>Signature</b>: void <b> right= </b> (int c)</p><p><b>Description</b>: Sets the right coordinate of the box</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'right'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-611"></a><h3>to_dtype</h3></td><td style="padding-bottom: 16px"><a name="method62"></a><a name="m_to_dtype"></a><a name="k_64"></a><p><b>Signature</b>: <i>[const] </i><a href="class_DBox.html">DBox</a><b> to_dtype </b> (double dbu = 1)</p><p><b>Description</b>: Converts the box to a floating-point coordinate box</p><p><p></p><p>The database unit can be specified to translate the integer-coordinate box into a floating-point coordinate box in micron units. The database unit is basically a scaling factor.</p><p>This method has been introduced in version 0.25.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-616"></a><h3>to_s</h3></td><td style="padding-bottom: 16px"><a name="method63"></a><a name="m_to_s"></a><a name="k_65"></a><p><b>Signature</b>: <i>[const] </i>string <b> to_s </b> (double dbu = 0)</p><p><b>Description</b>: Returns a string representing this box</p><p><p></p><p>This string can be turned into a box again by using <a href="#m_from_s">from_s</a>
|
| 191 |
+
. If a DBU is given, the output units will be micrometers.</p><p>The DBU argument has been added in version 0.27.6.
|
| 192 |
+
</p></p><p><b>Python specific notes: </b><br>This method is also available as 'str(object)'.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-624"></a><h3>top</h3></td><td style="padding-bottom: 16px"><a name="method64"></a><a name="m_top"></a><a name="k_66"></a><p><b>Signature</b>: <i>[const] </i>int <b> top </b></p><p><b>Description</b>: Gets the top coordinate of the box</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'top'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-629"></a><h3>top=</h3></td><td style="padding-bottom: 16px"><a name="method65"></a><a name="m_top="></a><a name="k_67"></a><p><b>Signature</b>: void <b> top= </b> (int c)</p><p><b>Description</b>: Sets the top coordinate of the box</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'top'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-634"></a><h3>touches?</h3></td><td style="padding-bottom: 16px"><a name="method66"></a><a name="m_touches?"></a><a name="k_68"></a><p><b>Signature</b>: <i>[const] </i>bool <b> touches? </b> (const <a href="class_Box.html">Box</a> box)</p><p><b>Description</b>: Tests if this box touches the argument box</p><p><p></p><p>Two boxes touch if they overlap or their boundaries share at least one common point. Touching is equivalent to a non-empty intersection ('!(b1 & b2).empty?').</p></p></td></tr><tr class="bigrow1"><td rowspan="3"><a name="h3-639"></a><h3>transformed</h3></td><td style="padding-bottom: 16px"><a name="method67"></a><a name="m_transformed"></a><a name="k_69"></a><p><b>(1) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> transformed </b> (const <a href="class_ICplxTrans.html">ICplxTrans</a> t)</p><p><b>Description</b>: Transforms the box with the given complex transformation</p><table class="layout-table"><tr><td><b>t</b>:</td><td>The magnifying transformation to apply</td></tr><tr><td><b>Returns</b>:</td><td>The transformed box (in this case an integer coordinate box)</td></tr></table><p><p></p><p>This method has been introduced in version 0.18.
|
| 193 |
+
</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method68"></a><a name="m_transformed"></a><a name="k_70"></a><p><b>(2) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> transformed </b> (const <a href="class_Trans.html">Trans</a> t)</p><p><b>Description</b>: Returns the box transformed with the given simple transformation</p><table class="layout-table"><tr><td><b>t</b>:</td><td>The transformation to apply</td></tr><tr><td><b>Returns</b>:</td><td>The transformed box</td></tr></table></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method69"></a><a name="m_transformed"></a><a name="k_71"></a><p><b>(3) Signature</b>: <i>[const] </i><a href="class_DBox.html">DBox</a><b> transformed </b> (const <a href="class_CplxTrans.html">CplxTrans</a> t)</p><p><b>Description</b>: Returns the box transformed with the given complex transformation</p><table class="layout-table"><tr><td><b>t</b>:</td><td>The magnifying transformation to apply</td></tr><tr><td><b>Returns</b>:</td><td>The transformed box (a DBox now)</td></tr></table></td></tr><tr class="bigrow0"><td><a name="h3-663"></a><h3>width</h3></td><td style="padding-bottom: 16px"><a name="method70"></a><a name="m_width"></a><a name="k_72"></a><p><b>Signature</b>: <i>[const] </i>unsigned int <b> width </b></p><p><b>Description</b>: Gets the width of the box</p></td></tr><tr class="bigrow1"><td><a name="h3-667"></a><h3>world</h3></td><td style="padding-bottom: 16px"><a name="method71"></a><a name="m_world"></a><a name="k_73"></a><p><b>Signature</b>: <i>[static] </i><a href="class_Box.html">Box</a><b> world </b></p><p><b>Description</b>: Gets the 'world' box</p><p><p>
|
| 194 |
+
The world box is the biggest box that can be represented. So it is basically 'all'. The world box behaves neutral on intersections for example. In other operations such as displacement or transformations, the world box may render unexpected results because of coordinate overflow.</p><p>The world box can be used
|
| 195 |
+
<ul><li> for comparison ('==', '!=', '<') </li><li> in union and intersection ('+' and '&') </li><li> in relations (<a href="#m_contains?">contains?</a>, <a href="#m_overlaps?">overlaps?</a>, <a href="#m_touches?">touches?</a>) </li><li> as 'all' argument in region queries </li></ul></p><p>This method has been introduced in version 0.28.</p></p></td></tr></table></div>
|
| 196 |
+
</div>
|
| 197 |
+
</body>
|
| 198 |
+
</html>
|
| 199 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_BrowserDialog.html
ADDED
|
@@ -0,0 +1,168 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class BrowserDialog</p><h1>API reference - Class BrowserDialog</h1><property name="module" value="lay"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_lay.html">lay</a></p><p><b>Description</b>: A HTML display and browser dialog</p><p><b>Class hierarchy</b>: BrowserDialog » <a href="class_QDialog.html">QDialog</a> » <a href="class_QWidget.html">QWidget</a> » <a href="class_QObject.html">QObject</a></p><ul><li><a href="#h2-29">Public constructors</a></li><li><a href="#h2-40">Public methods</a></li><li><a href="#h2-77">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-92">Detailed description</a></li></ul><p></p><p>The browser dialog displays HTML code in a browser panel. The HTML code is delivered through a separate object of class <a href="class_BrowserSource.html">BrowserSource</a> which acts as a "server" for a specific kind of URL scheme. Whenever the browser sees a URL starting with "int:" it will ask the connected BrowserSource object for the HTML code of that page using its 'get' method. The task of the BrowserSource object is to format the data requested in HTML and deliver it.</p><p>One use case for that class is the implementation of rich data browsers for structured information. In a simple scenario, the browser dialog can be instantiated with a static HTML page. In that case, only the content of that page is shown.</p><p>Here's a simple example:</p><p><pre>
|
| 120 |
+
html = "<html><body>Hello, world!</body></html>"
|
| 121 |
+
RBA::BrowserDialog::new(html).exec
|
| 122 |
+
</pre></p><p>And that is an example for the use case with a <a href="class_BrowserSource.html">BrowserSource</a> as the "server":</p><p><pre>
|
| 123 |
+
class MySource < RBA::BrowserSource
|
| 124 |
+
def get(url)
|
| 125 |
+
if (url =~ /b.html$/)
|
| 126 |
+
return "<html><body>The second page</body></html>"
|
| 127 |
+
else
|
| 128 |
+
return "<html><body>The first page with a <a href='int:b.html'>link</a></body></html>"
|
| 129 |
+
end
|
| 130 |
+
end
|
| 131 |
+
end
|
| 132 |
+
|
| 133 |
+
source = MySource::new
|
| 134 |
+
RBA::BrowserDialog::new(source).exec
|
| 135 |
+
</pre></p><a name="h2-29"></a><h2>Public constructors</h2><table><tr class="row0"><td>new BrowserDialog ptr</td><td><b><a href="#method14">new</a></b></td><td>(BrowserSource ptr source)</td><td>Creates a HTML browser window with a <a href="class_BrowserSource.html">BrowserSource</a> as the source of HTML code</td></tr><tr class="row1"><td>new BrowserDialog ptr</td><td><b><a href="#method15">new</a></b></td><td>(string html)</td><td>Creates a HTML browser window with a static HTML content</td></tr><tr class="row0"><td>new BrowserDialog ptr</td><td><b><a href="#method16">new</a></b></td><td>(QWidget ptr parent,<br>BrowserSource ptr source)</td><td>Creates a HTML browser window with a <a href="class_BrowserSource.html">BrowserSource</a> as the source of HTML code</td></tr><tr class="row1"><td>new BrowserDialog ptr</td><td><b><a href="#method17">new</a></b></td><td>(QWidget ptr parent,<br>string html)</td><td>Creates a HTML browser window with a static HTML content</td></tr></table><a name="h2-40"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>BrowserDialog ptr</td><td><b><a href="#method0">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method1">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method2">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method3">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method4">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method5">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method6">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method7">caption=</a></b></td><td>(string caption)</td><td>Sets the caption of the window</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method10">execute</a></b></td><td></td><td>Executes the HTML browser dialog as a modal window</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method11">home=</a></b></td><td>(string home_url)</td><td>Sets the browser's initial and current URL which is selected if the "home" location is chosen</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method12">label=</a></b></td><td>(string label)</td><td>Sets the label text</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method13">load</a></b></td><td>(string url)</td><td>Loads the given URL into the browser dialog</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method18">reload</a></b></td><td></td><td>Reloads the current page</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method19">resize</a></b></td><td>(int width,<br>int height)</td><td>Sets the size of the dialog window</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method20">search</a></b></td><td>(string search_item)</td><td>Issues a search request using the given search item and the search URL specified with <a href="#m_set_search_url">set_search_url</a></td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method23">set_search_url</a></b></td><td>(string url,<br>string query_item)</td><td>Enables the search field and specifies the search URL generated for a search</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method26">source=</a></b></td><td>(BrowserSource ptr source)</td><td>Connects to a source object</td></tr></table><a name="h2-77"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td><i>[virtual]</i></td><td>void</td><td><b><a href="#method8">closed</a></b></td><td></td><td>Use of this method is deprecated</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method9">exec</a></b></td><td></td><td>Use of this method is deprecated. Use execute instead</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method21">set_caption</a></b></td><td>(string caption)</td><td>Use of this method is deprecated. Use caption= instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method22">set_home</a></b></td><td>(string home_url)</td><td>Use of this method is deprecated. Use home= instead</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method24">set_size</a></b></td><td>(int width,<br>int height)</td><td>Use of this method is deprecated. Use resize instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method25">set_source</a></b></td><td>(BrowserSource ptr source)</td><td>Use of this method is deprecated. Use source= instead</td></tr></table><a name="detailed"></a><a name="h2-92"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-93"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m__const_cast"></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i><a href="class_BrowserDialog.html">BrowserDialog</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 136 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-99"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m__create"></a><a name="k_3"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 137 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-105"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m__destroy"></a><a name="k_4"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 138 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 139 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-112"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__destroyed?"></a><a name="k_5"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 140 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 141 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-119"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__is_const_object?"></a><a name="k_6"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 142 |
+
This method returns true, if self is a const reference.
|
| 143 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-126"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__manage"></a><a name="k_7"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 144 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-132"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__unmanage"></a><a name="k_8"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 145 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-138"></a><h3>caption=</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m_caption="></a><a name="k_9"></a><p><b>Signature</b>: void <b> caption= </b> (string caption)</p><p><b>Description</b>: Sets the caption of the window</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'caption'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-143"></a><h3>closed</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_closed"></a><a name="k_10"></a><p><b>Signature</b>: <i>[virtual] </i>void <b> closed </b></p><p><b>Description</b>: Callback when the dialog is closed</p><p>Use of this method is deprecated</p><p><p>
|
| 146 |
+
This callback can be reimplemented to implement cleanup functionality when the dialog is closed.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-150"></a><h3>exec</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_exec"></a><a name="k_11"></a><p><b>Signature</b>: int <b> exec </b></p><p><b>Description</b>: Executes the HTML browser dialog as a modal window</p><p>Use of this method is deprecated. Use execute instead</p><p><b>Python specific notes: </b><br>This attribute is available as 'exec_' in Python.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-156"></a><h3>execute</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_execute"></a><a name="k_12"></a><p><b>Signature</b>: int <b> execute </b></p><p><b>Description</b>: Executes the HTML browser dialog as a modal window</p><p><b>Python specific notes: </b><br>This attribute is available as 'exec_' in Python.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-161"></a><h3>home=</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_home="></a><a name="k_13"></a><p><b>Signature</b>: void <b> home= </b> (string home_url)</p><p><b>Description</b>: Sets the browser's initial and current URL which is selected if the "home" location is chosen</p><p><p>
|
| 147 |
+
The home URL is the one shown initially and the one which is selected when the "home" button is pressed. The default location is "int:/index.html".
|
| 148 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'home'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-169"></a><h3>label=</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_label="></a><a name="k_14"></a><p><b>Signature</b>: void <b> label= </b> (string label)</p><p><b>Description</b>: Sets the label text</p><p><p></p><p>The label is shown left of the navigation buttons.
|
| 149 |
+
By default, no label is specified.</p><p>This method has been introduced in version 0.23.
|
| 150 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'label'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-177"></a><h3>load</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_load"></a><a name="k_15"></a><p><b>Signature</b>: void <b> load </b> (string url)</p><p><b>Description</b>: Loads the given URL into the browser dialog</p><p><p>
|
| 151 |
+
Typically the URL has the "int:" scheme so the HTML code is taken from the <a href="class_BrowserSource.html">BrowserSource</a> object.
|
| 152 |
+
</p></p></td></tr><tr class="bigrow0"><td rowspan="4"><a name="h3-184"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_new"></a><a name="k_16"></a><p><b>(1) Signature</b>: <i>[static] </i>new <a href="class_BrowserDialog.html">BrowserDialog</a> ptr <b> new </b> (<a href="class_BrowserSource.html">BrowserSource</a> ptr source)</p><p><b>Description</b>: Creates a HTML browser window with a <a href="class_BrowserSource.html">BrowserSource</a> as the source of HTML code</p><p><p>
|
| 153 |
+
This method has been introduced in version 0.23.
|
| 154 |
+
</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_new"></a><a name="k_17"></a><p><b>(2) Signature</b>: <i>[static] </i>new <a href="class_BrowserDialog.html">BrowserDialog</a> ptr <b> new </b> (string html)</p><p><b>Description</b>: Creates a HTML browser window with a static HTML content</p><p><p>
|
| 155 |
+
This method has been introduced in version 0.23.
|
| 156 |
+
</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_new"></a><a name="k_18"></a><p><b>(3) Signature</b>: <i>[static] </i>new <a href="class_BrowserDialog.html">BrowserDialog</a> ptr <b> new </b> (<a href="class_QWidget.html">QWidget</a> ptr parent, <a href="class_BrowserSource.html">BrowserSource</a> ptr source)</p><p><b>Description</b>: Creates a HTML browser window with a <a href="class_BrowserSource.html">BrowserSource</a> as the source of HTML code</p><p><p>
|
| 157 |
+
This method variant with a parent argument has been introduced in version 0.24.2.
|
| 158 |
+
</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_new"></a><a name="k_19"></a><p><b>(4) Signature</b>: <i>[static] </i>new <a href="class_BrowserDialog.html">BrowserDialog</a> ptr <b> new </b> (<a href="class_QWidget.html">QWidget</a> ptr parent, string html)</p><p><b>Description</b>: Creates a HTML browser window with a static HTML content</p><p><p>
|
| 159 |
+
This method variant with a parent argument has been introduced in version 0.24.2.
|
| 160 |
+
</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-213"></a><h3>reload</h3></td><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_reload"></a><a name="k_20"></a><p><b>Signature</b>: void <b> reload </b></p><p><b>Description</b>: Reloads the current page</p></td></tr><tr class="bigrow0"><td><a name="h3-217"></a><h3>resize</h3></td><td style="padding-bottom: 16px"><a name="method19"></a><a name="m_resize"></a><a name="k_21"></a><p><b>Signature</b>: void <b> resize </b> (int width, int height)</p><p><b>Description</b>: Sets the size of the dialog window</p></td></tr><tr class="bigrow1"><td><a name="h3-221"></a><h3>search</h3></td><td style="padding-bottom: 16px"><a name="method20"></a><a name="m_search"></a><a name="k_22"></a><p><b>Signature</b>: void <b> search </b> (string search_item)</p><p><b>Description</b>: Issues a search request using the given search item and the search URL specified with <a href="#m_set_search_url">set_search_url</a></p><p><p></p><p>See <a href="#m_set_search_url">set_search_url</a> for a description of the search mechanism.
|
| 161 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-227"></a><h3>set_caption</h3></td><td style="padding-bottom: 16px"><a name="method21"></a><a name="m_set_caption"></a><a name="k_23"></a><p><b>Signature</b>: void <b> set_caption </b> (string caption)</p><p><b>Description</b>: Sets the caption of the window</p><p>Use of this method is deprecated. Use caption= instead</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'caption'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-233"></a><h3>set_home</h3></td><td style="padding-bottom: 16px"><a name="method22"></a><a name="m_set_home"></a><a name="k_24"></a><p><b>Signature</b>: void <b> set_home </b> (string home_url)</p><p><b>Description</b>: Sets the browser's initial and current URL which is selected if the "home" location is chosen</p><p>Use of this method is deprecated. Use home= instead</p><p><p>
|
| 162 |
+
The home URL is the one shown initially and the one which is selected when the "home" button is pressed. The default location is "int:/index.html".
|
| 163 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'home'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-242"></a><h3>set_search_url</h3></td><td style="padding-bottom: 16px"><a name="method23"></a><a name="m_set_search_url"></a><a name="k_25"></a><p><b>Signature</b>: void <b> set_search_url </b> (string url, string query_item)</p><p><b>Description</b>: Enables the search field and specifies the search URL generated for a search</p><p><p></p><p>If a search URL is set, the search box right to the navigation bar will be enabled. When a text is entered into the search box, the browser will navigate to an URL composed of the search URL, the search item and the search text, i.e. "myurl?item=search_text".</p><p>This method has been introduced in version 0.23.
|
| 164 |
+
</p></p></td></tr><tr class="bigrow1"><td><a name="h3-248"></a><h3>set_size</h3></td><td style="padding-bottom: 16px"><a name="method24"></a><a name="m_set_size"></a><a name="k_26"></a><p><b>Signature</b>: void <b> set_size </b> (int width, int height)</p><p><b>Description</b>: Sets the size of the dialog window</p><p>Use of this method is deprecated. Use resize instead</p></td></tr><tr class="bigrow0"><td><a name="h3-253"></a><h3>set_source</h3></td><td style="padding-bottom: 16px"><a name="method25"></a><a name="m_set_source"></a><a name="k_27"></a><p><b>Signature</b>: void <b> set_source </b> (<a href="class_BrowserSource.html">BrowserSource</a> ptr source)</p><p><b>Description</b>: Connects to a source object</p><p>Use of this method is deprecated. Use source= instead</p><p><p></p><p>Setting the source should be the first thing done after the BrowserDialog object is created. It will not have any effect after the browser has loaded the first page. In particular, <a href="#m_home=">home=</a> should be called after the source was set.</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'source'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-260"></a><h3>source=</h3></td><td style="padding-bottom: 16px"><a name="method26"></a><a name="m_source="></a><a name="k_28"></a><p><b>Signature</b>: void <b> source= </b> (<a href="class_BrowserSource.html">BrowserSource</a> ptr source)</p><p><b>Description</b>: Connects to a source object</p><p><p></p><p>Setting the source should be the first thing done after the BrowserDialog object is created. It will not have any effect after the browser has loaded the first page. In particular, <a href="#m_home=">home=</a> should be called after the source was set.</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'source'. This is the setter.<br></p></td></tr></table></div>
|
| 165 |
+
</div>
|
| 166 |
+
</body>
|
| 167 |
+
</html>
|
| 168 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_BrowserPanel.html
ADDED
|
@@ -0,0 +1,142 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class BrowserPanel</p><h1>API reference - Class BrowserPanel</h1><property name="module" value="lay"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_lay.html">lay</a></p><p><b>Description</b>: A HTML display and browser widget</p><p><b>Class hierarchy</b>: BrowserPanel » <a href="class_QWidget.html">QWidget</a> » <a href="class_QObject.html">QObject</a></p><ul><li><a href="#h2-13">Public constructors</a></li><li><a href="#h2-20">Public methods</a></li><li><a href="#h2-53">Detailed description</a></li></ul><p></p><p>This widget provides the functionality of <a href="class_BrowserDialog.html">BrowserDialog</a> within a widget. It can be embedded into other dialogs. For details about the use model of this class see <a href="class_BrowserDialog.html">BrowserDialog</a>.</p><p>This class has been introduced in version 0.25.
|
| 120 |
+
</p><a name="h2-13"></a><h2>Public constructors</h2><table><tr class="row0"><td>new BrowserPanel ptr</td><td><b><a href="#method10">new</a></b></td><td>(QWidget ptr parent,<br>BrowserSource ptr source)</td><td>Creates a HTML browser widget with a <a href="class_BrowserSource.html">BrowserSource</a> as the source of HTML code</td></tr><tr class="row1"><td>new BrowserPanel ptr</td><td><b><a href="#method11">new</a></b></td><td>(QWidget ptr parent)</td><td>Creates a HTML browser widget</td></tr></table><a name="h2-20"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>BrowserPanel ptr</td><td><b><a href="#method0">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method1">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method2">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method3">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method4">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method5">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method6">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method7">home=</a></b></td><td>(string home_url)</td><td>Sets the browser widget's initial and current URL which is selected if the "home" location is chosen</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method8">label=</a></b></td><td>(string label)</td><td>Sets the label text</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method9">load</a></b></td><td>(string url)</td><td>Loads the given URL into the browser widget</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method12">reload</a></b></td><td></td><td>Reloads the current page</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method13">search</a></b></td><td>(string search_item)</td><td>Issues a search request using the given search item and the search URL specified with <a href="#m_set_search_url">set_search_url</a></td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method14">set_search_url</a></b></td><td>(string url,<br>string query_item)</td><td>Enables the search field and specifies the search URL generated for a search</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method15">source=</a></b></td><td>(BrowserSource ptr source)</td><td>Connects to a source object</td></tr><tr class="row0"><td><i>[const]</i></td><td>string</td><td><b><a href="#method16">url</a></b></td><td></td><td>Gets the URL currently shown</td></tr></table><a name="detailed"></a><a name="h2-53"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-54"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m__const_cast"></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i><a href="class_BrowserPanel.html">BrowserPanel</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 121 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-60"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m__create"></a><a name="k_3"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 122 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-66"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m__destroy"></a><a name="k_4"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 123 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 124 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-73"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__destroyed?"></a><a name="k_5"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 125 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 126 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-80"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__is_const_object?"></a><a name="k_6"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 127 |
+
This method returns true, if self is a const reference.
|
| 128 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-87"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__manage"></a><a name="k_7"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 129 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-93"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__unmanage"></a><a name="k_8"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 130 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-99"></a><h3>home=</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m_home="></a><a name="k_9"></a><p><b>Signature</b>: void <b> home= </b> (string home_url)</p><p><b>Description</b>: Sets the browser widget's initial and current URL which is selected if the "home" location is chosen</p><p><p>
|
| 131 |
+
The home URL is the one shown initially and the one which is selected when the "home" button is pressed. The default location is "int:/index.html".
|
| 132 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'home'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-107"></a><h3>label=</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_label="></a><a name="k_10"></a><p><b>Signature</b>: void <b> label= </b> (string label)</p><p><b>Description</b>: Sets the label text</p><p><p></p><p>The label is shown left of the navigation buttons.
|
| 133 |
+
By default, no label is specified.
|
| 134 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'label'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-115"></a><h3>load</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_load"></a><a name="k_11"></a><p><b>Signature</b>: void <b> load </b> (string url)</p><p><b>Description</b>: Loads the given URL into the browser widget</p><p><p>
|
| 135 |
+
Typically the URL has the "int:" scheme so the HTML code is taken from the <a href="class_BrowserSource.html">BrowserSource</a> object.
|
| 136 |
+
</p></p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-122"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_new"></a><a name="k_12"></a><p><b>(1) Signature</b>: <i>[static] </i>new <a href="class_BrowserPanel.html">BrowserPanel</a> ptr <b> new </b> (<a href="class_QWidget.html">QWidget</a> ptr parent, <a href="class_BrowserSource.html">BrowserSource</a> ptr source)</p><p><b>Description</b>: Creates a HTML browser widget with a <a href="class_BrowserSource.html">BrowserSource</a> as the source of HTML code</p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_new"></a><a name="k_13"></a><p><b>(2) Signature</b>: <i>[static] </i>new <a href="class_BrowserPanel.html">BrowserPanel</a> ptr <b> new </b> (<a href="class_QWidget.html">QWidget</a> ptr parent)</p><p><b>Description</b>: Creates a HTML browser widget</p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-131"></a><h3>reload</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_reload"></a><a name="k_14"></a><p><b>Signature</b>: void <b> reload </b></p><p><b>Description</b>: Reloads the current page</p></td></tr><tr class="bigrow0"><td><a name="h3-135"></a><h3>search</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_search"></a><a name="k_15"></a><p><b>Signature</b>: void <b> search </b> (string search_item)</p><p><b>Description</b>: Issues a search request using the given search item and the search URL specified with <a href="#m_set_search_url">set_search_url</a></p><p><p></p><p>See search_url= for a description of the search mechanism.
|
| 137 |
+
</p></p></td></tr><tr class="bigrow1"><td><a name="h3-141"></a><h3>set_search_url</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_set_search_url"></a><a name="k_16"></a><p><b>Signature</b>: void <b> set_search_url </b> (string url, string query_item)</p><p><b>Description</b>: Enables the search field and specifies the search URL generated for a search</p><p><p></p><p>If a search URL is set, the search box right to the navigation bar will be enabled. When a text is entered into the search box, the browser will navigate to an URL composed of the search URL, the search item and the search text, i.e. "myurl?item=search_text".
|
| 138 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-147"></a><h3>source=</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_source="></a><a name="k_17"></a><p><b>Signature</b>: void <b> source= </b> (<a href="class_BrowserSource.html">BrowserSource</a> ptr source)</p><p><b>Description</b>: Connects to a source object</p><p><p></p><p>Setting the source should be the first thing done after the BrowserDialog object is created. It will not have any effect after the browser has loaded the first page. In particular, <a href="#m_home=">home=</a> should be called after the source was set.</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'source'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-153"></a><h3>url</h3></td><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_url"></a><a name="k_18"></a><p><b>Signature</b>: <i>[const] </i>string <b> url </b></p><p><b>Description</b>: Gets the URL currently shown</p></td></tr></table></div>
|
| 139 |
+
</div>
|
| 140 |
+
</body>
|
| 141 |
+
</html>
|
| 142 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_BrowserSource.html
ADDED
|
@@ -0,0 +1,151 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class BrowserSource</p><h1>API reference - Class BrowserSource</h1><property name="module" value="lay"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_lay.html">lay</a></p><p><b>Description</b>: The BrowserDialog's source for "int" URL's</p><ul><li><a href="#h2-15">Public constructors</a></li><li><a href="#h2-20">Public methods</a></li><li><a href="#h2-49">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-62">Detailed description</a></li></ul><p></p><p>The source object basically acts as a "server" for special URL's using "int" as the scheme.
|
| 120 |
+
Classes that want to implement such functionality must derive from BrowserSource and reimplement
|
| 121 |
+
the <a href="#m_get">get</a> method. This method is supposed to deliver a HTML page for the given URL.</p><p>Alternatively to implementing this functionality, a source object may be instantiated using the
|
| 122 |
+
constructor with a HTML code string. This will create a source object that simply displays the given string
|
| 123 |
+
as the initial and only page.</p><a name="h2-15"></a><h2>Public constructors</h2><table><tr class="row0"><td>new BrowserSource ptr</td><td><b><a href="#method15">new</a></b></td><td>(string html)</td><td>Constructs a BrowserSource object with a default HTML string</td></tr></table><a name="h2-20"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>BrowserSource ptr</td><td><b><a href="#method0">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method1">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method2">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method3">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method4">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method5">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method6">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method7">assign</a></b></td><td>(const BrowserSource other)</td><td>Assigns another object to self</td></tr><tr class="row0"><td><i>[const]</i></td><td>new BrowserSource ptr</td><td><b><a href="#method11">dup</a></b></td><td></td><td>Creates a copy of self</td></tr><tr class="row1"><td><i>[virtual]</i></td><td>string</td><td><b><a href="#method12">get</a></b></td><td>(string url)</td><td>Gets the HTML code for a given "int" URL.</td></tr><tr class="row0"><td></td><td>QImage</td><td><b><a href="#method13">get_image</a></b></td><td>(string url)</td><td>Gets the image object for a specific URL</td></tr><tr class="row1"><td></td><td>string</td><td><b><a href="#method17">next_topic</a></b></td><td>(string url)</td><td>Gets the next topic URL from a given URL</td></tr><tr class="row0"><td></td><td>string</td><td><b><a href="#method18">prev_topic</a></b></td><td>(string url)</td><td>Gets the previous topic URL from a given URL</td></tr></table><a name="h2-49"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td></td><td>void</td><td><b><a href="#method8">create</a></b></td><td></td><td>Use of this method is deprecated. Use _create instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method9">destroy</a></b></td><td></td><td>Use of this method is deprecated. Use _destroy instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method10">destroyed?</a></b></td><td></td><td>Use of this method is deprecated. Use _destroyed? instead</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method14">is_const_object?</a></b></td><td></td><td>Use of this method is deprecated. Use _is_const_object? instead</td></tr><tr class="row0"><td><i>[static]</i></td><td>new BrowserSource ptr</td><td><b><a href="#method16">new_html</a></b></td><td>(string html)</td><td>Use of this method is deprecated. Use new instead</td></tr></table><a name="detailed"></a><a name="h2-62"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-63"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m__const_cast"></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i><a href="class_BrowserSource.html">BrowserSource</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 124 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-69"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m__create"></a><a name="k_3"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 125 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-75"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m__destroy"></a><a name="k_4"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 126 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 127 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-82"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__destroyed?"></a><a name="k_5"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 128 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 129 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-89"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__is_const_object?"></a><a name="k_6"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 130 |
+
This method returns true, if self is a const reference.
|
| 131 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-96"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__manage"></a><a name="k_7"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 132 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-102"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__unmanage"></a><a name="k_8"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 133 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-108"></a><h3>assign</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m_assign"></a><a name="k_9"></a><p><b>Signature</b>: void <b> assign </b> (const <a href="class_BrowserSource.html">BrowserSource</a> other)</p><p><b>Description</b>: Assigns another object to self</p></td></tr><tr class="bigrow0"><td><a name="h3-112"></a><h3>create</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_create"></a><a name="k_10"></a><p><b>Signature</b>: void <b> create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p>Use of this method is deprecated. Use _create instead</p><p><p>
|
| 134 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-119"></a><h3>destroy</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_destroy"></a><a name="k_11"></a><p><b>Signature</b>: void <b> destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p>Use of this method is deprecated. Use _destroy instead</p><p><p>
|
| 135 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 136 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-127"></a><h3>destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_destroyed?"></a><a name="k_12"></a><p><b>Signature</b>: <i>[const] </i>bool <b> destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p>Use of this method is deprecated. Use _destroyed? instead</p><p><p>
|
| 137 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 138 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-135"></a><h3>dup</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_dup"></a><a name="k_13"></a><p><b>Signature</b>: <i>[const] </i>new <a href="class_BrowserSource.html">BrowserSource</a> ptr <b> dup </b></p><p><b>Description</b>: Creates a copy of self</p><p><b>Python specific notes: </b><br>This method also implements '__copy__' and '__deepcopy__'.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-140"></a><h3>get</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_get"></a><a name="k_14"></a><p><b>Signature</b>: <i>[virtual] </i>string <b> get </b> (string url)</p><p><b>Description</b>: Gets the HTML code for a given "int" URL.</p><p><p></p><p>If this method returns an empty string, the browser will not be set to
|
| 139 |
+
a new location. This allows implementing any functionality behind such links.
|
| 140 |
+
If the method returns a string, the content of this string is displayed in the HTML
|
| 141 |
+
browser page.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-148"></a><h3>get_image</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_get_image"></a><a name="k_15"></a><p><b>Signature</b>: <a href="class_QImage.html">QImage</a><b> get_image </b> (string url)</p><p><b>Description</b>: Gets the image object for a specific URL</p><p><p></p><p>This method has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-153"></a><h3>is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_is_const_object?"></a><a name="k_16"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p>Use of this method is deprecated. Use _is_const_object? instead</p><p><p>
|
| 142 |
+
This method returns true, if self is a const reference.
|
| 143 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-161"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_new"></a><a name="k_17"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_BrowserSource.html">BrowserSource</a> ptr <b> new </b> (string html)</p><p><b>Description</b>: Constructs a BrowserSource object with a default HTML string</p><p><p></p><p>The default HTML string is sent when no specific implementation is provided.
|
| 144 |
+
</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-168"></a><h3>new_html</h3></td><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_new_html"></a><a name="k_18"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_BrowserSource.html">BrowserSource</a> ptr <b> new_html </b> (string html)</p><p><b>Description</b>: Constructs a BrowserSource object with a default HTML string</p><p>Use of this method is deprecated. Use new instead</p><p><p></p><p>The default HTML string is sent when no specific implementation is provided.
|
| 145 |
+
</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-176"></a><h3>next_topic</h3></td><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_next_topic"></a><a name="k_19"></a><p><b>Signature</b>: string <b> next_topic </b> (string url)</p><p><b>Description</b>: Gets the next topic URL from a given URL</p><p><p>
|
| 146 |
+
An empty string will be returned if no next topic is available.</p><p>This method has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-182"></a><h3>prev_topic</h3></td><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_prev_topic"></a><a name="k_20"></a><p><b>Signature</b>: string <b> prev_topic </b> (string url)</p><p><b>Description</b>: Gets the previous topic URL from a given URL</p><p><p>
|
| 147 |
+
An empty string will be returned if no previous topic is available.</p><p>This method has been introduced in version 0.28.</p></p></td></tr></table></div>
|
| 148 |
+
</div>
|
| 149 |
+
</body>
|
| 150 |
+
</html>
|
| 151 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_ButtonState.html
ADDED
|
@@ -0,0 +1,149 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class ButtonState</p><h1>API reference - Class ButtonState</h1><property name="module" value="lay"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_lay.html">lay</a></p><p><b>Description</b>: The namespace for the button state flags in the mouse events of the Plugin class.</p><ul><li><a href="#h2-14">Public constructors</a></li><li><a href="#h2-19">Public methods</a></li><li><a href="#h2-40">Public static methods and constants</a></li><li><a href="#h2-55">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-66">Detailed description</a></li></ul><p>
|
| 120 |
+
This class defines the constants for the button state. In the event handler, the button state is indicated by a bitwise combination of these constants. See <a href="class_Plugin.html">Plugin</a> for further details.
|
| 121 |
+
This class has been introduced in version 0.22.
|
| 122 |
+
</p><a name="h2-14"></a><h2>Public constructors</h2><table><tr class="row0"><td>new ButtonState ptr</td><td><b><a href="#method19">new</a></b></td><td></td><td>Creates a new object of this class</td></tr></table><a name="h2-19"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>ButtonState ptr</td><td><b><a href="#method6">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method7">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method8">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method9">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method10">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method11">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method12">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method13">assign</a></b></td><td>(const ButtonState other)</td><td>Assigns another object to self</td></tr><tr class="row0"><td><i>[const]</i></td><td>new ButtonState ptr</td><td><b><a href="#method17">dup</a></b></td><td></td><td>Creates a copy of self</td></tr></table><a name="h2-40"></a><h2>Public static methods and constants</h2><table><tr class="row0"><td></td><td>int</td><td><b><a href="#method0">AltKey</a></b></td><td></td><td>Indicates that the Alt key is pressed</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method1">ControlKey</a></b></td><td></td><td>Indicates that the Control key is pressed</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method2">LeftButton</a></b></td><td></td><td>Indicates that the left mouse button is pressed</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method3">MidButton</a></b></td><td></td><td>Indicates that the middle mouse button is pressed</td></tr><tr class="row0"><td></td><td>int</td><td><b><a href="#method4">RightButton</a></b></td><td></td><td>Indicates that the right mouse button is pressed</td></tr><tr class="row1"><td></td><td>int</td><td><b><a href="#method5">ShiftKey</a></b></td><td></td><td>Indicates that the Shift key is pressed</td></tr></table><a name="h2-55"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td></td><td>void</td><td><b><a href="#method14">create</a></b></td><td></td><td>Use of this method is deprecated. Use _create instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method15">destroy</a></b></td><td></td><td>Use of this method is deprecated. Use _destroy instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method16">destroyed?</a></b></td><td></td><td>Use of this method is deprecated. Use _destroyed? instead</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method18">is_const_object?</a></b></td><td></td><td>Use of this method is deprecated. Use _is_const_object? instead</td></tr></table><a name="detailed"></a><a name="h2-66"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-67"></a><h3>AltKey</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m_AltKey"></a><a name="k_2"></a><p><b>Signature</b>: <i>[static] </i>int <b> AltKey </b></p><p><b>Description</b>: Indicates that the Alt key is pressed</p><p><p>
|
| 123 |
+
This constant is combined with other constants within <a href="class_ButtonState.html">ButtonState</a></p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'AltKey'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-74"></a><h3>ControlKey</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m_ControlKey"></a><a name="k_3"></a><p><b>Signature</b>: <i>[static] </i>int <b> ControlKey </b></p><p><b>Description</b>: Indicates that the Control key is pressed</p><p><p>
|
| 124 |
+
This constant is combined with other constants within <a href="class_ButtonState.html">ButtonState</a></p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'ControlKey'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-81"></a><h3>LeftButton</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m_LeftButton"></a><a name="k_4"></a><p><b>Signature</b>: <i>[static] </i>int <b> LeftButton </b></p><p><b>Description</b>: Indicates that the left mouse button is pressed</p><p><p>
|
| 125 |
+
This constant is combined with other constants within <a href="class_ButtonState.html">ButtonState</a></p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'LeftButton'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-88"></a><h3>MidButton</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m_MidButton"></a><a name="k_5"></a><p><b>Signature</b>: <i>[static] </i>int <b> MidButton </b></p><p><b>Description</b>: Indicates that the middle mouse button is pressed</p><p><p>
|
| 126 |
+
This constant is combined with other constants within <a href="class_ButtonState.html">ButtonState</a></p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'MidButton'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-95"></a><h3>RightButton</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m_RightButton"></a><a name="k_6"></a><p><b>Signature</b>: <i>[static] </i>int <b> RightButton </b></p><p><b>Description</b>: Indicates that the right mouse button is pressed</p><p><p>
|
| 127 |
+
This constant is combined with other constants within <a href="class_ButtonState.html">ButtonState</a></p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'RightButton'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-102"></a><h3>ShiftKey</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m_ShiftKey"></a><a name="k_7"></a><p><b>Signature</b>: <i>[static] </i>int <b> ShiftKey </b></p><p><b>Description</b>: Indicates that the Shift key is pressed</p><p><p>
|
| 128 |
+
This constant is combined with other constants within <a href="class_ButtonState.html">ButtonState</a></p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'ShiftKey'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-109"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__const_cast"></a><a name="k_8"></a><p><b>Signature</b>: <i>[const] </i><a href="class_ButtonState.html">ButtonState</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 129 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-115"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m__create"></a><a name="k_9"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 130 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-121"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m__destroy"></a><a name="k_10"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 131 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 132 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-128"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m__destroyed?"></a><a name="k_11"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 133 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 134 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-135"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m__is_const_object?"></a><a name="k_12"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 135 |
+
This method returns true, if self is a const reference.
|
| 136 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-142"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m__manage"></a><a name="k_13"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 137 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-148"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m__unmanage"></a><a name="k_14"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 138 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-154"></a><h3>assign</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_assign"></a><a name="k_15"></a><p><b>Signature</b>: void <b> assign </b> (const <a href="class_ButtonState.html">ButtonState</a> other)</p><p><b>Description</b>: Assigns another object to self</p></td></tr><tr class="bigrow0"><td><a name="h3-158"></a><h3>create</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_create"></a><a name="k_16"></a><p><b>Signature</b>: void <b> create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p>Use of this method is deprecated. Use _create instead</p><p><p>
|
| 139 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-165"></a><h3>destroy</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_destroy"></a><a name="k_17"></a><p><b>Signature</b>: void <b> destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p>Use of this method is deprecated. Use _destroy instead</p><p><p>
|
| 140 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 141 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-173"></a><h3>destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_destroyed?"></a><a name="k_18"></a><p><b>Signature</b>: <i>[const] </i>bool <b> destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p>Use of this method is deprecated. Use _destroyed? instead</p><p><p>
|
| 142 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 143 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-181"></a><h3>dup</h3></td><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_dup"></a><a name="k_19"></a><p><b>Signature</b>: <i>[const] </i>new <a href="class_ButtonState.html">ButtonState</a> ptr <b> dup </b></p><p><b>Description</b>: Creates a copy of self</p><p><b>Python specific notes: </b><br>This method also implements '__copy__' and '__deepcopy__'.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-186"></a><h3>is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_is_const_object?"></a><a name="k_20"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p>Use of this method is deprecated. Use _is_const_object? instead</p><p><p>
|
| 144 |
+
This method returns true, if self is a const reference.
|
| 145 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-194"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method19"></a><a name="m_new"></a><a name="k_21"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_ButtonState.html">ButtonState</a> ptr <b> new </b></p><p><b>Description</b>: Creates a new object of this class</p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr></table></div>
|
| 146 |
+
</div>
|
| 147 |
+
</body>
|
| 148 |
+
</html>
|
| 149 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_Cell.html
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_CellInstArray.html
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class CellInstArray</p><h1>API reference - Class CellInstArray</h1><property name="module" value="db"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_db.html">db</a></p><p><b>Description</b>: A single or array cell instance</p><ul><li><a href="#h2-13">Public constructors</a></li><li><a href="#h2-42">Public methods</a></li><li><a href="#h2-127">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-140">Detailed description</a></li></ul><p>
|
| 120 |
+
This object represents either single or array cell instances. A cell instance array is a regular array, described by two displacement vectors (a, b) and the instance count along that axes (na, nb). </p><p>In addition, this object represents either instances with simple transformations or instances with complex transformations. The latter includes magnified instances and instances rotated by an arbitrary angle.</p><p>The cell which is instantiated is given by a cell index. The cell index can be converted to a cell pointer by using <a href="class_Layout.html#m_cell">Layout#cell</a>. The cell index of a cell can be obtained using <a href="class_Cell.html#m_cell_index">Cell#cell_index</a>.</p><p>See <a href="../programming/database_api.html">The Database API</a> for more details about the database objects.
|
| 121 |
+
</p><a name="h2-13"></a><h2>Public constructors</h2><table><tr class="row0"><td>new CellInstArray ptr</td><td><b><a href="#method38">new</a></b></td><td></td><td>Creates en empty cell instance with size 0</td></tr><tr class="row1"><td>new CellInstArray ptr</td><td><b><a href="#method39">new</a></b></td><td>(unsigned int cell_index,<br>const Trans trans)</td><td>Creates a single cell instance</td></tr><tr class="row0"><td>new CellInstArray ptr</td><td><b><a href="#method40">new</a></b></td><td>(const Cell ptr cell,<br>const Trans trans)</td><td>Creates a single cell instance</td></tr><tr class="row1"><td>new CellInstArray ptr</td><td><b><a href="#method41">new</a></b></td><td>(unsigned int cell_index,<br>const Vector disp)</td><td>Creates a single cell instance</td></tr><tr class="row0"><td>new CellInstArray ptr</td><td><b><a href="#method42">new</a></b></td><td>(const Cell ptr cell,<br>const Vector disp)</td><td>Creates a single cell instance</td></tr><tr class="row1"><td>new CellInstArray ptr</td><td><b><a href="#method43">new</a></b></td><td>(unsigned int cell_index,<br>const ICplxTrans trans)</td><td>Creates a single cell instance with a complex transformation</td></tr><tr class="row0"><td>new CellInstArray ptr</td><td><b><a href="#method44">new</a></b></td><td>(const Cell ptr cell,<br>const ICplxTrans trans)</td><td>Creates a single cell instance with a complex transformation</td></tr><tr class="row1"><td>new CellInstArray ptr</td><td><b><a href="#method45">new</a></b></td><td>(unsigned int cell_index,<br>const Trans trans,<br>const Vector a,<br>const Vector b,<br>unsigned long na,<br>unsigned long nb)</td><td>Creates a single cell instance</td></tr><tr class="row0"><td>new CellInstArray ptr</td><td><b><a href="#method46">new</a></b></td><td>(const Cell ptr cell,<br>const Trans trans,<br>const Vector a,<br>const Vector b,<br>unsigned long na,<br>unsigned long nb)</td><td>Creates a single cell instance</td></tr><tr class="row1"><td>new CellInstArray ptr</td><td><b><a href="#method47">new</a></b></td><td>(unsigned int cell_index,<br>const Vector disp,<br>const Vector a,<br>const Vector b,<br>unsigned long na,<br>unsigned long nb)</td><td>Creates a single cell instance</td></tr><tr class="row0"><td>new CellInstArray ptr</td><td><b><a href="#method48">new</a></b></td><td>(const Cell ptr cell,<br>const Vector disp,<br>const Vector a,<br>const Vector b,<br>unsigned long na,<br>unsigned long nb)</td><td>Creates a single cell instance</td></tr><tr class="row1"><td>new CellInstArray ptr</td><td><b><a href="#method49">new</a></b></td><td>(unsigned int cell_index,<br>const ICplxTrans trans,<br>const Vector a,<br>const Vector b,<br>unsigned long na,<br>unsigned long nb)</td><td>Creates a single cell instance with a complex transformation</td></tr><tr class="row0"><td>new CellInstArray ptr</td><td><b><a href="#method50">new</a></b></td><td>(const Cell ptr cell,<br>const ICplxTrans trans,<br>const Vector a,<br>const Vector b,<br>unsigned long na,<br>unsigned long nb)</td><td>Creates a single cell instance with a complex transformation</td></tr></table><a name="h2-42"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method0">!=</a></b></td><td>(const CellInstArray other)</td><td>Compares two arrays for inequality</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method1"><</a></b></td><td>(const CellInstArray other)</td><td>Compares two arrays for 'less'</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method2">==</a></b></td><td>(const CellInstArray other)</td><td>Compares two arrays for equality</td></tr><tr class="row1"><td><i>[const]</i></td><td>CellInstArray ptr</td><td><b><a href="#method3">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method4">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method5">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method6">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method7">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method8">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method9">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row0"><td><i>[const]</i></td><td>Vector</td><td><b><a href="#method10">a</a></b></td><td></td><td>Gets the displacement vector for the 'a' axis</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method11">a=</a></b></td><td>(const Vector vector)</td><td>Sets the displacement vector for the 'a' axis</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method12">assign</a></b></td><td>(const CellInstArray other)</td><td>Assigns another object to self</td></tr><tr class="row1"><td><i>[const]</i></td><td>Vector</td><td><b><a href="#method13">b</a></b></td><td></td><td>Gets the displacement vector for the 'b' axis</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method14">b=</a></b></td><td>(const Vector vector)</td><td>Sets the displacement vector for the 'b' axis</td></tr><tr class="row1"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method15">bbox</a></b></td><td>(const Layout layout,<br>unsigned int layer_index)</td><td>Gets the bounding box of the array with respect to one layer</td></tr><tr class="row0"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method16">bbox</a></b></td><td>(const Layout layout)</td><td>Gets the bounding box of the array</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method18">cell=</a></b></td><td>(Cell ptr cell)</td><td>Sets the cell this instance refers to</td></tr><tr class="row0"><td><i>[const]</i></td><td>unsigned int</td><td><b><a href="#method19">cell_index</a></b></td><td></td><td>Gets the cell index of the cell instantiated </td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method20">cell_index=</a></b></td><td>(unsigned int index)</td><td>Sets the index of the cell this instance refers to</td></tr><tr class="row0"><td><i>[const]</i></td><td>ICplxTrans</td><td><b><a href="#method21">cplx_trans</a></b></td><td></td><td>Gets the complex transformation of the first instance in the array</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method22">cplx_trans=</a></b></td><td>(const ICplxTrans trans)</td><td>Sets the complex transformation of the instance or the first instance in the array</td></tr><tr class="row0"><td><i>[const]</i></td><td>new CellInstArray ptr</td><td><b><a href="#method26">dup</a></b></td><td></td><td>Creates a copy of self</td></tr><tr class="row1"><td><i>[const,iter]</i></td><td>ICplxTrans</td><td><b><a href="#method27">each_cplx_trans</a></b></td><td></td><td>Gets the complex transformations represented by this instance</td></tr><tr class="row0"><td><i>[const,iter]</i></td><td>Trans</td><td><b><a href="#method28">each_trans</a></b></td><td></td><td>Gets the simple transformations represented by this instance</td></tr><tr class="row1"><td><i>[const]</i></td><td>unsigned long</td><td><b><a href="#method29">hash</a></b></td><td></td><td>Computes a hash value</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method30">invert</a></b></td><td></td><td>Inverts the array reference</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method31">is_complex?</a></b></td><td></td><td>Gets a value indicating whether the array is a complex array</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method33">is_regular_array?</a></b></td><td></td><td>Gets a value indicating whether this instance is a regular array</td></tr><tr class="row1"><td><i>[const]</i></td><td>unsigned long</td><td><b><a href="#method34">na</a></b></td><td></td><td>Gets the number of instances in the 'a' axis</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method35">na=</a></b></td><td>(unsigned long n)</td><td>Sets the number of instances in the 'a' axis</td></tr><tr class="row1"><td><i>[const]</i></td><td>unsigned long</td><td><b><a href="#method36">nb</a></b></td><td></td><td>Gets the number of instances in the 'b' axis</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method37">nb=</a></b></td><td>(unsigned long n)</td><td>Sets the number of instances in the 'b' axis</td></tr><tr class="row1"><td><i>[const]</i></td><td>unsigned long</td><td><b><a href="#method51">size</a></b></td><td></td><td>Gets the number of single instances in the array</td></tr><tr class="row0"><td><i>[const]</i></td><td>string</td><td><b><a href="#method52">to_s</a></b></td><td></td><td>Converts the array to a string</td></tr><tr class="row1"><td><i>[const]</i></td><td>Trans</td><td><b><a href="#method53">trans</a></b></td><td></td><td>Gets the transformation of the first instance in the array</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method54">trans=</a></b></td><td>(const Trans t)</td><td>Sets the transformation of the instance or the first instance in the array</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method55">transform</a></b></td><td>(const Trans trans)</td><td>Transforms the cell instance with the given transformation</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method56">transform</a></b></td><td>(const ICplxTrans trans)</td><td>Transforms the cell instance with the given complex transformation</td></tr><tr class="row1"><td><i>[const]</i></td><td>CellInstArray</td><td><b><a href="#method57">transformed</a></b></td><td>(const Trans trans)</td><td>Gets the transformed cell instance</td></tr><tr class="row0"><td><i>[const]</i></td><td>CellInstArray</td><td><b><a href="#method58">transformed</a></b></td><td>(const ICplxTrans trans)</td><td>Gets the transformed cell instance (complex transformation)</td></tr></table><a name="h2-127"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td><i>[const]</i></td><td>Box</td><td><b><a href="#method17">bbox_per_layer</a></b></td><td>(const Layout layout,<br>unsigned int layer_index)</td><td>Use of this method is deprecated. Use bbox instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method23">create</a></b></td><td></td><td>Use of this method is deprecated. Use _create instead</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method24">destroy</a></b></td><td></td><td>Use of this method is deprecated. Use _destroy instead</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method25">destroyed?</a></b></td><td></td><td>Use of this method is deprecated. Use _destroyed? instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method32">is_const_object?</a></b></td><td></td><td>Use of this method is deprecated. Use _is_const_object? instead</td></tr></table><a name="detailed"></a><a name="h2-140"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-141"></a><h3>!=</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m_!="></a><a name="k_2"></a><p><b>Signature</b>: <i>[const] </i>bool <b> != </b> (const <a href="class_CellInstArray.html">CellInstArray</a> other)</p><p><b>Description</b>: Compares two arrays for inequality</p></td></tr><tr class="bigrow1"><td><a name="h3-145"></a><h3><</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m_<"></a><a name="k_3"></a><p><b>Signature</b>: <i>[const] </i>bool <b> < </b> (const <a href="class_CellInstArray.html">CellInstArray</a> other)</p><p><b>Description</b>: Compares two arrays for 'less'</p><p><p>
|
| 122 |
+
The comparison provides an arbitrary sorting criterion and not specific sorting order. It is guaranteed that if an array a is less than b, b is not less than a. In addition, it a is not less than b and b is not less than a, then a is equal to b.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-151"></a><h3>==</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m_=="></a><a name="k_4"></a><p><b>Signature</b>: <i>[const] </i>bool <b> == </b> (const <a href="class_CellInstArray.html">CellInstArray</a> other)</p><p><b>Description</b>: Compares two arrays for equality</p></td></tr><tr class="bigrow1"><td><a name="h3-155"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__const_cast"></a><a name="k_5"></a><p><b>Signature</b>: <i>[const] </i><a href="class_CellInstArray.html">CellInstArray</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 123 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-161"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__create"></a><a name="k_6"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 124 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-167"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__destroy"></a><a name="k_7"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 125 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 126 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-174"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__destroyed?"></a><a name="k_8"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 127 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 128 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-181"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m__is_const_object?"></a><a name="k_9"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 129 |
+
This method returns true, if self is a const reference.
|
| 130 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-188"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m__manage"></a><a name="k_10"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 131 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-194"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m__unmanage"></a><a name="k_11"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 132 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-200"></a><h3>a</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_a"></a><a name="k_12"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Vector.html">Vector</a><b> a </b></p><p><b>Description</b>: Gets the displacement vector for the 'a' axis</p><p><p></p><p>Starting with version 0.25 the displacement is of vector type.
|
| 133 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'a'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-207"></a><h3>a=</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_a="></a><a name="k_13"></a><p><b>Signature</b>: void <b> a= </b> (const <a href="class_Vector.html">Vector</a> vector)</p><p><b>Description</b>: Sets the displacement vector for the 'a' axis</p><p><p></p><p>If the instance was not regular before this property is set, it will be initialized to a regular instance.</p><p>This method was introduced in version 0.22. Starting with version 0.25 the displacement is of vector type.
|
| 134 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'a'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-214"></a><h3>assign</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_assign"></a><a name="k_14"></a><p><b>Signature</b>: void <b> assign </b> (const <a href="class_CellInstArray.html">CellInstArray</a> other)</p><p><b>Description</b>: Assigns another object to self</p></td></tr><tr class="bigrow1"><td><a name="h3-218"></a><h3>b</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_b"></a><a name="k_15"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Vector.html">Vector</a><b> b </b></p><p><b>Description</b>: Gets the displacement vector for the 'b' axis</p><p><p></p><p>Starting with version 0.25 the displacement is of vector type.
|
| 135 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'b'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-225"></a><h3>b=</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_b="></a><a name="k_16"></a><p><b>Signature</b>: void <b> b= </b> (const <a href="class_Vector.html">Vector</a> vector)</p><p><b>Description</b>: Sets the displacement vector for the 'b' axis</p><p><p></p><p>If the instance was not regular before this property is set, it will be initialized to a regular instance.</p><p>This method was introduced in version 0.22. Starting with version 0.25 the displacement is of vector type.
|
| 136 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'b'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td rowspan="2"><a name="h3-232"></a><h3>bbox</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_bbox"></a><a name="k_17"></a><p><b>(1) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> bbox </b> (const <a href="class_Layout.html">Layout</a> layout, unsigned int layer_index)</p><p><b>Description</b>: Gets the bounding box of the array with respect to one layer</p><p><p>
|
| 137 |
+
The bounding box incorporates all instances that the array represents. It needs the layout object to access the actual cell from the cell index.</p><p>'bbox' is the preferred synonym since version 0.28.
|
| 138 |
+
</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_bbox"></a><a name="k_18"></a><p><b>(2) Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> bbox </b> (const <a href="class_Layout.html">Layout</a> layout)</p><p><b>Description</b>: Gets the bounding box of the array</p><p><p>
|
| 139 |
+
The bounding box incorporates all instances that the array represents. It needs the layout object to access the actual cell from the cell index.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-244"></a><h3>bbox_per_layer</h3></td><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_bbox_per_layer"></a><a name="k_19"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Box.html">Box</a><b> bbox_per_layer </b> (const <a href="class_Layout.html">Layout</a> layout, unsigned int layer_index)</p><p><b>Description</b>: Gets the bounding box of the array with respect to one layer</p><p>Use of this method is deprecated. Use bbox instead</p><p><p>
|
| 140 |
+
The bounding box incorporates all instances that the array represents. It needs the layout object to access the actual cell from the cell index.</p><p>'bbox' is the preferred synonym since version 0.28.
|
| 141 |
+
</p></p></td></tr><tr class="bigrow1"><td><a name="h3-252"></a><h3>cell=</h3></td><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_cell="></a><a name="k_20"></a><p><b>Signature</b>: void <b> cell= </b> (<a href="class_Cell.html">Cell</a> ptr cell)</p><p><b>Description</b>: Sets the cell this instance refers to</p><p><p>
|
| 142 |
+
This is a convenience method and equivalent to 'cell_index = cell.cell_index()'. There is no getter for the cell pointer because the <a href="class_CellInstArray.html">CellInstArray</a> object only knows about cell indexes.</p><p>This convenience method has been introduced in version 0.28.
|
| 143 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'cell'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-260"></a><h3>cell_index</h3></td><td style="padding-bottom: 16px"><a name="method19"></a><a name="m_cell_index"></a><a name="k_21"></a><p><b>Signature</b>: <i>[const] </i>unsigned int <b> cell_index </b></p><p><b>Description</b>: Gets the cell index of the cell instantiated </p><p><p>
|
| 144 |
+
Use <a href="class_Layout.html#m_cell">Layout#cell</a> to get the <a href="class_Cell.html">Cell</a> object from the cell index.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'cell_index'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-267"></a><h3>cell_index=</h3></td><td style="padding-bottom: 16px"><a name="method20"></a><a name="m_cell_index="></a><a name="k_22"></a><p><b>Signature</b>: void <b> cell_index= </b> (unsigned int index)</p><p><b>Description</b>: Sets the index of the cell this instance refers to</p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'cell_index'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-272"></a><h3>cplx_trans</h3></td><td style="padding-bottom: 16px"><a name="method21"></a><a name="m_cplx_trans"></a><a name="k_23"></a><p><b>Signature</b>: <i>[const] </i><a href="class_ICplxTrans.html">ICplxTrans</a><b> cplx_trans </b></p><p><b>Description</b>: Gets the complex transformation of the first instance in the array</p><p><p>
|
| 145 |
+
This method is always applicable, compared to <a href="#m_trans">trans</a>, since simple transformations can be expressed as complex transformations as well.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'cplx_trans'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-279"></a><h3>cplx_trans=</h3></td><td style="padding-bottom: 16px"><a name="method22"></a><a name="m_cplx_trans="></a><a name="k_24"></a><p><b>Signature</b>: void <b> cplx_trans= </b> (const <a href="class_ICplxTrans.html">ICplxTrans</a> trans)</p><p><b>Description</b>: Sets the complex transformation of the instance or the first instance in the array</p><p><p></p><p>This method was introduced in version 0.22.
|
| 146 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'cplx_trans'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-286"></a><h3>create</h3></td><td style="padding-bottom: 16px"><a name="method23"></a><a name="m_create"></a><a name="k_25"></a><p><b>Signature</b>: void <b> create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p>Use of this method is deprecated. Use _create instead</p><p><p>
|
| 147 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-293"></a><h3>destroy</h3></td><td style="padding-bottom: 16px"><a name="method24"></a><a name="m_destroy"></a><a name="k_26"></a><p><b>Signature</b>: void <b> destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p>Use of this method is deprecated. Use _destroy instead</p><p><p>
|
| 148 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 149 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-301"></a><h3>destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method25"></a><a name="m_destroyed?"></a><a name="k_27"></a><p><b>Signature</b>: <i>[const] </i>bool <b> destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p>Use of this method is deprecated. Use _destroyed? instead</p><p><p>
|
| 150 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 151 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-309"></a><h3>dup</h3></td><td style="padding-bottom: 16px"><a name="method26"></a><a name="m_dup"></a><a name="k_28"></a><p><b>Signature</b>: <i>[const] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> dup </b></p><p><b>Description</b>: Creates a copy of self</p><p><b>Python specific notes: </b><br>This method also implements '__copy__' and '__deepcopy__'.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-314"></a><h3>each_cplx_trans</h3></td><td style="padding-bottom: 16px"><a name="method27"></a><a name="m_each_cplx_trans"></a><a name="k_29"></a><p><b>Signature</b>: <i>[const,iter] </i><a href="class_ICplxTrans.html">ICplxTrans</a><b> each_cplx_trans </b></p><p><b>Description</b>: Gets the complex transformations represented by this instance</p><p><p>
|
| 152 |
+
For a single instance, this iterator will deliver the single, complex transformation. For array instances, the iterator will deliver each complex transformation of the expanded array.
|
| 153 |
+
This iterator is a generalization of <a href="#m_each_trans">each_trans</a> for general complex transformations.</p><p>This method has been introduced in version 0.25.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-321"></a><h3>each_trans</h3></td><td style="padding-bottom: 16px"><a name="method28"></a><a name="m_each_trans"></a><a name="k_30"></a><p><b>Signature</b>: <i>[const,iter] </i><a href="class_Trans.html">Trans</a><b> each_trans </b></p><p><b>Description</b>: Gets the simple transformations represented by this instance</p><p><p>
|
| 154 |
+
For a single instance, this iterator will deliver the single, simple transformation. For array instances, the iterator will deliver each simple transformation of the expanded array.</p><p>This iterator will only deliver valid transformations if the instance array is not of complex type (see <a href="#m_is_complex?">is_complex?</a>). A more general iterator that delivers the complex transformations is <a href="#m_each_cplx_trans">each_cplx_trans</a>.</p><p>This method has been introduced in version 0.25.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-327"></a><h3>hash</h3></td><td style="padding-bottom: 16px"><a name="method29"></a><a name="m_hash"></a><a name="k_31"></a><p><b>Signature</b>: <i>[const] </i>unsigned long <b> hash </b></p><p><b>Description</b>: Computes a hash value</p><p><p>
|
| 155 |
+
Returns a hash value for the given cell instance. This method enables cell instances as hash keys.</p><p>This method has been introduced in version 0.25.
|
| 156 |
+
</p></p><p><b>Python specific notes: </b><br>This method is also available as 'hash(object)'.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-335"></a><h3>invert</h3></td><td style="padding-bottom: 16px"><a name="method30"></a><a name="m_invert"></a><a name="k_32"></a><p><b>Signature</b>: void <b> invert </b></p><p><b>Description</b>: Inverts the array reference</p><p><p></p><p>The inverted array reference describes in which transformations the parent cell is
|
| 157 |
+
seen from the current cell.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-341"></a><h3>is_complex?</h3></td><td style="padding-bottom: 16px"><a name="method31"></a><a name="m_is_complex?"></a><a name="k_33"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_complex? </b></p><p><b>Description</b>: Gets a value indicating whether the array is a complex array</p><p><p></p><p>Returns true if the array represents complex instances (that is, with magnification and
|
| 158 |
+
arbitrary rotation angles).
|
| 159 |
+
</p></p></td></tr><tr class="bigrow1"><td><a name="h3-348"></a><h3>is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method32"></a><a name="m_is_const_object?"></a><a name="k_34"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p>Use of this method is deprecated. Use _is_const_object? instead</p><p><p>
|
| 160 |
+
This method returns true, if self is a const reference.
|
| 161 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-356"></a><h3>is_regular_array?</h3></td><td style="padding-bottom: 16px"><a name="method33"></a><a name="m_is_regular_array?"></a><a name="k_35"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_regular_array? </b></p><p><b>Description</b>: Gets a value indicating whether this instance is a regular array</p></td></tr><tr class="bigrow1"><td><a name="h3-360"></a><h3>na</h3></td><td style="padding-bottom: 16px"><a name="method34"></a><a name="m_na"></a><a name="k_36"></a><p><b>Signature</b>: <i>[const] </i>unsigned long <b> na </b></p><p><b>Description</b>: Gets the number of instances in the 'a' axis</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'na'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-365"></a><h3>na=</h3></td><td style="padding-bottom: 16px"><a name="method35"></a><a name="m_na="></a><a name="k_37"></a><p><b>Signature</b>: void <b> na= </b> (unsigned long n)</p><p><b>Description</b>: Sets the number of instances in the 'a' axis</p><p><p></p><p>If the instance was not regular before this property is set to a value larger than zero, it will be initialized to a regular instance.
|
| 162 |
+
To make an instance a single instance, set na or nb to 0.</p><p>This method was introduced in version 0.22.
|
| 163 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'na'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-373"></a><h3>nb</h3></td><td style="padding-bottom: 16px"><a name="method36"></a><a name="m_nb"></a><a name="k_38"></a><p><b>Signature</b>: <i>[const] </i>unsigned long <b> nb </b></p><p><b>Description</b>: Gets the number of instances in the 'b' axis</p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'nb'. This is the getter.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-378"></a><h3>nb=</h3></td><td style="padding-bottom: 16px"><a name="method37"></a><a name="m_nb="></a><a name="k_39"></a><p><b>Signature</b>: void <b> nb= </b> (unsigned long n)</p><p><b>Description</b>: Sets the number of instances in the 'b' axis</p><p><p></p><p>If the instance was not regular before this property is set to a value larger than zero, it will be initialized to a regular instance.
|
| 164 |
+
To make an instance a single instance, set na or nb to 0.</p><p>This method was introduced in version 0.22.
|
| 165 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'nb'. This is the setter.<br></p></td></tr><tr class="bigrow1"><td rowspan="13"><a name="h3-386"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method38"></a><a name="m_new"></a><a name="k_40"></a><p><b>(1) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b></p><p><b>Description</b>: Creates en empty cell instance with size 0</p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method39"></a><a name="m_new"></a><a name="k_41"></a><p><b>(2) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (unsigned int cell_index, const <a href="class_Trans.html">Trans</a> trans)</p><p><b>Description</b>: Creates a single cell instance</p><table class="layout-table"><tr><td><b>cell_index</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>trans</b>:</td><td>The transformation by which to instantiate the cell</td></tr></table><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method40"></a><a name="m_new"></a><a name="k_42"></a><p><b>(3) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (const <a href="class_Cell.html">Cell</a> ptr cell, const <a href="class_Trans.html">Trans</a> trans)</p><p><b>Description</b>: Creates a single cell instance</p><table class="layout-table"><tr><td><b>cell</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>trans</b>:</td><td>The transformation by which to instantiate the cell</td></tr></table><p><p></p><p>This convenience variant takes a <a href="class_Cell.html">Cell</a> pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method41"></a><a name="m_new"></a><a name="k_43"></a><p><b>(4) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (unsigned int cell_index, const <a href="class_Vector.html">Vector</a> disp)</p><p><b>Description</b>: Creates a single cell instance</p><table class="layout-table"><tr><td><b>cell_index</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>disp</b>:</td><td>The displacement</td></tr></table><p><p></p><p>This convenience initializer has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method42"></a><a name="m_new"></a><a name="k_44"></a><p><b>(5) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (const <a href="class_Cell.html">Cell</a> ptr cell, const <a href="class_Vector.html">Vector</a> disp)</p><p><b>Description</b>: Creates a single cell instance</p><table class="layout-table"><tr><td><b>cell</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>disp</b>:</td><td>The displacement</td></tr></table><p><p></p><p>This convenience variant takes a <a href="class_Cell.html">Cell</a> pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method43"></a><a name="m_new"></a><a name="k_45"></a><p><b>(6) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (unsigned int cell_index, const <a href="class_ICplxTrans.html">ICplxTrans</a> trans)</p><p><b>Description</b>: Creates a single cell instance with a complex transformation</p><table class="layout-table"><tr><td><b>cell_index</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>trans</b>:</td><td>The complex transformation by which to instantiate the cell</td></tr></table><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method44"></a><a name="m_new"></a><a name="k_46"></a><p><b>(7) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (const <a href="class_Cell.html">Cell</a> ptr cell, const <a href="class_ICplxTrans.html">ICplxTrans</a> trans)</p><p><b>Description</b>: Creates a single cell instance with a complex transformation</p><table class="layout-table"><tr><td><b>cell</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>trans</b>:</td><td>The complex transformation by which to instantiate the cell</td></tr></table><p><p></p><p>This convenience variant takes a <a href="class_Cell.html">Cell</a> pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method45"></a><a name="m_new"></a><a name="k_47"></a><p><b>(8) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (unsigned int cell_index, const <a href="class_Trans.html">Trans</a> trans, const <a href="class_Vector.html">Vector</a> a, const <a href="class_Vector.html">Vector</a> b, unsigned long na, unsigned long nb)</p><p><b>Description</b>: Creates a single cell instance</p><table class="layout-table"><tr><td><b>cell_index</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>trans</b>:</td><td>The transformation by which to instantiate the cell</td></tr><tr><td><b>a</b>:</td><td>The displacement vector of the array in the 'a' axis</td></tr><tr><td><b>b</b>:</td><td>The displacement vector of the array in the 'b' axis</td></tr><tr><td><b>na</b>:</td><td>The number of placements in the 'a' axis</td></tr><tr><td><b>nb</b>:</td><td>The number of placements in the 'b' axis</td></tr></table><p><p></p><p>Starting with version 0.25 the displacements are of vector type.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method46"></a><a name="m_new"></a><a name="k_48"></a><p><b>(9) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (const <a href="class_Cell.html">Cell</a> ptr cell, const <a href="class_Trans.html">Trans</a> trans, const <a href="class_Vector.html">Vector</a> a, const <a href="class_Vector.html">Vector</a> b, unsigned long na, unsigned long nb)</p><p><b>Description</b>: Creates a single cell instance</p><table class="layout-table"><tr><td><b>cell</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>trans</b>:</td><td>The transformation by which to instantiate the cell</td></tr><tr><td><b>a</b>:</td><td>The displacement vector of the array in the 'a' axis</td></tr><tr><td><b>b</b>:</td><td>The displacement vector of the array in the 'b' axis</td></tr><tr><td><b>na</b>:</td><td>The number of placements in the 'a' axis</td></tr><tr><td><b>nb</b>:</td><td>The number of placements in the 'b' axis</td></tr></table><p><p></p><p>This convenience variant takes a <a href="class_Cell.html">Cell</a> pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method47"></a><a name="m_new"></a><a name="k_49"></a><p><b>(10) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (unsigned int cell_index, const <a href="class_Vector.html">Vector</a> disp, const <a href="class_Vector.html">Vector</a> a, const <a href="class_Vector.html">Vector</a> b, unsigned long na, unsigned long nb)</p><p><b>Description</b>: Creates a single cell instance</p><table class="layout-table"><tr><td><b>cell_index</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>disp</b>:</td><td>The basic displacement of the first instance</td></tr><tr><td><b>a</b>:</td><td>The displacement vector of the array in the 'a' axis</td></tr><tr><td><b>b</b>:</td><td>The displacement vector of the array in the 'b' axis</td></tr><tr><td><b>na</b>:</td><td>The number of placements in the 'a' axis</td></tr><tr><td><b>nb</b>:</td><td>The number of placements in the 'b' axis</td></tr></table><p><p></p><p>This convenience initializer has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method48"></a><a name="m_new"></a><a name="k_50"></a><p><b>(11) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (const <a href="class_Cell.html">Cell</a> ptr cell, const <a href="class_Vector.html">Vector</a> disp, const <a href="class_Vector.html">Vector</a> a, const <a href="class_Vector.html">Vector</a> b, unsigned long na, unsigned long nb)</p><p><b>Description</b>: Creates a single cell instance</p><table class="layout-table"><tr><td><b>cell</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>disp</b>:</td><td>The basic displacement of the first instance</td></tr><tr><td><b>a</b>:</td><td>The displacement vector of the array in the 'a' axis</td></tr><tr><td><b>b</b>:</td><td>The displacement vector of the array in the 'b' axis</td></tr><tr><td><b>na</b>:</td><td>The number of placements in the 'a' axis</td></tr><tr><td><b>nb</b>:</td><td>The number of placements in the 'b' axis</td></tr></table><p><p></p><p>This convenience variant takes a <a href="class_Cell.html">Cell</a> pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method49"></a><a name="m_new"></a><a name="k_51"></a><p><b>(12) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (unsigned int cell_index, const <a href="class_ICplxTrans.html">ICplxTrans</a> trans, const <a href="class_Vector.html">Vector</a> a, const <a href="class_Vector.html">Vector</a> b, unsigned long na, unsigned long nb)</p><p><b>Description</b>: Creates a single cell instance with a complex transformation</p><table class="layout-table"><tr><td><b>cell_index</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>trans</b>:</td><td>The complex transformation by which to instantiate the cell</td></tr><tr><td><b>a</b>:</td><td>The displacement vector of the array in the 'a' axis</td></tr><tr><td><b>b</b>:</td><td>The displacement vector of the array in the 'b' axis</td></tr><tr><td><b>na</b>:</td><td>The number of placements in the 'a' axis</td></tr><tr><td><b>nb</b>:</td><td>The number of placements in the 'b' axis</td></tr></table><p><p></p><p>Starting with version 0.25 the displacements are of vector type.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method50"></a><a name="m_new"></a><a name="k_52"></a><p><b>(13) Signature</b>: <i>[static] </i>new <a href="class_CellInstArray.html">CellInstArray</a> ptr <b> new </b> (const <a href="class_Cell.html">Cell</a> ptr cell, const <a href="class_ICplxTrans.html">ICplxTrans</a> trans, const <a href="class_Vector.html">Vector</a> a, const <a href="class_Vector.html">Vector</a> b, unsigned long na, unsigned long nb)</p><p><b>Description</b>: Creates a single cell instance with a complex transformation</p><table class="layout-table"><tr><td><b>cell</b>:</td><td>The cell to instantiate</td></tr><tr><td><b>trans</b>:</td><td>The complex transformation by which to instantiate the cell</td></tr><tr><td><b>a</b>:</td><td>The displacement vector of the array in the 'a' axis</td></tr><tr><td><b>b</b>:</td><td>The displacement vector of the array in the 'b' axis</td></tr><tr><td><b>na</b>:</td><td>The number of placements in the 'a' axis</td></tr><tr><td><b>nb</b>:</td><td>The number of placements in the 'b' axis</td></tr></table><p><p></p><p>This convenience variant takes a <a href="class_Cell.html">Cell</a> pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28.</p></p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-521"></a><h3>size</h3></td><td style="padding-bottom: 16px"><a name="method51"></a><a name="m_size"></a><a name="k_53"></a><p><b>Signature</b>: <i>[const] </i>unsigned long <b> size </b></p><p><b>Description</b>: Gets the number of single instances in the array</p><p><p>
|
| 166 |
+
If the instance represents a single instance, the count is 1. Otherwise it is na*nb. Starting with version 0.27, there may be iterated instances for which the size is larger than 1, but <a href="#m_is_regular_array?">is_regular_array?</a> will return false. In this case, use <a href="#m_each_trans">each_trans</a> or <a href="#m_each_cplx_trans">each_cplx_trans</a> to retrieve the individual placements of the iterated instance.</p></p><p><b>Python specific notes: </b><br>This method is also available as 'len(object)'.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-528"></a><h3>to_s</h3></td><td style="padding-bottom: 16px"><a name="method52"></a><a name="m_to_s"></a><a name="k_54"></a><p><b>Signature</b>: <i>[const] </i>string <b> to_s </b></p><p><b>Description</b>: Converts the array to a string</p><p><p></p><p>This method was introduced in version 0.22.
|
| 167 |
+
</p></p><p><b>Python specific notes: </b><br>This method is also available as 'str(object)'.<br></p></td></tr><tr class="bigrow0"><td><a name="h3-535"></a><h3>trans</h3></td><td style="padding-bottom: 16px"><a name="method53"></a><a name="m_trans"></a><a name="k_55"></a><p><b>Signature</b>: <i>[const] </i><a href="class_Trans.html">Trans</a><b> trans </b></p><p><b>Description</b>: Gets the transformation of the first instance in the array</p><p><p>
|
| 168 |
+
The transformation returned is only valid if the array does not represent a complex transformation array</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'trans'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-542"></a><h3>trans=</h3></td><td style="padding-bottom: 16px"><a name="method54"></a><a name="m_trans="></a><a name="k_56"></a><p><b>Signature</b>: void <b> trans= </b> (const <a href="class_Trans.html">Trans</a> t)</p><p><b>Description</b>: Sets the transformation of the instance or the first instance in the array</p><p><p></p><p>This method was introduced in version 0.22.
|
| 169 |
+
</p></p><p><b>Python specific notes: </b><br>The object exposes a writable attribute 'trans'. This is the setter.<br></p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-549"></a><h3>transform</h3></td><td style="padding-bottom: 16px"><a name="method55"></a><a name="m_transform"></a><a name="k_57"></a><p><b>(1) Signature</b>: void <b> transform </b> (const <a href="class_Trans.html">Trans</a> trans)</p><p><b>Description</b>: Transforms the cell instance with the given transformation</p><p><p></p><p>This method has been introduced in version 0.20.
|
| 170 |
+
</p></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method56"></a><a name="m_transform"></a><a name="k_58"></a><p><b>(2) Signature</b>: void <b> transform </b> (const <a href="class_ICplxTrans.html">ICplxTrans</a> trans)</p><p><b>Description</b>: Transforms the cell instance with the given complex transformation</p><p><p></p><p>This method has been introduced in version 0.20.
|
| 171 |
+
</p></p></td></tr><tr class="bigrow1"><td rowspan="2"><a name="h3-560"></a><h3>transformed</h3></td><td style="padding-bottom: 16px"><a name="method57"></a><a name="m_transformed"></a><a name="k_59"></a><p><b>(1) Signature</b>: <i>[const] </i><a href="class_CellInstArray.html">CellInstArray</a><b> transformed </b> (const <a href="class_Trans.html">Trans</a> trans)</p><p><b>Description</b>: Gets the transformed cell instance</p><p><p></p><p>This method has been introduced in version 0.20.
|
| 172 |
+
</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method58"></a><a name="m_transformed"></a><a name="k_60"></a><p><b>(2) Signature</b>: <i>[const] </i><a href="class_CellInstArray.html">CellInstArray</a><b> transformed </b> (const <a href="class_ICplxTrans.html">ICplxTrans</a> trans)</p><p><b>Description</b>: Gets the transformed cell instance (complex transformation)</p><p><p></p><p>This method has been introduced in version 0.20.
|
| 173 |
+
</p></p></td></tr></table></div>
|
| 174 |
+
</div>
|
| 175 |
+
</body>
|
| 176 |
+
</html>
|
| 177 |
+
|
html/klayout_docs/www.klayout.de/doc-qt5/code/class_CellMapping.html
ADDED
|
@@ -0,0 +1,186 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
+
<html>
|
| 3 |
+
<head>
|
| 4 |
+
|
| 5 |
+
<!-- Meta -->
|
| 6 |
+
<meta name="Description" content="KLayout layout viewer and editor project page" />
|
| 7 |
+
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" />
|
| 8 |
+
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" />
|
| 9 |
+
<meta name="URL" content="https://www.klayout.de/" />
|
| 10 |
+
<meta name="Author" content="Matthias Koefferlein" />
|
| 11 |
+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
| 12 |
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
| 13 |
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
| 14 |
+
|
| 15 |
+
<title>KLayout Layout Viewer And Editor</title>
|
| 16 |
+
|
| 17 |
+
<!-- General -->
|
| 18 |
+
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/>
|
| 19 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/>
|
| 20 |
+
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/>
|
| 21 |
+
|
| 22 |
+
<!-- Fonts -->
|
| 23 |
+
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/>
|
| 24 |
+
|
| 25 |
+
<!-- jQuery -->
|
| 26 |
+
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script>
|
| 27 |
+
|
| 28 |
+
<!-- bootstrap -->
|
| 29 |
+
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet">
|
| 30 |
+
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script>
|
| 31 |
+
|
| 32 |
+
<link href="/generated-doc.css" rel="stylesheet">
|
| 33 |
+
<link href="/search.css" rel="stylesheet">
|
| 34 |
+
<script src="/klayout-search.js"></script>
|
| 35 |
+
|
| 36 |
+
</head>
|
| 37 |
+
|
| 38 |
+
<body>
|
| 39 |
+
|
| 40 |
+
<div class="klayout-header">
|
| 41 |
+
|
| 42 |
+
<div class="container mb-5">
|
| 43 |
+
|
| 44 |
+
<nav class="navbar navbar-dark navbar-expand-lg">
|
| 45 |
+
|
| 46 |
+
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a>
|
| 47 |
+
|
| 48 |
+
<div class="collapse navbar-collapse" id="navbarToggleExternalContent">
|
| 49 |
+
|
| 50 |
+
<ul class="navbar-nav ml-auto mr-auto">
|
| 51 |
+
|
| 52 |
+
<li class="nav-item dropdown active mr-4">
|
| 53 |
+
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
| 54 |
+
About
|
| 55 |
+
</a>
|
| 56 |
+
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
|
| 57 |
+
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a>
|
| 58 |
+
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a>
|
| 59 |
+
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a>
|
| 60 |
+
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a>
|
| 61 |
+
<div class="dropdown-divider"></div>
|
| 62 |
+
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a>
|
| 63 |
+
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a>
|
| 64 |
+
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a>
|
| 65 |
+
</div>
|
| 66 |
+
</li>
|
| 67 |
+
<li class="nav-item active mr-4">
|
| 68 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a>
|
| 69 |
+
</li>
|
| 70 |
+
<li class="nav-item active mr-4">
|
| 71 |
+
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a>
|
| 72 |
+
</li>
|
| 73 |
+
<li class="nav-item active mr-5">
|
| 74 |
+
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a>
|
| 75 |
+
</li>
|
| 76 |
+
<li class="nav-item active">
|
| 77 |
+
<span class="nav-link klayout-menu">
|
| 78 |
+
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a>
|
| 79 |
+
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a>
|
| 80 |
+
</span>
|
| 81 |
+
</li>
|
| 82 |
+
|
| 83 |
+
</ul>
|
| 84 |
+
|
| 85 |
+
</div>
|
| 86 |
+
|
| 87 |
+
<!-- collapse button -->
|
| 88 |
+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
|
| 89 |
+
<span class="navbar-toggler-icon"></span>
|
| 90 |
+
</button>
|
| 91 |
+
|
| 92 |
+
</nav>
|
| 93 |
+
|
| 94 |
+
</div>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
|
| 98 |
+
<div class="container">
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
<form class="search">
|
| 105 |
+
<div class="input-group">
|
| 106 |
+
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()">
|
| 107 |
+
<div class="input-group-append">
|
| 108 |
+
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button>
|
| 109 |
+
</div>
|
| 110 |
+
</div>
|
| 111 |
+
</form>
|
| 112 |
+
|
| 113 |
+
<div id="search-result">
|
| 114 |
+
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div>
|
| 115 |
+
<div id="search-results-container">
|
| 116 |
+
</div>
|
| 117 |
+
</div>
|
| 118 |
+
|
| 119 |
+
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Class Index</a> » API reference - Class CellMapping</p><h1>API reference - Class CellMapping</h1><property name="module" value="db"></property><a name="k_1"></a><p><a href="../about/rba_notation.html">Notation used in Ruby API documentation</a></p><p><b>Module</b>: <a href="module_db.html">db</a></p><p><b>Description</b>: A cell mapping (source to target layout)</p><ul><li><a href="#h2-57">Public constructors</a></li><li><a href="#h2-62">Public methods</a></li><li><a href="#h2-125">Public static methods and constants</a></li><li><a href="#h2-130">Deprecated methods (protected, public, static, non-static and constructors)</a></li><li><a href="#h2-141">Detailed description</a></li></ul><p></p><p>A cell mapping is an association of cells in two layouts forming pairs of cells, i.e. one cell corresponds to another cell in the other layout. The CellMapping object describes the mapping of cells of a source layout B to a target layout A. The cell mapping object is basically a table associating a cell in layout B with a cell in layout A.</p><p>The cell mapping is of particular interest for providing the cell mapping recipe in <a href="class_Cell.html#m_copy_tree_shapes">Cell#copy_tree_shapes</a> or <a href="class_Cell.html#m_move_tree_shapes">Cell#move_tree_shapes</a>.</p><p>The mapping object is used to create and hold that table. There are three basic modes in which a table can be generated:</p><p><ul><li> Top-level identity (<a href="#m_for_single_cell">for_single_cell</a> and <a href="#m_for_single_cell_full">for_single_cell_full</a>) </li><li> Top-level identify for multiple cells (<a href="#m_for_multi_cells_full">for_multi_cells_full</a> and <a href="#m_for_multi_cells_full">for_multi_cells_full</a>) </li><li> Geometrical identity (<a href="#m_from_geometry">from_geometry</a> and <a href="#m_from_geometry_full">from_geometry_full</a>)</li><li> Name identity (<a href="#m_from_names">from_names</a> and <a href="#m_from_names_full">from_names_full</a>) </li></ul></p><p>'full' refers to the way cells are treated which are not mentioned. In the 'full' versions, cells for which no mapping is established explicitly - specifically all child cells in top-level identity modes - are created in the target layout and instantiated according to their source layout hierarchy. Then, these new cells become targets of the respective source cells. In the plain version (without 'full' cells), no additional cells are created. For the case of <a href="class_Layout.html#m_copy_tree_shapes">Layout#copy_tree_shapes</a> cells not explicitly mapped are flattened. Hence for example, <a href="#m_for_single_cell">for_single_cell</a> will flatten all children of the source cell during <a href="class_Layout.html#m_copy_tree_shapes">Layout#copy_tree_shapes</a> or <a href="class_Layout.html#m_move_tree_shapes">Layout#move_tree_shapes</a>.</p><p>Top-level identity means that only one cell (the top cell) is regarded identical. All child cells are not considered identical. In full mode (see below), this will create a new, identical cell tree below the top cell in layout A.</p><p>Geometrical identity is defined by the exact identity of the set of expanded instances in each starting cell. Therefore, when a cell is mapped to another cell, shapes can be transferred from one cell to another while effectively rendering the same flat geometry (in the context of the given starting cells). Location identity is basically the safest way to map cells from one hierarchy into another, because it preserves the flat shape geometry. However in some cases the algorithm may find multiple mapping candidates. In that case it will make a guess about what mapping to choose.</p><p>Name identity means that cells are identified by their names - for a source cell in layer B, a target cell with the same name is looked up in the target layout A and a mapping is created if a cell with the same name is found. However, name identity does not mean that the cells are actually equivalent because they may be placed differently. Hence, cell mapping by name is not a good choice when it is important to preserve the shape geometry of a layer.</p><p>A cell might not be mapped to another cell which basically means that there is no corresponding cell. In this case, flattening to the next mapped cell is an option to transfer geometries despite the missing mapping. You can enforce a mapping by using the mapping generator methods in 'full' mode, i.e. <a href="#m_from_names_full">from_names_full</a> or <a href="#m_from_geometry_full">from_geometry_full</a>. These versions will create new cells and their corresponding instances in the target layout if no suitable target cell is found.</p><p>This is a simple example for a cell mapping preserving the hierarchy of the source cell and creating a hierarchy copy in the top cell of the target layout ('hierarchical merge'):</p><p><pre>
|
| 120 |
+
cell_names = [ "A", "B", "C" ]
|
| 121 |
+
|
| 122 |
+
source = RBA::Layout::new
|
| 123 |
+
source.read("input.gds")
|
| 124 |
+
|
| 125 |
+
target = RBA::Layout::new
|
| 126 |
+
target_top = target.create_cell("IMPORTED")
|
| 127 |
+
|
| 128 |
+
cm = RBA::CellMapping::new
|
| 129 |
+
# Copies the source layout hierarchy into the target top cell:
|
| 130 |
+
cm.for_single_cell_full(target_top, source.top_cell)
|
| 131 |
+
target.copy_tree_shapes(source, cm)
|
| 132 |
+
</pre></p><p>Without 'full', the effect is move-with-flattening (note we're using 'move' in this example):</p><p><pre>
|
| 133 |
+
cell_names = [ "A", "B", "C" ]
|
| 134 |
+
|
| 135 |
+
source = RBA::Layout::new
|
| 136 |
+
source.read("input.gds")
|
| 137 |
+
|
| 138 |
+
target = RBA::Layout::new
|
| 139 |
+
target_top = target.create_cell("IMPORTED")
|
| 140 |
+
|
| 141 |
+
cm = RBA::CellMapping::new
|
| 142 |
+
# Flattens the source layout hierarchy into the target top cell:
|
| 143 |
+
cm.for_single_cell(target_top, source.top_cell)
|
| 144 |
+
target.move_tree_shapes(source, cm)
|
| 145 |
+
</pre></p><p>This is another example for using <a href="class_CellMapping.html">CellMapping</a> in multiple top cell identity mode. It extracts cells 'A', 'B' and 'C' from one layout and copies them to another. It will also copy all shapes and all child cells. Child cells which are shared between the three initial cells will be shared in the target layout too.</p><p><pre>
|
| 146 |
+
cell_names = [ "A", "B", "C" ]
|
| 147 |
+
|
| 148 |
+
source = RBA::Layout::new
|
| 149 |
+
source.read("input.gds")
|
| 150 |
+
|
| 151 |
+
target = RBA::Layout::new
|
| 152 |
+
|
| 153 |
+
source_cells = cell_names.collect { |n| source.cell_by_name(n) }
|
| 154 |
+
target_cells = cell_names.collect { |n| target.create_cell(n) }
|
| 155 |
+
|
| 156 |
+
cm = RBA::CellMapping::new
|
| 157 |
+
cm.for_multi_cells_full(target_cells, source_cells)
|
| 158 |
+
target.copy_tree_shapes(source, cm)
|
| 159 |
+
</pre></p><a name="h2-57"></a><h2>Public constructors</h2><table><tr class="row0"><td>new CellMapping ptr</td><td><b><a href="#method34">new</a></b></td><td></td><td>Creates a new object of this class</td></tr></table><a name="h2-62"></a><h2>Public methods</h2><table><tr class="row0"><td><i>[const]</i></td><td>CellMapping ptr</td><td><b><a href="#method1">_const_cast</a></b></td><td></td><td>Returns a non-const reference to self.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method2">_create</a></b></td><td></td><td>Ensures the C++ object is created</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method3">_destroy</a></b></td><td></td><td>Explicitly destroys the object</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method4">_destroyed?</a></b></td><td></td><td>Returns a value indicating whether the object was already destroyed</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method5">_is_const_object?</a></b></td><td></td><td>Returns a value indicating whether the reference is a const reference</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method6">_manage</a></b></td><td></td><td>Marks the object as managed by the script side.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method7">_unmanage</a></b></td><td></td><td>Marks the object as no longer owned by the script side.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method8">assign</a></b></td><td>(const CellMapping other)</td><td>Assigns another object to self</td></tr><tr class="row0"><td><i>[const]</i></td><td>unsigned int</td><td><b><a href="#method9">cell_mapping</a></b></td><td>(unsigned int cell_index_b)</td><td>Determines cell mapping of a layout_b cell to the corresponding layout_a cell.</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method10">clear</a></b></td><td></td><td>Clears the mapping.</td></tr><tr class="row0"><td><i>[const]</i></td><td>new CellMapping ptr</td><td><b><a href="#method14">dup</a></b></td><td></td><td>Creates a copy of self</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method15">for_multi_cells</a></b></td><td>(const Layout layout_a,<br>unsigned int[] cell_indexes_a,<br>const Layout layout_b,<br>unsigned int[] cell_indexes_b)</td><td>Initializes the cell mapping for top-level identity</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method16">for_multi_cells</a></b></td><td>(Cell ptr[] cell_a,<br>const Cell ptr[] cell_b)</td><td>Initializes the cell mapping for top-level identity</td></tr><tr class="row1"><td></td><td>unsigned int[]</td><td><b><a href="#method17">for_multi_cells_full</a></b></td><td>(Layout layout_a,<br>unsigned int[] cell_indexes_a,<br>const Layout layout_b,<br>unsigned int[] cell_indexes_b)</td><td>Initializes the cell mapping for top-level identity in full mapping mode</td></tr><tr class="row0"><td></td><td>unsigned int[]</td><td><b><a href="#method18">for_multi_cells_full</a></b></td><td>(Cell ptr[] cell_a,<br>const Cell ptr[] cell_b)</td><td>Initializes the cell mapping for top-level identity in full mapping mode</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method19">for_single_cell</a></b></td><td>(const Layout layout_a,<br>unsigned int cell_index_a,<br>const Layout layout_b,<br>unsigned int cell_index_b)</td><td>Initializes the cell mapping for top-level identity</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method20">for_single_cell</a></b></td><td>(Cell cell_a,<br>const Cell cell_b)</td><td>Initializes the cell mapping for top-level identity</td></tr><tr class="row1"><td></td><td>unsigned int[]</td><td><b><a href="#method21">for_single_cell_full</a></b></td><td>(Layout layout_a,<br>unsigned int cell_index_a,<br>const Layout layout_b,<br>unsigned int cell_index_b)</td><td>Initializes the cell mapping for top-level identity in full mapping mode</td></tr><tr class="row0"><td></td><td>unsigned int[]</td><td><b><a href="#method22">for_single_cell_full</a></b></td><td>(Cell cell_a,<br>const Cell cell_b)</td><td>Initializes the cell mapping for top-level identity in full mapping mode</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method23">from_geometry</a></b></td><td>(const Layout layout_a,<br>unsigned int cell_index_a,<br>const Layout layout_b,<br>unsigned int cell_index_b)</td><td>Initializes the cell mapping using the geometrical identity</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method24">from_geometry</a></b></td><td>(Cell cell_a,<br>const Cell cell_b)</td><td>Initializes the cell mapping using the geometrical identity</td></tr><tr class="row1"><td></td><td>unsigned int[]</td><td><b><a href="#method25">from_geometry_full</a></b></td><td>(Layout layout_a,<br>unsigned int cell_index_a,<br>const Layout layout_b,<br>unsigned int cell_index_b)</td><td>Initializes the cell mapping using the geometrical identity in full mapping mode</td></tr><tr class="row0"><td></td><td>unsigned int[]</td><td><b><a href="#method26">from_geometry_full</a></b></td><td>(Cell cell_a,<br>const Cell cell_b)</td><td>Initializes the cell mapping using the geometrical identity in full mapping mode</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method27">from_names</a></b></td><td>(const Layout layout_a,<br>unsigned int cell_index_a,<br>const Layout layout_b,<br>unsigned int cell_index_b)</td><td>Initializes the cell mapping using the name identity</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method28">from_names</a></b></td><td>(Cell cell_a,<br>const Cell cell_b)</td><td>Initializes the cell mapping using the name identity</td></tr><tr class="row1"><td></td><td>unsigned int[]</td><td><b><a href="#method29">from_names_full</a></b></td><td>(Layout layout_a,<br>unsigned int cell_index_a,<br>const Layout layout_b,<br>unsigned int cell_index_b)</td><td>Initializes the cell mapping using the name identity in full mapping mode</td></tr><tr class="row0"><td></td><td>unsigned int[]</td><td><b><a href="#method30">from_names_full</a></b></td><td>(Cell cell_a,<br>const Cell cell_b)</td><td>Initializes the cell mapping using the name identity in full mapping mode</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method31">has_mapping?</a></b></td><td>(unsigned int cell_index_b)</td><td>Returns as value indicating whether a cell of layout_b has a mapping to a layout_a cell.</td></tr><tr class="row0"><td></td><td>void</td><td><b><a href="#method33">map</a></b></td><td>(unsigned int cell_index_b,<br>unsigned int cell_index_a)</td><td>Explicitly specifies a mapping.</td></tr><tr class="row1"><td><i>[const]</i></td><td>map<unsigned int,unsigned int></td><td><b><a href="#method35">table</a></b></td><td></td><td>Returns the mapping table.</td></tr></table><a name="h2-125"></a><h2>Public static methods and constants</h2><table><tr class="row0"><td></td><td>unsigned int</td><td><b><a href="#method0">DropCell</a></b></td><td></td><td>A constant indicating the request to drop a cell</td></tr></table><a name="h2-130"></a><h2>Deprecated methods (protected, public, static, non-static and constructors)</h2><table><tr class="row0"><td></td><td>void</td><td><b><a href="#method11">create</a></b></td><td></td><td>Use of this method is deprecated. Use _create instead</td></tr><tr class="row1"><td></td><td>void</td><td><b><a href="#method12">destroy</a></b></td><td></td><td>Use of this method is deprecated. Use _destroy instead</td></tr><tr class="row0"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method13">destroyed?</a></b></td><td></td><td>Use of this method is deprecated. Use _destroyed? instead</td></tr><tr class="row1"><td><i>[const]</i></td><td>bool</td><td><b><a href="#method32">is_const_object?</a></b></td><td></td><td>Use of this method is deprecated. Use _is_const_object? instead</td></tr></table><a name="detailed"></a><a name="h2-141"></a><h2>Detailed description</h2><table><tr class="bigrow0"><td><a name="h3-142"></a><h3>DropCell</h3></td><td style="padding-bottom: 16px"><a name="method0"></a><a name="m_DropCell"></a><a name="k_2"></a><p><b>Signature</b>: <i>[static] </i>unsigned int <b> DropCell </b></p><p><b>Description</b>: A constant indicating the request to drop a cell</p><p><p></p><p>If used as a pseudo-target for the cell mapping, this index indicates that the cell shall be dropped rather than created on the target side or skipped by flattening. Instead, all shapes of this cell are discarded and its children are not translated unless explicitly requested or if required are children for other cells.</p><p>This constant has been introduced in version 0.25.</p></p><p><b>Python specific notes: </b><br>The object exposes a readable attribute 'DropCell'. This is the getter.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-148"></a><h3>_const_cast</h3></td><td style="padding-bottom: 16px"><a name="method1"></a><a name="m__const_cast"></a><a name="k_3"></a><p><b>Signature</b>: <i>[const] </i><a href="class_CellMapping.html">CellMapping</a> ptr <b> _const_cast </b></p><p><b>Description</b>: Returns a non-const reference to self.</p><p><p>
|
| 160 |
+
Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.</p><p>This method has been introduced in version 0.29.6.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-154"></a><h3>_create</h3></td><td style="padding-bottom: 16px"><a name="method2"></a><a name="m__create"></a><a name="k_4"></a><p><b>Signature</b>: void <b> _create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p><p>
|
| 161 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-160"></a><h3>_destroy</h3></td><td style="padding-bottom: 16px"><a name="method3"></a><a name="m__destroy"></a><a name="k_5"></a><p><b>Signature</b>: void <b> _destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p><p>
|
| 162 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 163 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-167"></a><h3>_destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method4"></a><a name="m__destroyed?"></a><a name="k_6"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p><p>
|
| 164 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 165 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-174"></a><h3>_is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method5"></a><a name="m__is_const_object?"></a><a name="k_7"></a><p><b>Signature</b>: <i>[const] </i>bool <b> _is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p><p>
|
| 166 |
+
This method returns true, if self is a const reference.
|
| 167 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-181"></a><h3>_manage</h3></td><td style="padding-bottom: 16px"><a name="method6"></a><a name="m__manage"></a><a name="k_8"></a><p><b>Signature</b>: void <b> _manage </b></p><p><b>Description</b>: Marks the object as managed by the script side.</p><p><p>
|
| 168 |
+
After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-187"></a><h3>_unmanage</h3></td><td style="padding-bottom: 16px"><a name="method7"></a><a name="m__unmanage"></a><a name="k_9"></a><p><b>Signature</b>: void <b> _unmanage </b></p><p><b>Description</b>: Marks the object as no longer owned by the script side.</p><p><p>
|
| 169 |
+
Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.</p><p>Usually it's not required to call this method. It has been introduced in version 0.24.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-193"></a><h3>assign</h3></td><td style="padding-bottom: 16px"><a name="method8"></a><a name="m_assign"></a><a name="k_10"></a><p><b>Signature</b>: void <b> assign </b> (const <a href="class_CellMapping.html">CellMapping</a> other)</p><p><b>Description</b>: Assigns another object to self</p></td></tr><tr class="bigrow1"><td><a name="h3-197"></a><h3>cell_mapping</h3></td><td style="padding-bottom: 16px"><a name="method9"></a><a name="m_cell_mapping"></a><a name="k_11"></a><p><b>Signature</b>: <i>[const] </i>unsigned int <b> cell_mapping </b> (unsigned int cell_index_b)</p><p><b>Description</b>: Determines cell mapping of a layout_b cell to the corresponding layout_a cell.</p><table class="layout-table"><tr><td><b>cell_index_b</b>:</td><td>The index of the cell in layout_b whose mapping is requested.</td></tr><tr><td><b>Returns</b>:</td><td>The cell index in layout_a.</td></tr></table><p><p></p><p>Note that the returned index can be <a href="#m_DropCell">DropCell</a> to indicate the cell shall be dropped.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-206"></a><h3>clear</h3></td><td style="padding-bottom: 16px"><a name="method10"></a><a name="m_clear"></a><a name="k_12"></a><p><b>Signature</b>: void <b> clear </b></p><p><b>Description</b>: Clears the mapping.</p><p><p></p><p>This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-211"></a><h3>create</h3></td><td style="padding-bottom: 16px"><a name="method11"></a><a name="m_create"></a><a name="k_13"></a><p><b>Signature</b>: void <b> create </b></p><p><b>Description</b>: Ensures the C++ object is created</p><p>Use of this method is deprecated. Use _create instead</p><p><p>
|
| 170 |
+
Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-218"></a><h3>destroy</h3></td><td style="padding-bottom: 16px"><a name="method12"></a><a name="m_destroy"></a><a name="k_14"></a><p><b>Signature</b>: void <b> destroy </b></p><p><b>Description</b>: Explicitly destroys the object</p><p>Use of this method is deprecated. Use _destroy instead</p><p><p>
|
| 171 |
+
Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception.
|
| 172 |
+
If the object is not owned by the script, this method will do nothing.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-226"></a><h3>destroyed?</h3></td><td style="padding-bottom: 16px"><a name="method13"></a><a name="m_destroyed?"></a><a name="k_15"></a><p><b>Signature</b>: <i>[const] </i>bool <b> destroyed? </b></p><p><b>Description</b>: Returns a value indicating whether the object was already destroyed</p><p>Use of this method is deprecated. Use _destroyed? instead</p><p><p>
|
| 173 |
+
This method returns true, if the object was destroyed, either explicitly or by the C++ side.
|
| 174 |
+
The latter may happen, if the object is owned by a C++ object which got destroyed itself.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-234"></a><h3>dup</h3></td><td style="padding-bottom: 16px"><a name="method14"></a><a name="m_dup"></a><a name="k_16"></a><p><b>Signature</b>: <i>[const] </i>new <a href="class_CellMapping.html">CellMapping</a> ptr <b> dup </b></p><p><b>Description</b>: Creates a copy of self</p><p><b>Python specific notes: </b><br>This method also implements '__copy__' and '__deepcopy__'.<br></p></td></tr><tr class="bigrow1"><td rowspan="2"><a name="h3-239"></a><h3>for_multi_cells</h3></td><td style="padding-bottom: 16px"><a name="method15"></a><a name="m_for_multi_cells"></a><a name="k_17"></a><p><b>(1) Signature</b>: void <b> for_multi_cells </b> (const <a href="class_Layout.html">Layout</a> layout_a, unsigned int[] cell_indexes_a, const <a href="class_Layout.html">Layout</a> layout_b, unsigned int[] cell_indexes_b)</p><p><b>Description</b>: Initializes the cell mapping for top-level identity</p><table class="layout-table"><tr><td><b>layout_a</b>:</td><td>The target layout.</td></tr><tr><td><b>cell_indexes_a</b>:</td><td>A list of cell indexes for the target cells.</td></tr><tr><td><b>layout_b</b>:</td><td>The source layout.</td></tr><tr><td><b>cell_indexes_b</b>:</td><td>A list of cell indexes for the source cells (same number of indexes than cell_indexes_a).</td></tr></table><p><p></p><p>The cell mapping is created for cells from cell_indexes_b to cell from cell_indexes_a in the respective layouts. This method clears the mapping and creates one for each cell pair from cell_indexes_b vs. cell_indexes_a. If used for <a href="class_Layout.html#m_copy_tree_shapes">Layout#copy_tree_shapes</a> or <a href="class_Layout.html#m_move_tree_shapes">Layout#move_tree_shapes</a>, this cell mapping will essentially flatten the source cells in the target layout.</p><p>This method is equivalent to <a href="#m_clear">clear</a>, followed by <a href="#m_map">map</a>(cell_index_a, cell_index_b) for each cell pair.</p><p>This method has been introduced in version 0.27.</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method16"></a><a name="m_for_multi_cells"></a><a name="k_18"></a><p><b>(2) Signature</b>: void <b> for_multi_cells </b> (<a href="class_Cell.html">Cell</a> ptr[] cell_a, const <a href="class_Cell.html">Cell</a> ptr[] cell_b)</p><p><b>Description</b>: Initializes the cell mapping for top-level identity</p><table class="layout-table"><tr><td><b>cell_a</b>:</td><td>A list of target cells.</td></tr><tr><td><b>cell_b</b>:</td><td>A list of source cells.</td></tr><tr><td><b>Returns</b>:</td><td>A list of indexes of cells created.</td></tr></table><p><p></p><p>This is a convenience version which uses cell references instead of layout/cell index combinations. It has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-259"></a><h3>for_multi_cells_full</h3></td><td style="padding-bottom: 16px"><a name="method17"></a><a name="m_for_multi_cells_full"></a><a name="k_19"></a><p><b>(1) Signature</b>: unsigned int[] <b> for_multi_cells_full </b> (<a href="class_Layout.html">Layout</a> layout_a, unsigned int[] cell_indexes_a, const <a href="class_Layout.html">Layout</a> layout_b, unsigned int[] cell_indexes_b)</p><p><b>Description</b>: Initializes the cell mapping for top-level identity in full mapping mode</p><table class="layout-table"><tr><td><b>layout_a</b>:</td><td>The target layout.</td></tr><tr><td><b>cell_indexes_a</b>:</td><td>A list of cell indexes for the target cells.</td></tr><tr><td><b>layout_b</b>:</td><td>The source layout.</td></tr><tr><td><b>cell_indexes_b</b>:</td><td>A list of cell indexes for the source cells (same number of indexes than cell_indexes_a).</td></tr></table><p><p></p><p>The cell mapping is created for cells from cell_indexes_b to cell from cell_indexes_a in the respective layouts. This method clears the mapping and creates one for each cell pair from cell_indexes_b vs. cell_indexes_a. In addition and in contrast to <a href="#m_for_multi_cells">for_multi_cells</a>, this method completes the mapping by adding all the child cells of all cells in cell_indexes_b to layout_a and creating the proper instances.</p><p>This method has been introduced in version 0.27.</p></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method18"></a><a name="m_for_multi_cells_full"></a><a name="k_20"></a><p><b>(2) Signature</b>: unsigned int[] <b> for_multi_cells_full </b> (<a href="class_Cell.html">Cell</a> ptr[] cell_a, const <a href="class_Cell.html">Cell</a> ptr[] cell_b)</p><p><b>Description</b>: Initializes the cell mapping for top-level identity in full mapping mode</p><table class="layout-table"><tr><td><b>cell_a</b>:</td><td>A list of target cells.</td></tr><tr><td><b>cell_b</b>:</td><td>A list of source cells.</td></tr><tr><td><b>Returns</b>:</td><td>A list of indexes of cells created.</td></tr></table><p><p></p><p>This is a convenience version which uses cell references instead of layout/cell index combinations. It has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow1"><td rowspan="2"><a name="h3-279"></a><h3>for_single_cell</h3></td><td style="padding-bottom: 16px"><a name="method19"></a><a name="m_for_single_cell"></a><a name="k_21"></a><p><b>(1) Signature</b>: void <b> for_single_cell </b> (const <a href="class_Layout.html">Layout</a> layout_a, unsigned int cell_index_a, const <a href="class_Layout.html">Layout</a> layout_b, unsigned int cell_index_b)</p><p><b>Description</b>: Initializes the cell mapping for top-level identity</p><table class="layout-table"><tr><td><b>layout_a</b>:</td><td>The target layout.</td></tr><tr><td><b>cell_index_a</b>:</td><td>The index of the target cell.</td></tr><tr><td><b>layout_b</b>:</td><td>The source layout.</td></tr><tr><td><b>cell_index_b</b>:</td><td>The index of the source cell.</td></tr></table><p><p></p><p>The cell mapping is created for cell_b to cell_a in the respective layouts. This method clears the mapping and creates one for the single cell pair. If used for <a href="class_Cell.html#m_copy_tree">Cell#copy_tree</a> or <a href="class_Cell.html#m_move_tree">Cell#move_tree</a>, this cell mapping will essentially flatten the cell.</p><p>This method is equivalent to <a href="#m_clear">clear</a>, followed by <a href="#m_map">map</a>(cell_index_a, cell_index_b).</p><p>This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method20"></a><a name="m_for_single_cell"></a><a name="k_22"></a><p><b>(2) Signature</b>: void <b> for_single_cell </b> (<a href="class_Cell.html">Cell</a> cell_a, const <a href="class_Cell.html">Cell</a> cell_b)</p><p><b>Description</b>: Initializes the cell mapping for top-level identity</p><table class="layout-table"><tr><td><b>cell_a</b>:</td><td>The target cell.</td></tr><tr><td><b>cell_b</b>:</td><td>The source cell.</td></tr><tr><td><b>Returns</b>:</td><td>A list of indexes of cells created.</td></tr></table><p><p></p><p>This is a convenience version which uses cell references instead of layout/cell index combinations. It has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-299"></a><h3>for_single_cell_full</h3></td><td style="padding-bottom: 16px"><a name="method21"></a><a name="m_for_single_cell_full"></a><a name="k_23"></a><p><b>(1) Signature</b>: unsigned int[] <b> for_single_cell_full </b> (<a href="class_Layout.html">Layout</a> layout_a, unsigned int cell_index_a, const <a href="class_Layout.html">Layout</a> layout_b, unsigned int cell_index_b)</p><p><b>Description</b>: Initializes the cell mapping for top-level identity in full mapping mode</p><table class="layout-table"><tr><td><b>layout_a</b>:</td><td>The target layout.</td></tr><tr><td><b>cell_index_a</b>:</td><td>The index of the target cell.</td></tr><tr><td><b>layout_b</b>:</td><td>The source layout.</td></tr><tr><td><b>cell_index_b</b>:</td><td>The index of the source cell.</td></tr></table><p><p></p><p>The cell mapping is created for cell_b to cell_a in the respective layouts. This method clears the mapping and creates one for the single cell pair. In addition and in contrast to <a href="#m_for_single_cell">for_single_cell</a>, this method completes the mapping by adding all the child cells of cell_b to layout_a and creating the proper instances.</p><p>This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method22"></a><a name="m_for_single_cell_full"></a><a name="k_24"></a><p><b>(2) Signature</b>: unsigned int[] <b> for_single_cell_full </b> (<a href="class_Cell.html">Cell</a> cell_a, const <a href="class_Cell.html">Cell</a> cell_b)</p><p><b>Description</b>: Initializes the cell mapping for top-level identity in full mapping mode</p><table class="layout-table"><tr><td><b>cell_a</b>:</td><td>The target cell.</td></tr><tr><td><b>cell_b</b>:</td><td>The source cell.</td></tr><tr><td><b>Returns</b>:</td><td>A list of indexes of cells created.</td></tr></table><p><p></p><p>This is a convenience version which uses cell references instead of layout/cell index combinations. It has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow1"><td rowspan="2"><a name="h3-319"></a><h3>from_geometry</h3></td><td style="padding-bottom: 16px"><a name="method23"></a><a name="m_from_geometry"></a><a name="k_25"></a><p><b>(1) Signature</b>: void <b> from_geometry </b> (const <a href="class_Layout.html">Layout</a> layout_a, unsigned int cell_index_a, const <a href="class_Layout.html">Layout</a> layout_b, unsigned int cell_index_b)</p><p><b>Description</b>: Initializes the cell mapping using the geometrical identity</p><table class="layout-table"><tr><td><b>layout_a</b>:</td><td>The target layout.</td></tr><tr><td><b>cell_index_a</b>:</td><td>The index of the target starting cell.</td></tr><tr><td><b>layout_b</b>:</td><td>The source layout.</td></tr><tr><td><b>cell_index_b</b>:</td><td>The index of the source starting cell.</td></tr></table><p><p></p><p>The cell mapping is created for cells below cell_a and cell_b in the respective layouts. This method employs geometrical identity to derive mappings for the child cells of the starting cell in layout A and B.
|
| 175 |
+
If the geometrical identity is ambiguous, the algorithm will make an arbitrary choice.</p><p>This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method24"></a><a name="m_from_geometry"></a><a name="k_26"></a><p><b>(2) Signature</b>: void <b> from_geometry </b> (<a href="class_Cell.html">Cell</a> cell_a, const <a href="class_Cell.html">Cell</a> cell_b)</p><p><b>Description</b>: Initializes the cell mapping using the geometrical identity</p><table class="layout-table"><tr><td><b>cell_a</b>:</td><td>The target cell.</td></tr><tr><td><b>cell_b</b>:</td><td>The source cell.</td></tr><tr><td><b>Returns</b>:</td><td>A list of indexes of cells created.</td></tr></table><p><p></p><p>This is a convenience version which uses cell references instead of layout/cell index combinations. It has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-340"></a><h3>from_geometry_full</h3></td><td style="padding-bottom: 16px"><a name="method25"></a><a name="m_from_geometry_full"></a><a name="k_27"></a><p><b>(1) Signature</b>: unsigned int[] <b> from_geometry_full </b> (<a href="class_Layout.html">Layout</a> layout_a, unsigned int cell_index_a, const <a href="class_Layout.html">Layout</a> layout_b, unsigned int cell_index_b)</p><p><b>Description</b>: Initializes the cell mapping using the geometrical identity in full mapping mode</p><table class="layout-table"><tr><td><b>layout_a</b>:</td><td>The target layout.</td></tr><tr><td><b>cell_index_a</b>:</td><td>The index of the target starting cell.</td></tr><tr><td><b>layout_b</b>:</td><td>The source layout.</td></tr><tr><td><b>cell_index_b</b>:</td><td>The index of the source starting cell.</td></tr><tr><td><b>Returns</b>:</td><td>A list of indexes of cells created.</td></tr></table><p><p></p><p>The cell mapping is created for cells below cell_a and cell_b in the respective layouts. This method employs geometrical identity to derive mappings for the child cells of the starting cell in layout A and B.
|
| 176 |
+
If the geometrical identity is ambiguous, the algorithm will make an arbitrary choice.</p><p>Full mapping means that cells which are not found in the target layout A are created there plus their corresponding instances are created as well. The returned list will contain the indexes of all cells created for that reason.</p><p>This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method26"></a><a name="m_from_geometry_full"></a><a name="k_28"></a><p><b>(2) Signature</b>: unsigned int[] <b> from_geometry_full </b> (<a href="class_Cell.html">Cell</a> cell_a, const <a href="class_Cell.html">Cell</a> cell_b)</p><p><b>Description</b>: Initializes the cell mapping using the geometrical identity in full mapping mode</p><table class="layout-table"><tr><td><b>cell_a</b>:</td><td>The target cell.</td></tr><tr><td><b>cell_b</b>:</td><td>The source cell.</td></tr><tr><td><b>Returns</b>:</td><td>A list of indexes of cells created.</td></tr></table><p><p></p><p>This is a convenience version which uses cell references instead of layout/cell index combinations. It has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow1"><td rowspan="2"><a name="h3-362"></a><h3>from_names</h3></td><td style="padding-bottom: 16px"><a name="method27"></a><a name="m_from_names"></a><a name="k_29"></a><p><b>(1) Signature</b>: void <b> from_names </b> (const <a href="class_Layout.html">Layout</a> layout_a, unsigned int cell_index_a, const <a href="class_Layout.html">Layout</a> layout_b, unsigned int cell_index_b)</p><p><b>Description</b>: Initializes the cell mapping using the name identity</p><table class="layout-table"><tr><td><b>layout_a</b>:</td><td>The target layout.</td></tr><tr><td><b>cell_index_a</b>:</td><td>The index of the target starting cell.</td></tr><tr><td><b>layout_b</b>:</td><td>The source layout.</td></tr><tr><td><b>cell_index_b</b>:</td><td>The index of the source starting cell.</td></tr></table><p><p></p><p>The cell mapping is created for cells below cell_a and cell_b in the respective layouts.
|
| 177 |
+
This method employs name identity to derive mappings for the child cells of the starting cell in layout A and B.</p><p>This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow1"><td style="padding-bottom: 16px"><a name="method28"></a><a name="m_from_names"></a><a name="k_30"></a><p><b>(2) Signature</b>: void <b> from_names </b> (<a href="class_Cell.html">Cell</a> cell_a, const <a href="class_Cell.html">Cell</a> cell_b)</p><p><b>Description</b>: Initializes the cell mapping using the name identity</p><table class="layout-table"><tr><td><b>cell_a</b>:</td><td>The target cell.</td></tr><tr><td><b>cell_b</b>:</td><td>The source cell.</td></tr><tr><td><b>Returns</b>:</td><td>A list of indexes of cells created.</td></tr></table><p><p></p><p>This is a convenience version which uses cell references instead of layout/cell index combinations. It has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow0"><td rowspan="2"><a name="h3-383"></a><h3>from_names_full</h3></td><td style="padding-bottom: 16px"><a name="method29"></a><a name="m_from_names_full"></a><a name="k_31"></a><p><b>(1) Signature</b>: unsigned int[] <b> from_names_full </b> (<a href="class_Layout.html">Layout</a> layout_a, unsigned int cell_index_a, const <a href="class_Layout.html">Layout</a> layout_b, unsigned int cell_index_b)</p><p><b>Description</b>: Initializes the cell mapping using the name identity in full mapping mode</p><table class="layout-table"><tr><td><b>layout_a</b>:</td><td>The target layout.</td></tr><tr><td><b>cell_index_a</b>:</td><td>The index of the target starting cell.</td></tr><tr><td><b>layout_b</b>:</td><td>The source layout.</td></tr><tr><td><b>cell_index_b</b>:</td><td>The index of the source starting cell.</td></tr><tr><td><b>Returns</b>:</td><td>A list of indexes of cells created.</td></tr></table><p><p></p><p>The cell mapping is created for cells below cell_a and cell_b in the respective layouts.
|
| 178 |
+
This method employs name identity to derive mappings for the child cells of the starting cell in layout A and B.</p><p>Full mapping means that cells which are not found in the target layout A are created there plus their corresponding instances are created as well. The returned list will contain the indexes of all cells created for that reason.</p><p>This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow0"><td style="padding-bottom: 16px"><a name="method30"></a><a name="m_from_names_full"></a><a name="k_32"></a><p><b>(2) Signature</b>: unsigned int[] <b> from_names_full </b> (<a href="class_Cell.html">Cell</a> cell_a, const <a href="class_Cell.html">Cell</a> cell_b)</p><p><b>Description</b>: Initializes the cell mapping using the name identity in full mapping mode</p><table class="layout-table"><tr><td><b>cell_a</b>:</td><td>The target cell.</td></tr><tr><td><b>cell_b</b>:</td><td>The source cell.</td></tr><tr><td><b>Returns</b>:</td><td>A list of indexes of cells created.</td></tr></table><p><p></p><p>This is a convenience version which uses cell references instead of layout/cell index combinations. It has been introduced in version 0.28.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-405"></a><h3>has_mapping?</h3></td><td style="padding-bottom: 16px"><a name="method31"></a><a name="m_has_mapping?"></a><a name="k_33"></a><p><b>Signature</b>: <i>[const] </i>bool <b> has_mapping? </b> (unsigned int cell_index_b)</p><p><b>Description</b>: Returns as value indicating whether a cell of layout_b has a mapping to a layout_a cell.</p><table class="layout-table"><tr><td><b>cell_index_b</b>:</td><td>The index of the cell in layout_b whose mapping is requested.</td></tr><tr><td><b>Returns</b>:</td><td>true, if the cell has a mapping</td></tr></table><p><p></p><p>Note that if the cell is supposed to be dropped (see <a href="#m_DropCell">DropCell</a>), the respective source cell will also be regarded "mapped", so has_mapping? will return true in this case.
|
| 179 |
+
</p></p></td></tr><tr class="bigrow0"><td><a name="h3-415"></a><h3>is_const_object?</h3></td><td style="padding-bottom: 16px"><a name="method32"></a><a name="m_is_const_object?"></a><a name="k_34"></a><p><b>Signature</b>: <i>[const] </i>bool <b> is_const_object? </b></p><p><b>Description</b>: Returns a value indicating whether the reference is a const reference</p><p>Use of this method is deprecated. Use _is_const_object? instead</p><p><p>
|
| 180 |
+
This method returns true, if self is a const reference.
|
| 181 |
+
In that case, only const methods may be called on self.</p></p></td></tr><tr class="bigrow1"><td><a name="h3-423"></a><h3>map</h3></td><td style="padding-bottom: 16px"><a name="method33"></a><a name="m_map"></a><a name="k_35"></a><p><b>Signature</b>: void <b> map </b> (unsigned int cell_index_b, unsigned int cell_index_a)</p><p><b>Description</b>: Explicitly specifies a mapping.</p><table class="layout-table"><tr><td><b>cell_index_b</b>:</td><td>The index of the cell in layout B (the "source")</td></tr><tr><td><b>cell_index_a</b>:</td><td>The index of the cell in layout A (the "target") - this index can be <a href="#m_DropCell">DropCell</a></td></tr></table><p><p></p><p>Beside using the mapping generator algorithms provided through <a href="#m_from_names">from_names</a> and <a href="#m_from_geometry">from_geometry</a>, it is possible to explicitly specify cell mappings using this method.</p><p>This method has been introduced in version 0.23.</p></p></td></tr><tr class="bigrow0"><td><a name="h3-432"></a><h3>new</h3></td><td style="padding-bottom: 16px"><a name="method34"></a><a name="m_new"></a><a name="k_36"></a><p><b>Signature</b>: <i>[static] </i>new <a href="class_CellMapping.html">CellMapping</a> ptr <b> new </b></p><p><b>Description</b>: Creates a new object of this class</p><p><b>Python specific notes: </b><br>This method is the default initializer of the object.<br></p></td></tr><tr class="bigrow1"><td><a name="h3-437"></a><h3>table</h3></td><td style="padding-bottom: 16px"><a name="method35"></a><a name="m_table"></a><a name="k_37"></a><p><b>Signature</b>: <i>[const] </i>map<unsigned int,unsigned int> <b> table </b></p><p><b>Description</b>: Returns the mapping table.</p><p><p></p><p>The mapping table is a dictionary where the keys are source layout cell indexes and the values are the target layout cell indexes.
|
| 182 |
+
Note that the target cell index can be <a href="#m_DropCell">DropCell</a> to indicate that a cell is supposed to be dropped.</p><p>This method has been introduced in version 0.25.</p></p></td></tr></table></div>
|
| 183 |
+
</div>
|
| 184 |
+
</body>
|
| 185 |
+
</html>
|
| 186 |
+
|