607 lines
36 KiB
HTML
607 lines
36 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>GraphicsStroke | openfl</title>
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">openfl</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../index.html">openfl</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/openfl.display.html">display</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.display.graphicsstroke.html">GraphicsStroke</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class GraphicsStroke</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Defines a line style or stroke.</p>
|
|
</div>
|
|
<p> Use a GraphicsStroke object with the
|
|
<code>Graphics.drawGraphicsData()</code> method. Drawing a GraphicsStroke
|
|
object is the equivalent of calling one of the methods of the Graphics
|
|
class that sets the line style, such as the
|
|
<code>Graphics.lineStyle()</code> method, the
|
|
<code>Graphics.lineBitmapStyle()</code> method, or the
|
|
<code>Graphics.lineGradientStyle()</code> method.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">GraphicsStroke</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implements</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="openfl.display.igraphicsdata.html" class="tsd-signature-type">IGraphicsData</a></li>
|
|
<li><a href="openfl.display.igraphicsstroke.html" class="tsd-signature-type">IGraphicsStroke</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphicsstroke.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphicsstroke.html#caps" class="tsd-kind-icon">caps</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphicsstroke.html#fill" class="tsd-kind-icon">fill</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphicsstroke.html#joints" class="tsd-kind-icon">joints</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphicsstroke.html#miterlimit" class="tsd-kind-icon">miter<wbr>Limit</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphicsstroke.html#pixelhinting" class="tsd-kind-icon">pixel<wbr>Hinting</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphicsstroke.html#scalemode" class="tsd-kind-icon">scale<wbr>Mode</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphicsstroke.html#thickness" class="tsd-kind-icon">thickness</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Graphics<wbr>Stroke<span class="tsd-signature-symbol">(</span>thickness<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pixelHinting<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, scaleMode<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.linescalemode.html" class="tsd-signature-type">LineScaleMode</a>, caps<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.capsstyle.html" class="tsd-signature-type">CapsStyle</a>, joints<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.jointstyle.html" class="tsd-signature-type">JointStyle</a>, miterLimit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, fill<span class="tsd-signature-symbol">?: </span><a href="openfl.display.igraphicsfill.html" class="tsd-signature-type">IGraphicsFill</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.display.graphicsstroke.html" class="tsd-signature-type">GraphicsStroke</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/GraphicsStroke.d.ts#L132">lib/openfl/display/GraphicsStroke.d.ts:132</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Creates a new GraphicsStroke object.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thickness: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> pixelHinting: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A Boolean value that specifies whether to hint strokes
|
|
to full pixels. This affects both the position of
|
|
anchors of a curve and the line stroke size itself.
|
|
With <code>pixelHinting</code> set to
|
|
<code>true</code>, Flash Player hints line widths to
|
|
full pixel widths. With <code>pixelHinting</code> set
|
|
to <code>false</code>, disjoints can appear for curves
|
|
and straight lines. For example, the following
|
|
illustrations show how Flash Player renders two
|
|
rounded rectangles that are identical, except that the
|
|
<code>pixelHinting</code> parameter used in the
|
|
<code>lineStyle()</code> method is set differently
|
|
(the images are scaled by 200%, to emphasize the
|
|
difference):</p>
|
|
<pre><code> If <span class="hljs-keyword">a</span> <span class="hljs-built_in">value</span> is <span class="hljs-keyword">not</span> supplied, <span class="hljs-keyword">the</span> <span class="hljs-built_in">line</span> does <span class="hljs-keyword">not</span> use
|
|
pixel hinting.
|
|
</code></pre>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> scaleMode: <a href="../enums/openfl.display.linescalemode.html" class="tsd-signature-type">LineScaleMode</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A value from the LineScaleMode class that specifies
|
|
which scale mode to use:</p>
|
|
<pre><code> * `LineScaleMode.NORMAL` - Always
|
|
scale <span class="hljs-keyword">the</span> <span class="hljs-built_in">line</span> thickness when <span class="hljs-keyword">the</span> object is scaled
|
|
(<span class="hljs-keyword">the</span> default).
|
|
* `LineScaleMode.<span class="hljs-literal">NONE</span>` - Never scale
|
|
<span class="hljs-keyword">the</span> <span class="hljs-built_in">line</span> thickness.
|
|
* `LineScaleMode.VERTICAL` - Do <span class="hljs-keyword">not</span>
|
|
scale <span class="hljs-keyword">the</span> <span class="hljs-built_in">line</span> thickness <span class="hljs-keyword">if</span> <span class="hljs-keyword">the</span> object is scaled
|
|
vertically <span class="hljs-title">_only</span>_. For example, consider <span class="hljs-keyword">the</span>
|
|
following circles, drawn <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span> <span class="hljs-literal">one</span>-pixel <span class="hljs-built_in">line</span>, <span class="hljs-keyword">and</span>
|
|
<span class="hljs-keyword">each</span> <span class="hljs-keyword">with</span> <span class="hljs-keyword">the</span> `scaleMode` parameter <span class="hljs-built_in">set</span> <span class="hljs-built_in">to</span>
|
|
`LineScaleMode.VERTICAL`. The circle <span class="hljs-keyword">on</span> <span class="hljs-title">the</span>
|
|
left is scaled vertically only, <span class="hljs-keyword">and</span> <span class="hljs-keyword">the</span> circle <span class="hljs-keyword">on</span> <span class="hljs-title">the</span>
|
|
<span class="hljs-literal">right</span> is scaled both vertically <span class="hljs-keyword">and</span> horizontally:
|
|
|
|
* `LineScaleMode.HORIZONTAL` - Do <span class="hljs-keyword">not</span>
|
|
scale <span class="hljs-keyword">the</span> <span class="hljs-built_in">line</span> thickness <span class="hljs-keyword">if</span> <span class="hljs-keyword">the</span> object is scaled
|
|
horizontally <span class="hljs-title">_only</span>_. For example, consider <span class="hljs-keyword">the</span>
|
|
following circles, drawn <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span> <span class="hljs-literal">one</span>-pixel <span class="hljs-built_in">line</span>, <span class="hljs-keyword">and</span>
|
|
<span class="hljs-keyword">each</span> <span class="hljs-keyword">with</span> <span class="hljs-keyword">the</span> `scaleMode` parameter <span class="hljs-built_in">set</span> <span class="hljs-built_in">to</span>
|
|
`LineScaleMode.HORIZONTAL`. The circle <span class="hljs-keyword">on</span>
|
|
<span class="hljs-keyword">the</span> left is scaled horizontally only, <span class="hljs-keyword">and</span> <span class="hljs-keyword">the</span> circle
|
|
<span class="hljs-keyword">on</span> <span class="hljs-title">the</span> <span class="hljs-title">right</span> <span class="hljs-title">is</span> <span class="hljs-title">scaled</span> <span class="hljs-title">both</span> <span class="hljs-title">vertically</span> <span class="hljs-title">and</span>
|
|
horizontally:
|
|
</code></pre>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> caps: <a href="../enums/openfl.display.capsstyle.html" class="tsd-signature-type">CapsStyle</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A value from the CapsStyle class that specifies the
|
|
type of caps at the end of lines. Valid values are:
|
|
<code>CapsStyle.NONE</code>,
|
|
<code>CapsStyle.ROUND</code>, and
|
|
<code>CapsStyle.SQUARE</code>. If a value is not
|
|
indicated, Flash uses round caps.</p>
|
|
<pre><code> For example, <span class="hljs-keyword">the</span> following illustrations show <span class="hljs-keyword">the</span>
|
|
different `capsStyle` settings. For <span class="hljs-keyword">each</span>
|
|
setting, <span class="hljs-keyword">the</span> illustration shows <span class="hljs-keyword">a</span> blue <span class="hljs-built_in">line</span> <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span>
|
|
thickness <span class="hljs-keyword">of</span> <span class="hljs-number">30</span>(<span class="hljs-keyword">for</span> which <span class="hljs-keyword">the</span> `capsStyle`
|
|
applies), <span class="hljs-keyword">and</span> <span class="hljs-keyword">a</span> superimposed <span class="hljs-keyword">black</span> <span class="hljs-built_in">line</span> <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span>
|
|
thickness <span class="hljs-keyword">of</span> <span class="hljs-number">1</span>(<span class="hljs-keyword">for</span> which no `capsStyle`
|
|
applies):
|
|
</code></pre>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> joints: <a href="../enums/openfl.display.jointstyle.html" class="tsd-signature-type">JointStyle</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A value from the JointStyle class that specifies the
|
|
type of joint appearance used at angles. Valid values
|
|
are: <code>JointStyle.BEVEL</code>,
|
|
<code>JointStyle.MITER</code>, and
|
|
<code>JointStyle.ROUND</code>. If a value is not
|
|
indicated, Flash uses round joints.</p>
|
|
<pre><code> For example, <span class="hljs-keyword">the</span> following illustrations show <span class="hljs-keyword">the</span>
|
|
different `joints` settings. For <span class="hljs-keyword">each</span>
|
|
setting, <span class="hljs-keyword">the</span> illustration shows <span class="hljs-keyword">an</span> angled blue <span class="hljs-built_in">line</span>
|
|
<span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span> thickness <span class="hljs-keyword">of</span> <span class="hljs-number">30</span>(<span class="hljs-keyword">for</span> which <span class="hljs-keyword">the</span>
|
|
`jointStyle` applies), <span class="hljs-keyword">and</span> <span class="hljs-keyword">a</span> superimposed
|
|
angled <span class="hljs-keyword">black</span> <span class="hljs-built_in">line</span> <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span> thickness <span class="hljs-keyword">of</span> <span class="hljs-number">1</span>(<span class="hljs-keyword">for</span> which no
|
|
`jointStyle` applies):
|
|
|
|
**Note:** For `joints` <span class="hljs-built_in">set</span> <span class="hljs-built_in">to</span>
|
|
`JointStyle.MITER`, you can use <span class="hljs-keyword">the</span>
|
|
`miterLimit` parameter <span class="hljs-built_in">to</span> limit <span class="hljs-keyword">the</span> <span class="hljs-built_in">length</span>
|
|
<span class="hljs-keyword">of</span> <span class="hljs-keyword">the</span> miter.
|
|
</code></pre>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> miterLimit: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fill: <a href="openfl.display.igraphicsfill.html" class="tsd-signature-type">IGraphicsFill</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="openfl.display.graphicsstroke.html" class="tsd-signature-type">GraphicsStroke</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="caps" class="tsd-anchor"></a>
|
|
<h3>caps</h3>
|
|
<div class="tsd-signature tsd-kind-icon">caps<span class="tsd-signature-symbol">:</span> <a href="../enums/openfl.display.capsstyle.html" class="tsd-signature-type">CapsStyle</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/GraphicsStroke.d.ts#L38">lib/openfl/display/GraphicsStroke.d.ts:38</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Specifies the type of caps at the end of lines. Valid values are:
|
|
<code>CapsStyle.NONE</code>, <code>CapsStyle.ROUND</code>, and
|
|
<code>CapsStyle.SQUARE</code>. If a value is not indicated, Flash uses
|
|
round caps.</p>
|
|
</div>
|
|
<p>For example, the following illustrations show the different
|
|
<code>capsStyle</code> settings. For each setting, the illustration shows
|
|
a blue line with a thickness of 30(for which the <code>capsStyle</code>
|
|
applies), and a superimposed black line with a thickness of 1(for which
|
|
no <code>capsStyle</code> applies):</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="fill" class="tsd-anchor"></a>
|
|
<h3>fill</h3>
|
|
<div class="tsd-signature tsd-kind-icon">fill<span class="tsd-signature-symbol">:</span> <a href="openfl.display.igraphicsfill.html" class="tsd-signature-type">IGraphicsFill</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/GraphicsStroke.d.ts#L44">lib/openfl/display/GraphicsStroke.d.ts:44</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Specifies the instance containing data for filling a stroke. An
|
|
IGraphicsFill instance can represent a series of fill commands.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="joints" class="tsd-anchor"></a>
|
|
<h3>joints</h3>
|
|
<div class="tsd-signature tsd-kind-icon">joints<span class="tsd-signature-symbol">:</span> <a href="../enums/openfl.display.jointstyle.html" class="tsd-signature-type">JointStyle</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/GraphicsStroke.d.ts#L62">lib/openfl/display/GraphicsStroke.d.ts:62</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Specifies the type of joint appearance used at angles. Valid values are:
|
|
<code>JointStyle.BEVEL</code>, <code>JointStyle.MITER</code>, and
|
|
<code>JointStyle.ROUND</code>. If a value is not indicated, Flash uses
|
|
round joints.</p>
|
|
</div>
|
|
<p>For example, the following illustrations show the different
|
|
<code>joints</code> settings. For each setting, the illustration shows an
|
|
angled blue line with a thickness of 30(for which the
|
|
<code>jointStyle</code> applies), and a superimposed angled black line
|
|
with a thickness of 1(for which no <code>jointStyle</code> applies):</p>
|
|
<p><strong>Note:</strong> For <code>joints</code> set to
|
|
<code>JointStyle.MITER</code>, you can use the <code>miterLimit</code>
|
|
parameter to limit the length of the miter.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="miterlimit" class="tsd-anchor"></a>
|
|
<h3>miter<wbr>Limit</h3>
|
|
<div class="tsd-signature tsd-kind-icon">miter<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/GraphicsStroke.d.ts#L84">lib/openfl/display/GraphicsStroke.d.ts:84</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Indicates the limit at which a miter is cut off. Valid values range from 1
|
|
to 255(and values outside that range are rounded to 1 or 255). This value
|
|
is only used if the <code>jointStyle</code> is set to
|
|
<code>"miter"</code>. The <code>miterLimit</code> value represents the
|
|
length that a miter can extend beyond the point at which the lines meet to
|
|
form a joint. The value expresses a factor of the line
|
|
<code>thickness</code>. For example, with a <code>miterLimit</code> factor
|
|
of 2.5 and a <code>thickness</code> of 10 pixels, the miter is cut off at
|
|
25 pixels.</p>
|
|
</div>
|
|
<p>For example, consider the following angled lines, each drawn with a
|
|
<code>thickness</code> of 20, but with <code>miterLimit</code> set to 1,
|
|
2, and 4. Superimposed are black reference lines showing the meeting
|
|
points of the joints:</p>
|
|
<p>Notice that a given <code>miterLimit</code> value has a specific
|
|
maximum angle for which the miter is cut off. The following table lists
|
|
some examples:</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="pixelhinting" class="tsd-anchor"></a>
|
|
<h3>pixel<wbr>Hinting</h3>
|
|
<div class="tsd-signature tsd-kind-icon">pixel<wbr>Hinting<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/GraphicsStroke.d.ts#L98">lib/openfl/display/GraphicsStroke.d.ts:98</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Specifies whether to hint strokes to full pixels. This affects both the
|
|
position of anchors of a curve and the line stroke size itself. With
|
|
<code>pixelHinting</code> set to <code>true</code>, Flash Player hints
|
|
line widths to full pixel widths. With <code>pixelHinting</code> set to
|
|
<code>false</code>, disjoints can appear for curves and straight lines.
|
|
For example, the following illustrations show how Flash Player renders two
|
|
rounded rectangles that are identical, except that the
|
|
<code>pixelHinting</code> parameter used in the <code>lineStyle()</code>
|
|
method is set differently(the images are scaled by 200%, to emphasize the
|
|
difference):</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="scalemode" class="tsd-anchor"></a>
|
|
<h3>scale<wbr>Mode</h3>
|
|
<div class="tsd-signature tsd-kind-icon">scale<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/openfl.display.linescalemode.html" class="tsd-signature-type">LineScaleMode</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/GraphicsStroke.d.ts#L123">lib/openfl/display/GraphicsStroke.d.ts:123</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Specifies the stroke thickness scaling. Valid values are:</p>
|
|
</div>
|
|
<ul>
|
|
<li><code>LineScaleMode.NORMAL</code> - Always scale the line thickness
|
|
when the object is scaled(the default).</li>
|
|
<li><p><code>LineScaleMode.NONE</code> - Never scale the line thickness.</p>
|
|
</li>
|
|
<li><p><code>LineScaleMode.VERTICAL</code> - Do not scale the line
|
|
thickness if the object is scaled vertically <em>only</em>. For example,
|
|
consider the following circles, drawn with a one-pixel line, and each with
|
|
the <code>scaleMode</code> parameter set to
|
|
<code>LineScaleMode.VERTICAL</code>. The circle on the left is scaled
|
|
vertically only, and the circle on the right is scaled both vertically and
|
|
horizontally:</p>
|
|
</li>
|
|
<li><code>LineScaleMode.HORIZONTAL</code> - Do not scale the line
|
|
thickness if the object is scaled horizontally <em>only</em>. For example,
|
|
consider the following circles, drawn with a one-pixel line, and each with
|
|
the <code>scaleMode</code> parameter set to
|
|
<code>LineScaleMode.HORIZONTAL</code>. The circle on the left is scaled
|
|
horizontally only, and the circle on the right is scaled both vertically
|
|
and horizontally:</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="thickness" class="tsd-anchor"></a>
|
|
<h3>thickness</h3>
|
|
<div class="tsd-signature tsd-kind-icon">thickness<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/GraphicsStroke.d.ts#L132">lib/openfl/display/GraphicsStroke.d.ts:132</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Indicates the thickness of the line in points; valid values are 0-255. If
|
|
a number is not specified, or if the parameter is undefined, a line is not
|
|
drawn. If a value of less than 0 is passed, the default is 0. The value 0
|
|
indicates hairline thickness; the maximum thickness is 255. If a value
|
|
greater than 255 is passed, the default is 255.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="label tsd-is-external">
|
|
<span>Externals</span>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.desktop.html">openfl.desktop</a>
|
|
</li>
|
|
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display.html">openfl.display</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display3d.html">openfl.display3D</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.errors.html">openfl.errors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.events.html">openfl.events</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.external.html">openfl.external</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.filters.html">openfl.filters</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.geom.html">openfl.geom</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.media.html">openfl.media</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.net.html">openfl.net</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.profiler.html">openfl.profiler</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.sensors.html">openfl.sensors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.system.html">openfl.system</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.text.html">openfl.text</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.ui.html">openfl.ui</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.utils.html">openfl.utils</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.display.graphicsstroke.html" class="tsd-kind-icon">Graphics<wbr>Stroke</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphicsstroke.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphicsstroke.html#caps" class="tsd-kind-icon">caps</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphicsstroke.html#fill" class="tsd-kind-icon">fill</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphicsstroke.html#joints" class="tsd-kind-icon">joints</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphicsstroke.html#miterlimit" class="tsd-kind-icon">miter<wbr>Limit</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphicsstroke.html#pixelhinting" class="tsd-kind-icon">pixel<wbr>Hinting</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphicsstroke.html#scalemode" class="tsd-kind-icon">scale<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphicsstroke.html#thickness" class="tsd-kind-icon">thickness</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
|
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
|
</body>
|
|
</html> |