Skip to content

Commit

Permalink
deploy: 0985804
Browse files Browse the repository at this point in the history
  • Loading branch information
xxEoD2242 committed Jun 23, 2024
1 parent c5b8ccf commit 7f82666
Show file tree
Hide file tree
Showing 8 changed files with 50 additions and 4 deletions.
Binary file modified api_docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified api_docs/doctrees/index.doctree
Binary file not shown.
19 changes: 18 additions & 1 deletion api_docs/html/_modules/airsim/client.html
Original file line number Diff line number Diff line change
Expand Up @@ -629,6 +629,20 @@ <h1>Source code for airsim.client</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="s1">&#39;simListSceneObjects&#39;</span><span class="p">,</span> <span class="n">name_regex</span><span class="p">)</span></div>

<div class="viewcode-block" id="VehicleClient.simListSceneObjectsByTag"><a class="viewcode-back" href="../../index.html#airsim.client.VehicleClient.simListSceneObjectsByTag">[docs]</a> <span class="k">def</span> <span class="nf">simListSceneObjectsByTag</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag_regex</span> <span class="o">=</span> <span class="s1">&#39;.*&#39;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Lists the objects present in the environment by searching their tags</span>

<span class="sd"> Default behaviour is to list all objects, regex can be used to return smaller list of matching objects or actors</span>

<span class="sd"> Args:</span>
<span class="sd"> tag_regex (str, optional): String to match actor tags against, e.g. &quot;Tag.*&quot;</span>

<span class="sd"> Returns:</span>
<span class="sd"> list[str]: List containing all the names</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="s1">&#39;simListSceneObjectsByTag&#39;</span><span class="p">,</span> <span class="n">tag_regex</span><span class="p">)</span></div>

<div class="viewcode-block" id="VehicleClient.simLoadLevel"><a class="viewcode-back" href="../../index.html#airsim.client.VehicleClient.simLoadLevel">[docs]</a> <span class="k">def</span> <span class="nf">simLoadLevel</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level_name</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Loads a level specified by its name</span>
Expand Down Expand Up @@ -1195,7 +1209,10 @@ <h1>Source code for airsim.client</h1><div class="highlight"><pre>
<span class="sd"> Args:</span>
<span class="sd"> ext_force (Vector3r): Force, in World frame, NED direction, in N</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="s1">&#39;simSetExtForce&#39;</span><span class="p">,</span> <span class="n">ext_force</span><span class="p">)</span></div></div>
<span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="s1">&#39;simSetExtForce&#39;</span><span class="p">,</span> <span class="n">ext_force</span><span class="p">)</span></div>

<div class="viewcode-block" id="VehicleClient.simFindLookAtRotation"><a class="viewcode-back" href="../../index.html#airsim.client.VehicleClient.simFindLookAtRotation">[docs]</a> <span class="k">def</span> <span class="nf">simFindLookAtRotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">object_name</span><span class="p">,</span> <span class="n">vehicle_name</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="s1">&#39;simFindLookAtRotation&#39;</span><span class="p">,</span> <span class="n">vehicle_name</span><span class="p">,</span> <span class="n">object_name</span><span class="p">)</span></div></div>

<span class="c1"># ----------------------------------- Multirotor APIs ---------------------------------------------</span>
<div class="viewcode-block" id="MultirotorClient"><a class="viewcode-back" href="../../index.html#airsim.client.MultirotorClient">[docs]</a><span class="k">class</span> <span class="nc">MultirotorClient</span><span class="p">(</span><span class="n">VehicleClient</span><span class="p">,</span> <span class="nb">object</span><span class="p">):</span>
Expand Down
8 changes: 6 additions & 2 deletions api_docs/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -821,6 +821,8 @@ <h2 id="S">S</h2>
<li><a href="index.html#airsim.client.VehicleClient.simEnableManualFocus">simEnableManualFocus() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simEnableWeather">simEnableWeather() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simFindLookAtRotation">simFindLookAtRotation() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simFlushPersistentMarkers">simFlushPersistentMarkers() (airsim.client.VehicleClient method)</a>
</li>
Expand Down Expand Up @@ -875,17 +877,19 @@ <h2 id="S">S</h2>
<li><a href="index.html#airsim.client.VehicleClient.simListAssets">simListAssets() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simListSceneObjects">simListSceneObjects() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simListSceneObjectsByTag">simListSceneObjectsByTag() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simLoadLevel">simLoadLevel() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simPause">simPause() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simPlotArrows">simPlotArrows() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simPlotLineList">simPlotLineList() (airsim.client.VehicleClient method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#airsim.client.VehicleClient.simPlotLineList">simPlotLineList() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simPlotLineStrip">simPlotLineStrip() (airsim.client.VehicleClient method)</a>
</li>
<li><a href="index.html#airsim.client.VehicleClient.simPlotPoints">simPlotPoints() (airsim.client.VehicleClient method)</a>
Expand Down
25 changes: 25 additions & 0 deletions api_docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<li><a class="reference internal" href="#airsim.client.VehicleClient.simEnableFocusPlane"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simEnableFocusPlane()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simEnableManualFocus"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simEnableManualFocus()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simEnableWeather"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simEnableWeather()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simFindLookAtRotation"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simFindLookAtRotation()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simFlushPersistentMarkers"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simFlushPersistentMarkers()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simGetCameraInfo"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simGetCameraInfo()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simGetCollisionInfo"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simGetCollisionInfo()</span></code></a></li>
Expand Down Expand Up @@ -108,6 +109,7 @@
<li><a class="reference internal" href="#airsim.client.VehicleClient.simIsPause"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simIsPause()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simListAssets"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simListAssets()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simListSceneObjects"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simListSceneObjects()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simListSceneObjectsByTag"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simListSceneObjectsByTag()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simLoadLevel"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simLoadLevel()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simPause"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simPause()</span></code></a></li>
<li><a class="reference internal" href="#airsim.client.VehicleClient.simPlotArrows"><code class="docutils literal notranslate"><span class="pre">VehicleClient.simPlotArrows()</span></code></a></li>
Expand Down Expand Up @@ -979,6 +981,11 @@ <h1>airsim<a class="headerlink" href="#airsim" title="Permalink to this heading"
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="airsim.client.VehicleClient.simFindLookAtRotation">
<span class="sig-name descname"><span class="pre">simFindLookAtRotation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vehicle_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/airsim/client.html#VehicleClient.simFindLookAtRotation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airsim.client.VehicleClient.simFindLookAtRotation" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="airsim.client.VehicleClient.simFlushPersistentMarkers">
<span class="sig-name descname"><span class="pre">simFlushPersistentMarkers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/airsim/client.html#VehicleClient.simFlushPersistentMarkers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airsim.client.VehicleClient.simFlushPersistentMarkers" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -1320,6 +1327,24 @@ <h1>airsim<a class="headerlink" href="#airsim" title="Permalink to this heading"
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="airsim.client.VehicleClient.simListSceneObjectsByTag">
<span class="sig-name descname"><span class="pre">simListSceneObjectsByTag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_regex</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'.*'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/airsim/client.html#VehicleClient.simListSceneObjectsByTag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airsim.client.VehicleClient.simListSceneObjectsByTag" title="Permalink to this definition"></a></dt>
<dd><p>Lists the objects present in the environment by searching their tags</p>
<p>Default behaviour is to list all objects, regex can be used to return smaller list of matching objects or actors</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>tag_regex</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>optional</em>) – String to match actor tags against, e.g. “Tag.*”</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>List containing all the names</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)">list</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>]</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="airsim.client.VehicleClient.simLoadLevel">
<span class="sig-name descname"><span class="pre">simLoadLevel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/airsim/client.html#VehicleClient.simLoadLevel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airsim.client.VehicleClient.simLoadLevel" title="Permalink to this definition"></a></dt>
Expand Down
Binary file modified api_docs/html/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion api_docs/html/searchindex.js

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit 7f82666

Please sign in to comment.