Drawable.xml 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009
  1. <Type Name="Drawable" FullName="Urho.Drawable">
  2. <TypeSignature Language="C#" Value="public class Drawable : Urho.Component" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Drawable 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. Base class for visible components.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public Drawable (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 Drawable, 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 Drawable (Urho.UrhoObjectFlag emptyFlag);" />
  41. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  42. <MemberType>Constructor</MemberType>
  43. <AssemblyInfo>
  44. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  45. </AssemblyInfo>
  46. <Parameters>
  47. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  48. </Parameters>
  49. <Docs>
  50. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  51. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  52. <remarks>
  53. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  54. <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>
  55. <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>
  56. </remarks>
  57. </Docs>
  58. </Member>
  59. <Member MemberName="AddLight">
  60. <MemberSignature Language="C#" Value="public void AddLight (Urho.Light light);" />
  61. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddLight(class Urho.Light light) cil managed" />
  62. <MemberType>Method</MemberType>
  63. <AssemblyInfo>
  64. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  65. </AssemblyInfo>
  66. <ReturnValue>
  67. <ReturnType>System.Void</ReturnType>
  68. </ReturnValue>
  69. <Parameters>
  70. <Parameter Name="light" Type="Urho.Light" />
  71. </Parameters>
  72. <Docs>
  73. <param name="light">To be added.</param>
  74. <summary>To be added.</summary>
  75. <remarks>To be added.</remarks>
  76. </Docs>
  77. </Member>
  78. <Member MemberName="AddVertexLight">
  79. <MemberSignature Language="C#" Value="public void AddVertexLight (Urho.Light light);" />
  80. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddVertexLight(class Urho.Light light) cil managed" />
  81. <MemberType>Method</MemberType>
  82. <AssemblyInfo>
  83. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  84. </AssemblyInfo>
  85. <ReturnValue>
  86. <ReturnType>System.Void</ReturnType>
  87. </ReturnValue>
  88. <Parameters>
  89. <Parameter Name="light" Type="Urho.Light" />
  90. </Parameters>
  91. <Docs>
  92. <param name="light">To be added.</param>
  93. <summary>To be added.</summary>
  94. <remarks>To be added.</remarks>
  95. </Docs>
  96. </Member>
  97. <Member MemberName="BaseType">
  98. <MemberSignature Language="C#" Value="public override Urho.StringHash BaseType { get; }" />
  99. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash BaseType" />
  100. <MemberType>Property</MemberType>
  101. <AssemblyInfo>
  102. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  103. </AssemblyInfo>
  104. <ReturnValue>
  105. <ReturnType>Urho.StringHash</ReturnType>
  106. </ReturnValue>
  107. <Docs>
  108. <summary>Urho's type system base type.</summary>
  109. <value>StringHash representing the base type for this Urho type.</value>
  110. <remarks>This returns the Urho type system base type and is surfaced for low-level Urho code.</remarks>
  111. </Docs>
  112. </Member>
  113. <Member MemberName="BoundingBox">
  114. <MemberSignature Language="C#" Value="public Urho.BoundingBox BoundingBox { get; }" />
  115. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.BoundingBox BoundingBox" />
  116. <MemberType>Property</MemberType>
  117. <AssemblyInfo>
  118. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  119. </AssemblyInfo>
  120. <ReturnValue>
  121. <ReturnType>Urho.BoundingBox</ReturnType>
  122. </ReturnValue>
  123. <Docs>
  124. <summary>
  125. Return local space bounding box. May not be applicable or properly updated on all drawables.
  126. </summary>
  127. <value>To be added.</value>
  128. <remarks>To be added.</remarks>
  129. </Docs>
  130. </Member>
  131. <Member MemberName="CastShadows">
  132. <MemberSignature Language="C#" Value="public bool CastShadows { get; set; }" />
  133. <MemberSignature Language="ILAsm" Value=".property instance bool CastShadows" />
  134. <MemberType>Property</MemberType>
  135. <AssemblyInfo>
  136. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  137. </AssemblyInfo>
  138. <ReturnValue>
  139. <ReturnType>System.Boolean</ReturnType>
  140. </ReturnValue>
  141. <Docs>
  142. <summary>
  143. Return shadowcaster flag.
  144. Or
  145. Set shadowcaster flag.
  146. </summary>
  147. <value>To be added.</value>
  148. <remarks>To be added.</remarks>
  149. </Docs>
  150. </Member>
  151. <Member MemberName="Distance">
  152. <MemberSignature Language="C#" Value="public float Distance { get; }" />
  153. <MemberSignature Language="ILAsm" Value=".property instance float32 Distance" />
  154. <MemberType>Property</MemberType>
  155. <AssemblyInfo>
  156. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  157. </AssemblyInfo>
  158. <ReturnValue>
  159. <ReturnType>System.Single</ReturnType>
  160. </ReturnValue>
  161. <Docs>
  162. <summary>
  163. Return distance from camera.
  164. </summary>
  165. <value>To be added.</value>
  166. <remarks>To be added.</remarks>
  167. </Docs>
  168. </Member>
  169. <Member MemberName="DrawableFlags">
  170. <MemberSignature Language="C#" Value="public byte DrawableFlags { get; }" />
  171. <MemberSignature Language="ILAsm" Value=".property instance unsigned int8 DrawableFlags" />
  172. <MemberType>Property</MemberType>
  173. <AssemblyInfo>
  174. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  175. </AssemblyInfo>
  176. <ReturnValue>
  177. <ReturnType>System.Byte</ReturnType>
  178. </ReturnValue>
  179. <Docs>
  180. <summary>
  181. Return drawable flags.
  182. </summary>
  183. <value>To be added.</value>
  184. <remarks>To be added.</remarks>
  185. </Docs>
  186. </Member>
  187. <Member MemberName="DrawDebugGeometry">
  188. <MemberSignature Language="C#" Value="public override void DrawDebugGeometry (Urho.DebugRenderer debug, bool depthTest);" />
  189. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void DrawDebugGeometry(class Urho.DebugRenderer debug, bool depthTest) cil managed" />
  190. <MemberType>Method</MemberType>
  191. <AssemblyInfo>
  192. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  193. </AssemblyInfo>
  194. <ReturnValue>
  195. <ReturnType>System.Void</ReturnType>
  196. </ReturnValue>
  197. <Parameters>
  198. <Parameter Name="debug" Type="Urho.DebugRenderer" />
  199. <Parameter Name="depthTest" Type="System.Boolean" />
  200. </Parameters>
  201. <Docs>
  202. <param name="debug">To be added.</param>
  203. <param name="depthTest">To be added.</param>
  204. <summary>
  205. Visualize the component as debug geometry.
  206. </summary>
  207. <remarks>To be added.</remarks>
  208. </Docs>
  209. </Member>
  210. <Member MemberName="DrawDistance">
  211. <MemberSignature Language="C#" Value="public float DrawDistance { get; set; }" />
  212. <MemberSignature Language="ILAsm" Value=".property instance float32 DrawDistance" />
  213. <MemberType>Property</MemberType>
  214. <AssemblyInfo>
  215. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  216. </AssemblyInfo>
  217. <ReturnValue>
  218. <ReturnType>System.Single</ReturnType>
  219. </ReturnValue>
  220. <Docs>
  221. <summary>
  222. Return draw distance.
  223. Or
  224. Set draw distance.
  225. </summary>
  226. <value>To be added.</value>
  227. <remarks>To be added.</remarks>
  228. </Docs>
  229. </Member>
  230. <Member MemberName="DrawOcclusion">
  231. <MemberSignature Language="C#" Value="public virtual bool DrawOcclusion (Urho.OcclusionBuffer buffer);" />
  232. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool DrawOcclusion(class Urho.OcclusionBuffer buffer) cil managed" />
  233. <MemberType>Method</MemberType>
  234. <AssemblyInfo>
  235. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  236. </AssemblyInfo>
  237. <ReturnValue>
  238. <ReturnType>System.Boolean</ReturnType>
  239. </ReturnValue>
  240. <Parameters>
  241. <Parameter Name="buffer" Type="Urho.OcclusionBuffer" />
  242. </Parameters>
  243. <Docs>
  244. <param name="buffer">To be added.</param>
  245. <summary>
  246. Draw to occlusion buffer. Return true if did not run out of triangles.
  247. </summary>
  248. <returns>To be added.</returns>
  249. <remarks>To be added.</remarks>
  250. </Docs>
  251. </Member>
  252. <Member MemberName="FirstLight">
  253. <MemberSignature Language="C#" Value="public Urho.Light FirstLight { get; }" />
  254. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Light FirstLight" />
  255. <MemberType>Property</MemberType>
  256. <AssemblyInfo>
  257. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  258. </AssemblyInfo>
  259. <ReturnValue>
  260. <ReturnType>Urho.Light</ReturnType>
  261. </ReturnValue>
  262. <Docs>
  263. <summary>
  264. Return the first added per-pixel light.
  265. </summary>
  266. <value>To be added.</value>
  267. <remarks>To be added.</remarks>
  268. </Docs>
  269. </Member>
  270. <Member MemberName="GetLodGeometry">
  271. <MemberSignature Language="C#" Value="public virtual Urho.Geometry GetLodGeometry (uint batchIndex, uint level);" />
  272. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Urho.Geometry GetLodGeometry(unsigned int32 batchIndex, unsigned int32 level) cil managed" />
  273. <MemberType>Method</MemberType>
  274. <AssemblyInfo>
  275. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  276. </AssemblyInfo>
  277. <ReturnValue>
  278. <ReturnType>Urho.Geometry</ReturnType>
  279. </ReturnValue>
  280. <Parameters>
  281. <Parameter Name="batchIndex" Type="System.UInt32" />
  282. <Parameter Name="level" Type="System.UInt32" />
  283. </Parameters>
  284. <Docs>
  285. <param name="batchIndex">To be added.</param>
  286. <param name="level">To be added.</param>
  287. <summary>
  288. Return the geometry for a specific LOD level.
  289. </summary>
  290. <returns>To be added.</returns>
  291. <remarks>To be added.</remarks>
  292. </Docs>
  293. </Member>
  294. <Member MemberName="HasBasePass">
  295. <MemberSignature Language="C#" Value="public bool HasBasePass (uint batchIndex);" />
  296. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasBasePass(unsigned int32 batchIndex) cil managed" />
  297. <MemberType>Method</MemberType>
  298. <AssemblyInfo>
  299. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  300. </AssemblyInfo>
  301. <ReturnValue>
  302. <ReturnType>System.Boolean</ReturnType>
  303. </ReturnValue>
  304. <Parameters>
  305. <Parameter Name="batchIndex" Type="System.UInt32" />
  306. </Parameters>
  307. <Docs>
  308. <param name="batchIndex">To be added.</param>
  309. <summary>
  310. Return whether has a base pass.
  311. </summary>
  312. <returns>To be added.</returns>
  313. <remarks>To be added.</remarks>
  314. </Docs>
  315. </Member>
  316. <Member MemberName="IsInView">
  317. <MemberSignature Language="C#" Value="public bool IsInView ();" />
  318. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsInView() cil managed" />
  319. <MemberType>Method</MemberType>
  320. <AssemblyInfo>
  321. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  322. </AssemblyInfo>
  323. <ReturnValue>
  324. <ReturnType>System.Boolean</ReturnType>
  325. </ReturnValue>
  326. <Parameters />
  327. <Docs>
  328. <summary>
  329. Return whether is in view this frame from any viewport camera. Excludes shadow map cameras.
  330. </summary>
  331. <returns>To be added.</returns>
  332. <remarks>To be added.</remarks>
  333. </Docs>
  334. </Member>
  335. <Member MemberName="IsInView">
  336. <MemberSignature Language="C#" Value="public bool IsInView (Urho.Camera camera);" />
  337. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsInView(class Urho.Camera camera) cil managed" />
  338. <MemberType>Method</MemberType>
  339. <AssemblyInfo>
  340. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  341. </AssemblyInfo>
  342. <ReturnValue>
  343. <ReturnType>System.Boolean</ReturnType>
  344. </ReturnValue>
  345. <Parameters>
  346. <Parameter Name="camera" Type="Urho.Camera" />
  347. </Parameters>
  348. <Docs>
  349. <param name="camera">To be added.</param>
  350. <summary>
  351. Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.
  352. </summary>
  353. <returns>To be added.</returns>
  354. <remarks>To be added.</remarks>
  355. </Docs>
  356. </Member>
  357. <Member MemberName="IsOccludee">
  358. <MemberSignature Language="C#" Value="public bool IsOccludee ();" />
  359. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsOccludee() cil managed" />
  360. <MemberType>Method</MemberType>
  361. <AssemblyInfo>
  362. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  363. </AssemblyInfo>
  364. <ReturnValue>
  365. <ReturnType>System.Boolean</ReturnType>
  366. </ReturnValue>
  367. <Parameters />
  368. <Docs>
  369. <summary>
  370. Return occludee flag.
  371. </summary>
  372. <returns>To be added.</returns>
  373. <remarks>To be added.</remarks>
  374. </Docs>
  375. </Member>
  376. <Member MemberName="IsOccluder">
  377. <MemberSignature Language="C#" Value="public bool IsOccluder ();" />
  378. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsOccluder() cil managed" />
  379. <MemberType>Method</MemberType>
  380. <AssemblyInfo>
  381. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  382. </AssemblyInfo>
  383. <ReturnValue>
  384. <ReturnType>System.Boolean</ReturnType>
  385. </ReturnValue>
  386. <Parameters />
  387. <Docs>
  388. <summary>
  389. Return occluder flag.
  390. </summary>
  391. <returns>To be added.</returns>
  392. <remarks>To be added.</remarks>
  393. </Docs>
  394. </Member>
  395. <Member MemberName="IsZoneDirty">
  396. <MemberSignature Language="C#" Value="public bool IsZoneDirty ();" />
  397. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsZoneDirty() cil managed" />
  398. <MemberType>Method</MemberType>
  399. <AssemblyInfo>
  400. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  401. </AssemblyInfo>
  402. <ReturnValue>
  403. <ReturnType>System.Boolean</ReturnType>
  404. </ReturnValue>
  405. <Parameters />
  406. <Docs>
  407. <summary>
  408. Return whether current zone is inconclusive or dirty due to the drawable moving.
  409. </summary>
  410. <returns>To be added.</returns>
  411. <remarks>To be added.</remarks>
  412. </Docs>
  413. </Member>
  414. <Member MemberName="LightMask">
  415. <MemberSignature Language="C#" Value="public uint LightMask { get; set; }" />
  416. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 LightMask" />
  417. <MemberType>Property</MemberType>
  418. <AssemblyInfo>
  419. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  420. </AssemblyInfo>
  421. <ReturnValue>
  422. <ReturnType>System.UInt32</ReturnType>
  423. </ReturnValue>
  424. <Docs>
  425. <summary>
  426. Return light mask.
  427. Or
  428. Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit.
  429. </summary>
  430. <value>To be added.</value>
  431. <remarks>To be added.</remarks>
  432. </Docs>
  433. </Member>
  434. <Member MemberName="LimitLights">
  435. <MemberSignature Language="C#" Value="public void LimitLights ();" />
  436. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void LimitLights() cil managed" />
  437. <MemberType>Method</MemberType>
  438. <AssemblyInfo>
  439. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  440. </AssemblyInfo>
  441. <ReturnValue>
  442. <ReturnType>System.Void</ReturnType>
  443. </ReturnValue>
  444. <Parameters />
  445. <Docs>
  446. <summary>
  447. Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.
  448. </summary>
  449. <remarks>To be added.</remarks>
  450. </Docs>
  451. </Member>
  452. <Member MemberName="LimitVertexLights">
  453. <MemberSignature Language="C#" Value="public void LimitVertexLights (bool removeConvertedLights);" />
  454. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void LimitVertexLights(bool removeConvertedLights) cil managed" />
  455. <MemberType>Method</MemberType>
  456. <AssemblyInfo>
  457. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  458. </AssemblyInfo>
  459. <ReturnValue>
  460. <ReturnType>System.Void</ReturnType>
  461. </ReturnValue>
  462. <Parameters>
  463. <Parameter Name="removeConvertedLights" Type="System.Boolean" />
  464. </Parameters>
  465. <Docs>
  466. <param name="removeConvertedLights">To be added.</param>
  467. <summary>
  468. Sort and limit per-vertex lights to maximum allowed.
  469. </summary>
  470. <remarks>To be added.</remarks>
  471. </Docs>
  472. </Member>
  473. <Member MemberName="LodBias">
  474. <MemberSignature Language="C#" Value="public float LodBias { get; set; }" />
  475. <MemberSignature Language="ILAsm" Value=".property instance float32 LodBias" />
  476. <MemberType>Property</MemberType>
  477. <AssemblyInfo>
  478. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  479. </AssemblyInfo>
  480. <ReturnValue>
  481. <ReturnType>System.Single</ReturnType>
  482. </ReturnValue>
  483. <Docs>
  484. <summary>
  485. Return LOD bias.
  486. Or
  487. Set LOD bias.
  488. </summary>
  489. <value>To be added.</value>
  490. <remarks>To be added.</remarks>
  491. </Docs>
  492. </Member>
  493. <Member MemberName="LodDistance">
  494. <MemberSignature Language="C#" Value="public float LodDistance { get; }" />
  495. <MemberSignature Language="ILAsm" Value=".property instance float32 LodDistance" />
  496. <MemberType>Property</MemberType>
  497. <AssemblyInfo>
  498. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  499. </AssemblyInfo>
  500. <ReturnValue>
  501. <ReturnType>System.Single</ReturnType>
  502. </ReturnValue>
  503. <Docs>
  504. <summary>
  505. Return LOD scaled distance from camera.
  506. </summary>
  507. <value>To be added.</value>
  508. <remarks>To be added.</remarks>
  509. </Docs>
  510. </Member>
  511. <Member MemberName="MarkForUpdate">
  512. <MemberSignature Language="C#" Value="public void MarkForUpdate ();" />
  513. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void MarkForUpdate() cil managed" />
  514. <MemberType>Method</MemberType>
  515. <AssemblyInfo>
  516. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  517. </AssemblyInfo>
  518. <ReturnValue>
  519. <ReturnType>System.Void</ReturnType>
  520. </ReturnValue>
  521. <Parameters />
  522. <Docs>
  523. <summary>
  524. Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
  525. </summary>
  526. <remarks>To be added.</remarks>
  527. </Docs>
  528. </Member>
  529. <Member MemberName="MarkInView">
  530. <MemberSignature Language="C#" Value="public void MarkInView (uint frameNumber);" />
  531. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void MarkInView(unsigned int32 frameNumber) cil managed" />
  532. <MemberType>Method</MemberType>
  533. <AssemblyInfo>
  534. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  535. </AssemblyInfo>
  536. <ReturnValue>
  537. <ReturnType>System.Void</ReturnType>
  538. </ReturnValue>
  539. <Parameters>
  540. <Parameter Name="frameNumber" Type="System.UInt32" />
  541. </Parameters>
  542. <Docs>
  543. <param name="frameNumber">To be added.</param>
  544. <summary>
  545. Mark in view without specifying a camera. Used for shadow casters.
  546. </summary>
  547. <remarks>To be added.</remarks>
  548. </Docs>
  549. </Member>
  550. <Member MemberName="MaxLights">
  551. <MemberSignature Language="C#" Value="public uint MaxLights { get; set; }" />
  552. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 MaxLights" />
  553. <MemberType>Property</MemberType>
  554. <AssemblyInfo>
  555. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  556. </AssemblyInfo>
  557. <ReturnValue>
  558. <ReturnType>System.UInt32</ReturnType>
  559. </ReturnValue>
  560. <Docs>
  561. <summary>
  562. Return maximum number of per-pixel lights.
  563. Or
  564. Set maximum number of per-pixel lights. Default 0 is unlimited.
  565. </summary>
  566. <value>To be added.</value>
  567. <remarks>To be added.</remarks>
  568. </Docs>
  569. </Member>
  570. <Member MemberName="MaxZ">
  571. <MemberSignature Language="C#" Value="public float MaxZ { get; }" />
  572. <MemberSignature Language="ILAsm" Value=".property instance float32 MaxZ" />
  573. <MemberType>Property</MemberType>
  574. <AssemblyInfo>
  575. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  576. </AssemblyInfo>
  577. <ReturnValue>
  578. <ReturnType>System.Single</ReturnType>
  579. </ReturnValue>
  580. <Docs>
  581. <summary>
  582. Return the maximum view-space depth.
  583. </summary>
  584. <value>To be added.</value>
  585. <remarks>To be added.</remarks>
  586. </Docs>
  587. </Member>
  588. <Member MemberName="MinZ">
  589. <MemberSignature Language="C#" Value="public float MinZ { get; }" />
  590. <MemberSignature Language="ILAsm" Value=".property instance float32 MinZ" />
  591. <MemberType>Property</MemberType>
  592. <AssemblyInfo>
  593. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  594. </AssemblyInfo>
  595. <ReturnValue>
  596. <ReturnType>System.Single</ReturnType>
  597. </ReturnValue>
  598. <Docs>
  599. <summary>
  600. Return the minimum view-space depth.
  601. </summary>
  602. <value>To be added.</value>
  603. <remarks>To be added.</remarks>
  604. </Docs>
  605. </Member>
  606. <Member MemberName="NumOccluderTriangles">
  607. <MemberSignature Language="C#" Value="public virtual uint NumOccluderTriangles { get; }" />
  608. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumOccluderTriangles" />
  609. <MemberType>Property</MemberType>
  610. <AssemblyInfo>
  611. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  612. </AssemblyInfo>
  613. <ReturnValue>
  614. <ReturnType>System.UInt32</ReturnType>
  615. </ReturnValue>
  616. <Docs>
  617. <summary>
  618. Return number of occlusion geometry triangles.
  619. </summary>
  620. <value>To be added.</value>
  621. <remarks>To be added.</remarks>
  622. </Docs>
  623. </Member>
  624. <Member MemberName="Octant">
  625. <MemberSignature Language="C#" Value="public Urho.Octant* Octant { get; }" />
  626. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Octant* Octant" />
  627. <MemberType>Property</MemberType>
  628. <AssemblyInfo>
  629. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  630. </AssemblyInfo>
  631. <ReturnValue>
  632. <ReturnType>Urho.Octant*</ReturnType>
  633. </ReturnValue>
  634. <Docs>
  635. <summary>
  636. Return octree octant.
  637. </summary>
  638. <value>To be added.</value>
  639. <remarks>To be added.</remarks>
  640. </Docs>
  641. </Member>
  642. <Member MemberName="OnSetEnabled">
  643. <MemberSignature Language="C#" Value="public override void OnSetEnabled ();" />
  644. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void OnSetEnabled() cil managed" />
  645. <MemberType>Method</MemberType>
  646. <AssemblyInfo>
  647. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  648. </AssemblyInfo>
  649. <ReturnValue>
  650. <ReturnType>System.Void</ReturnType>
  651. </ReturnValue>
  652. <Parameters />
  653. <Docs>
  654. <summary>
  655. Handle enabled/disabled state change.
  656. </summary>
  657. <remarks>To be added.</remarks>
  658. </Docs>
  659. </Member>
  660. <Member MemberName="RegisterObject">
  661. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  662. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  663. <MemberType>Method</MemberType>
  664. <AssemblyInfo>
  665. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  666. </AssemblyInfo>
  667. <ReturnValue>
  668. <ReturnType>System.Void</ReturnType>
  669. </ReturnValue>
  670. <Parameters>
  671. <Parameter Name="context" Type="Urho.Context" />
  672. </Parameters>
  673. <Docs>
  674. <param name="context">To be added.</param>
  675. <summary>
  676. Register object attributes. Drawable must be registered first.
  677. </summary>
  678. <remarks>To be added.</remarks>
  679. </Docs>
  680. </Member>
  681. <Member MemberName="SetBasePass">
  682. <MemberSignature Language="C#" Value="public void SetBasePass (uint batchIndex);" />
  683. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetBasePass(unsigned int32 batchIndex) cil managed" />
  684. <MemberType>Method</MemberType>
  685. <AssemblyInfo>
  686. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  687. </AssemblyInfo>
  688. <ReturnValue>
  689. <ReturnType>System.Void</ReturnType>
  690. </ReturnValue>
  691. <Parameters>
  692. <Parameter Name="batchIndex" Type="System.UInt32" />
  693. </Parameters>
  694. <Docs>
  695. <param name="batchIndex">To be added.</param>
  696. <summary>
  697. Set base pass flag for a batch.
  698. </summary>
  699. <remarks>To be added.</remarks>
  700. </Docs>
  701. </Member>
  702. <Member MemberName="SetMinMaxZ">
  703. <MemberSignature Language="C#" Value="public void SetMinMaxZ (float minZ, float maxZ);" />
  704. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetMinMaxZ(float32 minZ, float32 maxZ) cil managed" />
  705. <MemberType>Method</MemberType>
  706. <AssemblyInfo>
  707. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  708. </AssemblyInfo>
  709. <ReturnValue>
  710. <ReturnType>System.Void</ReturnType>
  711. </ReturnValue>
  712. <Parameters>
  713. <Parameter Name="minZ" Type="System.Single" />
  714. <Parameter Name="maxZ" Type="System.Single" />
  715. </Parameters>
  716. <Docs>
  717. <param name="minZ">To be added.</param>
  718. <param name="maxZ">To be added.</param>
  719. <summary>
  720. Set view-space depth bounds.
  721. </summary>
  722. <remarks>To be added.</remarks>
  723. </Docs>
  724. </Member>
  725. <Member MemberName="SetOccludee">
  726. <MemberSignature Language="C#" Value="public void SetOccludee (bool enable);" />
  727. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetOccludee(bool enable) cil managed" />
  728. <MemberType>Method</MemberType>
  729. <AssemblyInfo>
  730. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  731. </AssemblyInfo>
  732. <ReturnValue>
  733. <ReturnType>System.Void</ReturnType>
  734. </ReturnValue>
  735. <Parameters>
  736. <Parameter Name="enable" Type="System.Boolean" />
  737. </Parameters>
  738. <Docs>
  739. <param name="enable">To be added.</param>
  740. <summary>
  741. Set occludee flag.
  742. </summary>
  743. <remarks>To be added.</remarks>
  744. </Docs>
  745. </Member>
  746. <Member MemberName="SetOccluder">
  747. <MemberSignature Language="C#" Value="public void SetOccluder (bool enable);" />
  748. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetOccluder(bool enable) cil managed" />
  749. <MemberType>Method</MemberType>
  750. <AssemblyInfo>
  751. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  752. </AssemblyInfo>
  753. <ReturnValue>
  754. <ReturnType>System.Void</ReturnType>
  755. </ReturnValue>
  756. <Parameters>
  757. <Parameter Name="enable" Type="System.Boolean" />
  758. </Parameters>
  759. <Docs>
  760. <param name="enable">To be added.</param>
  761. <summary>
  762. Set occlusion flag.
  763. </summary>
  764. <remarks>To be added.</remarks>
  765. </Docs>
  766. </Member>
  767. <Member MemberName="SetZone">
  768. <MemberSignature Language="C#" Value="public void SetZone (Urho.Zone zone, bool temporary);" />
  769. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetZone(class Urho.Zone zone, bool temporary) cil managed" />
  770. <MemberType>Method</MemberType>
  771. <AssemblyInfo>
  772. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  773. </AssemblyInfo>
  774. <ReturnValue>
  775. <ReturnType>System.Void</ReturnType>
  776. </ReturnValue>
  777. <Parameters>
  778. <Parameter Name="zone" Type="Urho.Zone" />
  779. <Parameter Name="temporary" Type="System.Boolean" />
  780. </Parameters>
  781. <Docs>
  782. <param name="zone">To be added.</param>
  783. <param name="temporary">To be added.</param>
  784. <summary>
  785. Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.
  786. </summary>
  787. <remarks>To be added.</remarks>
  788. </Docs>
  789. </Member>
  790. <Member MemberName="ShadowDistance">
  791. <MemberSignature Language="C#" Value="public float ShadowDistance { get; set; }" />
  792. <MemberSignature Language="ILAsm" Value=".property instance float32 ShadowDistance" />
  793. <MemberType>Property</MemberType>
  794. <AssemblyInfo>
  795. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  796. </AssemblyInfo>
  797. <ReturnValue>
  798. <ReturnType>System.Single</ReturnType>
  799. </ReturnValue>
  800. <Docs>
  801. <summary>
  802. Return shadow draw distance.
  803. Or
  804. Set shadow draw distance.
  805. </summary>
  806. <value>To be added.</value>
  807. <remarks>To be added.</remarks>
  808. </Docs>
  809. </Member>
  810. <Member MemberName="ShadowMask">
  811. <MemberSignature Language="C#" Value="public uint ShadowMask { get; set; }" />
  812. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 ShadowMask" />
  813. <MemberType>Property</MemberType>
  814. <AssemblyInfo>
  815. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  816. </AssemblyInfo>
  817. <ReturnValue>
  818. <ReturnType>System.UInt32</ReturnType>
  819. </ReturnValue>
  820. <Docs>
  821. <summary>
  822. Return shadow mask.
  823. Or
  824. Set shadow mask. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map.
  825. </summary>
  826. <value>To be added.</value>
  827. <remarks>To be added.</remarks>
  828. </Docs>
  829. </Member>
  830. <Member MemberName="SortValue">
  831. <MemberSignature Language="C#" Value="public float SortValue { get; set; }" />
  832. <MemberSignature Language="ILAsm" Value=".property instance float32 SortValue" />
  833. <MemberType>Property</MemberType>
  834. <AssemblyInfo>
  835. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  836. </AssemblyInfo>
  837. <ReturnValue>
  838. <ReturnType>System.Single</ReturnType>
  839. </ReturnValue>
  840. <Docs>
  841. <summary>
  842. Return sorting value.
  843. Or
  844. Set sorting value.
  845. </summary>
  846. <value>To be added.</value>
  847. <remarks>To be added.</remarks>
  848. </Docs>
  849. </Member>
  850. <Member MemberName="Type">
  851. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  852. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  853. <MemberType>Property</MemberType>
  854. <AssemblyInfo>
  855. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  856. </AssemblyInfo>
  857. <ReturnValue>
  858. <ReturnType>Urho.StringHash</ReturnType>
  859. </ReturnValue>
  860. <Docs>
  861. <summary>Urho's type system type.</summary>
  862. <value>StringHash representing the type for this C# type.</value>
  863. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  864. </Docs>
  865. </Member>
  866. <Member MemberName="TypeName">
  867. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  868. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  869. <MemberType>Property</MemberType>
  870. <AssemblyInfo>
  871. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  872. </AssemblyInfo>
  873. <ReturnValue>
  874. <ReturnType>System.String</ReturnType>
  875. </ReturnValue>
  876. <Docs>
  877. <summary>Urho's low-level type name.</summary>
  878. <value>Stringified low-level type name.</value>
  879. <remarks></remarks>
  880. </Docs>
  881. </Member>
  882. <Member MemberName="TypeNameStatic">
  883. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  884. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  885. <MemberType>Property</MemberType>
  886. <AssemblyInfo>
  887. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  888. </AssemblyInfo>
  889. <ReturnValue>
  890. <ReturnType>System.String</ReturnType>
  891. </ReturnValue>
  892. <Docs>
  893. <summary>Urho's low-level type name, accessible as a static method.</summary>
  894. <value>Stringified low-level type name.</value>
  895. <remarks></remarks>
  896. </Docs>
  897. </Member>
  898. <Member MemberName="TypeStatic">
  899. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  900. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  901. <MemberType>Property</MemberType>
  902. <AssemblyInfo>
  903. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  904. </AssemblyInfo>
  905. <ReturnValue>
  906. <ReturnType>Urho.StringHash</ReturnType>
  907. </ReturnValue>
  908. <Docs>
  909. <summary>To be added.</summary>
  910. <value>To be added.</value>
  911. <remarks>To be added.</remarks>
  912. </Docs>
  913. </Member>
  914. <Member MemberName="UpdateGeometryType">
  915. <MemberSignature Language="C#" Value="public virtual Urho.UpdateGeometryType UpdateGeometryType { get; }" />
  916. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.UpdateGeometryType UpdateGeometryType" />
  917. <MemberType>Property</MemberType>
  918. <AssemblyInfo>
  919. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  920. </AssemblyInfo>
  921. <ReturnValue>
  922. <ReturnType>Urho.UpdateGeometryType</ReturnType>
  923. </ReturnValue>
  924. <Docs>
  925. <summary>
  926. Return whether a geometry update is necessary, and if it can happen in a worker thread.
  927. </summary>
  928. <value>To be added.</value>
  929. <remarks>To be added.</remarks>
  930. </Docs>
  931. </Member>
  932. <Member MemberName="ViewMask">
  933. <MemberSignature Language="C#" Value="public uint ViewMask { get; set; }" />
  934. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 ViewMask" />
  935. <MemberType>Property</MemberType>
  936. <AssemblyInfo>
  937. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  938. </AssemblyInfo>
  939. <ReturnValue>
  940. <ReturnType>System.UInt32</ReturnType>
  941. </ReturnValue>
  942. <Docs>
  943. <summary>
  944. Return view mask.
  945. Or
  946. Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.
  947. </summary>
  948. <value>To be added.</value>
  949. <remarks>To be added.</remarks>
  950. </Docs>
  951. </Member>
  952. <Member MemberName="WorldBoundingBox">
  953. <MemberSignature Language="C#" Value="public Urho.BoundingBox WorldBoundingBox { get; }" />
  954. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.BoundingBox WorldBoundingBox" />
  955. <MemberType>Property</MemberType>
  956. <AssemblyInfo>
  957. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  958. </AssemblyInfo>
  959. <ReturnValue>
  960. <ReturnType>Urho.BoundingBox</ReturnType>
  961. </ReturnValue>
  962. <Docs>
  963. <summary>
  964. Return world-space bounding box.
  965. </summary>
  966. <value>To be added.</value>
  967. <remarks>To be added.</remarks>
  968. </Docs>
  969. </Member>
  970. <Member MemberName="Zone">
  971. <MemberSignature Language="C#" Value="public Urho.Zone Zone { get; }" />
  972. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Zone Zone" />
  973. <MemberType>Property</MemberType>
  974. <AssemblyInfo>
  975. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  976. </AssemblyInfo>
  977. <ReturnValue>
  978. <ReturnType>Urho.Zone</ReturnType>
  979. </ReturnValue>
  980. <Docs>
  981. <summary>
  982. Return current zone.
  983. </summary>
  984. <value>To be added.</value>
  985. <remarks>To be added.</remarks>
  986. </Docs>
  987. </Member>
  988. <Member MemberName="ZoneMask">
  989. <MemberSignature Language="C#" Value="public uint ZoneMask { get; set; }" />
  990. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 ZoneMask" />
  991. <MemberType>Property</MemberType>
  992. <AssemblyInfo>
  993. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  994. </AssemblyInfo>
  995. <ReturnValue>
  996. <ReturnType>System.UInt32</ReturnType>
  997. </ReturnValue>
  998. <Docs>
  999. <summary>
  1000. Return zone mask.
  1001. Or
  1002. Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.
  1003. </summary>
  1004. <value>To be added.</value>
  1005. <remarks>To be added.</remarks>
  1006. </Docs>
  1007. </Member>
  1008. </Members>
  1009. </Type>