Controls.xml 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. <Type Name="Controls" FullName="Urho.Controls">
  2. <TypeSignature Language="C#" Value="public class Controls" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Controls extends System.Object" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>System.Object</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>Controls sent over the network</summary>
  14. <remarks>To be added.</remarks>
  15. </Docs>
  16. <Members>
  17. <Member MemberName=".ctor">
  18. <MemberSignature Language="C#" Value="public Controls ();" />
  19. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  20. <MemberType>Constructor</MemberType>
  21. <AssemblyInfo>
  22. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  23. </AssemblyInfo>
  24. <Parameters />
  25. <Docs>
  26. <summary>
  27. <para>Initializes the instance with Pitch, Yaw and Buttons state set to zero.</para>
  28. <para>
  29. </para>
  30. </summary>
  31. <remarks>To be added.</remarks>
  32. </Docs>
  33. </Member>
  34. <Member MemberName="Buttons">
  35. <MemberSignature Language="C#" Value="public uint Buttons { get; set; }" />
  36. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 Buttons" />
  37. <MemberType>Property</MemberType>
  38. <AssemblyInfo>
  39. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  40. </AssemblyInfo>
  41. <ReturnValue>
  42. <ReturnType>System.UInt32</ReturnType>
  43. </ReturnValue>
  44. <Docs>
  45. <summary>Button state</summary>
  46. <value>To be added.</value>
  47. <remarks>To be added.</remarks>
  48. </Docs>
  49. </Member>
  50. <Member MemberName="Finalize">
  51. <MemberSignature Language="C#" Value="~Controls ();" />
  52. <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
  53. <MemberType>Method</MemberType>
  54. <AssemblyInfo>
  55. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  56. </AssemblyInfo>
  57. <ReturnValue>
  58. <ReturnType>System.Void</ReturnType>
  59. </ReturnValue>
  60. <Parameters />
  61. <Docs>
  62. <summary>To be added.</summary>
  63. <remarks>To be added.</remarks>
  64. </Docs>
  65. </Member>
  66. <Member MemberName="IsDown">
  67. <MemberSignature Language="C#" Value="public bool IsDown (uint button);" />
  68. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsDown(unsigned int32 button) cil managed" />
  69. <MemberType>Method</MemberType>
  70. <AssemblyInfo>
  71. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  72. </AssemblyInfo>
  73. <ReturnValue>
  74. <ReturnType>System.Boolean</ReturnType>
  75. </ReturnValue>
  76. <Parameters>
  77. <Parameter Name="button" Type="System.UInt32" />
  78. </Parameters>
  79. <Docs>
  80. <param name="button">To be added.</param>
  81. <summary>Checks if the specified button is down.</summary>
  82. <returns>To be added.</returns>
  83. <remarks>To be added.</remarks>
  84. </Docs>
  85. </Member>
  86. <Member MemberName="IsPressed">
  87. <MemberSignature Language="C#" Value="public bool IsPressed (uint button, ref Urho.Controls previousControls);" />
  88. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsPressed(unsigned int32 button, class Urho.Controls previousControls) cil managed" />
  89. <MemberType>Method</MemberType>
  90. <AssemblyInfo>
  91. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  92. </AssemblyInfo>
  93. <ReturnValue>
  94. <ReturnType>System.Boolean</ReturnType>
  95. </ReturnValue>
  96. <Parameters>
  97. <Parameter Name="button" Type="System.UInt32" />
  98. <Parameter Name="previousControls" Type="Urho.Controls&amp;" RefType="ref" />
  99. </Parameters>
  100. <Docs>
  101. <param name="button">To be added.</param>
  102. <param name="previousControls">To be added.</param>
  103. <summary>Checks if the specified buttons are pressed in this frame, requires the previous frame control state.</summary>
  104. <returns>To be added.</returns>
  105. <remarks>To be added.</remarks>
  106. </Docs>
  107. </Member>
  108. <Member MemberName="Pitch">
  109. <MemberSignature Language="C#" Value="public float Pitch { get; set; }" />
  110. <MemberSignature Language="ILAsm" Value=".property instance float32 Pitch" />
  111. <MemberType>Property</MemberType>
  112. <AssemblyInfo>
  113. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  114. </AssemblyInfo>
  115. <ReturnValue>
  116. <ReturnType>System.Single</ReturnType>
  117. </ReturnValue>
  118. <Docs>
  119. <summary>Mouse pitch</summary>
  120. <value>To be added.</value>
  121. <remarks>To be added.</remarks>
  122. </Docs>
  123. </Member>
  124. <Member MemberName="Reset">
  125. <MemberSignature Language="C#" Value="public void Reset ();" />
  126. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Reset() cil managed" />
  127. <MemberType>Method</MemberType>
  128. <AssemblyInfo>
  129. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  130. </AssemblyInfo>
  131. <ReturnValue>
  132. <ReturnType>System.Void</ReturnType>
  133. </ReturnValue>
  134. <Parameters />
  135. <Docs>
  136. <summary>Resets to the initial state (buttons, yaw and pitch are set to zero).</summary>
  137. <remarks>To be added.</remarks>
  138. </Docs>
  139. </Member>
  140. <Member MemberName="Set">
  141. <MemberSignature Language="C#" Value="public void Set (uint buttons, bool down);" />
  142. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Set(unsigned int32 buttons, bool down) cil managed" />
  143. <MemberType>Method</MemberType>
  144. <AssemblyInfo>
  145. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  146. </AssemblyInfo>
  147. <ReturnValue>
  148. <ReturnType>System.Void</ReturnType>
  149. </ReturnValue>
  150. <Parameters>
  151. <Parameter Name="buttons" Type="System.UInt32" />
  152. <Parameter Name="down" Type="System.Boolean" />
  153. </Parameters>
  154. <Docs>
  155. <param name="buttons">To be added.</param>
  156. <param name="down">To be added.</param>
  157. <summary>Set or release buttons.</summary>
  158. <remarks>To be added.</remarks>
  159. </Docs>
  160. </Member>
  161. <Member MemberName="Yaw">
  162. <MemberSignature Language="C#" Value="public float Yaw { get; set; }" />
  163. <MemberSignature Language="ILAsm" Value=".property instance float32 Yaw" />
  164. <MemberType>Property</MemberType>
  165. <AssemblyInfo>
  166. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  167. </AssemblyInfo>
  168. <ReturnValue>
  169. <ReturnType>System.Single</ReturnType>
  170. </ReturnValue>
  171. <Docs>
  172. <summary>Mouse yaw.</summary>
  173. <value>To be added.</value>
  174. <remarks>To be added.</remarks>
  175. </Docs>
  176. </Member>
  177. </Members>
  178. </Type>