Camera.xml 40 KB

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