387 lines
19 KiB
HTML
387 lines
19 KiB
HTML
<!doctype html>
|
||
<html class="default no-js">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<title>Flags | @esengine/egret-framework</title>
|
||
<meta name="description" content="Documentation for @esengine/egret-framework">
|
||
<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.json" 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">@esengine/egret-framework</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="../globals.html">Globals</a>
|
||
</li>
|
||
<li>
|
||
<a href="../modules/_math_flags_.html">"Math/Flags"</a>
|
||
</li>
|
||
<li>
|
||
<a href="../modules/_math_flags_.es.html">es</a>
|
||
</li>
|
||
<li>
|
||
<a href="_math_flags_.es.flags.html">Flags</a>
|
||
</li>
|
||
</ul>
|
||
<h1>Class Flags</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>帮助处理位掩码的实用程序类
|
||
除了isFlagSet之外，所有方法都期望flag参数是一个非移位的标志
|
||
允许您使用普通的(0、1、2、3等)来设置/取消您的标记</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="tsd-panel tsd-hierarchy">
|
||
<h3>Hierarchy</h3>
|
||
<ul class="tsd-hierarchy">
|
||
<li>
|
||
<span class="target">Flags</span>
|
||
</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 ">
|
||
<h3>Methods</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_math_flags_.es.flags.html#invertflags" class="tsd-kind-icon">invert<wbr>Flags</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_math_flags_.es.flags.html#isflagset" class="tsd-kind-icon">is<wbr>Flag<wbr>Set</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_math_flags_.es.flags.html#isunshiftedflagset" class="tsd-kind-icon">is<wbr>Unshifted<wbr>Flag<wbr>Set</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_math_flags_.es.flags.html#setflag" class="tsd-kind-icon">set<wbr>Flag</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_math_flags_.es.flags.html#setflagexclusive" class="tsd-kind-icon">set<wbr>Flag<wbr>Exclusive</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_math_flags_.es.flags.html#unsetflag" class="tsd-kind-icon">unset<wbr>Flag</a></li>
|
||
</ul>
|
||
</section>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-member-group ">
|
||
<h2>Methods</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="invertflags" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> invert<wbr>Flags</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">invert<wbr>Flags<span class="tsd-signature-symbol">(</span>self<span class="tsd-signature-symbol">: </span><a href="_utils_ref_.es.ref.html" class="tsd-signature-type">Ref</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Math/Flags.ts#L60">src/Math/Flags.ts:60</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>反转数值集合位</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>self: <a href="_utils_ref_.es.ref.html" class="tsd-signature-type">Ref</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="isflagset" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Flag<wbr>Set</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">is<wbr>Flag<wbr>Set<span class="tsd-signature-symbol">(</span>self<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, flag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Math/Flags.ts#L14">src/Math/Flags.ts:14</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>检查位标志是否已在数值中设置
|
||
检查期望标志是否已经移位</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>self: <span class="tsd-signature-type">number</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>flag: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="isunshiftedflagset" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Unshifted<wbr>Flag<wbr>Set</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">is<wbr>Unshifted<wbr>Flag<wbr>Set<span class="tsd-signature-symbol">(</span>self<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, flag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Math/Flags.ts#L23">src/Math/Flags.ts:23</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>检查位标志是否在数值中设置</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>self: <span class="tsd-signature-type">number</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>flag: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="setflag" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Flag</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">set<wbr>Flag<span class="tsd-signature-symbol">(</span>self<span class="tsd-signature-symbol">: </span><a href="_utils_ref_.es.ref.html" class="tsd-signature-type">Ref</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, flag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Math/Flags.ts#L42">src/Math/Flags.ts:42</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>设置标志位</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>self: <a href="_utils_ref_.es.ref.html" class="tsd-signature-type">Ref</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>flag: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="setflagexclusive" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Flag<wbr>Exclusive</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">set<wbr>Flag<wbr>Exclusive<span class="tsd-signature-symbol">(</span>self<span class="tsd-signature-symbol">: </span><a href="_utils_ref_.es.ref.html" class="tsd-signature-type">Ref</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, flag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Math/Flags.ts#L33">src/Math/Flags.ts:33</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p> 设置数值标志位，移除所有已经设置的标志</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>self: <a href="_utils_ref_.es.ref.html" class="tsd-signature-type">Ref</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>flag: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="unsetflag" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> unset<wbr>Flag</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">unset<wbr>Flag<span class="tsd-signature-symbol">(</span>self<span class="tsd-signature-symbol">: </span><a href="_utils_ref_.es.ref.html" class="tsd-signature-type">Ref</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, flag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Math/Flags.ts#L51">src/Math/Flags.ts:51</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>取消标志位</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>self: <a href="_utils_ref_.es.ref.html" class="tsd-signature-type">Ref</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>flag: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
</div>
|
||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||
<nav class="tsd-navigation primary">
|
||
<ul>
|
||
<li class="globals ">
|
||
<a href="../globals.html"><em>Globals</em></a>
|
||
</li>
|
||
<li class="current tsd-kind-module">
|
||
<a href="../modules/_math_flags_.html">"<wbr>Math/<wbr>Flags"</a>
|
||
<ul>
|
||
<li class="current tsd-kind-namespace tsd-parent-kind-module">
|
||
<a href="../modules/_math_flags_.es.html">es</a>
|
||
</li>
|
||
</ul>
|
||
</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-namespace">
|
||
<a href="_math_flags_.es.flags.html" class="tsd-kind-icon">Flags</a>
|
||
<ul>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_math_flags_.es.flags.html#invertflags" class="tsd-kind-icon">invert<wbr>Flags</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_math_flags_.es.flags.html#isflagset" class="tsd-kind-icon">is<wbr>Flag<wbr>Set</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_math_flags_.es.flags.html#isunshiftedflagset" class="tsd-kind-icon">is<wbr>Unshifted<wbr>Flag<wbr>Set</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_math_flags_.es.flags.html#setflag" class="tsd-kind-icon">set<wbr>Flag</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_math_flags_.es.flags.html#setflagexclusive" class="tsd-kind-icon">set<wbr>Flag<wbr>Exclusive</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_math_flags_.es.flags.html#unsetflag" class="tsd-kind-icon">unset<wbr>Flag</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-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||
</ul>
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||
</ul>
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||
</ul>
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-method 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="https://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> |