Scarfski/recastnavigation
1
0
Fork 0
mirror of https://github.com/recastnavigation/recastnavigation.git synced 2026-08-30 23:18:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
494b2f7f5f431e631d0d2003e006c67bd615d461
recastnavigation/structdtCrowdAgentParams.html

354 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Recast Navigation: dtCrowdAgentParams Struct 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign">
<div id="projectname">Recast Navigation
</div>
<div id="projectbrief">Navigation-mesh Toolset for Games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structdtCrowdAgentParams.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structdtCrowdAgentParams-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">dtCrowdAgentParams Struct Reference<div class="ingroups"><a class="el" href="group__crowd.html">Crowd</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Configuration parameters for a crowd agent.
<a href="structdtCrowdAgentParams.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="DetourCrowd_8h_source.html">DetourCrowd.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a780421355c73aecb187c1aa36de854d8" id="r_a780421355c73aecb187c1aa36de854d8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#a780421355c73aecb187c1aa36de854d8">radius</a></td></tr>
<tr class="memdesc:a780421355c73aecb187c1aa36de854d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Agent radius. [Limit: &gt;= 0]. <br /></td></tr>
<tr class="separator:a780421355c73aecb187c1aa36de854d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a762f702ee5339eebaf252d391f31a586" id="r_a762f702ee5339eebaf252d391f31a586"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#a762f702ee5339eebaf252d391f31a586">height</a></td></tr>
<tr class="memdesc:a762f702ee5339eebaf252d391f31a586"><td class="mdescLeft">&#160;</td><td class="mdescRight">Agent height. [Limit: &gt; 0]. <br /></td></tr>
<tr class="separator:a762f702ee5339eebaf252d391f31a586"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d1b22f12d2faf77c052b1bae3a27ada" id="r_a2d1b22f12d2faf77c052b1bae3a27ada"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#a2d1b22f12d2faf77c052b1bae3a27ada">maxAcceleration</a></td></tr>
<tr class="memdesc:a2d1b22f12d2faf77c052b1bae3a27ada"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum allowed acceleration. [Limit: &gt;= 0]. <br /></td></tr>
<tr class="separator:a2d1b22f12d2faf77c052b1bae3a27ada"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a023328c7266577eedeba25e480479f" id="r_a2a023328c7266577eedeba25e480479f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#a2a023328c7266577eedeba25e480479f">maxSpeed</a></td></tr>
<tr class="memdesc:a2a023328c7266577eedeba25e480479f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum allowed speed. [Limit: &gt;= 0]. <br /></td></tr>
<tr class="separator:a2a023328c7266577eedeba25e480479f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e1c7373b02e2f926360e3d3130be068" id="r_a5e1c7373b02e2f926360e3d3130be068"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#a5e1c7373b02e2f926360e3d3130be068">collisionQueryRange</a></td></tr>
<tr class="memdesc:a5e1c7373b02e2f926360e3d3130be068"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines how close a collision element must be before it is considered for steering behaviors. [Limits: &gt; 0]. <br /></td></tr>
<tr class="separator:a5e1c7373b02e2f926360e3d3130be068"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab390e7ccafffda667a1132917ad91b93" id="r_ab390e7ccafffda667a1132917ad91b93"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#ab390e7ccafffda667a1132917ad91b93">pathOptimizationRange</a></td></tr>
<tr class="memdesc:ab390e7ccafffda667a1132917ad91b93"><td class="mdescLeft">&#160;</td><td class="mdescRight">The path visibility optimization range. [Limit: &gt; 0]. <br /></td></tr>
<tr class="separator:ab390e7ccafffda667a1132917ad91b93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a616534204934492b4f3bc7eb2ff49a0b" id="r_a616534204934492b4f3bc7eb2ff49a0b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#a616534204934492b4f3bc7eb2ff49a0b">separationWeight</a></td></tr>
<tr class="memdesc:a616534204934492b4f3bc7eb2ff49a0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: &gt;= 0]. <br /></td></tr>
<tr class="separator:a616534204934492b4f3bc7eb2ff49a0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7066a4477bbfa53fc1c983e17aa3e5ae" id="r_a7066a4477bbfa53fc1c983e17aa3e5ae"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#a7066a4477bbfa53fc1c983e17aa3e5ae">updateFlags</a></td></tr>
<tr class="memdesc:a7066a4477bbfa53fc1c983e17aa3e5ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags that impact steering behavior. (See: <a class="el" href="group__crowd.html#gaa94b67d2fdcc390690c523f28019e52f" title="Crowd agent update flags.">UpdateFlags</a>) <br /></td></tr>
<tr class="separator:a7066a4477bbfa53fc1c983e17aa3e5ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8be062f1d9616d17d8b536f7a501498" id="r_ae8be062f1d9616d17d8b536f7a501498"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#ae8be062f1d9616d17d8b536f7a501498">obstacleAvoidanceType</a></td></tr>
<tr class="memdesc:ae8be062f1d9616d17d8b536f7a501498"><td class="mdescLeft">&#160;</td><td class="mdescRight">The index of the avoidance configuration to use for the agent. <br /></td></tr>
<tr class="separator:ae8be062f1d9616d17d8b536f7a501498"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5d15cba10237592b1766d7d82da1420" id="r_af5d15cba10237592b1766d7d82da1420"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#af5d15cba10237592b1766d7d82da1420">queryFilterType</a></td></tr>
<tr class="memdesc:af5d15cba10237592b1766d7d82da1420"><td class="mdescLeft">&#160;</td><td class="mdescRight">The index of the query filter used by this agent. <br /></td></tr>
<tr class="separator:af5d15cba10237592b1766d7d82da1420"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22dd9c496ce4404b8e2a836a14a01281" id="r_a22dd9c496ce4404b8e2a836a14a01281"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCrowdAgentParams.html#a22dd9c496ce4404b8e2a836a14a01281">userData</a></td></tr>
<tr class="memdesc:a22dd9c496ce4404b8e2a836a14a01281"><td class="mdescLeft">&#160;</td><td class="mdescRight">User defined data attached to the agent. <br /></td></tr>
<tr class="separator:a22dd9c496ce4404b8e2a836a14a01281"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>Configuration parameters for a crowd agent. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structdtCrowdAgent.html" title="Represents an agent managed by a dtCrowd object.">dtCrowdAgent</a>, <a class="el" href="classdtCrowd.html#ae8c89febfd979a6b963c62d8cdb60653" title="Adds a new agent to the crowd.">dtCrowd::addAgent()</a>, <a class="el" href="classdtCrowd.html#a6ed4aa0026c21593daa9ea12c71f84c2" title="Updates the specified agent&#39;s configuration.">dtCrowd::updateAgentParameters()</a> </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a5e1c7373b02e2f926360e3d3130be068" name="a5e1c7373b02e2f926360e3d3130be068"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e1c7373b02e2f926360e3d3130be068">&#9670;&#160;</a></span>collisionQueryRange</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtCrowdAgentParams::collisionQueryRange</td>
</tr>
</table>
</div><div class="memdoc">
<p>Defines how close a collision element must be before it is considered for steering behaviors. [Limits: &gt; 0]. </p>
<dl class="section user"><dt></dt><dd></dd></dl>
<p>Collision elements include other agents and navigation mesh boundaries.</p>
<p>This value is often based on the agent radius and/or maximum speed. E.g. radius * 8 </p>
</div>
</div>
<a id="a762f702ee5339eebaf252d391f31a586" name="a762f702ee5339eebaf252d391f31a586"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a762f702ee5339eebaf252d391f31a586">&#9670;&#160;</a></span>height</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float dtCrowdAgentParams::height</td>
</tr>
</table>
</div><div class="memdoc">
<p>Agent height. [Limit: &gt; 0]. </p>
</div>
</div>
<a id="a2d1b22f12d2faf77c052b1bae3a27ada" name="a2d1b22f12d2faf77c052b1bae3a27ada"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d1b22f12d2faf77c052b1bae3a27ada">&#9670;&#160;</a></span>maxAcceleration</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float dtCrowdAgentParams::maxAcceleration</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum allowed acceleration. [Limit: &gt;= 0]. </p>
</div>
</div>
<a id="a2a023328c7266577eedeba25e480479f" name="a2a023328c7266577eedeba25e480479f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a023328c7266577eedeba25e480479f">&#9670;&#160;</a></span>maxSpeed</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float dtCrowdAgentParams::maxSpeed</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum allowed speed. [Limit: &gt;= 0]. </p>
</div>
</div>
<a id="ae8be062f1d9616d17d8b536f7a501498" name="ae8be062f1d9616d17d8b536f7a501498"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8be062f1d9616d17d8b536f7a501498">&#9670;&#160;</a></span>obstacleAvoidanceType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtCrowdAgentParams::obstacleAvoidanceType</td>
</tr>
</table>
</div><div class="memdoc">
<p>The index of the avoidance configuration to use for the agent. </p>
<p>[Limits: 0 &lt;= value &lt;= <a class="el" href="group__crowd.html#gaca1e1a9395fd4406de712dc4330c60c5" title="The maximum number of crowd avoidance configurations supported by the crowd manager.">DT_CROWD_MAX_OBSTAVOIDANCE_PARAMS</a>]</p>
<dl class="section user"><dt></dt><dd></dd></dl>
<p><a class="el" href="classdtCrowd.html" title="Provides local steering behaviors for a group of agents.">dtCrowd</a> permits agents to use different avoidance configurations. This value is the index of the <a class="el" href="structdtObstacleAvoidanceParams.html">dtObstacleAvoidanceParams</a> within the crowd.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structdtObstacleAvoidanceParams.html">dtObstacleAvoidanceParams</a>, <a class="el" href="classdtCrowd.html#a96338b9a99e8d58a3051a9ce7934e8b1" title="Sets the shared avoidance configuration for the specified index.">dtCrowd::setObstacleAvoidanceParams()</a>, <a class="el" href="classdtCrowd.html#a4da076dabe04b63d801c63c99d2fb5bb" title="Gets the shared avoidance configuration for the specified index.">dtCrowd::getObstacleAvoidanceParams()</a> </dd></dl>
</div>
</div>
<a id="ab390e7ccafffda667a1132917ad91b93" name="ab390e7ccafffda667a1132917ad91b93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab390e7ccafffda667a1132917ad91b93">&#9670;&#160;</a></span>pathOptimizationRange</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtCrowdAgentParams::pathOptimizationRange</td>
</tr>
</table>
</div><div class="memdoc">
<p>The path visibility optimization range. [Limit: &gt; 0]. </p>
<dl class="section user"><dt></dt><dd></dd></dl>
<p>Only applicable if <a class="el" href="structdtCrowdAgentParams.html#a7066a4477bbfa53fc1c983e17aa3e5ae" title="Flags that impact steering behavior. (See: UpdateFlags)">updateFlags</a> includes the <a class="el" href="group__crowd.html#ggaa94b67d2fdcc390690c523f28019e52fad11f447facf1bf42c09de64e9483f3aa" title="Use dtPathCorridor::optimizePathVisibility() to optimize the agent path.">DT_CROWD_OPTIMIZE_VIS</a> flag.</p>
<p>This value is often based on the agent radius. E.g. radius * 30</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdtPathCorridor.html#a3970b6cd229731debe6beb41d9885463" title="Attempts to optimize the path if the specified point is visible from the current position.">dtPathCorridor::optimizePathVisibility()</a> </dd></dl>
</div>
</div>
<a id="af5d15cba10237592b1766d7d82da1420" name="af5d15cba10237592b1766d7d82da1420"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5d15cba10237592b1766d7d82da1420">&#9670;&#160;</a></span>queryFilterType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char dtCrowdAgentParams::queryFilterType</td>
</tr>
</table>
</div><div class="memdoc">
<p>The index of the query filter used by this agent. </p>
</div>
</div>
<a id="a780421355c73aecb187c1aa36de854d8" name="a780421355c73aecb187c1aa36de854d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a780421355c73aecb187c1aa36de854d8">&#9670;&#160;</a></span>radius</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float dtCrowdAgentParams::radius</td>
</tr>
</table>
</div><div class="memdoc">
<p>Agent radius. [Limit: &gt;= 0]. </p>
</div>
</div>
<a id="a616534204934492b4f3bc7eb2ff49a0b" name="a616534204934492b4f3bc7eb2ff49a0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a616534204934492b4f3bc7eb2ff49a0b">&#9670;&#160;</a></span>separationWeight</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtCrowdAgentParams::separationWeight</td>
</tr>
</table>
</div><div class="memdoc">
<p>How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: &gt;= 0]. </p>
<dl class="section user"><dt></dt><dd></dd></dl>
<p>A higher value will result in agents trying to stay farther away from each other at the cost of more difficult steering in tight spaces. </p>
</div>
</div>
<a id="a7066a4477bbfa53fc1c983e17aa3e5ae" name="a7066a4477bbfa53fc1c983e17aa3e5ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7066a4477bbfa53fc1c983e17aa3e5ae">&#9670;&#160;</a></span>updateFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char dtCrowdAgentParams::updateFlags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags that impact steering behavior. (See: <a class="el" href="group__crowd.html#gaa94b67d2fdcc390690c523f28019e52f" title="Crowd agent update flags.">UpdateFlags</a>) </p>
</div>
</div>
<a id="a22dd9c496ce4404b8e2a836a14a01281" name="a22dd9c496ce4404b8e2a836a14a01281"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22dd9c496ce4404b8e2a836a14a01281">&#9670;&#160;</a></span>userData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* dtCrowdAgentParams::userData</td>
</tr>
</table>
</div><div class="memdoc">
<p>User defined data attached to the agent. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="DetourCrowd_8h_source.html">DetourCrowd.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structdtCrowdAgentParams.html">dtCrowdAgentParams</a></li>
&nbsp;&nbsp;<a href="https://github.com/recastnavigation/recastnavigation">Project Home</a>
| <a href="./License.txt">Licence (ZLib)</a>
| Copyright 2009 Mikko Mononen
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink