Files
openmw.github.io/activator_8hpp_source.html
Travis CI 1afc571f3d Deploy code docs to GitHub Pages Travis build: 4489
Commit: 6e51b4ff57f622c4e11205ec444ffac21e73bbf7
2017-01-24 02:13:55 +00:00

165 lines
21 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.6"/>
<title>OpenMW: /home/travis/build/OpenMW/openmw/apps/openmw/mwclass/activator.hpp Source File</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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.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 style="padding-left: 0.5em;">
<div id="projectname">OpenMW
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(13)"><span class="SelectionMark">&#160;</span>Pages</a></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="dir_9654b8d08f4bba4e84b362c5fd320bee.html">apps</a></li><li class="navelem"><a class="el" href="dir_9edfe748cccf561d6c3b74e2990846ba.html">openmw</a></li><li class="navelem"><a class="el" href="dir_a29bed4991674bf09e6b827d2ad966c6.html">mwclass</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">activator.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="activator_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef GAME_MWCLASS_ACTIVATOR_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GAME_MWCLASS_ACTIVATOR_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;../mwworld/class.hpp&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">namespace </span>MWClass</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;{</div>
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="classMWClass_1_1Activator.html"> 8</a></span>&#160; <span class="keyword">class </span><a class="code" href="classMWClass_1_1Activator.html">Activator</a> : <span class="keyword">public</span> <a class="code" href="classMWWorld_1_1Class.html">MWWorld::Class</a></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; {</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classMWWorld_1_1Ptr.html">MWWorld::Ptr</a> <a class="code" href="classMWClass_1_1Activator.html#ad1d88d1e2a67360cc890e57d19737253">copyToCellImpl</a>(<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1ConstPtr.html">MWWorld::ConstPtr</a> &amp;ptr, <a class="code" href="classMWWorld_1_1CellStore.html">MWWorld::CellStore</a> &amp;cell) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classMWClass_1_1Activator.html#a29563a707c15b5d83a6f0510e9eaafbc">insertObjectRendering</a> (<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1Ptr.html">MWWorld::Ptr</a>&amp; ptr, <span class="keyword">const</span> std::string&amp; model, <a class="code" href="classMWRender_1_1RenderingInterface.html">MWRender::RenderingInterface</a>&amp; renderingInterface) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classMWClass_1_1Activator.html#afeb977f74d778d8fc356284e7646d3c5">insertObject</a>(<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1Ptr.html">MWWorld::Ptr</a>&amp; ptr, <span class="keyword">const</span> std::string&amp; model, <a class="code" href="classMWPhysics_1_1PhysicsSystem.html">MWPhysics::PhysicsSystem</a>&amp; physics) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">virtual</span> std::string <a class="code" href="classMWClass_1_1Activator.html#a36528d07aeead2f5060d4aa7819f4f2f">getName</a> (<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1ConstPtr.html">MWWorld::ConstPtr</a>&amp; ptr) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classMWClass_1_1Activator.html#a30dfd520e90dbf941cf643acc260c1ba">hasToolTip</a> (<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1ConstPtr.html">MWWorld::ConstPtr</a>&amp; ptr) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classMWClass_1_1Activator.html#ae865dc4b5805ee98c1d38f1d9e9b13d1">allowTelekinesis</a>(<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1ConstPtr.html">MWWorld::ConstPtr</a>&amp; ptr) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">virtual</span> <a class="code" href="structMWGui_1_1ToolTipInfo.html">MWGui::ToolTipInfo</a> <a class="code" href="classMWClass_1_1Activator.html#a1f7997772d61a8c5ae974e88eff9c0f5">getToolTipInfo</a> (<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1ConstPtr.html">MWWorld::ConstPtr</a>&amp; ptr, <span class="keywordtype">int</span> count) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">virtual</span> std::string <a class="code" href="classMWClass_1_1Activator.html#acff6d155f2cf2cab5b76289ed81e7182">getScript</a> (<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1ConstPtr.html">MWWorld::ConstPtr</a>&amp; ptr) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">virtual</span> boost::shared_ptr&lt;MWWorld::Action&gt; <a class="code" href="classMWClass_1_1Activator.html#adae76d6d215263b816a1b654a7dde63f">activate</a> (<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1Ptr.html">MWWorld::Ptr</a>&amp; ptr, <span class="keyword">const</span> <a class="code" href="classMWWorld_1_1Ptr.html">MWWorld::Ptr</a>&amp; actor) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classMWClass_1_1Activator.html#ae2b55ea66c5078c158bdb38a1ba8d53a">registerSelf</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">virtual</span> std::string <a class="code" href="classMWClass_1_1Activator.html#a9f926601c5bd560d99001398f2102602">getModel</a>(<span class="keyword">const</span> <a class="code" href="classMWWorld_1_1ConstPtr.html">MWWorld::ConstPtr</a> &amp;ptr) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; };</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;}</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="structMWGui_1_1ToolTipInfo_html"><div class="ttname"><a href="structMWGui_1_1ToolTipInfo.html">MWGui::ToolTipInfo</a></div><div class="ttdef"><b>Definition:</b> tooltips.hpp:18</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_a30dfd520e90dbf941cf643acc260c1ba"><div class="ttname"><a href="classMWClass_1_1Activator.html#a30dfd520e90dbf941cf643acc260c1ba">MWClass::Activator::hasToolTip</a></div><div class="ttdeci">virtual bool hasToolTip(const MWWorld::ConstPtr &amp;ptr) const </div><div class="ttdef"><b>Definition:</b> activator.cpp:77</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_acff6d155f2cf2cab5b76289ed81e7182"><div class="ttname"><a href="classMWClass_1_1Activator.html#acff6d155f2cf2cab5b76289ed81e7182">MWClass::Activator::getScript</a></div><div class="ttdeci">virtual std::string getScript(const MWWorld::ConstPtr &amp;ptr) const </div><div class="ttdoc">Return name of the script attached to ptr. </div><div class="ttdef"><b>Definition:</b> activator.cpp:62</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_adae76d6d215263b816a1b654a7dde63f"><div class="ttname"><a href="classMWClass_1_1Activator.html#adae76d6d215263b816a1b654a7dde63f">MWClass::Activator::activate</a></div><div class="ttdeci">virtual boost::shared_ptr&lt; MWWorld::Action &gt; activate(const MWWorld::Ptr &amp;ptr, const MWWorld::Ptr &amp;actor) const </div><div class="ttdoc">Generate action for activation. </div><div class="ttdef"><b>Definition:</b> activator.cpp:106</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_ad1d88d1e2a67360cc890e57d19737253"><div class="ttname"><a href="classMWClass_1_1Activator.html#ad1d88d1e2a67360cc890e57d19737253">MWClass::Activator::copyToCellImpl</a></div><div class="ttdeci">virtual MWWorld::Ptr copyToCellImpl(const MWWorld::ConstPtr &amp;ptr, MWWorld::CellStore &amp;cell) const </div><div class="ttdef"><b>Definition:</b> activator.cpp:122</div></div>
<div class="ttc" id="classMWRender_1_1RenderingInterface_html"><div class="ttname"><a href="classMWRender_1_1RenderingInterface.html">MWRender::RenderingInterface</a></div><div class="ttdef"><b>Definition:</b> renderinginterface.hpp:9</div></div>
<div class="ttc" id="classMWPhysics_1_1PhysicsSystem_html"><div class="ttname"><a href="classMWPhysics_1_1PhysicsSystem.html">MWPhysics::PhysicsSystem</a></div><div class="ttdef"><b>Definition:</b> physicssystem.hpp:51</div></div>
<div class="ttc" id="classMWWorld_1_1Class_html"><div class="ttname"><a href="classMWWorld_1_1Class.html">MWWorld::Class</a></div><div class="ttdoc">Base class for referenceable esm records. </div><div class="ttdef"><b>Definition:</b> class.hpp:52</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_afeb977f74d778d8fc356284e7646d3c5"><div class="ttname"><a href="classMWClass_1_1Activator.html#afeb977f74d778d8fc356284e7646d3c5">MWClass::Activator::insertObject</a></div><div class="ttdeci">virtual void insertObject(const MWWorld::Ptr &amp;ptr, const std::string &amp;model, MWPhysics::PhysicsSystem &amp;physics) const </div><div class="ttdoc">Add reference into a cell for rendering (default implementation: don&#39;t render anything). </div><div class="ttdef"><b>Definition:</b> activator.cpp:37</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_a9f926601c5bd560d99001398f2102602"><div class="ttname"><a href="classMWClass_1_1Activator.html#a9f926601c5bd560d99001398f2102602">MWClass::Activator::getModel</a></div><div class="ttdeci">virtual std::string getModel(const MWWorld::ConstPtr &amp;ptr) const </div><div class="ttdef"><b>Definition:</b> activator.cpp:44</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_a1f7997772d61a8c5ae974e88eff9c0f5"><div class="ttname"><a href="classMWClass_1_1Activator.html#a1f7997772d61a8c5ae974e88eff9c0f5">MWClass::Activator::getToolTipInfo</a></div><div class="ttdeci">virtual MWGui::ToolTipInfo getToolTipInfo(const MWWorld::ConstPtr &amp;ptr, int count) const </div><div class="ttdef"><b>Definition:</b> activator.cpp:88</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_ae2b55ea66c5078c158bdb38a1ba8d53a"><div class="ttname"><a href="classMWClass_1_1Activator.html#ae2b55ea66c5078c158bdb38a1ba8d53a">MWClass::Activator::registerSelf</a></div><div class="ttdeci">static void registerSelf()</div><div class="ttdef"><b>Definition:</b> activator.cpp:70</div></div>
<div class="ttc" id="classMWWorld_1_1CellStore_html"><div class="ttname"><a href="classMWWorld_1_1CellStore.html">MWWorld::CellStore</a></div><div class="ttdoc">Mutable state of a cell. </div><div class="ttdef"><b>Definition:</b> cellstore.hpp:53</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html"><div class="ttname"><a href="classMWClass_1_1Activator.html">MWClass::Activator</a></div><div class="ttdef"><b>Definition:</b> activator.hpp:8</div></div>
<div class="ttc" id="classMWWorld_1_1ConstPtr_html"><div class="ttname"><a href="classMWWorld_1_1ConstPtr.html">MWWorld::ConstPtr</a></div><div class="ttdoc">Pointer to a const LiveCellRef. </div><div class="ttdef"><b>Definition:</b> ptr.hpp:90</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_a29563a707c15b5d83a6f0510e9eaafbc"><div class="ttname"><a href="classMWClass_1_1Activator.html#a29563a707c15b5d83a6f0510e9eaafbc">MWClass::Activator::insertObjectRendering</a></div><div class="ttdeci">virtual void insertObjectRendering(const MWWorld::Ptr &amp;ptr, const std::string &amp;model, MWRender::RenderingInterface &amp;renderingInterface) const </div><div class="ttdoc">Add reference into a cell for rendering. </div><div class="ttdef"><b>Definition:</b> activator.cpp:30</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_ae865dc4b5805ee98c1d38f1d9e9b13d1"><div class="ttname"><a href="classMWClass_1_1Activator.html#ae865dc4b5805ee98c1d38f1d9e9b13d1">MWClass::Activator::allowTelekinesis</a></div><div class="ttdeci">virtual bool allowTelekinesis(const MWWorld::ConstPtr &amp;ptr) const </div><div class="ttdoc">Return whether this class of object can be activated with telekinesis. </div><div class="ttdef"><b>Definition:</b> activator.cpp:84</div></div>
<div class="ttc" id="classMWWorld_1_1Ptr_html"><div class="ttname"><a href="classMWWorld_1_1Ptr.html">MWWorld::Ptr</a></div><div class="ttdoc">Pointer to a LiveCellRef. </div><div class="ttdef"><b>Definition:</b> ptr.hpp:19</div></div>
<div class="ttc" id="classMWClass_1_1Activator_html_a36528d07aeead2f5060d4aa7819f4f2f"><div class="ttname"><a href="classMWClass_1_1Activator.html#a36528d07aeead2f5060d4aa7819f4f2f">MWClass::Activator::getName</a></div><div class="ttdeci">virtual std::string getName(const MWWorld::ConstPtr &amp;ptr) const </div><div class="ttdef"><b>Definition:</b> activator.cpp:55</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 24 2017 02:05:49 for OpenMW by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>