1161 lines
72 KiB
HTML
1161 lines
72 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.20"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::basic_storage< Entity, Type, typename > Class Template Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">EnTT
|
|
 <span id="projectnumber">3.6.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.20 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1basic__storage.html">basic_storage</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classentt_1_1basic__storage-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">entt::basic_storage< Entity, Type, typename > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Basic storage implementation.
|
|
<a href="classentt_1_1basic__storage.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="storage_8hpp_source.html">storage.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:aa5b7f0d0c7b64522503c073fabc2a827"><td class="memItemLeft" align="right" valign="top"><a id="aa5b7f0d0c7b64522503c073fabc2a827"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a> = Type</td></tr>
|
|
<tr class="memdesc:aa5b7f0d0c7b64522503c073fabc2a827"><td class="mdescLeft"> </td><td class="mdescRight">Type of the objects associated with the entities. <br /></td></tr>
|
|
<tr class="separator:aa5b7f0d0c7b64522503c073fabc2a827"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab49ab5a065759dcd17f6c0b6a0b8fcba"><td class="memItemLeft" align="right" valign="top"><a id="ab49ab5a065759dcd17f6c0b6a0b8fcba"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#ab49ab5a065759dcd17f6c0b6a0b8fcba">entity_type</a> = Entity</td></tr>
|
|
<tr class="memdesc:ab49ab5a065759dcd17f6c0b6a0b8fcba"><td class="mdescLeft"> </td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
|
|
<tr class="separator:ab49ab5a065759dcd17f6c0b6a0b8fcba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afffeca2fda54eebf889c2e4f447ab37b"><td class="memItemLeft" align="right" valign="top"><a id="afffeca2fda54eebf889c2e4f447ab37b"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#afffeca2fda54eebf889c2e4f447ab37b">size_type</a> = std::size_t</td></tr>
|
|
<tr class="memdesc:afffeca2fda54eebf889c2e4f447ab37b"><td class="mdescLeft"> </td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
|
|
<tr class="separator:afffeca2fda54eebf889c2e4f447ab37b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8132568bade1021cb018419341d77da0"><td class="memItemLeft" align="right" valign="top"><a id="a8132568bade1021cb018419341d77da0"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a8132568bade1021cb018419341d77da0">iterator</a> = storage_iterator< Type ></td></tr>
|
|
<tr class="memdesc:a8132568bade1021cb018419341d77da0"><td class="mdescLeft"> </td><td class="mdescRight">Random access iterator type. <br /></td></tr>
|
|
<tr class="separator:a8132568bade1021cb018419341d77da0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7bd7ed8c51254df6f6337db3503a5e12"><td class="memItemLeft" align="right" valign="top"><a id="a7bd7ed8c51254df6f6337db3503a5e12"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a7bd7ed8c51254df6f6337db3503a5e12">const_iterator</a> = storage_iterator< const Type ></td></tr>
|
|
<tr class="memdesc:a7bd7ed8c51254df6f6337db3503a5e12"><td class="mdescLeft"> </td><td class="mdescRight">Constant random access iterator type. <br /></td></tr>
|
|
<tr class="separator:a7bd7ed8c51254df6f6337db3503a5e12"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a165b562c6886b302b9114a2b604cb439"><td class="memItemLeft" align="right" valign="top"><a id="a165b562c6886b302b9114a2b604cb439"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a165b562c6886b302b9114a2b604cb439">reverse_iterator</a> = Type *</td></tr>
|
|
<tr class="memdesc:a165b562c6886b302b9114a2b604cb439"><td class="mdescLeft"> </td><td class="mdescRight">Reverse iterator type. <br /></td></tr>
|
|
<tr class="separator:a165b562c6886b302b9114a2b604cb439"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a512f0f9f97404851a0b7c1f7419a9b45"><td class="memItemLeft" align="right" valign="top"><a id="a512f0f9f97404851a0b7c1f7419a9b45"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a512f0f9f97404851a0b7c1f7419a9b45">const_reverse_iterator</a> = const Type *</td></tr>
|
|
<tr class="memdesc:a512f0f9f97404851a0b7c1f7419a9b45"><td class="mdescLeft"> </td><td class="mdescRight">Constant reverse iterator type. <br /></td></tr>
|
|
<tr class="separator:a512f0f9f97404851a0b7c1f7419a9b45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a43a1e8ab7ad31d8ef65bdfc66c114466"><td class="memItemLeft" align="right" valign="top"><a id="a43a1e8ab7ad31d8ef65bdfc66c114466"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a43a1e8ab7ad31d8ef65bdfc66c114466">storage_category</a> = <a class="el" href="structentt_1_1dense__storage__tag.html">dense_storage_tag</a></td></tr>
|
|
<tr class="memdesc:a43a1e8ab7ad31d8ef65bdfc66c114466"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structentt_1_1Storage.html" title="Basic poly storage implementation.">Storage</a> category. <br /></td></tr>
|
|
<tr class="separator:a43a1e8ab7ad31d8ef65bdfc66c114466"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a8f2a2a968a241832acc338b8dca2f744"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a8f2a2a968a241832acc338b8dca2f744">reserve</a> (const <a class="el" href="classentt_1_1basic__storage.html#afffeca2fda54eebf889c2e4f447ab37b">size_type</a> cap)</td></tr>
|
|
<tr class="memdesc:a8f2a2a968a241832acc338b8dca2f744"><td class="mdescLeft"> </td><td class="mdescRight">Increases the capacity of a storage. <a href="classentt_1_1basic__storage.html#a8f2a2a968a241832acc338b8dca2f744">More...</a><br /></td></tr>
|
|
<tr class="separator:a8f2a2a968a241832acc338b8dca2f744"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a208fc8c4400c12e41229345badd0bc99"><td class="memItemLeft" align="right" valign="top"><a id="a208fc8c4400c12e41229345badd0bc99"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a208fc8c4400c12e41229345badd0bc99">shrink_to_fit</a> ()</td></tr>
|
|
<tr class="memdesc:a208fc8c4400c12e41229345badd0bc99"><td class="mdescLeft"> </td><td class="mdescRight">Requests the removal of unused capacity. <br /></td></tr>
|
|
<tr class="separator:a208fc8c4400c12e41229345badd0bc99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d1e7d9a099c304597435c7e91c8230b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a4d1e7d9a099c304597435c7e91c8230b">raw</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a4d1e7d9a099c304597435c7e91c8230b"><td class="mdescLeft"> </td><td class="mdescRight">Direct access to the array of objects. <a href="classentt_1_1basic__storage.html#a4d1e7d9a099c304597435c7e91c8230b">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d1e7d9a099c304597435c7e91c8230b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c200794ba3bd9fb52130757765a0f7c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a5c200794ba3bd9fb52130757765a0f7c">raw</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a5c200794ba3bd9fb52130757765a0f7c"><td class="mdescLeft"> </td><td class="mdescRight">Direct access to the array of objects. <a href="classentt_1_1basic__storage.html#a5c200794ba3bd9fb52130757765a0f7c">More...</a><br /></td></tr>
|
|
<tr class="separator:a5c200794ba3bd9fb52130757765a0f7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a574b51345185e1fbbd1ab4c21a5e44e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a7bd7ed8c51254df6f6337db3503a5e12">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a574b51345185e1fbbd1ab4c21a5e44e6">cbegin</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a574b51345185e1fbbd1ab4c21a5e44e6"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the beginning. <a href="classentt_1_1basic__storage.html#a574b51345185e1fbbd1ab4c21a5e44e6">More...</a><br /></td></tr>
|
|
<tr class="separator:a574b51345185e1fbbd1ab4c21a5e44e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a1a37940bf86e28814f8cd4f638a472"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a7bd7ed8c51254df6f6337db3503a5e12">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a6a1a37940bf86e28814f8cd4f638a472">begin</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a6a1a37940bf86e28814f8cd4f638a472"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the beginning. <a href="classentt_1_1basic__storage.html#a6a1a37940bf86e28814f8cd4f638a472">More...</a><br /></td></tr>
|
|
<tr class="separator:a6a1a37940bf86e28814f8cd4f638a472"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a462a9ce7b0cf069b677c4f5ec7c9782b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a8132568bade1021cb018419341d77da0">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a462a9ce7b0cf069b677c4f5ec7c9782b">begin</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a462a9ce7b0cf069b677c4f5ec7c9782b"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the beginning. <a href="classentt_1_1basic__storage.html#a462a9ce7b0cf069b677c4f5ec7c9782b">More...</a><br /></td></tr>
|
|
<tr class="separator:a462a9ce7b0cf069b677c4f5ec7c9782b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c7befdaa0a585b6ee59703c73a7eda4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a7bd7ed8c51254df6f6337db3503a5e12">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a6c7befdaa0a585b6ee59703c73a7eda4">cend</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a6c7befdaa0a585b6ee59703c73a7eda4"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the end. <a href="classentt_1_1basic__storage.html#a6c7befdaa0a585b6ee59703c73a7eda4">More...</a><br /></td></tr>
|
|
<tr class="separator:a6c7befdaa0a585b6ee59703c73a7eda4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c7a8ba904777d5ad519da2d60899ce9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a7bd7ed8c51254df6f6337db3503a5e12">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a1c7a8ba904777d5ad519da2d60899ce9">end</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a1c7a8ba904777d5ad519da2d60899ce9"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the end. <a href="classentt_1_1basic__storage.html#a1c7a8ba904777d5ad519da2d60899ce9">More...</a><br /></td></tr>
|
|
<tr class="separator:a1c7a8ba904777d5ad519da2d60899ce9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f4968b7ed57d0ffe34370e1d3fb8f1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a8132568bade1021cb018419341d77da0">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a8f4968b7ed57d0ffe34370e1d3fb8f1d">end</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a8f4968b7ed57d0ffe34370e1d3fb8f1d"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the end. <a href="classentt_1_1basic__storage.html#a8f4968b7ed57d0ffe34370e1d3fb8f1d">More...</a><br /></td></tr>
|
|
<tr class="separator:a8f4968b7ed57d0ffe34370e1d3fb8f1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad309c1c2d310e66a5d2ad18ae7639a08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a512f0f9f97404851a0b7c1f7419a9b45">const_reverse_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#ad309c1c2d310e66a5d2ad18ae7639a08">crbegin</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ad309c1c2d310e66a5d2ad18ae7639a08"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reverse iterator to the beginning. <a href="classentt_1_1basic__storage.html#ad309c1c2d310e66a5d2ad18ae7639a08">More...</a><br /></td></tr>
|
|
<tr class="separator:ad309c1c2d310e66a5d2ad18ae7639a08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa574dae2c6459ccc44e8f01bfb892e75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a512f0f9f97404851a0b7c1f7419a9b45">const_reverse_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#aa574dae2c6459ccc44e8f01bfb892e75">rbegin</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:aa574dae2c6459ccc44e8f01bfb892e75"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reverse iterator to the beginning. <a href="classentt_1_1basic__storage.html#aa574dae2c6459ccc44e8f01bfb892e75">More...</a><br /></td></tr>
|
|
<tr class="separator:aa574dae2c6459ccc44e8f01bfb892e75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af99c1ecf427c96f40562fd60c180f0cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a165b562c6886b302b9114a2b604cb439">reverse_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#af99c1ecf427c96f40562fd60c180f0cb">rbegin</a> () noexcept</td></tr>
|
|
<tr class="memdesc:af99c1ecf427c96f40562fd60c180f0cb"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reverse iterator to the beginning. <a href="classentt_1_1basic__storage.html#af99c1ecf427c96f40562fd60c180f0cb">More...</a><br /></td></tr>
|
|
<tr class="separator:af99c1ecf427c96f40562fd60c180f0cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8c9856f455fa96f96c2eb20244c8fa1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a512f0f9f97404851a0b7c1f7419a9b45">const_reverse_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#ab8c9856f455fa96f96c2eb20244c8fa1">crend</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ab8c9856f455fa96f96c2eb20244c8fa1"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reverse iterator to the end. <a href="classentt_1_1basic__storage.html#ab8c9856f455fa96f96c2eb20244c8fa1">More...</a><br /></td></tr>
|
|
<tr class="separator:ab8c9856f455fa96f96c2eb20244c8fa1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50f3c87d13562c0feb2cb2964160ce16"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a512f0f9f97404851a0b7c1f7419a9b45">const_reverse_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a50f3c87d13562c0feb2cb2964160ce16">rend</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a50f3c87d13562c0feb2cb2964160ce16"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reverse iterator to the end. <a href="classentt_1_1basic__storage.html#a50f3c87d13562c0feb2cb2964160ce16">More...</a><br /></td></tr>
|
|
<tr class="separator:a50f3c87d13562c0feb2cb2964160ce16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6570d0a34cb6a731e079536f17aa0618"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#a165b562c6886b302b9114a2b604cb439">reverse_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a6570d0a34cb6a731e079536f17aa0618">rend</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a6570d0a34cb6a731e079536f17aa0618"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reverse iterator to the end. <a href="classentt_1_1basic__storage.html#a6570d0a34cb6a731e079536f17aa0618">More...</a><br /></td></tr>
|
|
<tr class="separator:a6570d0a34cb6a731e079536f17aa0618"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ed5094d61941d46c34e6e18fd73f578"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a2ed5094d61941d46c34e6e18fd73f578">get</a> (const <a class="el" href="classentt_1_1basic__storage.html#ab49ab5a065759dcd17f6c0b6a0b8fcba">entity_type</a> entt) const</td></tr>
|
|
<tr class="memdesc:a2ed5094d61941d46c34e6e18fd73f578"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object associated with an entity. <a href="classentt_1_1basic__storage.html#a2ed5094d61941d46c34e6e18fd73f578">More...</a><br /></td></tr>
|
|
<tr class="separator:a2ed5094d61941d46c34e6e18fd73f578"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ee59dd153af233b3ccd95bc74b1bfca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a0ee59dd153af233b3ccd95bc74b1bfca">get</a> (const <a class="el" href="classentt_1_1basic__storage.html#ab49ab5a065759dcd17f6c0b6a0b8fcba">entity_type</a> entt)</td></tr>
|
|
<tr class="memdesc:a0ee59dd153af233b3ccd95bc74b1bfca"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object associated with an entity. <a href="classentt_1_1basic__storage.html#a0ee59dd153af233b3ccd95bc74b1bfca">More...</a><br /></td></tr>
|
|
<tr class="separator:a0ee59dd153af233b3ccd95bc74b1bfca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7eca6c57538e87443ce9be3f294c563"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr>
|
|
<tr class="memitem:af7eca6c57538e87443ce9be3f294c563"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#af7eca6c57538e87443ce9be3f294c563">emplace</a> (const <a class="el" href="classentt_1_1basic__storage.html#ab49ab5a065759dcd17f6c0b6a0b8fcba">entity_type</a> entt, Args &&... args)</td></tr>
|
|
<tr class="memdesc:af7eca6c57538e87443ce9be3f294c563"><td class="mdescLeft"> </td><td class="mdescRight">Assigns an entity to a storage and constructs its object. <a href="classentt_1_1basic__storage.html#af7eca6c57538e87443ce9be3f294c563">More...</a><br /></td></tr>
|
|
<tr class="separator:af7eca6c57538e87443ce9be3f294c563"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18fbea023050e5f40753c608bdd21cf8"><td class="memTemplParams" colspan="2">template<typename It > </td></tr>
|
|
<tr class="memitem:a18fbea023050e5f40753c608bdd21cf8"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a18fbea023050e5f40753c608bdd21cf8">insert</a> (It first, It last, const <a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a> &value={})</td></tr>
|
|
<tr class="memdesc:a18fbea023050e5f40753c608bdd21cf8"><td class="mdescLeft"> </td><td class="mdescRight">Assigns one or more entities to a storage and constructs their objects from a given instance. <a href="classentt_1_1basic__storage.html#a18fbea023050e5f40753c608bdd21cf8">More...</a><br /></td></tr>
|
|
<tr class="separator:a18fbea023050e5f40753c608bdd21cf8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb1a43a222b3126864027c4f0e91715e"><td class="memTemplParams" colspan="2">template<typename EIt , typename CIt > </td></tr>
|
|
<tr class="memitem:afb1a43a222b3126864027c4f0e91715e"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#afb1a43a222b3126864027c4f0e91715e">insert</a> (EIt first, EIt last, CIt from, CIt to)</td></tr>
|
|
<tr class="memdesc:afb1a43a222b3126864027c4f0e91715e"><td class="mdescLeft"> </td><td class="mdescRight">Assigns one or more entities to a storage and constructs their objects from a given range. <a href="classentt_1_1basic__storage.html#afb1a43a222b3126864027c4f0e91715e">More...</a><br /></td></tr>
|
|
<tr class="separator:afb1a43a222b3126864027c4f0e91715e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81cb4b11b654044be8fbd88b8733ea2d"><td class="memTemplParams" colspan="2">template<typename Compare , typename Sort = std_sort, typename... Args> </td></tr>
|
|
<tr class="memitem:a81cb4b11b654044be8fbd88b8733ea2d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#a81cb4b11b654044be8fbd88b8733ea2d">sort_n</a> (const <a class="el" href="classentt_1_1basic__storage.html#afffeca2fda54eebf889c2e4f447ab37b">size_type</a> count, Compare compare, Sort algo=Sort{}, Args &&... args)</td></tr>
|
|
<tr class="memdesc:a81cb4b11b654044be8fbd88b8733ea2d"><td class="mdescLeft"> </td><td class="mdescRight">Sort elements according to the given comparison function. <a href="classentt_1_1basic__storage.html#a81cb4b11b654044be8fbd88b8733ea2d">More...</a><br /></td></tr>
|
|
<tr class="separator:a81cb4b11b654044be8fbd88b8733ea2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1ed30f50fdc3eb2f994e3b4440dcf32"><td class="memTemplParams" colspan="2">template<typename Compare , typename Sort = std_sort, typename... Args> </td></tr>
|
|
<tr class="memitem:ac1ed30f50fdc3eb2f994e3b4440dcf32"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__storage.html#ac1ed30f50fdc3eb2f994e3b4440dcf32">sort</a> (Compare compare, Sort algo=Sort{}, Args &&... args)</td></tr>
|
|
<tr class="memdesc:ac1ed30f50fdc3eb2f994e3b4440dcf32"><td class="mdescLeft"> </td><td class="mdescRight">Sort all elements according to the given comparison function. <a href="classentt_1_1basic__storage.html#ac1ed30f50fdc3eb2f994e3b4440dcf32">More...</a><br /></td></tr>
|
|
<tr class="separator:ac1ed30f50fdc3eb2f994e3b4440dcf32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename Entity, typename Type, typename = void><br />
|
|
class entt::basic_storage< Entity, Type, typename ></h3>
|
|
|
|
<p>Basic storage implementation. </p>
|
|
<p>This class is a refinement of a sparse set that associates an object to an entity. The main purpose of this class is to extend sparse sets to store components in a registry. It guarantees fast access both to the elements and to the entities.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Entities and objects have the same order. It's guaranteed both in case of raw access (either to entities or objects) and when using random or input access iterators.</dd>
|
|
<dd>
|
|
Internal data structures arrange elements to maximize performance. There are no guarantees that objects are returned in the insertion order when iterate a storage. Do not make assumption on the order in any case.</dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Empty types aren't explicitly instantiated. Therefore, many of the functions normally available for non-empty types will not be available for empty ones.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceentt.html#ac27c0013e504d544508cdacc01170b68" title="Alias declaration for the most common use case.">sparse_set<Entity></a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Entity</td><td>A valid entity type (see <a class="el" href="structentt_1_1entt__traits.html" title="Entity traits.">entt_traits</a> for more details). </td></tr>
|
|
<tr><td class="paramname">Type</td><td>Type of objects assigned to the entities. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00058">58</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a6a1a37940bf86e28814f8cd4f638a472"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6a1a37940bf86e28814f8cd4f638a472">◆ </a></span>begin() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a7bd7ed8c51254df6f6337db3503a5e12">const_iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::begin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator to the beginning. </p>
|
|
<p>The returned iterator points to the first instance of the internal array. If the storage is empty, the returned iterator will be equal to <code><a class="el" href="classentt_1_1basic__storage.html#a8f4968b7ed57d0ffe34370e1d3fb8f1d" title="Returns an iterator to the end.">end()</a></code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first instance of the internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00253">253</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a462a9ce7b0cf069b677c4f5ec7c9782b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a462a9ce7b0cf069b677c4f5ec7c9782b">◆ </a></span>begin() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a8132568bade1021cb018419341d77da0">iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::begin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator to the beginning. </p>
|
|
<p>The returned iterator points to the first instance of the internal array. If the storage is empty, the returned iterator will be equal to <code><a class="el" href="classentt_1_1basic__storage.html#a8f4968b7ed57d0ffe34370e1d3fb8f1d" title="Returns an iterator to the end.">end()</a></code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first instance of the internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00258">258</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a574b51345185e1fbbd1ab4c21a5e44e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a574b51345185e1fbbd1ab4c21a5e44e6">◆ </a></span>cbegin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a7bd7ed8c51254df6f6337db3503a5e12">const_iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::cbegin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator to the beginning. </p>
|
|
<p>The returned iterator points to the first instance of the internal array. If the storage is empty, the returned iterator will be equal to <code><a class="el" href="classentt_1_1basic__storage.html#a8f4968b7ed57d0ffe34370e1d3fb8f1d" title="Returns an iterator to the end.">end()</a></code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first instance of the internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00247">247</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6c7befdaa0a585b6ee59703c73a7eda4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c7befdaa0a585b6ee59703c73a7eda4">◆ </a></span>cend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a7bd7ed8c51254df6f6337db3503a5e12">const_iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::cend </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator to the end. </p>
|
|
<p>The returned iterator points to the element following the last instance of the internal array. Attempting to dereference the returned iterator results in undefined behavior.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the element following the last instance of the internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00273">273</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad309c1c2d310e66a5d2ad18ae7639a08"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad309c1c2d310e66a5d2ad18ae7639a08">◆ </a></span>crbegin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a512f0f9f97404851a0b7c1f7419a9b45">const_reverse_iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::crbegin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a reverse iterator to the beginning. </p>
|
|
<p>The returned iterator points to the first instance of the reversed internal array. If the storage is empty, the returned iterator will be equal to <code><a class="el" href="classentt_1_1basic__storage.html#a6570d0a34cb6a731e079536f17aa0618" title="Returns a reverse iterator to the end.">rend()</a></code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first instance of the reversed internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00296">296</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab8c9856f455fa96f96c2eb20244c8fa1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8c9856f455fa96f96c2eb20244c8fa1">◆ </a></span>crend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a512f0f9f97404851a0b7c1f7419a9b45">const_reverse_iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::crend </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a reverse iterator to the end. </p>
|
|
<p>The returned iterator points to the element following the last instance of the reversed internal array. Attempting to dereference the returned iterator results in undefined behavior.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the element following the last instance of the reversed internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00320">320</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7eca6c57538e87443ce9be3f294c563"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7eca6c57538e87443ce9be3f294c563">◆ </a></span>emplace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a>& <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::emplace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__storage.html#ab49ab5a065759dcd17f6c0b6a0b8fcba">entity_type</a> </td>
|
|
<td class="paramname"><em>entt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&... </td>
|
|
<td class="paramname"><em>args</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns an entity to a storage and constructs its object. </p>
|
|
<p>This version accept both types that can be constructed in place directly and types like aggregates that do not work well with a placement new as performed usually under the hood during an <em>emplace back</em>.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to use an entity that already belongs to the storage results in undefined behavior.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid entity identifier. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Parameters to use to construct an object for the entity. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the newly created object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00370">370</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1c7a8ba904777d5ad519da2d60899ce9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1c7a8ba904777d5ad519da2d60899ce9">◆ </a></span>end() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a7bd7ed8c51254df6f6337db3503a5e12">const_iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::end </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator to the end. </p>
|
|
<p>The returned iterator points to the element following the last instance of the internal array. Attempting to dereference the returned iterator results in undefined behavior.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the element following the last instance of the internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00278">278</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f4968b7ed57d0ffe34370e1d3fb8f1d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f4968b7ed57d0ffe34370e1d3fb8f1d">◆ </a></span>end() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a8132568bade1021cb018419341d77da0">iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::end </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator to the end. </p>
|
|
<p>The returned iterator points to the element following the last instance of the internal array. Attempting to dereference the returned iterator results in undefined behavior.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the element following the last instance of the internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00283">283</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0ee59dd153af233b3ccd95bc74b1bfca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0ee59dd153af233b3ccd95bc74b1bfca">◆ </a></span>get() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a>& <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__storage.html#ab49ab5a065759dcd17f6c0b6a0b8fcba">entity_type</a> </td>
|
|
<td class="paramname"><em>entt</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the object associated with an entity. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to use an entity that doesn't belong to the storage results in undefined behavior.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid entity identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The object associated with the entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00349">349</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2ed5094d61941d46c34e6e18fd73f578"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ed5094d61941d46c34e6e18fd73f578">◆ </a></span>get() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a>& <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__storage.html#ab49ab5a065759dcd17f6c0b6a0b8fcba">entity_type</a> </td>
|
|
<td class="paramname"><em>entt</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the object associated with an entity. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to use an entity that doesn't belong to the storage results in undefined behavior.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid entity identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The object associated with the entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00344">344</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afb1a43a222b3126864027c4f0e91715e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb1a43a222b3126864027c4f0e91715e">◆ </a></span>insert() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<div class="memtemplate">
|
|
template<typename EIt , typename CIt > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::insert </td>
|
|
<td>(</td>
|
|
<td class="paramtype">EIt </td>
|
|
<td class="paramname"><em>first</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">EIt </td>
|
|
<td class="paramname"><em>last</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">CIt </td>
|
|
<td class="paramname"><em>from</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">CIt </td>
|
|
<td class="paramname"><em>to</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns one or more entities to a storage and constructs their objects from a given range. </p>
|
|
<dl class="section see"><dt>See also</dt><dd>construct</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">EIt</td><td>Type of input iterator. </td></tr>
|
|
<tr><td class="paramname">CIt</td><td>Type of input iterator. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">first</td><td>An iterator to the first element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">last</td><td>An iterator past the last element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">from</td><td>An iterator to the first element of the range of objects. </td></tr>
|
|
<tr><td class="paramname">to</td><td>An iterator past the last element of the range of objects. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00416">416</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a18fbea023050e5f40753c608bdd21cf8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a18fbea023050e5f40753c608bdd21cf8">◆ </a></span>insert() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<div class="memtemplate">
|
|
template<typename It > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::insert </td>
|
|
<td>(</td>
|
|
<td class="paramtype">It </td>
|
|
<td class="paramname"><em>first</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">It </td>
|
|
<td class="paramname"><em>last</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a> & </td>
|
|
<td class="paramname"><em>value</em> = <code>{}</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns one or more entities to a storage and constructs their objects from a given instance. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to assign an entity that already belongs to the storage results in undefined behavior.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">It</td><td>Type of input iterator. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">first</td><td>An iterator to the first element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">last</td><td>An iterator past the last element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">value</td><td>An instance of the object to construct. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00396">396</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d1e7d9a099c304597435c7e91c8230b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d1e7d9a099c304597435c7e91c8230b">◆ </a></span>raw() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a>* <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::raw </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Direct access to the array of objects. </p>
|
|
<p>The returned pointer is such that range <code>[<a class="el" href="classentt_1_1basic__storage.html#a5c200794ba3bd9fb52130757765a0f7c" title="Direct access to the array of objects.">raw()</a>, <a class="el" href="classentt_1_1basic__storage.html#a5c200794ba3bd9fb52130757765a0f7c" title="Direct access to the array of objects.">raw()</a> + size())</code> is always a valid range, even if the container is empty.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Objects are in the reverse order as returned by the <code>begin</code>/<code>end</code> iterators.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the array of objects. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00230">230</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c200794ba3bd9fb52130757765a0f7c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c200794ba3bd9fb52130757765a0f7c">◆ </a></span>raw() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#aa5b7f0d0c7b64522503c073fabc2a827">value_type</a>* <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::raw </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Direct access to the array of objects. </p>
|
|
<p>The returned pointer is such that range <code>[<a class="el" href="classentt_1_1basic__storage.html#a5c200794ba3bd9fb52130757765a0f7c" title="Direct access to the array of objects.">raw()</a>, <a class="el" href="classentt_1_1basic__storage.html#a5c200794ba3bd9fb52130757765a0f7c" title="Direct access to the array of objects.">raw()</a> + size())</code> is always a valid range, even if the container is empty.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Objects are in the reverse order as returned by the <code>begin</code>/<code>end</code> iterators.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the array of objects. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00235">235</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa574dae2c6459ccc44e8f01bfb892e75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa574dae2c6459ccc44e8f01bfb892e75">◆ </a></span>rbegin() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a512f0f9f97404851a0b7c1f7419a9b45">const_reverse_iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::rbegin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a reverse iterator to the beginning. </p>
|
|
<p>The returned iterator points to the first instance of the reversed internal array. If the storage is empty, the returned iterator will be equal to <code><a class="el" href="classentt_1_1basic__storage.html#a6570d0a34cb6a731e079536f17aa0618" title="Returns a reverse iterator to the end.">rend()</a></code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first instance of the reversed internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00301">301</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af99c1ecf427c96f40562fd60c180f0cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af99c1ecf427c96f40562fd60c180f0cb">◆ </a></span>rbegin() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a165b562c6886b302b9114a2b604cb439">reverse_iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::rbegin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a reverse iterator to the beginning. </p>
|
|
<p>The returned iterator points to the first instance of the reversed internal array. If the storage is empty, the returned iterator will be equal to <code><a class="el" href="classentt_1_1basic__storage.html#a6570d0a34cb6a731e079536f17aa0618" title="Returns a reverse iterator to the end.">rend()</a></code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first instance of the reversed internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00306">306</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a50f3c87d13562c0feb2cb2964160ce16"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50f3c87d13562c0feb2cb2964160ce16">◆ </a></span>rend() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a512f0f9f97404851a0b7c1f7419a9b45">const_reverse_iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::rend </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a reverse iterator to the end. </p>
|
|
<p>The returned iterator points to the element following the last instance of the reversed internal array. Attempting to dereference the returned iterator results in undefined behavior.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the element following the last instance of the reversed internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00325">325</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6570d0a34cb6a731e079536f17aa0618"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6570d0a34cb6a731e079536f17aa0618">◆ </a></span>rend() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__storage.html#a165b562c6886b302b9114a2b604cb439">reverse_iterator</a> <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::rend </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a reverse iterator to the end. </p>
|
|
<p>The returned iterator points to the element following the last instance of the reversed internal array. Attempting to dereference the returned iterator results in undefined behavior.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the element following the last instance of the reversed internal array. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00330">330</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f2a2a968a241832acc338b8dca2f744"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f2a2a968a241832acc338b8dca2f744">◆ </a></span>reserve()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::reserve </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__storage.html#afffeca2fda54eebf889c2e4f447ab37b">size_type</a> </td>
|
|
<td class="paramname"><em>cap</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Increases the capacity of a storage. </p>
|
|
<p>If the new capacity is greater than the current capacity, new storage is allocated, otherwise the method does nothing.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cap</td><td>Desired capacity. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00207">207</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1ed30f50fdc3eb2f994e3b4440dcf32"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1ed30f50fdc3eb2f994e3b4440dcf32">◆ </a></span>sort()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<div class="memtemplate">
|
|
template<typename Compare , typename Sort = std_sort, typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::sort </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Compare </td>
|
|
<td class="paramname"><em>compare</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Sort </td>
|
|
<td class="paramname"><em>algo</em> = <code>Sort{}</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&... </td>
|
|
<td class="paramname"><em>args</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sort all elements according to the given comparison function. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__storage.html#a81cb4b11b654044be8fbd88b8733ea2d" title="Sort elements according to the given comparison function.">sort_n</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Compare</td><td>Type of comparison function object. </td></tr>
|
|
<tr><td class="paramname">Sort</td><td>Type of sort function object. </td></tr>
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to forward to the sort function object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">compare</td><td>A valid comparison function object. </td></tr>
|
|
<tr><td class="paramname">algo</td><td>A valid sort function object. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Arguments to forward to the sort function object, if any. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00481">481</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a81cb4b11b654044be8fbd88b8733ea2d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81cb4b11b654044be8fbd88b8733ea2d">◆ </a></span>sort_n()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Type , typename = void> </div>
|
|
<div class="memtemplate">
|
|
template<typename Compare , typename Sort = std_sort, typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__storage.html">entt::basic_storage</a>< Entity, Type, typename >::sort_n </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__storage.html#afffeca2fda54eebf889c2e4f447ab37b">size_type</a> </td>
|
|
<td class="paramname"><em>count</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Compare </td>
|
|
<td class="paramname"><em>compare</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Sort </td>
|
|
<td class="paramname"><em>algo</em> = <code>Sort{}</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&... </td>
|
|
<td class="paramname"><em>args</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sort elements according to the given comparison function. </p>
|
|
<p>The comparison function object must return <code>true</code> if the first element is <em>less</em> than the second one, <code>false</code> otherwise. The signature of the comparison function should be equivalent to one of the following:</p>
|
|
<div class="fragment"><div class="line">bool(<span class="keyword">const</span> Entity, <span class="keyword">const</span> Entity);</div>
|
|
<div class="line">bool(<span class="keyword">const</span> Type &, <span class="keyword">const</span> Type &);</div>
|
|
</div><!-- fragment --><p>Moreover, the comparison function object shall induce a <em>strict weak ordering</em> on the values.</p>
|
|
<p>The sort function oject must offer a member function template <code>operator()</code> that accepts three arguments:</p>
|
|
<ul>
|
|
<li>An iterator to the first element of the range to sort.</li>
|
|
<li>An iterator past the last element of the range to sort.</li>
|
|
<li>A comparison function to use to compare the elements.</li>
|
|
</ul>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Empty types are never instantiated. Therefore, only comparison function objects that require to return entities rather than components are accepted.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Compare</td><td>Type of comparison function object. </td></tr>
|
|
<tr><td class="paramname">Sort</td><td>Type of sort function object. </td></tr>
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to forward to the sort function object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">count</td><td>Number of elements to sort. </td></tr>
|
|
<tr><td class="paramname">compare</td><td>A valid comparison function object. </td></tr>
|
|
<tr><td class="paramname">algo</td><td>A valid sort function object. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Arguments to forward to the sort function object, if any. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="storage_8hpp_source.html#l00458">458</a> of file <a class="el" href="storage_8hpp_source.html">storage.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/entt/entity/<a class="el" href="entity_2fwd_8hpp_source.html">fwd.hpp</a></li>
|
|
<li>src/entt/entity/<a class="el" href="storage_8hpp_source.html">storage.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
|
|
</small></address>
|
|
</body>
|
|
</html>
|