PrimitiveMesh

package
v0.0.0-...-535787f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2025 License: MIT Imports: 26 Imported by: 0

Documentation

Overview

Base class for all primitive meshes. Handles applying a graphics.gd/classdb/Material to a primitive mesh. Examples include graphics.gd/classdb/BoxMesh, graphics.gd/classdb/CapsuleMesh, graphics.gd/classdb/CylinderMesh, graphics.gd/classdb/PlaneMesh, graphics.gd/classdb/PrismMesh, and graphics.gd/classdb/SphereMesh.

Index

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 Any

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

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this [Extension]See Interface for methods that can be overridden by T.

func (*Extension[T]) AsMesh

func (self *Extension[T]) AsMesh() Mesh.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsPrimitiveMesh

func (self *Extension[T]) AsPrimitiveMesh() Instance

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.PrimitiveMesh

Instance of the class with convieniently typed arguments and results.

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 the mesh arrays used to make up the surface of this primitive mesh.

Example: Pass the result to graphics.gd/classdb/ArrayMesh.Instance.AddSurfaceFromArrays to create a new surface:

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Material

func (self Instance) Material() Material.Instance

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 Material.Instance)

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetUv2Padding

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

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 slice where each element is another Array of values required for the mesh (see the [Mesh.ArrayType] constants).
	CreateMeshArray() [][]interface{}
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL