Merge pull request #69 from albertoesmp/main

Minor fixes on visualhelios documentation. Also, added operator*() for Rotation as requested by JXO

Author: albertoesmp

doc/html/d0/d0e/XmlAssetsLoader_8h_source.html

@@ -94,7 +94,7 @@
 <div class="ttc" id="classXmlAssetsLoader_html_a9925003efb329261285a3b44581d07ab"><div class="ttname"><a href="../../d9/d82/classXmlAssetsLoader.html#a9925003efb329261285a3b44581d07ab">XmlAssetsLoader::getAssetById</a></div><div class="ttdeci">std::shared_ptr&lt; Asset &gt; getAssetById(std::string type, std::string id)</div><div class="ttdoc">Get asset by its identifier. </div><div class="ttdef"><b>Definition:</b> XmlAssetsLoader.cpp:905</div></div>
 <div class="ttc" id="classXmlAssetsLoader_html_ab05a3221c932ac16673676f671879b7a"><div class="ttname"><a href="../../d9/d82/classXmlAssetsLoader.html#ab05a3221c932ac16673676f671879b7a">XmlAssetsLoader::XmlAssetsLoader</a></div><div class="ttdeci">XmlAssetsLoader(std::string &amp;filePath, std::string &amp;assetsDir)</div><div class="ttdoc">Build a XmlAssetsLoader for given XML file and assets directory. </div><div class="ttdef"><b>Definition:</b> XmlAssetsLoader.cpp:46</div></div>
 <div class="ttc" id="classXmlAssetsLoader_html_a390fb954561c1b239d869a14d5c43557"><div class="ttname"><a href="../../d9/d82/classXmlAssetsLoader.html#a390fb954561c1b239d869a14d5c43557">XmlAssetsLoader::getAssetByLocation</a></div><div class="ttdeci">std::shared_ptr&lt; Asset &gt; getAssetByLocation(std::string type, std::string location)</div><div class="ttdoc">Get asset by location. </div><div class="ttdef"><b>Definition:</b> XmlAssetsLoader.cpp:944</div></div>
-<div class="ttc" id="classRotation_html"><div class="ttname"><a href="../../d5/dcb/classRotation.html">Rotation</a></div><div class="ttdef"><b>Definition:</b> Rotation.h:81</div></div>
+<div class="ttc" id="classRotation_html"><div class="ttname"><a href="../../d5/dcb/classRotation.html">Rotation</a></div><div class="ttdef"><b>Definition:</b> Rotation.h:80</div></div>
 <div class="ttc" id="classXmlAssetsLoader_html_a6f7ad9729a9484ca0bf81116bc56dc6a"><div class="ttname"><a href="../../d9/d82/classXmlAssetsLoader.html#a6f7ad9729a9484ca0bf81116bc56dc6a">XmlAssetsLoader::createColorFromXml</a></div><div class="ttdeci">Color4f createColorFromXml(tinyxml2::XMLElement *node)</div><div class="ttdoc">Create a color from given XML element (node) </div><div class="ttdef"><b>Definition:</b> XmlAssetsLoader.cpp:103</div></div>
 <div class="ttc" id="classXmlAssetsLoader_html_ae7fd1316d53f07d26ebe67c67f1d9f31"><div class="ttname"><a href="../../d9/d82/classXmlAssetsLoader.html#ae7fd1316d53f07d26ebe67c67f1d9f31">XmlAssetsLoader::createRotationFromXml</a></div><div class="ttdeci">Rotation createRotationFromXml(tinyxml2::XMLElement *rotGroupNode)</div><div class="ttdoc">Create a rotation from given XML element (node) </div><div class="ttdef"><b>Definition:</b> XmlAssetsLoader.cpp:849</div></div>
 <div class="ttc" id="classXmlAssetsLoader_html_ab170508a8bf8e75ef837582a72c731b5"><div class="ttname"><a href="../../d9/d82/classXmlAssetsLoader.html#ab170508a8bf8e75ef837582a72c731b5">XmlAssetsLoader::createPlatformSettingsFromXml</a></div><div class="ttdeci">std::shared_ptr&lt; PlatformSettings &gt; createPlatformSettingsFromXml(tinyxml2::XMLElement *node)</div><div class="ttdoc">Create platform settings from given XML element (node) </div><div class="ttdef"><b>Definition:</b> XmlAssetsLoader.cpp:288</div></div>

doc/html/d0/d8f/Rotation_8h_source.html

@@ -90,7 +90,7 @@
 <div class="title">PyScenePartWrapper.h</div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#ifdef PYTHON_BINDING</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;ScenePart.h&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d1/df9/namespacepyhelios.html">pyhelios</a>{</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="../../df/d28/classpyhelios_1_1PyScenePartWrapper.html">   16</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../df/d28/classpyhelios_1_1PyScenePartWrapper.html">PyScenePartWrapper</a>{</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    <span class="comment">// ***  ATTRIBUTES  *** //</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;    <span class="comment">// ******************** //</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;    <a class="code" href="../../dd/dc4/classScenePart.html">ScenePart</a> &amp;sp;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    <span class="comment">// ***  CONSTRUCTION / DESTRUCTION  *** //</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    <span class="comment">// ************************************ //</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    <a class="code" href="../../df/d28/classpyhelios_1_1PyScenePartWrapper.html">PyScenePartWrapper</a>(<a class="code" href="../../dd/dc4/classScenePart.html">ScenePart</a> &amp;sp) : sp(sp) {}</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="../../df/d28/classpyhelios_1_1PyScenePartWrapper.html">PyScenePartWrapper</a>() {}</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="comment">// ***  GETTERS and SETTERS  *** //</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <span class="comment">// ***************************** //</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    std::string getId() {<span class="keywordflow">return</span> sp.<a class="code" href="../../dd/dc4/classScenePart.html#aec8d33ac2f3d49bd036659c1eda5166b">mId</a>;};</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    <span class="keywordtype">void</span> setId(std::string <span class="keywordtype">id</span>) {sp.<a class="code" href="../../dd/dc4/classScenePart.html#aec8d33ac2f3d49bd036659c1eda5166b">mId</a> = id;}</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <a class="code" href="../../dd/d8f/classpyhelios_1_1PythonDVec3.html">PythonDVec3</a> * getOrigin() {<span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="../../dd/d8f/classpyhelios_1_1PythonDVec3.html">PythonDVec3</a>(sp.<a class="code" href="../../dd/dc4/classScenePart.html#a7ceef50b5837b5b221110c247a20165c">mOrigin</a>);}</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keywordtype">void</span> setOrigin(<span class="keywordtype">double</span> x, <span class="keywordtype">double</span> y, <span class="keywordtype">double</span> z)</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;        {sp.<a class="code" href="../../dd/dc4/classScenePart.html#a7ceef50b5837b5b221110c247a20165c">mOrigin</a> = glm::dvec3(x, y, z);}</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <a class="code" href="../../d5/dcb/classRotation.html">Rotation</a> &amp; getRotation() {<span class="keywordflow">return</span> sp.<a class="code" href="../../dd/dc4/classScenePart.html#a8591181e785dc96dfc98be922ba52b14">mRotation</a>;}</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keywordtype">void</span> setRotation(<span class="keywordtype">double</span> x, <span class="keywordtype">double</span> y, <span class="keywordtype">double</span> z, <span class="keywordtype">double</span> angle)</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;        {sp.<a class="code" href="../../dd/dc4/classScenePart.html#a8591181e785dc96dfc98be922ba52b14">mRotation</a> = <a class="code" href="../../d5/dcb/classRotation.html">Rotation</a>(glm::dvec3(x, y, z), angle);}</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="keywordtype">double</span> getScale() {<span class="keywordflow">return</span> sp.<a class="code" href="../../dd/dc4/classScenePart.html#ac24a8aed9151384e58ed415d753916c3">mScale</a>;}</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <span class="keywordtype">void</span> setScale(<span class="keywordtype">double</span> scale) {sp.<a class="code" href="../../dd/dc4/classScenePart.html#ac24a8aed9151384e58ed415d753916c3">mScale</a> = scale;}</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;};</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;}</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;<span class="preprocessor">#endif</span></div><div class="ttc" id="classRotation_html"><div class="ttname"><a href="../../d5/dcb/classRotation.html">Rotation</a></div><div class="ttdef"><b>Definition:</b> Rotation.h:81</div></div>
+<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#ifdef PYTHON_BINDING</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;ScenePart.h&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d1/df9/namespacepyhelios.html">pyhelios</a>{</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="../../df/d28/classpyhelios_1_1PyScenePartWrapper.html">   16</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../df/d28/classpyhelios_1_1PyScenePartWrapper.html">PyScenePartWrapper</a>{</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    <span class="comment">// ***  ATTRIBUTES  *** //</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;    <span class="comment">// ******************** //</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;    <a class="code" href="../../dd/dc4/classScenePart.html">ScenePart</a> &amp;sp;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    <span class="comment">// ***  CONSTRUCTION / DESTRUCTION  *** //</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    <span class="comment">// ************************************ //</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    <a class="code" href="../../df/d28/classpyhelios_1_1PyScenePartWrapper.html">PyScenePartWrapper</a>(<a class="code" href="../../dd/dc4/classScenePart.html">ScenePart</a> &amp;sp) : sp(sp) {}</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="../../df/d28/classpyhelios_1_1PyScenePartWrapper.html">PyScenePartWrapper</a>() {}</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="comment">// ***  GETTERS and SETTERS  *** //</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <span class="comment">// ***************************** //</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    std::string getId() {<span class="keywordflow">return</span> sp.<a class="code" href="../../dd/dc4/classScenePart.html#aec8d33ac2f3d49bd036659c1eda5166b">mId</a>;};</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    <span class="keywordtype">void</span> setId(std::string <span class="keywordtype">id</span>) {sp.<a class="code" href="../../dd/dc4/classScenePart.html#aec8d33ac2f3d49bd036659c1eda5166b">mId</a> = id;}</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <a class="code" href="../../dd/d8f/classpyhelios_1_1PythonDVec3.html">PythonDVec3</a> * getOrigin() {<span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="../../dd/d8f/classpyhelios_1_1PythonDVec3.html">PythonDVec3</a>(sp.<a class="code" href="../../dd/dc4/classScenePart.html#a7ceef50b5837b5b221110c247a20165c">mOrigin</a>);}</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keywordtype">void</span> setOrigin(<span class="keywordtype">double</span> x, <span class="keywordtype">double</span> y, <span class="keywordtype">double</span> z)</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;        {sp.<a class="code" href="../../dd/dc4/classScenePart.html#a7ceef50b5837b5b221110c247a20165c">mOrigin</a> = glm::dvec3(x, y, z);}</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <a class="code" href="../../d5/dcb/classRotation.html">Rotation</a> &amp; getRotation() {<span class="keywordflow">return</span> sp.<a class="code" href="../../dd/dc4/classScenePart.html#a8591181e785dc96dfc98be922ba52b14">mRotation</a>;}</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keywordtype">void</span> setRotation(<span class="keywordtype">double</span> x, <span class="keywordtype">double</span> y, <span class="keywordtype">double</span> z, <span class="keywordtype">double</span> angle)</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;        {sp.<a class="code" href="../../dd/dc4/classScenePart.html#a8591181e785dc96dfc98be922ba52b14">mRotation</a> = <a class="code" href="../../d5/dcb/classRotation.html">Rotation</a>(glm::dvec3(x, y, z), angle);}</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="keywordtype">double</span> getScale() {<span class="keywordflow">return</span> sp.<a class="code" href="../../dd/dc4/classScenePart.html#ac24a8aed9151384e58ed415d753916c3">mScale</a>;}</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <span class="keywordtype">void</span> setScale(<span class="keywordtype">double</span> scale) {sp.<a class="code" href="../../dd/dc4/classScenePart.html#ac24a8aed9151384e58ed415d753916c3">mScale</a> = scale;}</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;};</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;}</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;<span class="preprocessor">#endif</span></div><div class="ttc" id="classRotation_html"><div class="ttname"><a href="../../d5/dcb/classRotation.html">Rotation</a></div><div class="ttdef"><b>Definition:</b> Rotation.h:80</div></div>
 <div class="ttc" id="classpyhelios_1_1PyScenePartWrapper_html"><div class="ttname"><a href="../../df/d28/classpyhelios_1_1PyScenePartWrapper.html">pyhelios::PyScenePartWrapper</a></div><div class="ttdoc">Wrapper for ScenePart class. </div><div class="ttdef"><b>Definition:</b> PyScenePartWrapper.h:16</div></div>
 <div class="ttc" id="classScenePart_html_a8591181e785dc96dfc98be922ba52b14"><div class="ttname"><a href="../../dd/dc4/classScenePart.html#a8591181e785dc96dfc98be922ba52b14">ScenePart::mRotation</a></div><div class="ttdeci">Rotation mRotation</div><div class="ttdoc">Specify the rotation for the scene part. </div><div class="ttdef"><b>Definition:</b> ScenePart.h:85</div></div>
 <div class="ttc" id="namespacepyhelios_html"><div class="ttname"><a href="../../d1/df9/namespacepyhelios.html">pyhelios</a></div><div class="ttdef"><b>Definition:</b> PyAABBWrapper.h:7</div></div>