PrimitiveMesh.xml 1.5 KB

123456789101112131415161718192021222324252627282930313233
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="PrimitiveMesh" inherits="Mesh" category="Core" version="3.1.2">
  3. <brief_description>
  4. Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh.
  5. </brief_description>
  6. <description>
  7. Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh. Examples include [CapsuleMesh], [CubeMesh], [CylinderMesh], [PlaneMesh], [PrismMesh], [QuadMesh], and [SphereMesh].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="get_mesh_arrays" qualifiers="const">
  13. <return type="Array">
  14. </return>
  15. <description>
  16. Returns mesh arrays used to constitute surface of [Mesh]. Mesh array can be used with [ArrayMesh] to create new surface.
  17. </description>
  18. </method>
  19. </methods>
  20. <members>
  21. <member name="custom_aabb" type="AABB" setter="set_custom_aabb" getter="get_custom_aabb">
  22. Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when using a shader to offset vertices.
  23. </member>
  24. <member name="flip_faces" type="bool" setter="set_flip_faces" getter="get_flip_faces">
  25. If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. Result is the same as using *CULL_BACK* in [SpatialMaterial]. Default is false.
  26. </member>
  27. <member name="material" type="Material" setter="set_material" getter="get_material">
  28. The current [Material] of the primitive mesh.
  29. </member>
  30. </members>
  31. <constants>
  32. </constants>
  33. </class>