Camera.xml 40 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015
  1. <Type Name="Camera" FullName="Urho.Camera">
  2. <TypeSignature Language="C#" Value="public class Camera : Urho.Component" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Camera 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>Camera component.
  14. </summary>
  15. <remarks>To be added.</remarks>
  16. </Docs>
  17. <Members>
  18. <Member MemberName=".ctor">
  19. <MemberSignature Language="C#" Value="public Camera ();" />
  20. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  21. <MemberType>Constructor</MemberType>
  22. <AssemblyInfo>
  23. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  24. </AssemblyInfo>
  25. <Parameters />
  26. <Docs>
  27. <summary>
  28. <para>Constructs a new instance of Urho.Camera which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  29. </summary>
  30. <remarks></remarks>
  31. </Docs>
  32. </Member>
  33. <Member MemberName=".ctor">
  34. <MemberSignature Language="C#" Value="public Camera (IntPtr handle);" />
  35. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  36. <MemberType>Constructor</MemberType>
  37. <AssemblyInfo>
  38. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  39. </AssemblyInfo>
  40. <Parameters>
  41. <Parameter Name="handle" Type="System.IntPtr" />
  42. </Parameters>
  43. <Docs>
  44. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  45. <summary>Constructs a new instance of Urho.Camera, given a raw pointer to an unmanaged object</summary>
  46. <remarks>
  47. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  48. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  49. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  50. </remarks>
  51. </Docs>
  52. </Member>
  53. <Member MemberName=".ctor">
  54. <MemberSignature Language="C#" Value="public Camera (Urho.Context context);" />
  55. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  56. <MemberType>Constructor</MemberType>
  57. <AssemblyInfo>
  58. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  59. </AssemblyInfo>
  60. <Parameters>
  61. <Parameter Name="context" Type="Urho.Context" />
  62. </Parameters>
  63. <Docs>
  64. <param name="context">The context that this object will be attached to.</param>
  65. <summary>
  66. <para>Constructs a new instance of Urho.Camera linked to a specific <see cref="T:Urho.Context" />.</para>
  67. </summary>
  68. <remarks></remarks>
  69. </Docs>
  70. </Member>
  71. <Member MemberName=".ctor">
  72. <MemberSignature Language="C#" Value="protected Camera (Urho.UrhoObjectFlag emptyFlag);" />
  73. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  74. <MemberType>Constructor</MemberType>
  75. <AssemblyInfo>
  76. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  77. </AssemblyInfo>
  78. <Parameters>
  79. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  80. </Parameters>
  81. <Docs>
  82. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  83. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  84. <remarks>
  85. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  86. <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>
  87. <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>
  88. </remarks>
  89. </Docs>
  90. </Member>
  91. <Member MemberName="AspectRatio">
  92. <MemberSignature Language="C#" Value="public float AspectRatio { get; set; }" />
  93. <MemberSignature Language="ILAsm" Value=".property instance float32 AspectRatio" />
  94. <MemberType>Property</MemberType>
  95. <AssemblyInfo>
  96. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  97. </AssemblyInfo>
  98. <ReturnValue>
  99. <ReturnType>System.Single</ReturnType>
  100. </ReturnValue>
  101. <Docs>
  102. <summary>
  103. Return aspect ratio.
  104. Or
  105. Set aspect ratio manually. Disables the auto aspect ratio -mode.
  106. </summary>
  107. <value>To be added.</value>
  108. <remarks>To be added.</remarks>
  109. </Docs>
  110. </Member>
  111. <Member MemberName="AutoAspectRatio">
  112. <MemberSignature Language="C#" Value="public bool AutoAspectRatio { get; set; }" />
  113. <MemberSignature Language="ILAsm" Value=".property instance bool AutoAspectRatio" />
  114. <MemberType>Property</MemberType>
  115. <AssemblyInfo>
  116. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  117. </AssemblyInfo>
  118. <ReturnValue>
  119. <ReturnType>System.Boolean</ReturnType>
  120. </ReturnValue>
  121. <Docs>
  122. <summary>
  123. Return auto aspect ratio flag.
  124. Or
  125. Set automatic aspect ratio based on viewport dimensions. Enabled by default.
  126. </summary>
  127. <value>To be added.</value>
  128. <remarks>To be added.</remarks>
  129. </Docs>
  130. </Member>
  131. <Member MemberName="ClipPlane">
  132. <MemberSignature Language="C#" Value="public Urho.Plane ClipPlane { get; set; }" />
  133. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Plane ClipPlane" />
  134. <MemberType>Property</MemberType>
  135. <AssemblyInfo>
  136. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  137. </AssemblyInfo>
  138. <ReturnValue>
  139. <ReturnType>Urho.Plane</ReturnType>
  140. </ReturnValue>
  141. <Docs>
  142. <summary>
  143. Return the custom clipping plane.
  144. Or
  145. Set custom clipping plane in world space.
  146. </summary>
  147. <value>To be added.</value>
  148. <remarks>To be added.</remarks>
  149. </Docs>
  150. </Member>
  151. <Member MemberName="ClipPlaneAttr">
  152. <MemberSignature Language="C#" Value="public Urho.Vector4 ClipPlaneAttr { get; }" />
  153. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Vector4 ClipPlaneAttr" />
  154. <MemberType>Property</MemberType>
  155. <AssemblyInfo>
  156. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  157. </AssemblyInfo>
  158. <ReturnValue>
  159. <ReturnType>Urho.Vector4</ReturnType>
  160. </ReturnValue>
  161. <Docs>
  162. <summary>
  163. Return clipping plane attribute.
  164. </summary>
  165. <value>To be added.</value>
  166. <remarks>To be added.</remarks>
  167. </Docs>
  168. </Member>
  169. <Member MemberName="DrawDebugGeometry">
  170. <MemberSignature Language="C#" Value="public override void DrawDebugGeometry (Urho.DebugRenderer debug, bool depthTest);" />
  171. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void DrawDebugGeometry(class Urho.DebugRenderer debug, bool depthTest) 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="debug" Type="Urho.DebugRenderer" />
  181. <Parameter Name="depthTest" Type="System.Boolean" />
  182. </Parameters>
  183. <Docs>
  184. <param name="debug">To be added.</param>
  185. <param name="depthTest">To be added.</param>
  186. <summary>
  187. Visualize the component as debug geometry.
  188. </summary>
  189. <remarks>To be added.</remarks>
  190. </Docs>
  191. </Member>
  192. <Member MemberName="EffectiveWorldTransform">
  193. <MemberSignature Language="C#" Value="public Urho.Matrix3x4 EffectiveWorldTransform { get; }" />
  194. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Matrix3x4 EffectiveWorldTransform" />
  195. <MemberType>Property</MemberType>
  196. <AssemblyInfo>
  197. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  198. </AssemblyInfo>
  199. <ReturnValue>
  200. <ReturnType>Urho.Matrix3x4</ReturnType>
  201. </ReturnValue>
  202. <Docs>
  203. <summary>
  204. Get effective world transform for matrix and frustum calculations including reflection but excluding node scaling.
  205. </summary>
  206. <value>To be added.</value>
  207. <remarks>To be added.</remarks>
  208. </Docs>
  209. </Member>
  210. <Member MemberName="FarClip">
  211. <MemberSignature Language="C#" Value="public float FarClip { get; set; }" />
  212. <MemberSignature Language="ILAsm" Value=".property instance float32 FarClip" />
  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 far clip distance.
  223. Or
  224. Set far clip distance.
  225. </summary>
  226. <value>To be added.</value>
  227. <remarks>To be added.</remarks>
  228. </Docs>
  229. </Member>
  230. <Member MemberName="FillMode">
  231. <MemberSignature Language="C#" Value="public Urho.FillMode FillMode { get; set; }" />
  232. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.FillMode FillMode" />
  233. <MemberType>Property</MemberType>
  234. <AssemblyInfo>
  235. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  236. </AssemblyInfo>
  237. <ReturnValue>
  238. <ReturnType>Urho.FillMode</ReturnType>
  239. </ReturnValue>
  240. <Docs>
  241. <summary>
  242. Return fill mode.
  243. Or
  244. Set polygon fill mode to use when rendering a scene.
  245. </summary>
  246. <value>To be added.</value>
  247. <remarks>To be added.</remarks>
  248. </Docs>
  249. </Member>
  250. <Member MemberName="FlipVertical">
  251. <MemberSignature Language="C#" Value="public bool FlipVertical { get; set; }" />
  252. <MemberSignature Language="ILAsm" Value=".property instance bool FlipVertical" />
  253. <MemberType>Property</MemberType>
  254. <AssemblyInfo>
  255. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  256. </AssemblyInfo>
  257. <ReturnValue>
  258. <ReturnType>System.Boolean</ReturnType>
  259. </ReturnValue>
  260. <Docs>
  261. <summary>
  262. Return vertical flipping mode.
  263. Or
  264. Set vertical flipping mode. Called internally by View to resolve OpenGL / Direct3D9 rendertarget sampling differences.
  265. </summary>
  266. <value>To be added.</value>
  267. <remarks>To be added.</remarks>
  268. </Docs>
  269. </Member>
  270. <Member MemberName="Fov">
  271. <MemberSignature Language="C#" Value="public float Fov { get; set; }" />
  272. <MemberSignature Language="ILAsm" Value=".property instance float32 Fov" />
  273. <MemberType>Property</MemberType>
  274. <AssemblyInfo>
  275. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  276. </AssemblyInfo>
  277. <ReturnValue>
  278. <ReturnType>System.Single</ReturnType>
  279. </ReturnValue>
  280. <Docs>
  281. <summary>
  282. Return vertical field of view in degrees.
  283. Or
  284. Set vertical field of view in degrees.
  285. </summary>
  286. <value>To be added.</value>
  287. <remarks>To be added.</remarks>
  288. </Docs>
  289. </Member>
  290. <Member MemberName="GetDistance">
  291. <MemberSignature Language="C#" Value="public float GetDistance (Urho.Vector3 worldPos);" />
  292. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetDistance(valuetype Urho.Vector3 worldPos) cil managed" />
  293. <MemberType>Method</MemberType>
  294. <AssemblyInfo>
  295. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  296. </AssemblyInfo>
  297. <ReturnValue>
  298. <ReturnType>System.Single</ReturnType>
  299. </ReturnValue>
  300. <Parameters>
  301. <Parameter Name="worldPos" Type="Urho.Vector3" />
  302. </Parameters>
  303. <Docs>
  304. <param name="worldPos">To be added.</param>
  305. <summary>
  306. Return distance to position. In orthographic mode uses only Z coordinate.
  307. </summary>
  308. <returns>To be added.</returns>
  309. <remarks>To be added.</remarks>
  310. </Docs>
  311. </Member>
  312. <Member MemberName="GetDistanceSquared">
  313. <MemberSignature Language="C#" Value="public float GetDistanceSquared (Urho.Vector3 worldPos);" />
  314. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetDistanceSquared(valuetype Urho.Vector3 worldPos) cil managed" />
  315. <MemberType>Method</MemberType>
  316. <AssemblyInfo>
  317. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  318. </AssemblyInfo>
  319. <ReturnValue>
  320. <ReturnType>System.Single</ReturnType>
  321. </ReturnValue>
  322. <Parameters>
  323. <Parameter Name="worldPos" Type="Urho.Vector3" />
  324. </Parameters>
  325. <Docs>
  326. <param name="worldPos">To be added.</param>
  327. <summary>
  328. Return squared distance to position. In orthographic mode uses only Z coordinate.
  329. </summary>
  330. <returns>To be added.</returns>
  331. <remarks>To be added.</remarks>
  332. </Docs>
  333. </Member>
  334. <Member MemberName="GetFaceCameraRotation">
  335. <MemberSignature Language="C#" Value="public Urho.Quaternion GetFaceCameraRotation (Urho.Vector3 position, Urho.Quaternion rotation, Urho.FaceCameraMode mode);" />
  336. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Quaternion GetFaceCameraRotation(valuetype Urho.Vector3 position, valuetype Urho.Quaternion rotation, valuetype Urho.FaceCameraMode mode) cil managed" />
  337. <MemberType>Method</MemberType>
  338. <AssemblyInfo>
  339. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  340. </AssemblyInfo>
  341. <ReturnValue>
  342. <ReturnType>Urho.Quaternion</ReturnType>
  343. </ReturnValue>
  344. <Parameters>
  345. <Parameter Name="position" Type="Urho.Vector3" />
  346. <Parameter Name="rotation" Type="Urho.Quaternion" />
  347. <Parameter Name="mode" Type="Urho.FaceCameraMode" />
  348. </Parameters>
  349. <Docs>
  350. <param name="position">To be added.</param>
  351. <param name="rotation">To be added.</param>
  352. <param name="mode">To be added.</param>
  353. <summary>
  354. Return a world rotation for facing a camera on certain axes based on the existing world rotation.
  355. </summary>
  356. <returns>To be added.</returns>
  357. <remarks>To be added.</remarks>
  358. </Docs>
  359. </Member>
  360. <Member MemberName="GetLodDistance">
  361. <MemberSignature Language="C#" Value="public float GetLodDistance (float distance, float scale, float bias);" />
  362. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetLodDistance(float32 distance, float32 scale, float32 bias) cil managed" />
  363. <MemberType>Method</MemberType>
  364. <AssemblyInfo>
  365. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  366. </AssemblyInfo>
  367. <ReturnValue>
  368. <ReturnType>System.Single</ReturnType>
  369. </ReturnValue>
  370. <Parameters>
  371. <Parameter Name="distance" Type="System.Single" />
  372. <Parameter Name="scale" Type="System.Single" />
  373. <Parameter Name="bias" Type="System.Single" />
  374. </Parameters>
  375. <Docs>
  376. <param name="distance">To be added.</param>
  377. <param name="scale">To be added.</param>
  378. <param name="bias">To be added.</param>
  379. <summary>
  380. Return a scene node's LOD scaled distance.
  381. </summary>
  382. <returns>To be added.</returns>
  383. <remarks>To be added.</remarks>
  384. </Docs>
  385. </Member>
  386. <Member MemberName="GetProjection">
  387. <MemberSignature Language="C#" Value="public Urho.Matrix4 GetProjection (bool apiSpecific);" />
  388. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Matrix4 GetProjection(bool apiSpecific) cil managed" />
  389. <MemberType>Method</MemberType>
  390. <AssemblyInfo>
  391. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  392. </AssemblyInfo>
  393. <ReturnValue>
  394. <ReturnType>Urho.Matrix4</ReturnType>
  395. </ReturnValue>
  396. <Parameters>
  397. <Parameter Name="apiSpecific" Type="System.Boolean" />
  398. </Parameters>
  399. <Docs>
  400. <param name="apiSpecific">To be added.</param>
  401. <summary>
  402. Return either API-specific or API-independent (D3D convention) projection matrix.
  403. </summary>
  404. <returns>To be added.</returns>
  405. <remarks>To be added.</remarks>
  406. </Docs>
  407. </Member>
  408. <Member MemberName="GetScreenRay">
  409. <MemberSignature Language="C#" Value="public Urho.Ray GetScreenRay (float x, float y);" />
  410. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Ray GetScreenRay(float32 x, float32 y) cil managed" />
  411. <MemberType>Method</MemberType>
  412. <AssemblyInfo>
  413. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  414. </AssemblyInfo>
  415. <ReturnValue>
  416. <ReturnType>Urho.Ray</ReturnType>
  417. </ReturnValue>
  418. <Parameters>
  419. <Parameter Name="x" Type="System.Single" />
  420. <Parameter Name="y" Type="System.Single" />
  421. </Parameters>
  422. <Docs>
  423. <param name="x">To be added.</param>
  424. <param name="y">To be added.</param>
  425. <summary>
  426. Return ray corresponding to normalized screen coordinates (0.0 - 1.0).
  427. </summary>
  428. <returns>To be added.</returns>
  429. <remarks>To be added.</remarks>
  430. </Docs>
  431. </Member>
  432. <Member MemberName="GetSplitFrustum">
  433. <MemberSignature Language="C#" Value="public Urho.Frustum GetSplitFrustum (float nearClip, float farClip);" />
  434. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Frustum GetSplitFrustum(float32 nearClip, float32 farClip) cil managed" />
  435. <MemberType>Method</MemberType>
  436. <AssemblyInfo>
  437. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  438. </AssemblyInfo>
  439. <ReturnValue>
  440. <ReturnType>Urho.Frustum</ReturnType>
  441. </ReturnValue>
  442. <Parameters>
  443. <Parameter Name="nearClip" Type="System.Single" />
  444. <Parameter Name="farClip" Type="System.Single" />
  445. </Parameters>
  446. <Docs>
  447. <param name="nearClip">To be added.</param>
  448. <param name="farClip">To be added.</param>
  449. <summary>
  450. Return frustum split by custom near and far clip distances.
  451. </summary>
  452. <returns>To be added.</returns>
  453. <remarks>To be added.</remarks>
  454. </Docs>
  455. </Member>
  456. <Member MemberName="GetViewSpaceSplitFrustum">
  457. <MemberSignature Language="C#" Value="public Urho.Frustum GetViewSpaceSplitFrustum (float nearClip, float farClip);" />
  458. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Frustum GetViewSpaceSplitFrustum(float32 nearClip, float32 farClip) cil managed" />
  459. <MemberType>Method</MemberType>
  460. <AssemblyInfo>
  461. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  462. </AssemblyInfo>
  463. <ReturnValue>
  464. <ReturnType>Urho.Frustum</ReturnType>
  465. </ReturnValue>
  466. <Parameters>
  467. <Parameter Name="nearClip" Type="System.Single" />
  468. <Parameter Name="farClip" Type="System.Single" />
  469. </Parameters>
  470. <Docs>
  471. <param name="nearClip">To be added.</param>
  472. <param name="farClip">To be added.</param>
  473. <summary>
  474. Return split frustum in view space.
  475. </summary>
  476. <returns>To be added.</returns>
  477. <remarks>To be added.</remarks>
  478. </Docs>
  479. </Member>
  480. <Member MemberName="HalfViewSize">
  481. <MemberSignature Language="C#" Value="public float HalfViewSize { get; }" />
  482. <MemberSignature Language="ILAsm" Value=".property instance float32 HalfViewSize" />
  483. <MemberType>Property</MemberType>
  484. <AssemblyInfo>
  485. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  486. </AssemblyInfo>
  487. <ReturnValue>
  488. <ReturnType>System.Single</ReturnType>
  489. </ReturnValue>
  490. <Docs>
  491. <summary>
  492. Return half view size.
  493. </summary>
  494. <value>To be added.</value>
  495. <remarks>To be added.</remarks>
  496. </Docs>
  497. </Member>
  498. <Member MemberName="LodBias">
  499. <MemberSignature Language="C#" Value="public float LodBias { get; set; }" />
  500. <MemberSignature Language="ILAsm" Value=".property instance float32 LodBias" />
  501. <MemberType>Property</MemberType>
  502. <AssemblyInfo>
  503. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  504. </AssemblyInfo>
  505. <ReturnValue>
  506. <ReturnType>System.Single</ReturnType>
  507. </ReturnValue>
  508. <Docs>
  509. <summary>
  510. Return LOD bias.
  511. Or
  512. Set LOD bias.
  513. </summary>
  514. <value>To be added.</value>
  515. <remarks>To be added.</remarks>
  516. </Docs>
  517. </Member>
  518. <Member MemberName="NearClip">
  519. <MemberSignature Language="C#" Value="public float NearClip { get; set; }" />
  520. <MemberSignature Language="ILAsm" Value=".property instance float32 NearClip" />
  521. <MemberType>Property</MemberType>
  522. <AssemblyInfo>
  523. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  524. </AssemblyInfo>
  525. <ReturnValue>
  526. <ReturnType>System.Single</ReturnType>
  527. </ReturnValue>
  528. <Docs>
  529. <summary>
  530. Return near clip distance.
  531. Or
  532. Set near clip distance.
  533. </summary>
  534. <value>To be added.</value>
  535. <remarks>To be added.</remarks>
  536. </Docs>
  537. </Member>
  538. <Member MemberName="Orthographic">
  539. <MemberSignature Language="C#" Value="public bool Orthographic { get; set; }" />
  540. <MemberSignature Language="ILAsm" Value=".property instance bool Orthographic" />
  541. <MemberType>Property</MemberType>
  542. <AssemblyInfo>
  543. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  544. </AssemblyInfo>
  545. <ReturnValue>
  546. <ReturnType>System.Boolean</ReturnType>
  547. </ReturnValue>
  548. <Docs>
  549. <summary>Determines whether the camera is Orthographic or not.</summary>
  550. <value>To be added.</value>
  551. <remarks>To be added.</remarks>
  552. </Docs>
  553. </Member>
  554. <Member MemberName="OrthoSize">
  555. <MemberSignature Language="C#" Value="public float OrthoSize { get; set; }" />
  556. <MemberSignature Language="ILAsm" Value=".property instance float32 OrthoSize" />
  557. <MemberType>Property</MemberType>
  558. <AssemblyInfo>
  559. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  560. </AssemblyInfo>
  561. <ReturnValue>
  562. <ReturnType>System.Single</ReturnType>
  563. </ReturnValue>
  564. <Docs>
  565. <summary>
  566. Return orthographic mode size.
  567. Or
  568. Set orthographic mode view uniform size.
  569. </summary>
  570. <value>To be added.</value>
  571. <remarks>To be added.</remarks>
  572. </Docs>
  573. </Member>
  574. <Member MemberName="ProjectionOffset">
  575. <MemberSignature Language="C#" Value="public Urho.Vector2 ProjectionOffset { get; set; }" />
  576. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Vector2 ProjectionOffset" />
  577. <MemberType>Property</MemberType>
  578. <AssemblyInfo>
  579. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  580. </AssemblyInfo>
  581. <ReturnValue>
  582. <ReturnType>Urho.Vector2</ReturnType>
  583. </ReturnValue>
  584. <Docs>
  585. <summary>
  586. Return projection offset.
  587. Or
  588. Set projection offset. It needs to be calculated as (offset in pixels) / (viewport dimensions.)
  589. </summary>
  590. <value>To be added.</value>
  591. <remarks>To be added.</remarks>
  592. </Docs>
  593. </Member>
  594. <Member MemberName="ProjectionValid">
  595. <MemberSignature Language="C#" Value="public bool ProjectionValid { get; }" />
  596. <MemberSignature Language="ILAsm" Value=".property instance bool ProjectionValid" />
  597. <MemberType>Property</MemberType>
  598. <AssemblyInfo>
  599. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  600. </AssemblyInfo>
  601. <ReturnValue>
  602. <ReturnType>System.Boolean</ReturnType>
  603. </ReturnValue>
  604. <Docs>
  605. <summary>Return if projection parameters are valid for rendering and raycasting.</summary>
  606. <value>To be added.</value>
  607. <remarks>To be added.</remarks>
  608. </Docs>
  609. </Member>
  610. <Member MemberName="ReflectionPlane">
  611. <MemberSignature Language="C#" Value="public Urho.Plane ReflectionPlane { get; set; }" />
  612. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Plane ReflectionPlane" />
  613. <MemberType>Property</MemberType>
  614. <AssemblyInfo>
  615. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  616. </AssemblyInfo>
  617. <ReturnValue>
  618. <ReturnType>Urho.Plane</ReturnType>
  619. </ReturnValue>
  620. <Docs>
  621. <summary>
  622. Return the reflection plane.
  623. Or
  624. Set reflection plane in world space for reflection mode.
  625. </summary>
  626. <value>To be added.</value>
  627. <remarks>To be added.</remarks>
  628. </Docs>
  629. </Member>
  630. <Member MemberName="ReflectionPlaneAttr">
  631. <MemberSignature Language="C#" Value="public Urho.Vector4 ReflectionPlaneAttr { get; }" />
  632. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Vector4 ReflectionPlaneAttr" />
  633. <MemberType>Property</MemberType>
  634. <AssemblyInfo>
  635. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  636. </AssemblyInfo>
  637. <ReturnValue>
  638. <ReturnType>Urho.Vector4</ReturnType>
  639. </ReturnValue>
  640. <Docs>
  641. <summary>
  642. Return reflection plane attribute.
  643. </summary>
  644. <value>To be added.</value>
  645. <remarks>To be added.</remarks>
  646. </Docs>
  647. </Member>
  648. <Member MemberName="RegisterObject">
  649. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  650. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  651. <MemberType>Method</MemberType>
  652. <AssemblyInfo>
  653. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  654. </AssemblyInfo>
  655. <ReturnValue>
  656. <ReturnType>System.Void</ReturnType>
  657. </ReturnValue>
  658. <Parameters>
  659. <Parameter Name="context" Type="Urho.Context" />
  660. </Parameters>
  661. <Docs>
  662. <param name="context">To be added.</param>
  663. <summary>
  664. Register object factory.
  665. </summary>
  666. <remarks>To be added.</remarks>
  667. </Docs>
  668. </Member>
  669. <Member MemberName="ReverseCulling">
  670. <MemberSignature Language="C#" Value="public bool ReverseCulling { get; }" />
  671. <MemberSignature Language="ILAsm" Value=".property instance bool ReverseCulling" />
  672. <MemberType>Property</MemberType>
  673. <AssemblyInfo>
  674. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  675. </AssemblyInfo>
  676. <ReturnValue>
  677. <ReturnType>System.Boolean</ReturnType>
  678. </ReturnValue>
  679. <Docs>
  680. <summary>
  681. Return whether to reverse culling; affected by vertical flipping and reflection.
  682. </summary>
  683. <value>To be added.</value>
  684. <remarks>To be added.</remarks>
  685. </Docs>
  686. </Member>
  687. <Member MemberName="ScreenToWorldPoint">
  688. <MemberSignature Language="C#" Value="public Urho.Vector3 ScreenToWorldPoint (Urho.Vector3 screenPos);" />
  689. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Vector3 ScreenToWorldPoint(valuetype Urho.Vector3 screenPos) cil managed" />
  690. <MemberType>Method</MemberType>
  691. <AssemblyInfo>
  692. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  693. </AssemblyInfo>
  694. <ReturnValue>
  695. <ReturnType>Urho.Vector3</ReturnType>
  696. </ReturnValue>
  697. <Parameters>
  698. <Parameter Name="screenPos" Type="Urho.Vector3" />
  699. </Parameters>
  700. <Docs>
  701. <param name="screenPos">To be added.</param>
  702. <summary>To be added.</summary>
  703. <returns>To be added.</returns>
  704. <remarks>To be added.</remarks>
  705. </Docs>
  706. </Member>
  707. <Member MemberName="SetAspectRatioInternal">
  708. <MemberSignature Language="C#" Value="public void SetAspectRatioInternal (float aspectRatio);" />
  709. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetAspectRatioInternal(float32 aspectRatio) cil managed" />
  710. <MemberType>Method</MemberType>
  711. <AssemblyInfo>
  712. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  713. </AssemblyInfo>
  714. <ReturnValue>
  715. <ReturnType>System.Void</ReturnType>
  716. </ReturnValue>
  717. <Parameters>
  718. <Parameter Name="aspectRatio" Type="System.Single" />
  719. </Parameters>
  720. <Docs>
  721. <param name="aspectRatio">To be added.</param>
  722. <summary>
  723. Set aspect ratio without disabling the "auto aspect ratio" mode. Called internally by View.
  724. </summary>
  725. <remarks>To be added.</remarks>
  726. </Docs>
  727. </Member>
  728. <Member MemberName="SetClipPlaneAttr">
  729. <MemberSignature Language="C#" Value="public void SetClipPlaneAttr (Urho.Vector4 value);" />
  730. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetClipPlaneAttr(valuetype Urho.Vector4 value) cil managed" />
  731. <MemberType>Method</MemberType>
  732. <AssemblyInfo>
  733. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  734. </AssemblyInfo>
  735. <ReturnValue>
  736. <ReturnType>System.Void</ReturnType>
  737. </ReturnValue>
  738. <Parameters>
  739. <Parameter Name="value" Type="Urho.Vector4" />
  740. </Parameters>
  741. <Docs>
  742. <param name="value">To be added.</param>
  743. <summary>
  744. Set clipping plane attribute.
  745. </summary>
  746. <remarks>To be added.</remarks>
  747. </Docs>
  748. </Member>
  749. <Member MemberName="SetOrthoSize">
  750. <MemberSignature Language="C#" Value="public void SetOrthoSize (Urho.Vector2 orthoSize);" />
  751. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetOrthoSize(valuetype Urho.Vector2 orthoSize) cil managed" />
  752. <MemberType>Method</MemberType>
  753. <AssemblyInfo>
  754. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  755. </AssemblyInfo>
  756. <ReturnValue>
  757. <ReturnType>System.Void</ReturnType>
  758. </ReturnValue>
  759. <Parameters>
  760. <Parameter Name="orthoSize" Type="Urho.Vector2" />
  761. </Parameters>
  762. <Docs>
  763. <param name="orthoSize">To be added.</param>
  764. <summary>
  765. Set orthographic mode view non-uniform size. Disables the auto aspect ratio -mode.
  766. </summary>
  767. <remarks>To be added.</remarks>
  768. </Docs>
  769. </Member>
  770. <Member MemberName="SetOrthoSizeAttr">
  771. <MemberSignature Language="C#" Value="public void SetOrthoSizeAttr (float orthoSize);" />
  772. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetOrthoSizeAttr(float32 orthoSize) cil managed" />
  773. <MemberType>Method</MemberType>
  774. <AssemblyInfo>
  775. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  776. </AssemblyInfo>
  777. <ReturnValue>
  778. <ReturnType>System.Void</ReturnType>
  779. </ReturnValue>
  780. <Parameters>
  781. <Parameter Name="orthoSize" Type="System.Single" />
  782. </Parameters>
  783. <Docs>
  784. <param name="orthoSize">To be added.</param>
  785. <summary>
  786. Set orthographic size attribute without forcing the aspect ratio.
  787. </summary>
  788. <remarks>To be added.</remarks>
  789. </Docs>
  790. </Member>
  791. <Member MemberName="SetReflectionPlaneAttr">
  792. <MemberSignature Language="C#" Value="public void SetReflectionPlaneAttr (Urho.Vector4 value);" />
  793. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetReflectionPlaneAttr(valuetype Urho.Vector4 value) cil managed" />
  794. <MemberType>Method</MemberType>
  795. <AssemblyInfo>
  796. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  797. </AssemblyInfo>
  798. <ReturnValue>
  799. <ReturnType>System.Void</ReturnType>
  800. </ReturnValue>
  801. <Parameters>
  802. <Parameter Name="value" Type="Urho.Vector4" />
  803. </Parameters>
  804. <Docs>
  805. <param name="value">To be added.</param>
  806. <summary>
  807. Set reflection plane attribute.
  808. </summary>
  809. <remarks>To be added.</remarks>
  810. </Docs>
  811. </Member>
  812. <Member MemberName="Type">
  813. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  814. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  815. <MemberType>Property</MemberType>
  816. <AssemblyInfo>
  817. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  818. </AssemblyInfo>
  819. <ReturnValue>
  820. <ReturnType>Urho.StringHash</ReturnType>
  821. </ReturnValue>
  822. <Docs>
  823. <summary>Urho's type system type.</summary>
  824. <value>StringHash representing the type for this C# type.</value>
  825. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  826. </Docs>
  827. </Member>
  828. <Member MemberName="TypeName">
  829. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  830. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  831. <MemberType>Property</MemberType>
  832. <AssemblyInfo>
  833. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  834. </AssemblyInfo>
  835. <ReturnValue>
  836. <ReturnType>System.String</ReturnType>
  837. </ReturnValue>
  838. <Docs>
  839. <summary>Urho's low-level type name.</summary>
  840. <value>Stringified low-level type name.</value>
  841. <remarks></remarks>
  842. </Docs>
  843. </Member>
  844. <Member MemberName="TypeNameStatic">
  845. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  846. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  847. <MemberType>Property</MemberType>
  848. <AssemblyInfo>
  849. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  850. </AssemblyInfo>
  851. <ReturnValue>
  852. <ReturnType>System.String</ReturnType>
  853. </ReturnValue>
  854. <Docs>
  855. <summary>Urho's low-level type name, accessible as a static method.</summary>
  856. <value>Stringified low-level type name.</value>
  857. <remarks></remarks>
  858. </Docs>
  859. </Member>
  860. <Member MemberName="TypeStatic">
  861. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  862. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  863. <MemberType>Property</MemberType>
  864. <AssemblyInfo>
  865. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  866. </AssemblyInfo>
  867. <ReturnValue>
  868. <ReturnType>Urho.StringHash</ReturnType>
  869. </ReturnValue>
  870. <Docs>
  871. <summary>Urho's low-level type, accessible as a static method.</summary>
  872. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  873. <remarks></remarks>
  874. </Docs>
  875. </Member>
  876. <Member MemberName="UseClipping">
  877. <MemberSignature Language="C#" Value="public bool UseClipping { get; set; }" />
  878. <MemberSignature Language="ILAsm" Value=".property instance bool UseClipping" />
  879. <MemberType>Property</MemberType>
  880. <AssemblyInfo>
  881. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  882. </AssemblyInfo>
  883. <ReturnValue>
  884. <ReturnType>System.Boolean</ReturnType>
  885. </ReturnValue>
  886. <Docs>
  887. <summary>
  888. Return whether is using a custom clipping plane.
  889. Or
  890. Set whether to use a custom clip plane.
  891. </summary>
  892. <value>To be added.</value>
  893. <remarks>To be added.</remarks>
  894. </Docs>
  895. </Member>
  896. <Member MemberName="UseReflection">
  897. <MemberSignature Language="C#" Value="public bool UseReflection { get; set; }" />
  898. <MemberSignature Language="ILAsm" Value=".property instance bool UseReflection" />
  899. <MemberType>Property</MemberType>
  900. <AssemblyInfo>
  901. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  902. </AssemblyInfo>
  903. <ReturnValue>
  904. <ReturnType>System.Boolean</ReturnType>
  905. </ReturnValue>
  906. <Docs>
  907. <summary>
  908. Return whether is using reflection.
  909. Or
  910. Set reflection mode.
  911. </summary>
  912. <value>To be added.</value>
  913. <remarks>To be added.</remarks>
  914. </Docs>
  915. </Member>
  916. <Member MemberName="ViewMask">
  917. <MemberSignature Language="C#" Value="public uint ViewMask { get; set; }" />
  918. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 ViewMask" />
  919. <MemberType>Property</MemberType>
  920. <AssemblyInfo>
  921. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  922. </AssemblyInfo>
  923. <ReturnValue>
  924. <ReturnType>System.UInt32</ReturnType>
  925. </ReturnValue>
  926. <Docs>
  927. <summary>
  928. Return view mask.
  929. Or
  930. Set view mask. Will be and'ed with object's view mask to see if the object should be rendered.
  931. </summary>
  932. <value>To be added.</value>
  933. <remarks>To be added.</remarks>
  934. </Docs>
  935. </Member>
  936. <Member MemberName="ViewOverrideFlags">
  937. <MemberSignature Language="C#" Value="public Urho.ViewOverrideFlags ViewOverrideFlags { get; set; }" />
  938. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.ViewOverrideFlags ViewOverrideFlags" />
  939. <MemberType>Property</MemberType>
  940. <AssemblyInfo>
  941. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  942. </AssemblyInfo>
  943. <ReturnValue>
  944. <ReturnType>Urho.ViewOverrideFlags</ReturnType>
  945. </ReturnValue>
  946. <Docs>
  947. <summary>
  948. Return view override flags.
  949. Or
  950. Set view override flags.
  951. </summary>
  952. <value>To be added.</value>
  953. <remarks>To be added.</remarks>
  954. </Docs>
  955. </Member>
  956. <Member MemberName="ViewSpaceFrustum">
  957. <MemberSignature Language="C#" Value="public Urho.Frustum ViewSpaceFrustum { get; }" />
  958. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Frustum ViewSpaceFrustum" />
  959. <MemberType>Property</MemberType>
  960. <AssemblyInfo>
  961. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  962. </AssemblyInfo>
  963. <ReturnValue>
  964. <ReturnType>Urho.Frustum</ReturnType>
  965. </ReturnValue>
  966. <Docs>
  967. <summary>
  968. Return frustum in view space.
  969. </summary>
  970. <value>To be added.</value>
  971. <remarks>To be added.</remarks>
  972. </Docs>
  973. </Member>
  974. <Member MemberName="WorldToScreenPoint">
  975. <MemberSignature Language="C#" Value="public Urho.Vector2 WorldToScreenPoint (Urho.Vector3 worldPos);" />
  976. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Vector2 WorldToScreenPoint(valuetype Urho.Vector3 worldPos) cil managed" />
  977. <MemberType>Method</MemberType>
  978. <AssemblyInfo>
  979. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  980. </AssemblyInfo>
  981. <ReturnValue>
  982. <ReturnType>Urho.Vector2</ReturnType>
  983. </ReturnValue>
  984. <Parameters>
  985. <Parameter Name="worldPos" Type="Urho.Vector3" />
  986. </Parameters>
  987. <Docs>
  988. <param name="worldPos">To be added.</param>
  989. <summary>To be added.</summary>
  990. <returns>To be added.</returns>
  991. <remarks>To be added.</remarks>
  992. </Docs>
  993. </Member>
  994. <Member MemberName="Zoom">
  995. <MemberSignature Language="C#" Value="public float Zoom { get; set; }" />
  996. <MemberSignature Language="ILAsm" Value=".property instance float32 Zoom" />
  997. <MemberType>Property</MemberType>
  998. <AssemblyInfo>
  999. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1000. </AssemblyInfo>
  1001. <ReturnValue>
  1002. <ReturnType>System.Single</ReturnType>
  1003. </ReturnValue>
  1004. <Docs>
  1005. <summary>
  1006. Return zoom.
  1007. Or
  1008. Set zoom.
  1009. </summary>
  1010. <value>To be added.</value>
  1011. <remarks>To be added.</remarks>
  1012. </Docs>
  1013. </Member>
  1014. </Members>
  1015. </Type>