NavArea.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
  1. <Type Name="NavArea" FullName="Urho.Navigation.NavArea">
  2. <TypeSignature Language="C#" Value="public class NavArea : Urho.Component" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NavArea 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. Construct.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public NavArea ();" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Attributes>
  27. <Attribute>
  28. <AttributeName>Preserve</AttributeName>
  29. </Attribute>
  30. </Attributes>
  31. <Parameters />
  32. <Docs>
  33. <summary>To be added.</summary>
  34. <remarks>To be added.</remarks>
  35. </Docs>
  36. </Member>
  37. <Member MemberName=".ctor">
  38. <MemberSignature Language="C#" Value="public NavArea (IntPtr handle);" />
  39. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  40. <MemberType>Constructor</MemberType>
  41. <AssemblyInfo>
  42. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  43. </AssemblyInfo>
  44. <Attributes>
  45. <Attribute>
  46. <AttributeName>Preserve</AttributeName>
  47. </Attribute>
  48. </Attributes>
  49. <Parameters>
  50. <Parameter Name="handle" Type="System.IntPtr" />
  51. </Parameters>
  52. <Docs>
  53. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  54. <summary>Constructs a new instance of Urho.Navigation.NavArea, given a raw pointer to an unmanaged object</summary>
  55. <remarks>
  56. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  57. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  58. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  59. </remarks>
  60. </Docs>
  61. </Member>
  62. <Member MemberName=".ctor">
  63. <MemberSignature Language="C#" Value="public NavArea (Urho.Context param1);" />
  64. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context param1) cil managed" />
  65. <MemberType>Constructor</MemberType>
  66. <AssemblyInfo>
  67. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  68. </AssemblyInfo>
  69. <Attributes>
  70. <Attribute>
  71. <AttributeName>Preserve</AttributeName>
  72. </Attribute>
  73. </Attributes>
  74. <Parameters>
  75. <Parameter Name="param1" Type="Urho.Context" />
  76. </Parameters>
  77. <Docs>
  78. <param name="param1">To be added.</param>
  79. <summary>To be added.</summary>
  80. <remarks>To be added.</remarks>
  81. </Docs>
  82. </Member>
  83. <Member MemberName=".ctor">
  84. <MemberSignature Language="C#" Value="protected NavArea (Urho.UrhoObjectFlag emptyFlag);" />
  85. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  86. <MemberType>Constructor</MemberType>
  87. <AssemblyInfo>
  88. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  89. </AssemblyInfo>
  90. <Attributes>
  91. <Attribute>
  92. <AttributeName>Preserve</AttributeName>
  93. </Attribute>
  94. </Attributes>
  95. <Parameters>
  96. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  97. </Parameters>
  98. <Docs>
  99. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  100. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  101. <remarks>
  102. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  103. <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>
  104. <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>
  105. </remarks>
  106. </Docs>
  107. </Member>
  108. <Member MemberName="AreaID">
  109. <MemberSignature Language="C#" Value="public uint AreaID { get; set; }" />
  110. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 AreaID" />
  111. <MemberType>Property</MemberType>
  112. <AssemblyInfo>
  113. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  114. </AssemblyInfo>
  115. <ReturnValue>
  116. <ReturnType>System.UInt32</ReturnType>
  117. </ReturnValue>
  118. <Docs>
  119. <summary>
  120. Get the area id for this volume.
  121. Or
  122. Set the area id for this volume.
  123. </summary>
  124. <value>To be added.</value>
  125. <remarks>To be added.</remarks>
  126. </Docs>
  127. </Member>
  128. <Member MemberName="BoundingBox">
  129. <MemberSignature Language="C#" Value="public Urho.BoundingBox BoundingBox { get; }" />
  130. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.BoundingBox BoundingBox" />
  131. <MemberType>Property</MemberType>
  132. <AssemblyInfo>
  133. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  134. </AssemblyInfo>
  135. <ReturnValue>
  136. <ReturnType>Urho.BoundingBox</ReturnType>
  137. </ReturnValue>
  138. <Docs>
  139. <summary>
  140. Get the bounding box of this navigation area, in local space.
  141. </summary>
  142. <value>To be added.</value>
  143. <remarks>To be added.</remarks>
  144. </Docs>
  145. </Member>
  146. <Member MemberName="DrawDebugGeometry">
  147. <MemberSignature Language="C#" Value="public override void DrawDebugGeometry (Urho.DebugRenderer debug, bool depthTest);" />
  148. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void DrawDebugGeometry(class Urho.DebugRenderer debug, bool depthTest) cil managed" />
  149. <MemberType>Method</MemberType>
  150. <AssemblyInfo>
  151. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  152. </AssemblyInfo>
  153. <ReturnValue>
  154. <ReturnType>System.Void</ReturnType>
  155. </ReturnValue>
  156. <Parameters>
  157. <Parameter Name="debug" Type="Urho.DebugRenderer" />
  158. <Parameter Name="depthTest" Type="System.Boolean" />
  159. </Parameters>
  160. <Docs>
  161. <param name="debug">To be added.</param>
  162. <param name="depthTest">To be added.</param>
  163. <summary>
  164. Render debug geometry for the bounds.
  165. </summary>
  166. <remarks>To be added.</remarks>
  167. </Docs>
  168. </Member>
  169. <Member MemberName="RegisterObject">
  170. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context param1);" />
  171. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context param1) cil managed" />
  172. <MemberType>Method</MemberType>
  173. <AssemblyInfo>
  174. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  175. </AssemblyInfo>
  176. <ReturnValue>
  177. <ReturnType>System.Void</ReturnType>
  178. </ReturnValue>
  179. <Parameters>
  180. <Parameter Name="param1" Type="Urho.Context" />
  181. </Parameters>
  182. <Docs>
  183. <param name="param1">To be added.</param>
  184. <summary>
  185. Register object factory and attributes.
  186. </summary>
  187. <remarks>To be added.</remarks>
  188. </Docs>
  189. </Member>
  190. <Member MemberName="SetBoundingBox">
  191. <MemberSignature Language="C#" Value="public void SetBoundingBox (Urho.BoundingBox bnds);" />
  192. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetBoundingBox(valuetype Urho.BoundingBox bnds) cil managed" />
  193. <MemberType>Method</MemberType>
  194. <AssemblyInfo>
  195. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  196. </AssemblyInfo>
  197. <ReturnValue>
  198. <ReturnType>System.Void</ReturnType>
  199. </ReturnValue>
  200. <Parameters>
  201. <Parameter Name="bnds" Type="Urho.BoundingBox" />
  202. </Parameters>
  203. <Docs>
  204. <param name="bnds">To be added.</param>
  205. <summary>
  206. Set the bounding box of this area, in local space.
  207. </summary>
  208. <remarks>To be added.</remarks>
  209. </Docs>
  210. </Member>
  211. <Member MemberName="Type">
  212. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  213. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  214. <MemberType>Property</MemberType>
  215. <AssemblyInfo>
  216. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  217. </AssemblyInfo>
  218. <ReturnValue>
  219. <ReturnType>Urho.StringHash</ReturnType>
  220. </ReturnValue>
  221. <Docs>
  222. <summary>Urho's type system type.</summary>
  223. <value>StringHash representing the type for this C# type.</value>
  224. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  225. </Docs>
  226. </Member>
  227. <Member MemberName="TypeName">
  228. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  229. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  230. <MemberType>Property</MemberType>
  231. <AssemblyInfo>
  232. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  233. </AssemblyInfo>
  234. <ReturnValue>
  235. <ReturnType>System.String</ReturnType>
  236. </ReturnValue>
  237. <Docs>
  238. <summary>Urho's low-level type name.</summary>
  239. <value>Stringified low-level type name.</value>
  240. <remarks>
  241. </remarks>
  242. </Docs>
  243. </Member>
  244. <Member MemberName="TypeNameStatic">
  245. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  246. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  247. <MemberType>Property</MemberType>
  248. <AssemblyInfo>
  249. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  250. </AssemblyInfo>
  251. <ReturnValue>
  252. <ReturnType>System.String</ReturnType>
  253. </ReturnValue>
  254. <Docs>
  255. <summary>Urho's low-level type name, accessible as a static method.</summary>
  256. <value>Stringified low-level type name.</value>
  257. <remarks>
  258. </remarks>
  259. </Docs>
  260. </Member>
  261. <Member MemberName="TypeStatic">
  262. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  263. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  264. <MemberType>Property</MemberType>
  265. <AssemblyInfo>
  266. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  267. </AssemblyInfo>
  268. <Attributes>
  269. <Attribute>
  270. <AttributeName>Preserve</AttributeName>
  271. </Attribute>
  272. </Attributes>
  273. <ReturnValue>
  274. <ReturnType>Urho.StringHash</ReturnType>
  275. </ReturnValue>
  276. <Docs>
  277. <summary>Urho's low-level type, accessible as a static method.</summary>
  278. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  279. <remarks>
  280. </remarks>
  281. </Docs>
  282. </Member>
  283. <Member MemberName="WorldBoundingBox">
  284. <MemberSignature Language="C#" Value="public Urho.BoundingBox WorldBoundingBox { get; }" />
  285. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.BoundingBox WorldBoundingBox" />
  286. <MemberType>Property</MemberType>
  287. <AssemblyInfo>
  288. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  289. </AssemblyInfo>
  290. <ReturnValue>
  291. <ReturnType>Urho.BoundingBox</ReturnType>
  292. </ReturnValue>
  293. <Docs>
  294. <summary>
  295. Get the bounds of this navigation area in world space.
  296. </summary>
  297. <value>To be added.</value>
  298. <remarks>To be added.</remarks>
  299. </Docs>
  300. </Member>
  301. </Members>
  302. </Type>