ImportOptions.cs 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384
  1. using System;
  2. using System.Runtime.CompilerServices;
  3. using BansheeEngine;
  4. namespace BansheeEditor
  5. {
  6. /// <summary>
  7. /// Base class for all import options. Allows control over how is a specific resource type imported.
  8. /// </summary>
  9. public class ImportOptions : ScriptObject
  10. {
  11. }
  12. /// <summary>
  13. /// Provides options for controlling how is a texture resource imported.
  14. /// </summary>
  15. public class TextureImportOptions : ImportOptions
  16. {
  17. /// <summary>
  18. /// Creates new texture import options with default values.
  19. /// </summary>
  20. public TextureImportOptions()
  21. {
  22. Internal_CreateInstance(this);
  23. }
  24. /// <summary>
  25. /// Pixel format to import as.
  26. /// </summary>
  27. public PixelFormat Format
  28. {
  29. get { return Internal_GetPixelFormat(mCachedPtr); }
  30. set { Internal_SetPixelFormat(mCachedPtr, value); }
  31. }
  32. /// <summary>
  33. /// Determines whether the imported texture will have mipmaps generated.
  34. /// </summary>
  35. public bool GenerateMipmaps
  36. {
  37. get { return Internal_GetGenerateMipmaps(mCachedPtr); }
  38. set { Internal_SetGenerateMipmaps(mCachedPtr, value); }
  39. }
  40. /// <summary>
  41. /// Maximum mipmap level to generate, if mipmap generation is enabled.
  42. /// </summary>
  43. public int MaxMipmapLevel
  44. {
  45. get { return Internal_GetMaxMipmapLevel(mCachedPtr); }
  46. set { Internal_SetMaxMipmapLevel(mCachedPtr, value); }
  47. }
  48. /// <summary>
  49. /// Determines whether the texture data is also stored in main memory, available for fast CPU access.
  50. /// </summary>
  51. public bool CPUReadable
  52. {
  53. get { return Internal_GetCPUReadable(mCachedPtr); }
  54. set { Internal_SetCPUReadable(mCachedPtr, value); }
  55. }
  56. /// <summary>
  57. /// Determines should the texture data be treated as if its in sRGB (gamma) space. Such texture will be converted by
  58. /// hardware to linear space before use on the GPU.
  59. /// </summary>
  60. public bool IsSRGB
  61. {
  62. get { return Internal_GetIsSRGB(mCachedPtr); }
  63. set { Internal_SetIsSRGB(mCachedPtr, value); }
  64. }
  65. [MethodImpl(MethodImplOptions.InternalCall)]
  66. private static extern void Internal_CreateInstance(TextureImportOptions instance);
  67. [MethodImpl(MethodImplOptions.InternalCall)]
  68. private static extern PixelFormat Internal_GetPixelFormat(IntPtr thisPtr);
  69. [MethodImpl(MethodImplOptions.InternalCall)]
  70. private static extern void Internal_SetPixelFormat(IntPtr thisPtr, PixelFormat value);
  71. [MethodImpl(MethodImplOptions.InternalCall)]
  72. private static extern bool Internal_GetGenerateMipmaps(IntPtr thisPtr);
  73. [MethodImpl(MethodImplOptions.InternalCall)]
  74. private static extern void Internal_SetGenerateMipmaps(IntPtr thisPtr, bool value);
  75. [MethodImpl(MethodImplOptions.InternalCall)]
  76. private static extern int Internal_GetMaxMipmapLevel(IntPtr thisPtr);
  77. [MethodImpl(MethodImplOptions.InternalCall)]
  78. private static extern void Internal_SetMaxMipmapLevel(IntPtr thisPtr, int value);
  79. [MethodImpl(MethodImplOptions.InternalCall)]
  80. private static extern bool Internal_GetCPUReadable(IntPtr thisPtr);
  81. [MethodImpl(MethodImplOptions.InternalCall)]
  82. private static extern void Internal_SetCPUReadable(IntPtr thisPtr, bool value);
  83. [MethodImpl(MethodImplOptions.InternalCall)]
  84. private static extern bool Internal_GetIsSRGB(IntPtr thisPtr);
  85. [MethodImpl(MethodImplOptions.InternalCall)]
  86. private static extern void Internal_SetIsSRGB(IntPtr thisPtr, bool value);
  87. }
  88. /// <summary>
  89. /// Provides options for controlling how is a mesh resource imported.
  90. /// </summary>
  91. public class MeshImportOptions : ImportOptions
  92. {
  93. /// <summary>
  94. /// Creates new mesh import options with default values.
  95. /// </summary>
  96. public MeshImportOptions()
  97. {
  98. Internal_CreateInstance(this);
  99. }
  100. /// <summary>
  101. /// Determines whether the mesh data is also stored in main memory, available for fast CPU access.
  102. /// </summary>
  103. public bool CPUReadable
  104. {
  105. get { return Internal_GetCPUReadable(mCachedPtr); }
  106. set { Internal_SetCPUReadable(mCachedPtr, value); }
  107. }
  108. /// <summary>
  109. /// Controls should mesh normals be imported if available.
  110. /// </summary>
  111. public bool ImportNormals
  112. {
  113. get { return Internal_GetImportNormals(mCachedPtr); }
  114. set { Internal_SetImportNormals(mCachedPtr, value); }
  115. }
  116. /// <summary>
  117. /// Controls should mesh tangents/bitangents be imported if available.
  118. /// </summary>
  119. public bool ImportTangents
  120. {
  121. get { return Internal_GetImportTangents(mCachedPtr); }
  122. set { Internal_SetImportTangents(mCachedPtr, value); }
  123. }
  124. /// <summary>
  125. /// Controls should mesh skin data like bone weights, indices and bind poses be imported if available.
  126. /// </summary>
  127. public bool ImportSkin
  128. {
  129. get { return Internal_GetImportSkin(mCachedPtr); }
  130. set { Internal_SetImportSkin(mCachedPtr, value); }
  131. }
  132. /// <summary>
  133. /// Controls should animation clips be imported if available.
  134. /// </summary>
  135. public bool ImportAnimation
  136. {
  137. get { return Internal_GetImportAnimation(mCachedPtr); }
  138. set { Internal_SetImportAnimation(mCachedPtr, value); }
  139. }
  140. /// <summary>
  141. /// Controls should mesh blend shapes be imported if available.
  142. /// </summary>
  143. public bool ImportBlendShapes
  144. {
  145. get { return Internal_GetImportBlendShapes(mCachedPtr); }
  146. set { Internal_SetImportBlendShapes(mCachedPtr, value); }
  147. }
  148. /// <summary>
  149. /// Uniformly scales the imported mesh by the specified value.
  150. /// </summary>
  151. public float Scale
  152. {
  153. get { return Internal_GetScale(mCachedPtr); }
  154. set { Internal_SetScale(mCachedPtr, value); }
  155. }
  156. [MethodImpl(MethodImplOptions.InternalCall)]
  157. private static extern void Internal_CreateInstance(MeshImportOptions instance);
  158. [MethodImpl(MethodImplOptions.InternalCall)]
  159. private static extern bool Internal_GetCPUReadable(IntPtr thisPtr);
  160. [MethodImpl(MethodImplOptions.InternalCall)]
  161. private static extern void Internal_SetCPUReadable(IntPtr thisPtr, bool value);
  162. [MethodImpl(MethodImplOptions.InternalCall)]
  163. private static extern bool Internal_GetImportNormals(IntPtr thisPtr);
  164. [MethodImpl(MethodImplOptions.InternalCall)]
  165. private static extern void Internal_SetImportNormals(IntPtr thisPtr, bool value);
  166. [MethodImpl(MethodImplOptions.InternalCall)]
  167. private static extern bool Internal_GetImportTangents(IntPtr thisPtr);
  168. [MethodImpl(MethodImplOptions.InternalCall)]
  169. private static extern void Internal_SetImportTangents(IntPtr thisPtr, bool value);
  170. [MethodImpl(MethodImplOptions.InternalCall)]
  171. private static extern bool Internal_GetImportSkin(IntPtr thisPtr);
  172. [MethodImpl(MethodImplOptions.InternalCall)]
  173. private static extern void Internal_SetImportSkin(IntPtr thisPtr, bool value);
  174. [MethodImpl(MethodImplOptions.InternalCall)]
  175. private static extern bool Internal_GetImportAnimation(IntPtr thisPtr);
  176. [MethodImpl(MethodImplOptions.InternalCall)]
  177. private static extern void Internal_SetImportAnimation(IntPtr thisPtr, bool value);
  178. [MethodImpl(MethodImplOptions.InternalCall)]
  179. private static extern bool Internal_GetImportBlendShapes(IntPtr thisPtr);
  180. [MethodImpl(MethodImplOptions.InternalCall)]
  181. private static extern void Internal_SetImportBlendShapes(IntPtr thisPtr, bool value);
  182. [MethodImpl(MethodImplOptions.InternalCall)]
  183. private static extern float Internal_GetScale(IntPtr thisPtr);
  184. [MethodImpl(MethodImplOptions.InternalCall)]
  185. private static extern void Internal_SetScale(IntPtr thisPtr, float value);
  186. }
  187. /// <summary>
  188. /// Import options that provide various options for controlling how is a font resource imported.
  189. /// </summary>
  190. public class FontImportOptions : ImportOptions
  191. {
  192. /// <summary>
  193. /// Creates new font import options with default values.
  194. /// </summary>
  195. public FontImportOptions()
  196. {
  197. Internal_CreateInstance(this);
  198. }
  199. /// <summary>
  200. /// Font sizes in points that are to be imported.
  201. /// </summary>
  202. public int[] FontSizes
  203. {
  204. get { return Internal_GetFontSizes(mCachedPtr); }
  205. set { Internal_SetFontSizes(mCachedPtr, value); }
  206. }
  207. /// <summary>
  208. /// Dots per inch resolution to use when rendering the characters into the texture.
  209. /// </summary>
  210. public int DPI
  211. {
  212. get { return Internal_GetDPI(mCachedPtr); }
  213. set { Internal_SetDPI(mCachedPtr, value); }
  214. }
  215. /// <summary>
  216. /// Determines rendering mode used when rendering the characters into the bitmap.
  217. /// </summary>
  218. public FontRenderMode RenderMode
  219. {
  220. get { return Internal_GetRenderMode(mCachedPtr); }
  221. set { Internal_SetRenderMode(mCachedPtr, value); }
  222. }
  223. /// <summary>
  224. /// Determines should the characters be rendered in bold style.
  225. /// </summary>
  226. public bool Bold
  227. {
  228. get { return Internal_GetBold(mCachedPtr); }
  229. set { Internal_SetBold(mCachedPtr, value); }
  230. }
  231. /// <summary>
  232. /// Determines should the characters be rendered in italic style.
  233. /// </summary>
  234. public bool Italic
  235. {
  236. get { return Internal_GetItalic(mCachedPtr); }
  237. set { Internal_SetItalic(mCachedPtr, value); }
  238. }
  239. /// <summary>
  240. /// Determines character ranges to import from the font. Ranges are defined as unicode numbers.
  241. /// </summary>
  242. public CharRange[] CharRanges
  243. {
  244. get { return Internal_GetCharRanges(mCachedPtr); }
  245. set { Internal_SetCharRanges(mCachedPtr, value); }
  246. }
  247. [MethodImpl(MethodImplOptions.InternalCall)]
  248. private static extern void Internal_CreateInstance(FontImportOptions instance);
  249. [MethodImpl(MethodImplOptions.InternalCall)]
  250. private static extern int[] Internal_GetFontSizes(IntPtr thisPtr);
  251. [MethodImpl(MethodImplOptions.InternalCall)]
  252. private static extern void Internal_SetFontSizes(IntPtr thisPtr, int[] value);
  253. [MethodImpl(MethodImplOptions.InternalCall)]
  254. private static extern int Internal_GetDPI(IntPtr thisPtr);
  255. [MethodImpl(MethodImplOptions.InternalCall)]
  256. private static extern void Internal_SetDPI(IntPtr thisPtr, int value);
  257. [MethodImpl(MethodImplOptions.InternalCall)]
  258. private static extern FontRenderMode Internal_GetRenderMode(IntPtr thisPtr);
  259. [MethodImpl(MethodImplOptions.InternalCall)]
  260. private static extern void Internal_SetRenderMode(IntPtr thisPtr, FontRenderMode value);
  261. [MethodImpl(MethodImplOptions.InternalCall)]
  262. private static extern bool Internal_GetBold(IntPtr thisPtr);
  263. [MethodImpl(MethodImplOptions.InternalCall)]
  264. private static extern void Internal_SetBold(IntPtr thisPtr, bool value);
  265. [MethodImpl(MethodImplOptions.InternalCall)]
  266. private static extern bool Internal_GetItalic(IntPtr thisPtr);
  267. [MethodImpl(MethodImplOptions.InternalCall)]
  268. private static extern void Internal_SetItalic(IntPtr thisPtr, bool value);
  269. [MethodImpl(MethodImplOptions.InternalCall)]
  270. private static extern CharRange[] Internal_GetCharRanges(IntPtr thisPtr);
  271. [MethodImpl(MethodImplOptions.InternalCall)]
  272. private static extern void Internal_SetCharRanges(IntPtr thisPtr, CharRange[] value);
  273. }
  274. /// <summary>
  275. /// Provides various options for controlling how is a script file imported.
  276. /// </summary>
  277. public class ScriptCodeImportOptions : ImportOptions
  278. {
  279. /// <summary>
  280. /// Creates new script import options with default values.
  281. /// </summary>
  282. public ScriptCodeImportOptions()
  283. {
  284. Internal_CreateInstance(this);
  285. }
  286. /// <summary>
  287. /// Determines whether the script is editor-only or a normal game script. Editor scripts are compiled in a separate
  288. /// assembly and may reference editor specific functionality, but are not available in the final game code.
  289. /// </summary>
  290. public bool EditorScript
  291. {
  292. get { return Internal_IsEditorScript(mCachedPtr); }
  293. set { Internal_SetEditorScript(mCachedPtr, value); }
  294. }
  295. [MethodImpl(MethodImplOptions.InternalCall)]
  296. private static extern void Internal_CreateInstance(ScriptCodeImportOptions instance);
  297. [MethodImpl(MethodImplOptions.InternalCall)]
  298. private static extern bool Internal_IsEditorScript(IntPtr thisPtr);
  299. [MethodImpl(MethodImplOptions.InternalCall)]
  300. private static extern void Internal_SetEditorScript(IntPtr thisPtr, bool value);
  301. }
  302. /// <summary>
  303. /// Determines how is a font rendered into the bitmap texture.
  304. /// </summary>
  305. public enum FontRenderMode // Note: Must match C++ enum FontRenderMode
  306. {
  307. /// <summary>Render antialiased fonts without hinting (slightly more blurry).</summary>
  308. Smooth,
  309. /// <summary>Render non-antialiased fonts without hinting (slightly more blurry).</summary>
  310. Raster,
  311. /// <summary>Render antialiased fonts with hinting.</summary>
  312. HintedSmooth,
  313. /// <summary>Render non-antialiased fonts with hinting.</summary>
  314. HintedRaster
  315. };
  316. }