840 lines
54 KiB
HTML
840 lines
54 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>entt: entt::View< Entity, Component > 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">2.7.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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_1View_3_01Entity_00_01Component_01_4.html">View< Entity, Component ></a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classentt_1_1View_3_01Entity_00_01Component_01_4-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">entt::View< Entity, Component > Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Single component view specialization.
|
|
<a href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="view_8hpp_source.html">view.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:a8bdfb1fbdd4340131be9c70bf02671b5"><td class="memItemLeft" align="right" valign="top"><a id="a8bdfb1fbdd4340131be9c70bf02671b5"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a8bdfb1fbdd4340131be9c70bf02671b5">raw_type</a> = typename pool_type::object_type</td></tr>
|
|
<tr class="memdesc:a8bdfb1fbdd4340131be9c70bf02671b5"><td class="mdescLeft"> </td><td class="mdescRight">Type of component iterated by the view. <br /></td></tr>
|
|
<tr class="separator:a8bdfb1fbdd4340131be9c70bf02671b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75fc64bf381a3003d8acf03ed66728f2"><td class="memItemLeft" align="right" valign="top"><a id="a75fc64bf381a3003d8acf03ed66728f2"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a> = typename pool_type::entity_type</td></tr>
|
|
<tr class="memdesc:a75fc64bf381a3003d8acf03ed66728f2"><td class="mdescLeft"> </td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
|
|
<tr class="separator:a75fc64bf381a3003d8acf03ed66728f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa754b0f10b28dbdb2149b5b8d0fdf73"><td class="memItemLeft" align="right" valign="top"><a id="afa754b0f10b28dbdb2149b5b8d0fdf73"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#afa754b0f10b28dbdb2149b5b8d0fdf73">size_type</a> = typename pool_type::size_type</td></tr>
|
|
<tr class="memdesc:afa754b0f10b28dbdb2149b5b8d0fdf73"><td class="mdescLeft"> </td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
|
|
<tr class="separator:afa754b0f10b28dbdb2149b5b8d0fdf73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a791a1288db896fda8e77acad396aa513"><td class="memItemLeft" align="right" valign="top"><a id="a791a1288db896fda8e77acad396aa513"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a791a1288db896fda8e77acad396aa513">iterator_type</a> = typename <a class="el" href="classentt_1_1SparseSet_3_01Entity_01_4.html#a1ad77aed1e49af60b61044c996969b9a">view_type::iterator_type</a></td></tr>
|
|
<tr class="memdesc:a791a1288db896fda8e77acad396aa513"><td class="mdescLeft"> </td><td class="mdescRight">Input iterator type. <br /></td></tr>
|
|
<tr class="separator:a791a1288db896fda8e77acad396aa513"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79316bcf7c15b52712689653fff419c3"><td class="memItemLeft" align="right" valign="top"><a id="a79316bcf7c15b52712689653fff419c3"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a79316bcf7c15b52712689653fff419c3">const_iterator_type</a> = typename <a class="el" href="classentt_1_1SparseSet_3_01Entity_01_4.html#aba42055f0c8a43cae63d443a17f6a5e2">view_type::const_iterator_type</a></td></tr>
|
|
<tr class="memdesc:a79316bcf7c15b52712689653fff419c3"><td class="mdescLeft"> </td><td class="mdescRight">Constant input iterator type. <br /></td></tr>
|
|
<tr class="separator:a79316bcf7c15b52712689653fff419c3"><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:a2244b847c1e148f901ea3b83ec2d6703"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#afa754b0f10b28dbdb2149b5b8d0fdf73">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a2244b847c1e148f901ea3b83ec2d6703">size</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a2244b847c1e148f901ea3b83ec2d6703"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of entities that have the given component. <a href="#a2244b847c1e148f901ea3b83ec2d6703">More...</a><br /></td></tr>
|
|
<tr class="separator:a2244b847c1e148f901ea3b83ec2d6703"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee65a80863abccbe3117e60b22695dc4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#aee65a80863abccbe3117e60b22695dc4">empty</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:aee65a80863abccbe3117e60b22695dc4"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the view is empty. <a href="#aee65a80863abccbe3117e60b22695dc4">More...</a><br /></td></tr>
|
|
<tr class="separator:aee65a80863abccbe3117e60b22695dc4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67bdaf39828b8055069d51825192541d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a8bdfb1fbdd4340131be9c70bf02671b5">raw_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a67bdaf39828b8055069d51825192541d">raw</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a67bdaf39828b8055069d51825192541d"><td class="mdescLeft"> </td><td class="mdescRight">Direct access to the list of components. <a href="#a67bdaf39828b8055069d51825192541d">More...</a><br /></td></tr>
|
|
<tr class="separator:a67bdaf39828b8055069d51825192541d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07d8b7d15b93f9988f6b4fbf514a356a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a8bdfb1fbdd4340131be9c70bf02671b5">raw_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a07d8b7d15b93f9988f6b4fbf514a356a">raw</a> () ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a07d8b7d15b93f9988f6b4fbf514a356a"><td class="mdescLeft"> </td><td class="mdescRight">Direct access to the list of components. <a href="#a07d8b7d15b93f9988f6b4fbf514a356a">More...</a><br /></td></tr>
|
|
<tr class="separator:a07d8b7d15b93f9988f6b4fbf514a356a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b1ac1bc68c41fb4007ad5c47ed754a0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a7b1ac1bc68c41fb4007ad5c47ed754a0">data</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a7b1ac1bc68c41fb4007ad5c47ed754a0"><td class="mdescLeft"> </td><td class="mdescRight">Direct access to the list of entities. <a href="#a7b1ac1bc68c41fb4007ad5c47ed754a0">More...</a><br /></td></tr>
|
|
<tr class="separator:a7b1ac1bc68c41fb4007ad5c47ed754a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2cefabdbdd85098f9ac789a47fcc930a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a79316bcf7c15b52712689653fff419c3">const_iterator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a2cefabdbdd85098f9ac789a47fcc930a">cbegin</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a2cefabdbdd85098f9ac789a47fcc930a"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the first entity that has the given component. <a href="#a2cefabdbdd85098f9ac789a47fcc930a">More...</a><br /></td></tr>
|
|
<tr class="separator:a2cefabdbdd85098f9ac789a47fcc930a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c59406241bd142289a0d618a33f98d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a79316bcf7c15b52712689653fff419c3">const_iterator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a7c59406241bd142289a0d618a33f98d3">begin</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a7c59406241bd142289a0d618a33f98d3"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the first entity that has the given component. <a href="#a7c59406241bd142289a0d618a33f98d3">More...</a><br /></td></tr>
|
|
<tr class="separator:a7c59406241bd142289a0d618a33f98d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d4b1ac137a2dd3ac7f8f91a40b6eb0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a791a1288db896fda8e77acad396aa513">iterator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a5d4b1ac137a2dd3ac7f8f91a40b6eb0e">begin</a> () ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a5d4b1ac137a2dd3ac7f8f91a40b6eb0e"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the first entity that has the given component. <a href="#a5d4b1ac137a2dd3ac7f8f91a40b6eb0e">More...</a><br /></td></tr>
|
|
<tr class="separator:a5d4b1ac137a2dd3ac7f8f91a40b6eb0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab57c0ac7a0bb1487f525757a07a6bd71"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a79316bcf7c15b52712689653fff419c3">const_iterator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#ab57c0ac7a0bb1487f525757a07a6bd71">cend</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:ab57c0ac7a0bb1487f525757a07a6bd71"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator that is past the last entity that has the given component. <a href="#ab57c0ac7a0bb1487f525757a07a6bd71">More...</a><br /></td></tr>
|
|
<tr class="separator:ab57c0ac7a0bb1487f525757a07a6bd71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0cbc67f83e47cb4cbb3a1a26d7cd263"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a79316bcf7c15b52712689653fff419c3">const_iterator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#af0cbc67f83e47cb4cbb3a1a26d7cd263">end</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:af0cbc67f83e47cb4cbb3a1a26d7cd263"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator that is past the last entity that has the given component. <a href="#af0cbc67f83e47cb4cbb3a1a26d7cd263">More...</a><br /></td></tr>
|
|
<tr class="separator:af0cbc67f83e47cb4cbb3a1a26d7cd263"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34bca7c2c996fe26e150c0a7a2dbb69d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a791a1288db896fda8e77acad396aa513">iterator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a34bca7c2c996fe26e150c0a7a2dbb69d">end</a> () ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a34bca7c2c996fe26e150c0a7a2dbb69d"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator that is past the last entity that has the given component. <a href="#a34bca7c2c996fe26e150c0a7a2dbb69d">More...</a><br /></td></tr>
|
|
<tr class="separator:a34bca7c2c996fe26e150c0a7a2dbb69d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6094dd00422b07f0a9523699b9bf77aa"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a6094dd00422b07f0a9523699b9bf77aa">operator[]</a> (const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#afa754b0f10b28dbdb2149b5b8d0fdf73">size_type</a> pos) const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a6094dd00422b07f0a9523699b9bf77aa"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the element at the given position. <a href="#a6094dd00422b07f0a9523699b9bf77aa">More...</a><br /></td></tr>
|
|
<tr class="separator:a6094dd00422b07f0a9523699b9bf77aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abbc407e2fecdbcf97c129ade5db185e8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#abbc407e2fecdbcf97c129ade5db185e8">contains</a> (const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a> entity) const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:abbc407e2fecdbcf97c129ade5db185e8"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a view contains an entity. <a href="#abbc407e2fecdbcf97c129ade5db185e8">More...</a><br /></td></tr>
|
|
<tr class="separator:abbc407e2fecdbcf97c129ade5db185e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a51d497700a0322a130022eea97643d0f"><td class="memItemLeft" align="right" valign="top">const Component & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a51d497700a0322a130022eea97643d0f">get</a> (const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a> entity) const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a51d497700a0322a130022eea97643d0f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component assigned to the given entity. <a href="#a51d497700a0322a130022eea97643d0f">More...</a><br /></td></tr>
|
|
<tr class="separator:a51d497700a0322a130022eea97643d0f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a269fac4009da89c9743202b16dcd6d87"><td class="memItemLeft" align="right" valign="top">Component & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a269fac4009da89c9743202b16dcd6d87">get</a> (const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a> entity) ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a269fac4009da89c9743202b16dcd6d87"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component assigned to the given entity. <a href="#a269fac4009da89c9743202b16dcd6d87">More...</a><br /></td></tr>
|
|
<tr class="separator:a269fac4009da89c9743202b16dcd6d87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85eea1ef9655368de8da355019fbeaa0"><td class="memTemplParams" colspan="2">template<typename Func > </td></tr>
|
|
<tr class="memitem:a85eea1ef9655368de8da355019fbeaa0"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a85eea1ef9655368de8da355019fbeaa0">each</a> (Func func) const</td></tr>
|
|
<tr class="memdesc:a85eea1ef9655368de8da355019fbeaa0"><td class="mdescLeft"> </td><td class="mdescRight">Iterates entities and components and applies the given function object to them. <a href="#a85eea1ef9655368de8da355019fbeaa0">More...</a><br /></td></tr>
|
|
<tr class="separator:a85eea1ef9655368de8da355019fbeaa0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c540ac6937e6e9cf931cccaabcec745"><td class="memTemplParams" colspan="2">template<typename Func > </td></tr>
|
|
<tr class="memitem:a6c540ac6937e6e9cf931cccaabcec745"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a6c540ac6937e6e9cf931cccaabcec745">each</a> (Func func)</td></tr>
|
|
<tr class="memdesc:a6c540ac6937e6e9cf931cccaabcec745"><td class="mdescLeft"> </td><td class="mdescRight">Iterates entities and components and applies the given function object to them. <a href="#a6c540ac6937e6e9cf931cccaabcec745">More...</a><br /></td></tr>
|
|
<tr class="separator:a6c540ac6937e6e9cf931cccaabcec745"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a200646cfe88496da691aab5f61c0fa69"><td class="memItemLeft" align="right" valign="top"><a id="a200646cfe88496da691aab5f61c0fa69"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a200646cfe88496da691aab5f61c0fa69">Registry< Entity ></a></td></tr>
|
|
<tr class="memdesc:a200646cfe88496da691aab5f61c0fa69"><td class="mdescLeft"> </td><td class="mdescRight">A registry is allowed to create views. <br /></td></tr>
|
|
<tr class="separator:a200646cfe88496da691aab5f61c0fa69"><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 Component><br />
|
|
class entt::View< Entity, Component ></h3>
|
|
|
|
<p>Single component view specialization. </p>
|
|
<p>Single component views are specialized in order to get a boost in terms of performance. This kind of views can access the underlying data structure directly and avoid superfluous checks.<br />
|
|
Order of elements during iterations are highly dependent on the order of the underlying data structure. See <a class="el" href="classentt_1_1SparseSet.html" title="Sparse set. ">SparseSet</a> and its specializations for more details.</p>
|
|
<p><b>Important</b> </p>
|
|
<p>Iterators aren't invalidated if:</p>
|
|
<ul>
|
|
<li>New instances of the given component are created and assigned to entities.</li>
|
|
<li>The entity currently pointed is modified (as an example, the given component is removed from the entity to which the iterator points).</li>
|
|
</ul>
|
|
<p>In all the other cases, modifying the pool of the given component in any way invalidates all the iterators and using them results in undefined behavior.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Views share a reference to the underlying data structure with the <a class="el" href="classentt_1_1Registry.html" title="Fast and reliable entity-component system. ">Registry</a> that generated them. Therefore any change to the entities and to the components made by means of the registry are immediately reflected by views.</dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Lifetime of a view must overcome the one of the registry that generated it. In any other case, attempting to use a view results in undefined behavior.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1View.html" title="Multi component view. ">View</a> </dd>
|
|
<dd>
|
|
<a class="el" href="classentt_1_1PersistentView.html" title="Persistent view. ">PersistentView</a> </dd>
|
|
<dd>
|
|
<a class="el" href="classentt_1_1RawView.html" title="Raw view. ">RawView</a> </dd>
|
|
<dd>
|
|
<a class="el" href="classentt_1_1RuntimeView.html" title="Runtime view. ">RuntimeView</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">Component</td><td>Type of component iterated by the view. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00956">956</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a7c59406241bd142289a0d618a33f98d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c59406241bd142289a0d618a33f98d3">◆ </a></span>begin() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a79316bcf7c15b52712689653fff419c3">const_iterator_type</a> <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator to the first entity that has the given component. </p>
|
|
<p>The returned iterator points to the first entity that has the given component. If the view is empty, the returned iterator will be equal to <code><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a34bca7c2c996fe26e150c0a7a2dbb69d" title="Returns an iterator that is past the last entity that has the given component. ">end()</a></code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Input iterators stay true to the order imposed to the underlying data structures.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first entity that has the given component. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01075">1075</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5d4b1ac137a2dd3ac7f8f91a40b6eb0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d4b1ac137a2dd3ac7f8f91a40b6eb0e">◆ </a></span>begin() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a791a1288db896fda8e77acad396aa513">iterator_type</a> <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator to the first entity that has the given component. </p>
|
|
<p>The returned iterator points to the first entity that has the given component. If the view is empty, the returned iterator will be equal to <code><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a34bca7c2c996fe26e150c0a7a2dbb69d" title="Returns an iterator that is past the last entity that has the given component. ">end()</a></code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Input iterators stay true to the order imposed to the underlying data structures.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first entity that has the given component. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01093">1093</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2cefabdbdd85098f9ac789a47fcc930a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2cefabdbdd85098f9ac789a47fcc930a">◆ </a></span>cbegin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a79316bcf7c15b52712689653fff419c3">const_iterator_type</a> <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator to the first entity that has the given component. </p>
|
|
<p>The returned iterator points to the first entity that has the given component. If the view is empty, the returned iterator will be equal to <code><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a34bca7c2c996fe26e150c0a7a2dbb69d" title="Returns an iterator that is past the last entity that has the given component. ">end()</a></code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Input iterators stay true to the order imposed to the underlying data structures.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first entity that has the given component. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01057">1057</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab57c0ac7a0bb1487f525757a07a6bd71"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab57c0ac7a0bb1487f525757a07a6bd71">◆ </a></span>cend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a79316bcf7c15b52712689653fff419c3">const_iterator_type</a> <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator that is past the last entity that has the given component. </p>
|
|
<p>The returned iterator points to the entity following the last entity that has the given component. Attempting to dereference the returned iterator results in undefined behavior.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Input iterators stay true to the order imposed to the underlying data structures.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the entity following the last entity that has the given component. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01112">1112</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abbc407e2fecdbcf97c129ade5db185e8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abbc407e2fecdbcf97c129ade5db185e8">◆ </a></span>contains()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::contains </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a> </td>
|
|
<td class="paramname"><em>entity</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>Checks if a view contains an entity. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entity</td><td>A valid entity identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the view contains the given entity, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01168">1168</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7b1ac1bc68c41fb4007ad5c47ed754a0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b1ac1bc68c41fb4007ad5c47ed754a0">◆ </a></span>data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a>* <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::data </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Direct access to the list of entities. </p>
|
|
<p>The returned pointer is such that range <code>[<a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a7b1ac1bc68c41fb4007ad5c47ed754a0" title="Direct access to the list of entities. ">data()</a>, <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a7b1ac1bc68c41fb4007ad5c47ed754a0" title="Direct access to the list of entities. ">data()</a> + <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a2244b847c1e148f901ea3b83ec2d6703" title="Returns the number of entities that have the given component. ">size()</a>]</code> is always a valid range, even if the container is empty.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>There are no guarantees on the order of the entities. Use <code>begin</code> and <code>end</code> if you want to iterate the view in the expected order.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the array of entities. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01039">1039</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a85eea1ef9655368de8da355019fbeaa0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85eea1ef9655368de8da355019fbeaa0">◆ </a></span>each() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<div class="memtemplate">
|
|
template<typename Func > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::each </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Func </td>
|
|
<td class="paramname"><em>func</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>Iterates entities and components and applies the given function object to them. </p>
|
|
<p>The function object is invoked for each entity. It is provided with the entity itself and a const reference to the component of the view.<br />
|
|
The signature of the function should be equivalent to the following:</p>
|
|
<div class="fragment"><div class="line">void(<span class="keyword">const</span> <a class="code" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a>, <span class="keyword">const</span> Component &);</div></div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Func</td><td>Type of the function object to invoke. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>A valid function object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01227">1227</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6c540ac6937e6e9cf931cccaabcec745"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c540ac6937e6e9cf931cccaabcec745">◆ </a></span>each() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<div class="memtemplate">
|
|
template<typename Func > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::each </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Func </td>
|
|
<td class="paramname"><em>func</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>Iterates entities and components and applies the given function object to them. </p>
|
|
<p>The function object is invoked for each entity. It is provided with the entity itself and a reference to the component of the view.<br />
|
|
The signature of the function should be equivalent to the following:</p>
|
|
<div class="fragment"><div class="line">void(<span class="keyword">const</span> <a class="code" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a>, Component &);</div></div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Func</td><td>Type of the function object to invoke. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>A valid function object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01249">1249</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee65a80863abccbe3117e60b22695dc4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee65a80863abccbe3117e60b22695dc4">◆ </a></span>empty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::empty </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks whether the view is empty. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the view is empty, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00991">991</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af0cbc67f83e47cb4cbb3a1a26d7cd263"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af0cbc67f83e47cb4cbb3a1a26d7cd263">◆ </a></span>end() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a79316bcf7c15b52712689653fff419c3">const_iterator_type</a> <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator that is past the last entity that has the given component. </p>
|
|
<p>The returned iterator points to the entity following the last entity that has the given component. Attempting to dereference the returned iterator results in undefined behavior.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Input iterators stay true to the order imposed to the underlying data structures.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the entity following the last entity that has the given component. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01131">1131</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a34bca7c2c996fe26e150c0a7a2dbb69d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a34bca7c2c996fe26e150c0a7a2dbb69d">◆ </a></span>end() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a791a1288db896fda8e77acad396aa513">iterator_type</a> <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator that is past the last entity that has the given component. </p>
|
|
<p>The returned iterator points to the entity following the last entity that has the given component. Attempting to dereference the returned iterator results in undefined behavior.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Input iterators stay true to the order imposed to the underlying data structures.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the entity following the last entity that has the given component. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01150">1150</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a51d497700a0322a130022eea97643d0f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a51d497700a0322a130022eea97643d0f">◆ </a></span>get() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const Component& <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a> </td>
|
|
<td class="paramname"><em>entity</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 component assigned to the given entity. </p>
|
|
<p>Prefer this function instead of <code><a class="el" href="classentt_1_1Registry.html#a2079fb67093feb86b75e9dede6bb6c4d" title="Returns a reference to the given tag. ">Registry::get</a></code> during iterations. It has far better performance than its companion function.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to use an entity that doesn't belong to the view results in undefined behavior.<br />
|
|
An assertion will abort the execution at runtime in debug mode if the view doesn't contain the given entity.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entity</td><td>A valid entity identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The component assigned to the entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01187">1187</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a269fac4009da89c9743202b16dcd6d87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a269fac4009da89c9743202b16dcd6d87">◆ </a></span>get() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Component& <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a> </td>
|
|
<td class="paramname"><em>entity</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 component assigned to the given entity. </p>
|
|
<p>Prefer this function instead of <code><a class="el" href="classentt_1_1Registry.html#a2079fb67093feb86b75e9dede6bb6c4d" title="Returns a reference to the given tag. ">Registry::get</a></code> during iterations. It has far better performance than its companion function.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to use an entity that doesn't belong to the view results in undefined behavior.<br />
|
|
An assertion will abort the execution at runtime in debug mode if the view doesn't contain the given entity.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entity</td><td>A valid entity identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The component assigned to the entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01207">1207</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6094dd00422b07f0a9523699b9bf77aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6094dd00422b07f0a9523699b9bf77aa">◆ </a></span>operator[]()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a75fc64bf381a3003d8acf03ed66728f2">entity_type</a>& <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#afa754b0f10b28dbdb2149b5b8d0fdf73">size_type</a> </td>
|
|
<td class="paramname"><em>pos</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 a reference to the element at the given position. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pos</td><td>Position of the element to return. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the requested element. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01159">1159</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a67bdaf39828b8055069d51825192541d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a67bdaf39828b8055069d51825192541d">◆ </a></span>raw() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a8bdfb1fbdd4340131be9c70bf02671b5">raw_type</a>* <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Direct access to the list of components. </p>
|
|
<p>The returned pointer is such that range <code>[<a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a07d8b7d15b93f9988f6b4fbf514a356a" title="Direct access to the list of components. ">raw()</a>, <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a07d8b7d15b93f9988f6b4fbf514a356a" title="Direct access to the list of components. ">raw()</a> + <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a2244b847c1e148f901ea3b83ec2d6703" title="Returns the number of entities that have the given component. ">size()</a>]</code> is always a valid range, even if the container is empty.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>There are no guarantees on the order of the components. Use <code>begin</code> and <code>end</code> if you want to iterate the view in the expected order.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the array of components. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01007">1007</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a07d8b7d15b93f9988f6b4fbf514a356a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07d8b7d15b93f9988f6b4fbf514a356a">◆ </a></span>raw() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a8bdfb1fbdd4340131be9c70bf02671b5">raw_type</a>* <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Direct access to the list of components. </p>
|
|
<p>The returned pointer is such that range <code>[<a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a07d8b7d15b93f9988f6b4fbf514a356a" title="Direct access to the list of components. ">raw()</a>, <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a07d8b7d15b93f9988f6b4fbf514a356a" title="Direct access to the list of components. ">raw()</a> + <a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#a2244b847c1e148f901ea3b83ec2d6703" title="Returns the number of entities that have the given component. ">size()</a>]</code> is always a valid range, even if the container is empty.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>There are no guarantees on the order of the components. Use <code>begin</code> and <code>end</code> if you want to iterate the view in the expected order.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the array of components. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l01023">1023</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2244b847c1e148f901ea3b83ec2d6703"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2244b847c1e148f901ea3b83ec2d6703">◆ </a></span>size()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity , typename Component > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html#afa754b0f10b28dbdb2149b5b8d0fdf73">size_type</a> <a class="el" href="classentt_1_1View.html">entt::View</a>< Entity, Component >::size </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the number of entities that have the given component. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of entities that have the given component. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00983">983</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/entt/entity/<a class="el" href="view_8hpp_source.html">view.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.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|