CSGPolygon3D

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: 31 Imported by: 0

Documentation

Overview

An array of 2D points is extruded to quickly and easily create a variety of 3D meshes. See also CSGMesh3D for using 3D meshes 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

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

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

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

func (self Instance) AsCSGPolygon3D() 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) Depth 

func (self Instance) Depth() Float.X

When Mode is ModeDepth, the depth of the extrusion.

func (Instance) ID 

func (self Instance) ID() ID

func (Instance) Material 

func (self Instance) Material() Material.Instance

Material to use for the resulting mesh. The UV maps the top half of the material to the extruded shape (U along the length of the extrusions and V around the outline of the Polygon), the bottom-left quarter to the front end face, and the bottom-right quarter to the back end face.

func (Instance) Mode 

func (self Instance) Mode() Mode

The Mode used to extrude the Polygon.

func (Instance) PathContinuousU 

func (self Instance) PathContinuousU() bool

When Mode is ModePath, by default, the top half of the Material is stretched along the entire length of the extruded shape. If false the top half of the material is repeated every step of the extrusion.

func (Instance) PathInterval 

func (self Instance) PathInterval() Float.X

When Mode is ModePath, the path interval or ratio of path points to extrusions.

func (Instance) PathIntervalType 

func (self Instance) PathIntervalType() PathIntervalType

When Mode is ModePath, this will determine if the interval should be by distance (PathIntervalDistance) or subdivision fractions (PathIntervalSubdivide).

func (Instance) PathJoined 

func (self Instance) PathJoined() bool

When Mode is ModePath, if true the ends of the path are joined, by adding an extrusion between the last and first points of the path.

func (Instance) PathLocal 

func (self Instance) PathLocal() bool

When Mode is ModePath, if true the Transform3D.BasisOrigin of the CSGPolygon3D is used as the starting point for the extrusions, not the Transform3D.BasisOrigin of the PathNode.

func (Instance) PathNode 

func (self Instance) PathNode() string

When Mode is ModePath, the location of the Path3D object used to extrude the Polygon.

func (Instance) PathRotation 

func (self Instance) PathRotation() PathRotation

When Mode is ModePath, the path rotation method used to rotate the Polygon as it is extruded.

func (Instance) PathRotationAccurate 

func (self Instance) PathRotationAccurate() bool

When Mode is ModePath, if true the polygon will be rotated according to the proper tangent of the path at the sampled points. If false an approximation is used, which decreases in accuracy as the number of subdivisions decreases.

func (Instance) PathSimplifyAngle 

func (self Instance) PathSimplifyAngle() Angle.Radians

When Mode is ModePath, extrusions that are less than this angle, will be merged together to reduce polygon count.

func (Instance) PathUDistance 

func (self Instance) PathUDistance() Float.X

When Mode is ModePath, this is the distance along the path, in meters, the texture coordinates will tile. When set to 0, texture coordinates will match geometry exactly with no tiling.

func (Instance) Polygon 

func (self Instance) Polygon() []Vector2.XY

The point array that defines the 2D polygon that is extruded. This can be a convex or concave polygon with 3 or more points. The polygon must not have any intersecting edges. Otherwise, triangulation will fail and no mesh will be generated.

Note: If only 1 or 2 points are defined in Polygon, no mesh will be generated.

func (Instance) SetDepth 

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

SetDepth sets the property returned by [GetDepth].

func (Instance) SetMaterial 

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

SetMaterial sets the property returned by [GetMaterial].

func (Instance) SetMode 

func (self Instance) SetMode(value Mode)

SetMode sets the property returned by [GetMode].

func (*Instance) SetObject 

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

func (Instance) SetPathContinuousU 

func (self Instance) SetPathContinuousU(value bool)

SetPathContinuousU sets the property returned by [IsPathContinuousU].

func (Instance) SetPathInterval 

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

SetPathInterval sets the property returned by [GetPathInterval].

func (Instance) SetPathIntervalType 

func (self Instance) SetPathIntervalType(value PathIntervalType)

SetPathIntervalType sets the property returned by [GetPathIntervalType].

func (Instance) SetPathJoined 

func (self Instance) SetPathJoined(value bool)

SetPathJoined sets the property returned by [IsPathJoined].

func (Instance) SetPathLocal 

func (self Instance) SetPathLocal(value bool)

SetPathLocal sets the property returned by [IsPathLocal].

func (Instance) SetPathNode 

func (self Instance) SetPathNode(value string)

SetPathNode sets the property returned by [GetPathNode].

func (Instance) SetPathRotation 

func (self Instance) SetPathRotation(value PathRotation)

SetPathRotation sets the property returned by [GetPathRotation].

func (Instance) SetPathRotationAccurate 

func (self Instance) SetPathRotationAccurate(value bool)

SetPathRotationAccurate sets the property returned by [GetPathRotationAccurate].

func (Instance) SetPathSimplifyAngle 

func (self Instance) SetPathSimplifyAngle(value Angle.Radians)

SetPathSimplifyAngle sets the property returned by [GetPathSimplifyAngle].

func (Instance) SetPathUDistance 

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

SetPathUDistance sets the property returned by [GetPathUDistance].

func (Instance) SetPolygon 

func (self Instance) SetPolygon(value []Vector2.XY)

SetPolygon sets the property returned by [GetPolygon].

func (Instance) SetSmoothFaces 

func (self Instance) SetSmoothFaces(value bool)

SetSmoothFaces sets the property returned by [GetSmoothFaces].

func (Instance) SetSpinDegrees 

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

SetSpinDegrees sets the property returned by [GetSpinDegrees].

func (Instance) SetSpinSides 

func (self Instance) SetSpinSides(value int)

SetSpinSides sets the property returned by [GetSpinSides].

func (Instance) SmoothFaces 

func (self Instance) SmoothFaces() bool

If true, applies smooth shading to the extrusions.

func (Instance) SpinDegrees 

func (self Instance) SpinDegrees() Float.X

When Mode is ModeSpin, the total number of degrees the Polygon is rotated when extruding.

func (Instance) SpinSides 

func (self Instance) SpinSides() int

When Mode is ModeSpin, the number of extrusions made.

func (Instance) Virtual 

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

type Mode 

type Mode int //gd:CSGPolygon3D.Mode

const (
	// The [Polygon] shape is extruded along the negative Z axis.
	//
	// [Polygon]: https://pkg.go.dev/graphics.gd/classdb/#Instance.Polygon
	ModeDepth Mode = 0
	// The [Polygon] shape is extruded by rotating it around the Y axis.
	//
	// [Polygon]: https://pkg.go.dev/graphics.gd/classdb/#Instance.Polygon
	ModeSpin Mode = 1
	// The [Polygon] shape is extruded along the [Path3D] specified in [PathNode].
	//
	// [Path3D]: https://pkg.go.dev/graphics.gd/classdb/Path3D
	// [PathNode]: https://pkg.go.dev/graphics.gd/classdb/#Instance.PathNode
	// [Polygon]: https://pkg.go.dev/graphics.gd/classdb/#Instance.Polygon
	ModePath Mode = 2
)

type PathIntervalType 

type PathIntervalType int //gd:CSGPolygon3D.PathIntervalType

const (
	// When [Mode] is set to [ModePath], [PathInterval] will determine the distance, in meters, each interval of the path will extrude.
	//
	// [Mode]: https://pkg.go.dev/graphics.gd/classdb/#Instance.Mode
	// [PathInterval]: https://pkg.go.dev/graphics.gd/classdb/#Instance.PathInterval
	PathIntervalDistance PathIntervalType = 0
	// When [Mode] is set to [ModePath], [PathInterval] will subdivide the polygons along the path.
	//
	// [Mode]: https://pkg.go.dev/graphics.gd/classdb/#Instance.Mode
	// [PathInterval]: https://pkg.go.dev/graphics.gd/classdb/#Instance.PathInterval
	PathIntervalSubdivide PathIntervalType = 1
)

type PathRotation 

type PathRotation int //gd:CSGPolygon3D.PathRotation

const (
	// The [Polygon] shape is not rotated.
	//
	// Note: Requires the path Z coordinates to continually decrease to ensure viable shapes.
	//
	// [Polygon]: https://pkg.go.dev/graphics.gd/classdb/#Instance.Polygon
	PathRotationPolygon PathRotation = 0
	// The [Polygon] shape is rotated along the path, but it is not rotated around the path axis.
	//
	// Note: Requires the path Z coordinates to continually decrease to ensure viable shapes.
	//
	// [Polygon]: https://pkg.go.dev/graphics.gd/classdb/#Instance.Polygon
	PathRotationPath PathRotation = 1
	// The [Polygon] shape follows the path and its rotations around the path axis.
	//
	// [Polygon]: https://pkg.go.dev/graphics.gd/classdb/#Instance.Polygon
	PathRotationPathFollow PathRotation = 2
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.