Documentation
¶
Overview ¶
Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh. Examples include [BoxMesh], [CapsuleMesh], [CylinderMesh], [PlaneMesh], [PrismMesh], and [SphereMesh].
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Implementation
- type 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) ID() ID
- func (self Instance) Material() Material.Instance
- 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 Material.Instance)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetUv2Padding(value Float.X)
- func (self Instance) Uv2Padding() Float.X
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
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 Extension ¶
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
func (*Extension[T]) AsPrimitiveMesh ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type 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.
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. See Interface for methods that can be overridden by a [Class] that extends it.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsPrimitiveMesh ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) CustomAabb ¶
func (self Instance) CustomAabb() AABB.PositionSize
func (Instance) GetMeshArrays ¶
Returns the mesh arrays used to make up the surface of this primitive mesh. Example: Pass the result to [Instance.Arraymesh.AddSurfaceFromArrays] to create a new surface:
[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]
func (Instance) RequestUpdate ¶
func (self Instance) RequestUpdate()
Request an update of this primitive mesh based on its properties.
func (Instance) SetCustomAabb ¶
func (self Instance) SetCustomAabb(value AABB.PositionSize)
Source Files