Documentation
¶
Overview ¶
Package ArrayMesh provides methods for working with ArrayMesh object instances.
Index ¶
- type Advanced
- type Any
- type Instance
- func (self Instance) AddBlendShape(name string)
- func (self Instance) AddSurfaceFromArrays(primitive gdclass.MeshPrimitiveType, arrays []any)
- func (self Instance) AsArrayMesh() Instance
- func (self Instance) AsMesh() Mesh.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) BlendShapeMode() gdclass.MeshBlendShapeMode
- func (self Instance) ClearBlendShapes()
- func (self Instance) ClearSurfaces()
- func (self Instance) CustomAabb() AABB.PositionSize
- func (self Instance) GetBlendShapeCount() int
- func (self Instance) GetBlendShapeName(index int) string
- func (self Instance) LightmapUnwrap(transform Transform3D.BasisOrigin, texel_size Float.X) error
- func (self Instance) RegenNormalMaps()
- func (self Instance) SetBlendShapeMode(value gdclass.MeshBlendShapeMode)
- func (self Instance) SetBlendShapeName(index int, name string)
- func (self Instance) SetCustomAabb(value AABB.PositionSize)
- func (self Instance) SetShadowMesh(value [1]gdclass.ArrayMesh)
- func (self Instance) ShadowMesh() [1]gdclass.ArrayMesh
- func (self Instance) SurfaceFindByName(name string) int
- func (self Instance) SurfaceGetArrayIndexLen(surf_idx int) int
- func (self Instance) SurfaceGetArrayLen(surf_idx int) int
- func (self Instance) SurfaceGetFormat(surf_idx int) gdclass.MeshArrayFormat
- func (self Instance) SurfaceGetName(surf_idx int) string
- func (self Instance) SurfaceGetPrimitiveType(surf_idx int) gdclass.MeshPrimitiveType
- func (self Instance) SurfaceSetName(surf_idx int, name string)
- func (self Instance) SurfaceUpdateAttributeRegion(surf_idx int, offset int, data []byte)
- func (self Instance) SurfaceUpdateSkinRegion(surf_idx int, offset int, data []byte)
- func (self Instance) SurfaceUpdateVertexRegion(surf_idx int, offset int, data []byte)
- func (self *Instance) UnsafePointer() unsafe.Pointer
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Instance ¶
The [ArrayMesh] is used to construct a [Mesh] by specifying the attributes as arrays. The most basic example is the creation of a single triangle: [codeblocks] [gdscript] var vertices = PackedVector3Array() vertices.push_back(Vector3(0, 1, 0)) vertices.push_back(Vector3(1, 0, 0)) vertices.push_back(Vector3(0, 0, 1))
# Initialize the ArrayMesh. var arr_mesh = ArrayMesh.new() var arrays = [] arrays.resize(Mesh.ARRAY_MAX) arrays[Mesh.ARRAY_VERTEX] = vertices
# Create the Mesh. arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arrays) var m = MeshInstance3D.new() m.mesh = arr_mesh [/gdscript] [csharp] var vertices = new Vector3[]
{
new Vector3(0, 1, 0),
new Vector3(1, 0, 0),
new Vector3(0, 0, 1),
};
// Initialize the ArrayMesh. var arrMesh = new ArrayMesh(); var arrays = new Godot.Collections.Array(); arrays.Resize((int)Mesh.ArrayType.Max); arrays[(int)Mesh.ArrayType.Vertex] = vertices;
// Create the Mesh. arrMesh.AddSurfaceFromArrays(Mesh.PrimitiveType.Triangles, arrays); var m = new MeshInstance3D(); m.Mesh = arrMesh; [/csharp] [/codeblocks] The [MeshInstance3D] is ready to be added to the [SceneTree] to be shown. See also [ImmediateMesh], [MeshDataTool] and [SurfaceTool] for procedural geometry generation. [b]Note:[/b] Godot uses clockwise [url=https://learnopengl.com/Advanced-OpenGL/Face-culling]winding order[/url] for front faces of triangle primitive modes.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AddBlendShape ¶
Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added.
func (Instance) AddSurfaceFromArrays ¶
func (self Instance) AddSurfaceFromArrays(primitive gdclass.MeshPrimitiveType, arrays []any)
Creates a new surface. [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface. Surfaces are created to be rendered using a [param primitive], which may be any of the values defined in [enum Mesh.PrimitiveType]. The [param arrays] argument is an array of arrays. Each of the [constant Mesh.ARRAY_MAX] elements contains an array with some of the mesh data for this surface as described by the corresponding member of [enum Mesh.ArrayType] or [code]null[/code] if it is not used by the surface. For example, [code]arrays[0][/code] is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this surface into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array (or be an exact multiple of the vertex array's length, when multiple elements of a sub-array correspond to a single vertex) or be empty, except for [constant Mesh.ARRAY_INDEX] if it is used. The [param blend_shapes] argument is an array of vertex data for each blend shape. Each element is an array of the same structure as [param arrays], but [constant Mesh.ARRAY_VERTEX], [constant Mesh.ARRAY_NORMAL], and [constant Mesh.ARRAY_TANGENT] are set if and only if they are set in [param arrays] and all other entries are [code]null[/code]. The [param lods] argument is a dictionary with [float] keys and [PackedInt32Array] values. Each entry in the dictionary represents an LOD level of the surface, where the value is the [constant Mesh.ARRAY_INDEX] array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of an LOD also increases the distance that the objects has to be from the camera before the LOD is used. The [param flags] argument is the bitwise or of, as required: One value of [enum Mesh.ArrayCustomFormat] left shifted by [code]ARRAY_FORMAT_CUSTOMn_SHIFT[/code] for each custom channel in use, [constant Mesh.ARRAY_FLAG_USE_DYNAMIC_UPDATE], [constant Mesh.ARRAY_FLAG_USE_8_BONE_WEIGHTS], or [constant Mesh.ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY]. [b]Note:[/b] When using indices, it is recommended to only use points, lines, or triangles.
func (Instance) AsArrayMesh ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) BlendShapeMode ¶
func (self Instance) BlendShapeMode() gdclass.MeshBlendShapeMode
func (Instance) ClearBlendShapes ¶
func (self Instance) ClearBlendShapes()
Removes all blend shapes from this [ArrayMesh].
func (Instance) ClearSurfaces ¶
func (self Instance) ClearSurfaces()
Removes all surfaces from this [ArrayMesh].
func (Instance) CustomAabb ¶
func (self Instance) CustomAabb() AABB.PositionSize
func (Instance) GetBlendShapeCount ¶
Returns the number of blend shapes that the [ArrayMesh] holds.
func (Instance) GetBlendShapeName ¶
Returns the name of the blend shape at this index.
func (Instance) LightmapUnwrap ¶
func (self Instance) LightmapUnwrap(transform Transform3D.BasisOrigin, texel_size Float.X) error
Performs a UV unwrap on the [ArrayMesh] to prepare the mesh for lightmapping.
func (Instance) RegenNormalMaps ¶
func (self Instance) RegenNormalMaps()
Regenerates tangents for each of the [ArrayMesh]'s surfaces.
func (Instance) SetBlendShapeMode ¶
func (self Instance) SetBlendShapeMode(value gdclass.MeshBlendShapeMode)
func (Instance) SetBlendShapeName ¶
Sets the name of the blend shape at this index.
func (Instance) SetCustomAabb ¶
func (self Instance) SetCustomAabb(value AABB.PositionSize)
func (Instance) SetShadowMesh ¶
func (Instance) ShadowMesh ¶
func (Instance) SurfaceFindByName ¶
Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found, -1 is returned.
func (Instance) SurfaceGetArrayIndexLen ¶
Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]).
func (Instance) SurfaceGetArrayLen ¶
Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]).
func (Instance) SurfaceGetFormat ¶
func (self Instance) SurfaceGetFormat(surf_idx int) gdclass.MeshArrayFormat
Returns the format mask of the requested surface (see [method add_surface_from_arrays]).
func (Instance) SurfaceGetName ¶
Gets the name assigned to this surface.
func (Instance) SurfaceGetPrimitiveType ¶
func (self Instance) SurfaceGetPrimitiveType(surf_idx int) gdclass.MeshPrimitiveType
Returns the primitive type of the requested surface (see [method add_surface_from_arrays]).
func (Instance) SurfaceSetName ¶
Sets a name for a given surface.
Source Files