316 lines
16 KiB
HTML
Executable File
316 lines
16 KiB
HTML
Executable File
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="description" content="API docs for the TouchPainter class from the TouchPainter library, for the Dart programming language.">
|
|
<title>TouchPainter class - TouchPainter library - Dart API</title>
|
|
<!-- required because all the links are pseudo-absolute -->
|
|
<base href="..">
|
|
|
|
<link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500,400i,400,300|Source+Sans+Pro:400,300,700" rel="stylesheet">
|
|
<link rel="stylesheet" href="static-assets/github.css">
|
|
<link rel="stylesheet" href="static-assets/styles.css">
|
|
<link rel="icon" href="static-assets/favicon.png">
|
|
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="overlay-under-drawer"></div>
|
|
|
|
<header id="title">
|
|
<button id="sidenav-left-toggle" type="button"> </button>
|
|
<ol class="breadcrumbs gt-separated dark hidden-xs">
|
|
<li><a href="index.html">touch_demonstrator</a></li>
|
|
<li><a href="ui_home_TouchPainter/ui_home_TouchPainter-library.html">TouchPainter</a></li>
|
|
<li class="self-crumb">TouchPainter class</li>
|
|
</ol>
|
|
<div class="self-name">TouchPainter</div>
|
|
<form class="search navbar-right" role="search">
|
|
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
|
|
</form>
|
|
</header>
|
|
|
|
<main>
|
|
|
|
<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
|
|
<h5>TouchPainter library</h5>
|
|
<ol>
|
|
<li class="section-title"><a href="ui_home_TouchPainter/ui_home_TouchPainter-library.html#classes">Classes</a></li>
|
|
<li><a href="ui_home_TouchPainter/TouchPainter-class.html">TouchPainter</a></li>
|
|
|
|
|
|
|
|
|
|
<li class="section-title"><a href="ui_home_TouchPainter/ui_home_TouchPainter-library.html#functions">Functions</a></li>
|
|
<li><a href="ui_home_TouchPainter/drawButton.html">drawButton</a></li>
|
|
|
|
|
|
|
|
</ol>
|
|
</div>
|
|
|
|
<div class="col-xs-12 col-sm-9 col-md-8 main-content">
|
|
<h1>TouchPainter class </h1>
|
|
|
|
|
|
|
|
<section class="summary offset-anchor" id="constructors">
|
|
<h2>Constructors</h2>
|
|
|
|
<dl class="constructor-summary-list">
|
|
<dt id="TouchPainter" class="callable">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/TouchPainter.html">TouchPainter</a></span><span class="signature">(<span class="parameter" id="-param-context"><span class="type-annotation">BuildContext</span> <span class="parameter-name">context</span>, </span> <span class="parameter" id="-param-touchCollection"><span class="type-annotation">Map<span class="signature"><<wbr><span class="type-parameter"><a href="model_touchData/TouchData-class.html">TouchData</a></span>, <span class="type-parameter">Color</span>></span></span> <span class="parameter-name">touchCollection</span></span>)</span>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
<section class="summary offset-anchor" id="instance-properties">
|
|
<h2>Properties</h2>
|
|
|
|
<dl class="properties">
|
|
<dt id="context" class="property">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/context.html">context</a></span>
|
|
<span class="signature">↔ BuildContext</span>
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features">read / write</div>
|
|
</dd>
|
|
<dt id="touchCollection" class="property">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/touchCollection.html">touchCollection</a></span>
|
|
<span class="signature">↔ Map<span class="signature"><<wbr><span class="type-parameter"><a href="model_touchData/TouchData-class.html">TouchData</a></span>, <span class="type-parameter">Color</span>></span></span>
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features">read / write</div>
|
|
</dd>
|
|
<dt id="width" class="property">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/width.html">width</a></span>
|
|
<span class="signature">↔ double</span>
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features">read / write</div>
|
|
</dd>
|
|
<dt id="hashCode" class="property inherited">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/hashCode.html">hashCode</a></span>
|
|
<span class="signature">→ int</span>
|
|
</dt>
|
|
<dd class="inherited">
|
|
The hash code for this object. <a href="ui_home_TouchPainter/TouchPainter/hashCode.html">[...]</a>
|
|
<div class="features">read-only, inherited</div>
|
|
</dd>
|
|
<dt id="runtimeType" class="property inherited">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/runtimeType.html">runtimeType</a></span>
|
|
<span class="signature">→ Type</span>
|
|
</dt>
|
|
<dd class="inherited">
|
|
A representation of the runtime type of the object.
|
|
<div class="features">read-only, inherited</div>
|
|
</dd>
|
|
<dt id="semanticsBuilder" class="property inherited">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/semanticsBuilder.html">semanticsBuilder</a></span>
|
|
<span class="signature">→ SemanticsBuilderCallback</span>
|
|
</dt>
|
|
<dd class="inherited">
|
|
Returns a function that builds semantic information for the picture drawn
|
|
by this painter. <a href="ui_home_TouchPainter/TouchPainter/semanticsBuilder.html">[...]</a>
|
|
<div class="features">read-only, inherited</div>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
<section class="summary offset-anchor" id="instance-methods">
|
|
<h2>Methods</h2>
|
|
<dl class="callables">
|
|
<dt id="paint" class="callable">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/paint.html">paint</a></span><span class="signature">(<wbr><span class="parameter" id="paint-param-canvas"><span class="type-annotation">Canvas</span> <span class="parameter-name">canvas</span>, </span> <span class="parameter" id="paint-param-size"><span class="type-annotation">Size</span> <span class="parameter-name">size</span></span>)
|
|
<span class="returntype parameter">→ void</span>
|
|
</span>
|
|
</dt>
|
|
<dd>
|
|
Called whenever the object needs to paint. The given <code>Canvas</code> has its
|
|
coordinate space configured such that the origin is at the top left of the
|
|
box. The area of the box is the size of the <code>size</code> argument. <a href="ui_home_TouchPainter/TouchPainter/paint.html">[...]</a>
|
|
|
|
</dd>
|
|
<dt id="shouldRepaint" class="callable">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/shouldRepaint.html">shouldRepaint</a></span><span class="signature">(<wbr><span class="parameter" id="shouldRepaint-param-oldDelegate"><span>covariant</span> <span class="type-annotation">CustomPainter</span> <span class="parameter-name">oldDelegate</span></span>)
|
|
<span class="returntype parameter">→ bool</span>
|
|
</span>
|
|
</dt>
|
|
<dd>
|
|
Called whenever a new instance of the custom painter delegate class is
|
|
provided to the <code>RenderCustomPaint</code> object, or any time that a new
|
|
<code>CustomPaint</code> object is created with a new instance of the custom painter
|
|
delegate class (which amounts to the same thing, because the latter is
|
|
implemented in terms of the former). <a href="ui_home_TouchPainter/TouchPainter/shouldRepaint.html">[...]</a>
|
|
|
|
</dd>
|
|
<dt id="addListener" class="callable inherited">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/addListener.html">addListener</a></span><span class="signature">(<wbr><span class="parameter" id="addListener-param-listener"><span class="type-annotation">VoidCallback</span> <span class="parameter-name">listener</span></span>)
|
|
<span class="returntype parameter">→ void</span>
|
|
</span>
|
|
</dt>
|
|
<dd class="inherited">
|
|
Register a closure to be notified when it is time to repaint. <a href="ui_home_TouchPainter/TouchPainter/addListener.html">[...]</a>
|
|
<div class="features">inherited</div>
|
|
</dd>
|
|
<dt id="hitTest" class="callable inherited">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/hitTest.html">hitTest</a></span><span class="signature">(<wbr><span class="parameter" id="hitTest-param-position"><span class="type-annotation">Offset</span> <span class="parameter-name">position</span></span>)
|
|
<span class="returntype parameter">→ bool</span>
|
|
</span>
|
|
</dt>
|
|
<dd class="inherited">
|
|
Called whenever a hit test is being performed on an object that is using
|
|
this custom paint delegate. <a href="ui_home_TouchPainter/TouchPainter/hitTest.html">[...]</a>
|
|
<div class="features">inherited</div>
|
|
</dd>
|
|
<dt id="noSuchMethod" class="callable inherited">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation">Invocation</span> <span class="parameter-name">invocation</span></span>)
|
|
<span class="returntype parameter">→ dynamic</span>
|
|
</span>
|
|
</dt>
|
|
<dd class="inherited">
|
|
Invoked when a non-existent method or property is accessed. <a href="ui_home_TouchPainter/TouchPainter/noSuchMethod.html">[...]</a>
|
|
<div class="features">inherited</div>
|
|
</dd>
|
|
<dt id="removeListener" class="callable inherited">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/removeListener.html">removeListener</a></span><span class="signature">(<wbr><span class="parameter" id="removeListener-param-listener"><span class="type-annotation">VoidCallback</span> <span class="parameter-name">listener</span></span>)
|
|
<span class="returntype parameter">→ void</span>
|
|
</span>
|
|
</dt>
|
|
<dd class="inherited">
|
|
Remove a previously registered closure from the list of closures that the
|
|
object notifies when it is time to repaint. <a href="ui_home_TouchPainter/TouchPainter/removeListener.html">[...]</a>
|
|
<div class="features">inherited</div>
|
|
</dd>
|
|
<dt id="shouldRebuildSemantics" class="callable inherited">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/shouldRebuildSemantics.html">shouldRebuildSemantics</a></span><span class="signature">(<wbr><span class="parameter" id="shouldRebuildSemantics-param-oldDelegate"><span>covariant</span> <span class="type-annotation">CustomPainter</span> <span class="parameter-name">oldDelegate</span></span>)
|
|
<span class="returntype parameter">→ bool</span>
|
|
</span>
|
|
</dt>
|
|
<dd class="inherited">
|
|
Called whenever a new instance of the custom painter delegate class is
|
|
provided to the <code>RenderCustomPaint</code> object, or any time that a new
|
|
<code>CustomPaint</code> object is created with a new instance of the custom painter
|
|
delegate class (which amounts to the same thing, because the latter is
|
|
implemented in terms of the former). <a href="ui_home_TouchPainter/TouchPainter/shouldRebuildSemantics.html">[...]</a>
|
|
<div class="features">inherited</div>
|
|
</dd>
|
|
<dt id="toString" class="callable inherited">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/toString.html">toString</a></span><span class="signature">(<wbr>)
|
|
<span class="returntype parameter">→ String</span>
|
|
</span>
|
|
</dt>
|
|
<dd class="inherited">
|
|
Returns a string representation of this object.
|
|
<div class="features">inherited</div>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
<section class="summary offset-anchor inherited" id="operators">
|
|
<h2>Operators</h2>
|
|
<dl class="callables">
|
|
<dt id="operator ==" class="callable inherited">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation">dynamic</span> <span class="parameter-name">other</span></span>)
|
|
<span class="returntype parameter">→ bool</span>
|
|
</span>
|
|
</dt>
|
|
<dd class="inherited">
|
|
The equality operator. <a href="ui_home_TouchPainter/TouchPainter/operator_equals.html">[...]</a>
|
|
<div class="features">inherited</div>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
<section class="summary offset-anchor" id="static-properties">
|
|
<h2>Static Properties</h2>
|
|
|
|
<dl class="properties">
|
|
<dt id="buttonPressed" class="property">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/buttonPressed.html">buttonPressed</a></span>
|
|
<span class="signature">↔ List<span class="signature"><<wbr><span class="type-parameter">bool</span>></span></span>
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features">read / write</div>
|
|
</dd>
|
|
<dt id="buttonReleased" class="property">
|
|
<span class="name"><a href="ui_home_TouchPainter/TouchPainter/buttonReleased.html">buttonReleased</a></span>
|
|
<span class="signature">↔ List<span class="signature"><<wbr><span class="type-parameter">bool</span>></span></span>
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features">read / write</div>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
</div> <!-- /.main-content -->
|
|
|
|
<div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
|
|
<ol>
|
|
<li class="section-title"><a href="ui_home_TouchPainter/TouchPainter-class.html#constructors">Constructors</a></li>
|
|
<li><a href="ui_home_TouchPainter/TouchPainter/TouchPainter.html">TouchPainter</a></li>
|
|
|
|
<li class="section-title">
|
|
<a href="ui_home_TouchPainter/TouchPainter-class.html#instance-properties">Properties</a>
|
|
</li>
|
|
<li><a href="ui_home_TouchPainter/TouchPainter/context.html">context</a></li>
|
|
<li><a href="ui_home_TouchPainter/TouchPainter/touchCollection.html">touchCollection</a></li>
|
|
<li><a href="ui_home_TouchPainter/TouchPainter/width.html">width</a></li>
|
|
<li class="inherited"><a href="ui_home_TouchPainter/TouchPainter/hashCode.html">hashCode</a></li>
|
|
<li class="inherited"><a href="ui_home_TouchPainter/TouchPainter/runtimeType.html">runtimeType</a></li>
|
|
<li class="inherited"><a href="ui_home_TouchPainter/TouchPainter/semanticsBuilder.html">semanticsBuilder</a></li>
|
|
|
|
<li class="section-title"><a href="ui_home_TouchPainter/TouchPainter-class.html#instance-methods">Methods</a></li>
|
|
<li><a href="ui_home_TouchPainter/TouchPainter/paint.html">paint</a></li>
|
|
<li><a href="ui_home_TouchPainter/TouchPainter/shouldRepaint.html">shouldRepaint</a></li>
|
|
<li class="inherited"><a href="ui_home_TouchPainter/TouchPainter/addListener.html">addListener</a></li>
|
|
<li class="inherited"><a href="ui_home_TouchPainter/TouchPainter/hitTest.html">hitTest</a></li>
|
|
<li class="inherited"><a href="ui_home_TouchPainter/TouchPainter/noSuchMethod.html">noSuchMethod</a></li>
|
|
<li class="inherited"><a href="ui_home_TouchPainter/TouchPainter/removeListener.html">removeListener</a></li>
|
|
<li class="inherited"><a href="ui_home_TouchPainter/TouchPainter/shouldRebuildSemantics.html">shouldRebuildSemantics</a></li>
|
|
<li class="inherited"><a href="ui_home_TouchPainter/TouchPainter/toString.html">toString</a></li>
|
|
|
|
<li class="section-title inherited"><a href="ui_home_TouchPainter/TouchPainter-class.html#operators">Operators</a></li>
|
|
<li class="inherited"><a href="ui_home_TouchPainter/TouchPainter/operator_equals.html">operator ==</a></li>
|
|
|
|
<li class="section-title"><a href="ui_home_TouchPainter/TouchPainter-class.html#static-properties">Static properties</a></li>
|
|
<li><a href="ui_home_TouchPainter/TouchPainter/buttonPressed.html">buttonPressed</a></li>
|
|
<li><a href="ui_home_TouchPainter/TouchPainter/buttonReleased.html">buttonReleased</a></li>
|
|
|
|
|
|
</ol>
|
|
</div><!--/.sidebar-offcanvas-->
|
|
|
|
</main>
|
|
|
|
<footer>
|
|
<span class="no-break">
|
|
touch_demonstrator 1.0.0+1
|
|
</span>
|
|
|
|
</footer>
|
|
|
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
|
|
<script src="static-assets/typeahead.bundle.min.js"></script>
|
|
<script src="static-assets/highlight.pack.js"></script>
|
|
<script src="static-assets/URI.js"></script>
|
|
<script src="static-assets/script.js"></script>
|
|
|
|
|
|
</body>
|
|
|
|
</html>
|