CSGMesh3D

Documentation

Overview

This CSG node allows you to use any mesh resource as a CSG shape, provided it is manifold. A manifold shape is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more than two faces. See also CSGPolygon3D for drawing 2D extruded polygons to be used as CSG nodes.

Note: CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a MeshInstance3D with a PrimitiveMesh. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.

Index

• type Advanced
• type Any
• type Extension
  • func (self *Extension[T]) AsCSGMesh3D() Instance
  • func (self *Extension[T]) AsCSGPrimitive3D() CSGPrimitive3D.Instance
  • func (self *Extension[T]) AsCSGShape3D() CSGShape3D.Instance
  • func (self *Extension[T]) AsGeometryInstance3D() GeometryInstance3D.Instance
  • func (self *Extension[T]) AsNode() Node.Instance
  • func (self *Extension[T]) AsNode3D() Node3D.Instance
  • func (self *Extension[T]) AsObject() [1]gd.Object
  • func (self *Extension[T]) AsVisualInstance3D() VisualInstance3D.Instance
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) AsCSGMesh3D() Instance
  • func (self Instance) AsCSGPrimitive3D() CSGPrimitive3D.Instance
  • func (self Instance) AsCSGShape3D() CSGShape3D.Instance
  • func (self Instance) AsGeometryInstance3D() GeometryInstance3D.Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance
  • func (self Instance) ID() ID
  • func (self Instance) Material() Material.Instance
  • func (self Instance) Mesh() Mesh.Instance
  • func (self Instance) SetMaterial(value Material.Instance)
  • func (self Instance) SetMesh(value Mesh.Instance)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) Virtual(name string) reflect.Value

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
	AsCSGMesh3D() 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

func (*Extension[T]) AsCSGMesh3D

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

func (*Extension[T]) AsCSGPrimitive3D

func (self *Extension[T]) AsCSGPrimitive3D() CSGPrimitive3D.Instance

func (*Extension[T]) AsCSGShape3D

func (self *Extension[T]) AsCSGShape3D() CSGShape3D.Instance

func (*Extension[T]) AsGeometryInstance3D

func (self *Extension[T]) AsGeometryInstance3D() GeometryInstance3D.Instance

func (*Extension[T]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode3D

func (self *Extension[T]) AsNode3D() Node3D.Instance

func (*Extension[T]) AsObject

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

func (*Extension[T]) AsVisualInstance3D

func (self *Extension[T]) AsVisualInstance3D() VisualInstance3D.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 Instance

type Instance [1]gdclass.CSGMesh3D

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) AsCSGMesh3D

func (self Instance) AsCSGMesh3D() Instance

func (Instance) AsCSGPrimitive3D

func (self Instance) AsCSGPrimitive3D() CSGPrimitive3D.Instance

func (Instance) AsCSGShape3D

func (self Instance) AsCSGShape3D() CSGShape3D.Instance

func (Instance) AsGeometryInstance3D

func (self Instance) AsGeometryInstance3D() GeometryInstance3D.Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject

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

func (Instance) AsVisualInstance3D

func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Material

func (self Instance) Material() Material.Instance

The Material used in drawing the CSG shape.

func (Instance) Mesh

func (self Instance) Mesh() Mesh.Instance

The Mesh resource to use as a CSG shape.

Note: Some Mesh types such as PlaneMesh, PointMesh, QuadMesh, and RibbonTrailMesh are excluded from the type hint for this property, as these primitives are non-manifold and thus not compatible with the CSG algorithm.

Note: When using an ArrayMesh, all vertex attributes except [Mesh.ArrayVertex], [Mesh.ArrayNormal] and [Mesh.ArrayTexUv] are left unused. Only [Mesh.ArrayVertex] and [Mesh.ArrayTexUv] will be passed to the GPU.

[Mesh.ArrayNormal] is only used to determine which faces require the use of flat shading. By default, CSGMesh will ignore the mesh's vertex normals, recalculate them for each vertex and use a smooth shader. If a flat shader is required for a face, ensure that all vertex normals of the face are approximately equal.

func (Instance) SetMaterial

func (self Instance) SetMaterial(value Material.Instance)

SetMaterial sets the property returned by [GetMaterial].

func (Instance) SetMesh

func (self Instance) SetMesh(value Mesh.Instance)

SetMesh sets the property returned by [GetMesh].

func (*Instance) SetObject

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

func (Instance) Virtual

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