Camera.xml 40 KB

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