CrowdManager.xml 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774
  1. <Type Name="CrowdManager" FullName="Urho.CrowdManager">
  2. <TypeSignature Language="C#" Value="public class CrowdManager : Urho.Component" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CrowdManager extends Urho.Component" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Component</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Crowd manager scene component. Should be added only to the root scene node.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public CrowdManager (IntPtr handle);" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Parameters>
  27. <Parameter Name="handle" Type="System.IntPtr" />
  28. </Parameters>
  29. <Docs>
  30. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  31. <summary>Constructs a new instance of CrowdManager, given a raw pointer to an unmanaged object</summary>
  32. <remarks>
  33. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  34. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  35. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  36. </remarks>
  37. </Docs>
  38. </Member>
  39. <Member MemberName=".ctor">
  40. <MemberSignature Language="C#" Value="public CrowdManager (Urho.Context context);" />
  41. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  42. <MemberType>Constructor</MemberType>
  43. <AssemblyInfo>
  44. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  45. </AssemblyInfo>
  46. <Parameters>
  47. <Parameter Name="context" Type="Urho.Context" />
  48. </Parameters>
  49. <Docs>
  50. <param name="context">The context that this object will be attached to.</param>
  51. <summary>Creates an instance of CrowdManager that is attached to an execution context.</summary>
  52. <remarks>
  53. <para>This creates an instance of CrowdManager attached to the specified execution context.</para>
  54. </remarks>
  55. </Docs>
  56. </Member>
  57. <Member MemberName=".ctor">
  58. <MemberSignature Language="C#" Value="public CrowdManager (Urho.UrhoObjectFlag emptyFlag);" />
  59. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  60. <MemberType>Constructor</MemberType>
  61. <AssemblyInfo>
  62. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  63. </AssemblyInfo>
  64. <Parameters>
  65. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  66. </Parameters>
  67. <Docs>
  68. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  69. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  70. <remarks>
  71. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  72. <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
  73. <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
  74. </remarks>
  75. </Docs>
  76. </Member>
  77. <Member MemberName="ApplyAttributes">
  78. <MemberSignature Language="C#" Value="public override void ApplyAttributes ();" />
  79. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void ApplyAttributes() cil managed" />
  80. <MemberType>Method</MemberType>
  81. <AssemblyInfo>
  82. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  83. </AssemblyInfo>
  84. <ReturnValue>
  85. <ReturnType>System.Void</ReturnType>
  86. </ReturnValue>
  87. <Parameters />
  88. <Docs>
  89. <summary>
  90. Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
  91. </summary>
  92. <remarks>To be added.</remarks>
  93. </Docs>
  94. </Member>
  95. <Member MemberName="BaseType">
  96. <MemberSignature Language="C#" Value="public override Urho.StringHash BaseType { get; }" />
  97. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash BaseType" />
  98. <MemberType>Property</MemberType>
  99. <AssemblyInfo>
  100. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  101. </AssemblyInfo>
  102. <ReturnValue>
  103. <ReturnType>Urho.StringHash</ReturnType>
  104. </ReturnValue>
  105. <Docs>
  106. <summary>Urho's type system base type.</summary>
  107. <value>StringHash representing the base type for this Urho type.</value>
  108. <remarks>This returns the Urho type system base type and is surfaced for low-level Urho code.</remarks>
  109. </Docs>
  110. </Member>
  111. <Member MemberName="DrawDebugGeometry">
  112. <MemberSignature Language="C#" Value="public void DrawDebugGeometry (bool depthTest);" />
  113. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DrawDebugGeometry(bool depthTest) cil managed" />
  114. <MemberType>Method</MemberType>
  115. <AssemblyInfo>
  116. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  117. </AssemblyInfo>
  118. <ReturnValue>
  119. <ReturnType>System.Void</ReturnType>
  120. </ReturnValue>
  121. <Parameters>
  122. <Parameter Name="depthTest" Type="System.Boolean" />
  123. </Parameters>
  124. <Docs>
  125. <param name="depthTest">To be added.</param>
  126. <summary>
  127. Add debug geometry to the debug renderer.
  128. </summary>
  129. <remarks>To be added.</remarks>
  130. </Docs>
  131. </Member>
  132. <Member MemberName="DrawDebugGeometry">
  133. <MemberSignature Language="C#" Value="public override void DrawDebugGeometry (Urho.DebugRenderer debug, bool depthTest);" />
  134. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void DrawDebugGeometry(class Urho.DebugRenderer debug, bool depthTest) cil managed" />
  135. <MemberType>Method</MemberType>
  136. <AssemblyInfo>
  137. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  138. </AssemblyInfo>
  139. <ReturnValue>
  140. <ReturnType>System.Void</ReturnType>
  141. </ReturnValue>
  142. <Parameters>
  143. <Parameter Name="debug" Type="Urho.DebugRenderer" />
  144. <Parameter Name="depthTest" Type="System.Boolean" />
  145. </Parameters>
  146. <Docs>
  147. <param name="debug">To be added.</param>
  148. <param name="depthTest">To be added.</param>
  149. <summary>
  150. Draw the agents' pathing debug data.
  151. </summary>
  152. <remarks>To be added.</remarks>
  153. </Docs>
  154. </Member>
  155. <Member MemberName="FindNearestPoint">
  156. <MemberSignature Language="C#" Value="public Urho.Vector3 FindNearestPoint (Urho.Vector3 point, int queryFilterType, uint* nearestRef);" />
  157. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Vector3 FindNearestPoint(valuetype Urho.Vector3 point, int32 queryFilterType, unsigned int32* nearestRef) cil managed" />
  158. <MemberType>Method</MemberType>
  159. <AssemblyInfo>
  160. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  161. </AssemblyInfo>
  162. <ReturnValue>
  163. <ReturnType>Urho.Vector3</ReturnType>
  164. </ReturnValue>
  165. <Parameters>
  166. <Parameter Name="point" Type="Urho.Vector3" />
  167. <Parameter Name="queryFilterType" Type="System.Int32" />
  168. <Parameter Name="nearestRef" Type="System.UInt32*" />
  169. </Parameters>
  170. <Docs>
  171. <param name="point">To be added.</param>
  172. <param name="queryFilterType">To be added.</param>
  173. <param name="nearestRef">To be added.</param>
  174. <summary>
  175. Find the nearest point on the navigation mesh to a given point using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type.
  176. </summary>
  177. <returns>To be added.</returns>
  178. <remarks>To be added.</remarks>
  179. </Docs>
  180. </Member>
  181. <Member MemberName="GetAreaCost">
  182. <MemberSignature Language="C#" Value="public float GetAreaCost (uint queryFilterType, uint areaID);" />
  183. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetAreaCost(unsigned int32 queryFilterType, unsigned int32 areaID) cil managed" />
  184. <MemberType>Method</MemberType>
  185. <AssemblyInfo>
  186. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  187. </AssemblyInfo>
  188. <ReturnValue>
  189. <ReturnType>System.Single</ReturnType>
  190. </ReturnValue>
  191. <Parameters>
  192. <Parameter Name="queryFilterType" Type="System.UInt32" />
  193. <Parameter Name="areaID" Type="System.UInt32" />
  194. </Parameters>
  195. <Docs>
  196. <param name="queryFilterType">To be added.</param>
  197. <param name="areaID">To be added.</param>
  198. <summary>
  199. Get the cost of an area for the specified query filter type.
  200. </summary>
  201. <returns>To be added.</returns>
  202. <remarks>To be added.</remarks>
  203. </Docs>
  204. </Member>
  205. <Member MemberName="GetDistanceToWall">
  206. <MemberSignature Language="C#" Value="public float GetDistanceToWall (Urho.Vector3 point, float radius, int queryFilterType, Urho.Vector3* hitPos, Urho.Vector3* hitNormal);" />
  207. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetDistanceToWall(valuetype Urho.Vector3 point, float32 radius, int32 queryFilterType, valuetype Urho.Vector3* hitPos, valuetype Urho.Vector3* hitNormal) cil managed" />
  208. <MemberType>Method</MemberType>
  209. <AssemblyInfo>
  210. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  211. </AssemblyInfo>
  212. <ReturnValue>
  213. <ReturnType>System.Single</ReturnType>
  214. </ReturnValue>
  215. <Parameters>
  216. <Parameter Name="point" Type="Urho.Vector3" />
  217. <Parameter Name="radius" Type="System.Single" />
  218. <Parameter Name="queryFilterType" Type="System.Int32" />
  219. <Parameter Name="hitPos" Type="Urho.Vector3*" />
  220. <Parameter Name="hitNormal" Type="Urho.Vector3*" />
  221. </Parameters>
  222. <Docs>
  223. <param name="point">To be added.</param>
  224. <param name="radius">To be added.</param>
  225. <param name="queryFilterType">To be added.</param>
  226. <param name="hitPos">To be added.</param>
  227. <param name="hitNormal">To be added.</param>
  228. <summary>
  229. Return distance to wall from a point using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type. Maximum search radius must be specified.
  230. </summary>
  231. <returns>To be added.</returns>
  232. <remarks>To be added.</remarks>
  233. </Docs>
  234. </Member>
  235. <Member MemberName="GetExcludeFlags">
  236. <MemberSignature Language="C#" Value="public ushort GetExcludeFlags (uint queryFilterType);" />
  237. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int16 GetExcludeFlags(unsigned int32 queryFilterType) cil managed" />
  238. <MemberType>Method</MemberType>
  239. <AssemblyInfo>
  240. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  241. </AssemblyInfo>
  242. <ReturnValue>
  243. <ReturnType>System.UInt16</ReturnType>
  244. </ReturnValue>
  245. <Parameters>
  246. <Parameter Name="queryFilterType" Type="System.UInt32" />
  247. </Parameters>
  248. <Docs>
  249. <param name="queryFilterType">To be added.</param>
  250. <summary>
  251. Get the exclude flags for the specified query filter type.
  252. </summary>
  253. <returns>To be added.</returns>
  254. <remarks>To be added.</remarks>
  255. </Docs>
  256. </Member>
  257. <Member MemberName="GetIncludeFlags">
  258. <MemberSignature Language="C#" Value="public ushort GetIncludeFlags (uint queryFilterType);" />
  259. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int16 GetIncludeFlags(unsigned int32 queryFilterType) cil managed" />
  260. <MemberType>Method</MemberType>
  261. <AssemblyInfo>
  262. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  263. </AssemblyInfo>
  264. <ReturnValue>
  265. <ReturnType>System.UInt16</ReturnType>
  266. </ReturnValue>
  267. <Parameters>
  268. <Parameter Name="queryFilterType" Type="System.UInt32" />
  269. </Parameters>
  270. <Docs>
  271. <param name="queryFilterType">To be added.</param>
  272. <summary>
  273. Get the include flags for the specified query filter type.
  274. </summary>
  275. <returns>To be added.</returns>
  276. <remarks>To be added.</remarks>
  277. </Docs>
  278. </Member>
  279. <Member MemberName="GetNumAreas">
  280. <MemberSignature Language="C#" Value="public uint GetNumAreas (uint queryFilterType);" />
  281. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 GetNumAreas(unsigned int32 queryFilterType) cil managed" />
  282. <MemberType>Method</MemberType>
  283. <AssemblyInfo>
  284. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  285. </AssemblyInfo>
  286. <ReturnValue>
  287. <ReturnType>System.UInt32</ReturnType>
  288. </ReturnValue>
  289. <Parameters>
  290. <Parameter Name="queryFilterType" Type="System.UInt32" />
  291. </Parameters>
  292. <Docs>
  293. <param name="queryFilterType">To be added.</param>
  294. <summary>
  295. Get the number of configured area in the specified query filter type.
  296. </summary>
  297. <returns>To be added.</returns>
  298. <remarks>To be added.</remarks>
  299. </Docs>
  300. </Member>
  301. <Member MemberName="GetObstacleAvoidanceParams">
  302. <MemberSignature Language="C#" Value="public Urho.CrowdObstacleAvoidanceParams GetObstacleAvoidanceParams (uint obstacleAvoidanceType);" />
  303. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.CrowdObstacleAvoidanceParams GetObstacleAvoidanceParams(unsigned int32 obstacleAvoidanceType) cil managed" />
  304. <MemberType>Method</MemberType>
  305. <AssemblyInfo>
  306. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  307. </AssemblyInfo>
  308. <ReturnValue>
  309. <ReturnType>Urho.CrowdObstacleAvoidanceParams</ReturnType>
  310. </ReturnValue>
  311. <Parameters>
  312. <Parameter Name="obstacleAvoidanceType" Type="System.UInt32" />
  313. </Parameters>
  314. <Docs>
  315. <param name="obstacleAvoidanceType">To be added.</param>
  316. <summary>
  317. Get the params for the specified obstacle avoidance type.
  318. </summary>
  319. <returns>To be added.</returns>
  320. <remarks>To be added.</remarks>
  321. </Docs>
  322. </Member>
  323. <Member MemberName="GetRandomPoint">
  324. <MemberSignature Language="C#" Value="public Urho.Vector3 GetRandomPoint (int queryFilterType, uint* randomRef);" />
  325. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Vector3 GetRandomPoint(int32 queryFilterType, unsigned int32* randomRef) cil managed" />
  326. <MemberType>Method</MemberType>
  327. <AssemblyInfo>
  328. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  329. </AssemblyInfo>
  330. <ReturnValue>
  331. <ReturnType>Urho.Vector3</ReturnType>
  332. </ReturnValue>
  333. <Parameters>
  334. <Parameter Name="queryFilterType" Type="System.Int32" />
  335. <Parameter Name="randomRef" Type="System.UInt32*" />
  336. </Parameters>
  337. <Docs>
  338. <param name="queryFilterType">To be added.</param>
  339. <param name="randomRef">To be added.</param>
  340. <summary>
  341. Return a random point on the navigation mesh using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type.
  342. </summary>
  343. <returns>To be added.</returns>
  344. <remarks>To be added.</remarks>
  345. </Docs>
  346. </Member>
  347. <Member MemberName="GetRandomPointInCircle">
  348. <MemberSignature Language="C#" Value="public Urho.Vector3 GetRandomPointInCircle (Urho.Vector3 center, float radius, int queryFilterType, uint* randomRef);" />
  349. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Vector3 GetRandomPointInCircle(valuetype Urho.Vector3 center, float32 radius, int32 queryFilterType, unsigned int32* randomRef) cil managed" />
  350. <MemberType>Method</MemberType>
  351. <AssemblyInfo>
  352. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  353. </AssemblyInfo>
  354. <ReturnValue>
  355. <ReturnType>Urho.Vector3</ReturnType>
  356. </ReturnValue>
  357. <Parameters>
  358. <Parameter Name="center" Type="Urho.Vector3" />
  359. <Parameter Name="radius" Type="System.Single" />
  360. <Parameter Name="queryFilterType" Type="System.Int32" />
  361. <Parameter Name="randomRef" Type="System.UInt32*" />
  362. </Parameters>
  363. <Docs>
  364. <param name="center">To be added.</param>
  365. <param name="radius">To be added.</param>
  366. <param name="queryFilterType">To be added.</param>
  367. <param name="randomRef">To be added.</param>
  368. <summary>
  369. Return a random point on the navigation mesh within a circle using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type. The circle radius is only a guideline and in practice the returned point may be further away.
  370. </summary>
  371. <returns>To be added.</returns>
  372. <remarks>To be added.</remarks>
  373. </Docs>
  374. </Member>
  375. <Member MemberName="MaxAgentRadius">
  376. <MemberSignature Language="C#" Value="public float MaxAgentRadius { get; set; }" />
  377. <MemberSignature Language="ILAsm" Value=".property instance float32 MaxAgentRadius" />
  378. <MemberType>Property</MemberType>
  379. <AssemblyInfo>
  380. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  381. </AssemblyInfo>
  382. <ReturnValue>
  383. <ReturnType>System.Single</ReturnType>
  384. </ReturnValue>
  385. <Docs>
  386. <summary>
  387. Get the maximum radius of any agent.
  388. Or
  389. Set the maximum radius of any agent.
  390. </summary>
  391. <value>To be added.</value>
  392. <remarks>To be added.</remarks>
  393. </Docs>
  394. </Member>
  395. <Member MemberName="MaxAgents">
  396. <MemberSignature Language="C#" Value="public uint MaxAgents { get; set; }" />
  397. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 MaxAgents" />
  398. <MemberType>Property</MemberType>
  399. <AssemblyInfo>
  400. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  401. </AssemblyInfo>
  402. <ReturnValue>
  403. <ReturnType>System.UInt32</ReturnType>
  404. </ReturnValue>
  405. <Docs>
  406. <summary>
  407. Get the maximum number of agents.
  408. Or
  409. Set the maximum number of agents.
  410. </summary>
  411. <value>To be added.</value>
  412. <remarks>To be added.</remarks>
  413. </Docs>
  414. </Member>
  415. <Member MemberName="MoveAlongSurface">
  416. <MemberSignature Language="C#" Value="public Urho.Vector3 MoveAlongSurface (Urho.Vector3 start, Urho.Vector3 end, int queryFilterType, int maxVisited);" />
  417. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Vector3 MoveAlongSurface(valuetype Urho.Vector3 start, valuetype Urho.Vector3 end, int32 queryFilterType, int32 maxVisited) cil managed" />
  418. <MemberType>Method</MemberType>
  419. <AssemblyInfo>
  420. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  421. </AssemblyInfo>
  422. <ReturnValue>
  423. <ReturnType>Urho.Vector3</ReturnType>
  424. </ReturnValue>
  425. <Parameters>
  426. <Parameter Name="start" Type="Urho.Vector3" />
  427. <Parameter Name="end" Type="Urho.Vector3" />
  428. <Parameter Name="queryFilterType" Type="System.Int32" />
  429. <Parameter Name="maxVisited" Type="System.Int32" />
  430. </Parameters>
  431. <Docs>
  432. <param name="start">To be added.</param>
  433. <param name="end">To be added.</param>
  434. <param name="queryFilterType">To be added.</param>
  435. <param name="maxVisited">To be added.</param>
  436. <summary>
  437. Try to move along the surface from one point to another using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type.
  438. </summary>
  439. <returns>To be added.</returns>
  440. <remarks>To be added.</remarks>
  441. </Docs>
  442. </Member>
  443. <Member MemberName="NavigationMesh">
  444. <MemberSignature Language="C#" Value="public Urho.NavigationMesh NavigationMesh { get; set; }" />
  445. <MemberSignature Language="ILAsm" Value=".property instance class Urho.NavigationMesh NavigationMesh" />
  446. <MemberType>Property</MemberType>
  447. <AssemblyInfo>
  448. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  449. </AssemblyInfo>
  450. <ReturnValue>
  451. <ReturnType>Urho.NavigationMesh</ReturnType>
  452. </ReturnValue>
  453. <Docs>
  454. <summary>
  455. Get the Navigation mesh assigned to the crowd.
  456. Or
  457. Assigns the navigation mesh for the crowd.
  458. </summary>
  459. <value>To be added.</value>
  460. <remarks>To be added.</remarks>
  461. </Docs>
  462. </Member>
  463. <Member MemberName="NumObstacleAvoidanceTypes">
  464. <MemberSignature Language="C#" Value="public uint NumObstacleAvoidanceTypes { get; }" />
  465. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumObstacleAvoidanceTypes" />
  466. <MemberType>Property</MemberType>
  467. <AssemblyInfo>
  468. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  469. </AssemblyInfo>
  470. <ReturnValue>
  471. <ReturnType>System.UInt32</ReturnType>
  472. </ReturnValue>
  473. <Docs>
  474. <summary>
  475. Get the number of configured obstacle avoidance types.
  476. </summary>
  477. <value>To be added.</value>
  478. <remarks>To be added.</remarks>
  479. </Docs>
  480. </Member>
  481. <Member MemberName="NumQueryFilterTypes">
  482. <MemberSignature Language="C#" Value="public uint NumQueryFilterTypes { get; }" />
  483. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumQueryFilterTypes" />
  484. <MemberType>Property</MemberType>
  485. <AssemblyInfo>
  486. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  487. </AssemblyInfo>
  488. <ReturnValue>
  489. <ReturnType>System.UInt32</ReturnType>
  490. </ReturnValue>
  491. <Docs>
  492. <summary>
  493. Get the number of configured query filter types.
  494. </summary>
  495. <value>To be added.</value>
  496. <remarks>To be added.</remarks>
  497. </Docs>
  498. </Member>
  499. <Member MemberName="Raycast">
  500. <MemberSignature Language="C#" Value="public Urho.Vector3 Raycast (Urho.Vector3 start, Urho.Vector3 end, int queryFilterType, Urho.Vector3* hitNormal);" />
  501. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Vector3 Raycast(valuetype Urho.Vector3 start, valuetype Urho.Vector3 end, int32 queryFilterType, valuetype Urho.Vector3* hitNormal) cil managed" />
  502. <MemberType>Method</MemberType>
  503. <AssemblyInfo>
  504. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  505. </AssemblyInfo>
  506. <ReturnValue>
  507. <ReturnType>Urho.Vector3</ReturnType>
  508. </ReturnValue>
  509. <Parameters>
  510. <Parameter Name="start" Type="Urho.Vector3" />
  511. <Parameter Name="end" Type="Urho.Vector3" />
  512. <Parameter Name="queryFilterType" Type="System.Int32" />
  513. <Parameter Name="hitNormal" Type="Urho.Vector3*" />
  514. </Parameters>
  515. <Docs>
  516. <param name="start">To be added.</param>
  517. <param name="end">To be added.</param>
  518. <param name="queryFilterType">To be added.</param>
  519. <param name="hitNormal">To be added.</param>
  520. <summary>
  521. Perform a walkability raycast on the navigation mesh between start and end using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type. Return the point where a wall was hit, or the end point if no walls.
  522. </summary>
  523. <returns>To be added.</returns>
  524. <remarks>To be added.</remarks>
  525. </Docs>
  526. </Member>
  527. <Member MemberName="RegisterObject">
  528. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  529. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  530. <MemberType>Method</MemberType>
  531. <AssemblyInfo>
  532. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  533. </AssemblyInfo>
  534. <ReturnValue>
  535. <ReturnType>System.Void</ReturnType>
  536. </ReturnValue>
  537. <Parameters>
  538. <Parameter Name="context" Type="Urho.Context" />
  539. </Parameters>
  540. <Docs>
  541. <param name="context">To be added.</param>
  542. <summary>
  543. Register object factory.
  544. </summary>
  545. <remarks>To be added.</remarks>
  546. </Docs>
  547. </Member>
  548. <Member MemberName="ResetCrowdTarget">
  549. <MemberSignature Language="C#" Value="public void ResetCrowdTarget (Urho.Node node);" />
  550. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResetCrowdTarget(class Urho.Node node) cil managed" />
  551. <MemberType>Method</MemberType>
  552. <AssemblyInfo>
  553. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  554. </AssemblyInfo>
  555. <ReturnValue>
  556. <ReturnType>System.Void</ReturnType>
  557. </ReturnValue>
  558. <Parameters>
  559. <Parameter Name="node" Type="Urho.Node" />
  560. </Parameters>
  561. <Docs>
  562. <param name="node">To be added.</param>
  563. <summary>
  564. Reset any crowd target for all crowd agents found in the specified node. Defaulted to scene node.
  565. </summary>
  566. <remarks>To be added.</remarks>
  567. </Docs>
  568. </Member>
  569. <Member MemberName="SetAreaCost">
  570. <MemberSignature Language="C#" Value="public void SetAreaCost (uint queryFilterType, uint areaID, float cost);" />
  571. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetAreaCost(unsigned int32 queryFilterType, unsigned int32 areaID, float32 cost) cil managed" />
  572. <MemberType>Method</MemberType>
  573. <AssemblyInfo>
  574. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  575. </AssemblyInfo>
  576. <ReturnValue>
  577. <ReturnType>System.Void</ReturnType>
  578. </ReturnValue>
  579. <Parameters>
  580. <Parameter Name="queryFilterType" Type="System.UInt32" />
  581. <Parameter Name="areaID" Type="System.UInt32" />
  582. <Parameter Name="cost" Type="System.Single" />
  583. </Parameters>
  584. <Docs>
  585. <param name="queryFilterType">To be added.</param>
  586. <param name="areaID">To be added.</param>
  587. <param name="cost">To be added.</param>
  588. <summary>
  589. Set the cost of an area for the specified query filter type.
  590. </summary>
  591. <remarks>To be added.</remarks>
  592. </Docs>
  593. </Member>
  594. <Member MemberName="SetCrowdTarget">
  595. <MemberSignature Language="C#" Value="public void SetCrowdTarget (Urho.Vector3 position, Urho.Node node);" />
  596. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetCrowdTarget(valuetype Urho.Vector3 position, class Urho.Node node) cil managed" />
  597. <MemberType>Method</MemberType>
  598. <AssemblyInfo>
  599. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  600. </AssemblyInfo>
  601. <ReturnValue>
  602. <ReturnType>System.Void</ReturnType>
  603. </ReturnValue>
  604. <Parameters>
  605. <Parameter Name="position" Type="Urho.Vector3" />
  606. <Parameter Name="node" Type="Urho.Node" />
  607. </Parameters>
  608. <Docs>
  609. <param name="position">To be added.</param>
  610. <param name="node">To be added.</param>
  611. <summary>
  612. Set the crowd target position. The target position is set to all crowd agents found in the specified node. Defaulted to scene node.
  613. </summary>
  614. <remarks>To be added.</remarks>
  615. </Docs>
  616. </Member>
  617. <Member MemberName="SetCrowdVelocity">
  618. <MemberSignature Language="C#" Value="public void SetCrowdVelocity (Urho.Vector3 velocity, Urho.Node node);" />
  619. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetCrowdVelocity(valuetype Urho.Vector3 velocity, class Urho.Node node) cil managed" />
  620. <MemberType>Method</MemberType>
  621. <AssemblyInfo>
  622. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  623. </AssemblyInfo>
  624. <ReturnValue>
  625. <ReturnType>System.Void</ReturnType>
  626. </ReturnValue>
  627. <Parameters>
  628. <Parameter Name="velocity" Type="Urho.Vector3" />
  629. <Parameter Name="node" Type="Urho.Node" />
  630. </Parameters>
  631. <Docs>
  632. <param name="velocity">To be added.</param>
  633. <param name="node">To be added.</param>
  634. <summary>
  635. Set the crowd move velocity. The move velocity is applied to all crowd agents found in the specified node. Defaulted to scene node.
  636. </summary>
  637. <remarks>To be added.</remarks>
  638. </Docs>
  639. </Member>
  640. <Member MemberName="SetExcludeFlags">
  641. <MemberSignature Language="C#" Value="public void SetExcludeFlags (uint queryFilterType, ushort flags);" />
  642. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetExcludeFlags(unsigned int32 queryFilterType, unsigned int16 flags) cil managed" />
  643. <MemberType>Method</MemberType>
  644. <AssemblyInfo>
  645. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  646. </AssemblyInfo>
  647. <ReturnValue>
  648. <ReturnType>System.Void</ReturnType>
  649. </ReturnValue>
  650. <Parameters>
  651. <Parameter Name="queryFilterType" Type="System.UInt32" />
  652. <Parameter Name="flags" Type="System.UInt16" />
  653. </Parameters>
  654. <Docs>
  655. <param name="queryFilterType">To be added.</param>
  656. <param name="flags">To be added.</param>
  657. <summary>
  658. Set the exclude flags for the specified query filter type.
  659. </summary>
  660. <remarks>To be added.</remarks>
  661. </Docs>
  662. </Member>
  663. <Member MemberName="SetIncludeFlags">
  664. <MemberSignature Language="C#" Value="public void SetIncludeFlags (uint queryFilterType, ushort flags);" />
  665. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetIncludeFlags(unsigned int32 queryFilterType, unsigned int16 flags) cil managed" />
  666. <MemberType>Method</MemberType>
  667. <AssemblyInfo>
  668. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  669. </AssemblyInfo>
  670. <ReturnValue>
  671. <ReturnType>System.Void</ReturnType>
  672. </ReturnValue>
  673. <Parameters>
  674. <Parameter Name="queryFilterType" Type="System.UInt32" />
  675. <Parameter Name="flags" Type="System.UInt16" />
  676. </Parameters>
  677. <Docs>
  678. <param name="queryFilterType">To be added.</param>
  679. <param name="flags">To be added.</param>
  680. <summary>
  681. Set the include flags for the specified query filter type.
  682. </summary>
  683. <remarks>To be added.</remarks>
  684. </Docs>
  685. </Member>
  686. <Member MemberName="SetObstacleAvoidanceParams">
  687. <MemberSignature Language="C#" Value="public void SetObstacleAvoidanceParams (uint obstacleAvoidanceType, Urho.CrowdObstacleAvoidanceParams params);" />
  688. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetObstacleAvoidanceParams(unsigned int32 obstacleAvoidanceType, valuetype Urho.CrowdObstacleAvoidanceParams params) cil managed" />
  689. <MemberType>Method</MemberType>
  690. <AssemblyInfo>
  691. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  692. </AssemblyInfo>
  693. <ReturnValue>
  694. <ReturnType>System.Void</ReturnType>
  695. </ReturnValue>
  696. <Parameters>
  697. <Parameter Name="obstacleAvoidanceType" Type="System.UInt32" />
  698. <Parameter Name="params" Type="Urho.CrowdObstacleAvoidanceParams" />
  699. </Parameters>
  700. <Docs>
  701. <param name="obstacleAvoidanceType">To be added.</param>
  702. <param name="params">To be added.</param>
  703. <summary>
  704. Set the params for the specified obstacle avoidance type.
  705. </summary>
  706. <remarks>To be added.</remarks>
  707. </Docs>
  708. </Member>
  709. <Member MemberName="Type">
  710. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  711. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  712. <MemberType>Property</MemberType>
  713. <AssemblyInfo>
  714. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  715. </AssemblyInfo>
  716. <ReturnValue>
  717. <ReturnType>Urho.StringHash</ReturnType>
  718. </ReturnValue>
  719. <Docs>
  720. <summary>Urho's type system type.</summary>
  721. <value>StringHash representing the type for this C# type.</value>
  722. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  723. </Docs>
  724. </Member>
  725. <Member MemberName="TypeName">
  726. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  727. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  728. <MemberType>Property</MemberType>
  729. <AssemblyInfo>
  730. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  731. </AssemblyInfo>
  732. <ReturnValue>
  733. <ReturnType>System.String</ReturnType>
  734. </ReturnValue>
  735. <Docs>
  736. <summary>Urho's low-level type name.</summary>
  737. <value>Stringified low-level type name.</value>
  738. <remarks></remarks>
  739. </Docs>
  740. </Member>
  741. <Member MemberName="TypeNameStatic">
  742. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  743. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  744. <MemberType>Property</MemberType>
  745. <AssemblyInfo>
  746. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  747. </AssemblyInfo>
  748. <ReturnValue>
  749. <ReturnType>System.String</ReturnType>
  750. </ReturnValue>
  751. <Docs>
  752. <summary>Urho's low-level type name, accessible as a static method.</summary>
  753. <value>Stringified low-level type name.</value>
  754. <remarks></remarks>
  755. </Docs>
  756. </Member>
  757. <Member MemberName="TypeStatic">
  758. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  759. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  760. <MemberType>Property</MemberType>
  761. <AssemblyInfo>
  762. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  763. </AssemblyInfo>
  764. <ReturnValue>
  765. <ReturnType>Urho.StringHash</ReturnType>
  766. </ReturnValue>
  767. <Docs>
  768. <summary>To be added.</summary>
  769. <value>To be added.</value>
  770. <remarks>To be added.</remarks>
  771. </Docs>
  772. </Member>
  773. </Members>
  774. </Type>