class_geometryinstance.rst 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. .. _class_GeometryInstance:
  2. GeometryInstance
  3. ================
  4. **Inherits:** :ref:`VisualInstance<class_visualinstance>`
  5. **Category:** Core
  6. Base node for geometry based visual instances.
  7. Member Functions
  8. ----------------
  9. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  10. | void | :ref:`set_material_override<class_GeometryInstance_set_material_override>` **(** :ref:`Object<class_object>` material **)** |
  11. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  12. | :ref:`Object<class_object>` | :ref:`get_material_override<class_GeometryInstance_get_material_override>` **(** **)** const |
  13. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`set_flag<class_GeometryInstance_set_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
  15. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`get_flag<class_GeometryInstance_get_flag>` **(** :ref:`int<class_int>` flag **)** const |
  17. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  18. | void | :ref:`set_draw_range_begin<class_GeometryInstance_set_draw_range_begin>` **(** :ref:`float<class_float>` mode **)** |
  19. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`get_draw_range_begin<class_GeometryInstance_get_draw_range_begin>` **(** **)** const |
  21. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_draw_range_end<class_GeometryInstance_set_draw_range_end>` **(** :ref:`float<class_float>` mode **)** |
  23. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`float<class_float>` | :ref:`get_draw_range_end<class_GeometryInstance_get_draw_range_end>` **(** **)** const |
  25. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`set_baked_light_texture_id<class_GeometryInstance_set_baked_light_texture_id>` **(** :ref:`int<class_int>` id **)** |
  27. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`int<class_int>` | :ref:`get_baked_light_texture_id<class_GeometryInstance_get_baked_light_texture_id>` **(** **)** const |
  29. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`set_extra_cull_margin<class_GeometryInstance_set_extra_cull_margin>` **(** :ref:`float<class_float>` margin **)** |
  31. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`float<class_float>` | :ref:`get_extra_cull_margin<class_GeometryInstance_get_extra_cull_margin>` **(** **)** const |
  33. +------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
  34. Numeric Constants
  35. -----------------
  36. - **FLAG_VISIBLE** = **0**
  37. - **FLAG_CAST_SHADOW** = **3**
  38. - **FLAG_RECEIVE_SHADOWS** = **4**
  39. - **FLAG_BILLBOARD** = **1**
  40. - **FLAG_BILLBOARD_FIX_Y** = **2**
  41. - **FLAG_DEPH_SCALE** = **5**
  42. - **FLAG_VISIBLE_IN_ALL_ROOMS** = **6**
  43. - **FLAG_MAX** = **8**
  44. Description
  45. -----------
  46. Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials.
  47. Member Function Description
  48. ---------------------------
  49. .. _class_GeometryInstance_set_material_override:
  50. - void **set_material_override** **(** :ref:`Object<class_object>` material **)**
  51. Set the material override for the whole geometry.
  52. .. _class_GeometryInstance_get_material_override:
  53. - :ref:`Object<class_object>` **get_material_override** **(** **)** const
  54. Return the material override for the whole geometry.
  55. .. _class_GeometryInstance_set_flag:
  56. - void **set_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
  57. .. _class_GeometryInstance_get_flag:
  58. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`int<class_int>` flag **)** const
  59. .. _class_GeometryInstance_set_draw_range_begin:
  60. - void **set_draw_range_begin** **(** :ref:`float<class_float>` mode **)**
  61. .. _class_GeometryInstance_get_draw_range_begin:
  62. - :ref:`float<class_float>` **get_draw_range_begin** **(** **)** const
  63. .. _class_GeometryInstance_set_draw_range_end:
  64. - void **set_draw_range_end** **(** :ref:`float<class_float>` mode **)**
  65. .. _class_GeometryInstance_get_draw_range_end:
  66. - :ref:`float<class_float>` **get_draw_range_end** **(** **)** const
  67. .. _class_GeometryInstance_set_baked_light_texture_id:
  68. - void **set_baked_light_texture_id** **(** :ref:`int<class_int>` id **)**
  69. .. _class_GeometryInstance_get_baked_light_texture_id:
  70. - :ref:`int<class_int>` **get_baked_light_texture_id** **(** **)** const
  71. .. _class_GeometryInstance_set_extra_cull_margin:
  72. - void **set_extra_cull_margin** **(** :ref:`float<class_float>` margin **)**
  73. .. _class_GeometryInstance_get_extra_cull_margin:
  74. - :ref:`float<class_float>` **get_extra_cull_margin** **(** **)** const