CSGCylinder3D

package
v0.0.0-...-357ca8a Latest Latest
Warning

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

Go to latest
Published: Sep 20, 2025 License: MIT Imports: 30 Imported by: 0

Documentation

Overview

This node allows you to create a cylinder (or cone) for use with the CSG system.

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

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
	AsCSGCylinder3D() 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]) AsCSGCylinder3D

func (self *Extension[T]) AsCSGCylinder3D() 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.CSGCylinder3D

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

func (self Instance) AsCSGCylinder3D() 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) Cone

func (self Instance) Cone() bool

If true a cone is created, the Radius will only apply to one side.

func (Instance) Height

func (self Instance) Height() Float.X

The height of the cylinder.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Material

func (self Instance) Material() Material.Instance

The material used to render the cylinder.

func (Instance) Radius

func (self Instance) Radius() Float.X

The radius of the cylinder.

func (Instance) SetCone

func (self Instance) SetCone(value bool)

SetCone sets the property returned by [IsCone].

func (Instance) SetHeight

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

SetHeight sets the property returned by [GetHeight].

func (Instance) SetMaterial

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

SetMaterial sets the property returned by [GetMaterial].

func (*Instance) SetObject

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

func (Instance) SetRadius

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

SetRadius sets the property returned by [GetRadius].

func (Instance) SetSides

func (self Instance) SetSides(value int)

SetSides sets the property returned by [GetSides].

func (Instance) SetSmoothFaces

func (self Instance) SetSmoothFaces(value bool)

SetSmoothFaces sets the property returned by [GetSmoothFaces].

func (Instance) Sides

func (self Instance) Sides() int

The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.

func (Instance) SmoothFaces

func (self Instance) SmoothFaces() bool

If true the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If false the cylinder will have a flat shaded look.

func (Instance) Virtual

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

Jump to

Keyboard shortcuts

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