NavArea.xml 11 KB

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