PrimitiveMesh

Documentation

Overview

Package PrimitiveMesh provides methods for working with PrimitiveMesh object instances.

Index

• type Advanced
• type Any
• type Implementation
• type Instance
  • func New() Instance
  • func (self Instance) AddUv2() bool
  • func (self Instance) AsMesh() Mesh.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsPrimitiveMesh() Instance
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) CustomAabb() AABB.PositionSize
  • func (self Instance) FlipFaces() bool
  • func (self Instance) GetMeshArrays() []any
  • func (self Instance) Material() [1]gdclass.Material
  • func (self Instance) RequestUpdate()
  • func (self Instance) SetAddUv2(value bool)
  • func (self Instance) SetCustomAabb(value AABB.PositionSize)
  • func (self Instance) SetFlipFaces(value bool)
  • func (self Instance) SetMaterial(value [1]gdclass.Material)
  • func (self Instance) SetUv2Padding(value Float.X)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Uv2Padding() Float.X
  • func (self Instance) Virtual(name string) reflect.Value
• type Interface

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 Any

type Any interface {
	gd.IsClass
	AsPrimitiveMesh() Instance
}

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.PrimitiveMesh

Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh. Examples include [BoxMesh], [CapsuleMesh], [CylinderMesh], [PlaneMesh], [PrismMesh], and [SphereMesh].

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=PrimitiveMesh)

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AddUv2

func (self Instance) AddUv2() bool

func (Instance) AsMesh

func (self Instance) AsMesh() Mesh.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsPrimitiveMesh

func (self Instance) AsPrimitiveMesh() Instance

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) CustomAabb

func (self Instance) CustomAabb() AABB.PositionSize

func (Instance) FlipFaces

func (self Instance) FlipFaces() bool

func (Instance) GetMeshArrays

func (self Instance) GetMeshArrays() []any

Returns mesh arrays used to constitute surface of [Mesh]. The result can be passed to [method ArrayMesh.add_surface_from_arrays] to create a new surface. For example: [codeblocks] [gdscript] var c = CylinderMesh.new() var arr_mesh = ArrayMesh.new() arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, c.get_mesh_arrays()) [/gdscript] [csharp] var c = new CylinderMesh(); var arrMesh = new ArrayMesh(); arrMesh.AddSurfaceFromArrays(Mesh.PrimitiveType.Triangles, c.GetMeshArrays()); [/csharp] [/codeblocks]

func (Instance) Material

func (self Instance) Material() [1]gdclass.Material

func (Instance) RequestUpdate

func (self Instance) RequestUpdate()

Request an update of this primitive mesh based on its properties.

func (Instance) SetAddUv2

func (self Instance) SetAddUv2(value bool)

func (Instance) SetCustomAabb

func (self Instance) SetCustomAabb(value AABB.PositionSize)

func (Instance) SetFlipFaces

func (self Instance) SetFlipFaces(value bool)

func (Instance) SetMaterial

func (self Instance) SetMaterial(value [1]gdclass.Material)

func (Instance) SetUv2Padding

func (self Instance) SetUv2Padding(value Float.X)

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Uv2Padding

func (self Instance) Uv2Padding() Float.X

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type Interface

type Interface interface {
	//Override this method to customize how this primitive mesh should be generated. Should return an [Array] where each element is another Array of values required for the mesh (see the [enum Mesh.ArrayType] constants).
	CreateMeshArray() []any
}