CSGPolygon3D

Documentation

Overview

Package CSGPolygon3D provides methods for working with CSGPolygon3D object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsCSGPolygon3D() 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) Depth() Float.X
  • func (self Instance) Material() [1]gdclass.Material
  • func (self Instance) Mode() gdclass.CSGPolygon3DMode
  • func (self Instance) PathContinuousU() bool
  • func (self Instance) PathInterval() Float.X
  • func (self Instance) PathIntervalType() gdclass.CSGPolygon3DPathIntervalType
  • func (self Instance) PathJoined() bool
  • func (self Instance) PathLocal() bool
  • func (self Instance) PathNode() string
  • func (self Instance) PathRotation() gdclass.CSGPolygon3DPathRotation
  • func (self Instance) PathSimplifyAngle() Float.X
  • func (self Instance) PathUDistance() Float.X
  • func (self Instance) Polygon() []Vector2.XY
  • func (self Instance) SetDepth(value Float.X)
  • func (self Instance) SetMaterial(value [1]gdclass.Material)
  • func (self Instance) SetMode(value gdclass.CSGPolygon3DMode)
  • func (self Instance) SetPathContinuousU(value bool)
  • func (self Instance) SetPathInterval(value Float.X)
  • func (self Instance) SetPathIntervalType(value gdclass.CSGPolygon3DPathIntervalType)
  • func (self Instance) SetPathJoined(value bool)
  • func (self Instance) SetPathLocal(value bool)
  • func (self Instance) SetPathNode(value string)
  • func (self Instance) SetPathRotation(value gdclass.CSGPolygon3DPathRotation)
  • func (self Instance) SetPathSimplifyAngle(value Float.X)
  • func (self Instance) SetPathUDistance(value Float.X)
  • func (self Instance) SetPolygon(value []Vector2.XY)
  • func (self Instance) SetSmoothFaces(value bool)
  • func (self Instance) SetSpinDegrees(value Float.X)
  • func (self Instance) SetSpinSides(value int)
  • func (self Instance) SmoothFaces() bool
  • func (self Instance) SpinDegrees() Float.X
  • func (self Instance) SpinSides() int
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Mode
• type PathIntervalType
• type PathRotation

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 Instance

type Instance [1]gdclass.CSGPolygon3D

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. [b]Note:[/b] 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.

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

func (Instance) Material

func (self Instance) Material() [1]gdclass.Material

func (Instance) Mode

func (self Instance) Mode() gdclass.CSGPolygon3DMode

func (Instance) PathContinuousU

func (self Instance) PathContinuousU() bool

func (Instance) PathInterval

func (self Instance) PathInterval() Float.X

func (Instance) PathIntervalType

func (self Instance) PathIntervalType() gdclass.CSGPolygon3DPathIntervalType

func (Instance) PathJoined

func (self Instance) PathJoined() bool

func (Instance) PathLocal

func (self Instance) PathLocal() bool

func (Instance) PathNode

func (self Instance) PathNode() string

func (Instance) PathRotation

func (self Instance) PathRotation() gdclass.CSGPolygon3DPathRotation

func (Instance) PathSimplifyAngle

func (self Instance) PathSimplifyAngle() Float.X

func (Instance) PathUDistance

func (self Instance) PathUDistance() Float.X

func (Instance) Polygon

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

func (Instance) SetDepth

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

func (Instance) SetMaterial

func (self Instance) SetMaterial(value [1]gdclass.Material)

func (Instance) SetMode

func (self Instance) SetMode(value gdclass.CSGPolygon3DMode)

func (Instance) SetPathContinuousU

func (self Instance) SetPathContinuousU(value bool)

func (Instance) SetPathInterval

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

func (Instance) SetPathIntervalType

func (self Instance) SetPathIntervalType(value gdclass.CSGPolygon3DPathIntervalType)

func (Instance) SetPathJoined

func (self Instance) SetPathJoined(value bool)

func (Instance) SetPathLocal

func (self Instance) SetPathLocal(value bool)

func (Instance) SetPathNode

func (self Instance) SetPathNode(value string)

func (Instance) SetPathRotation

func (self Instance) SetPathRotation(value gdclass.CSGPolygon3DPathRotation)

func (Instance) SetPathSimplifyAngle

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

func (Instance) SetPathUDistance

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

func (Instance) SetPolygon

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

func (Instance) SetSmoothFaces

func (self Instance) SetSmoothFaces(value bool)

func (Instance) SetSpinDegrees

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

func (Instance) SetSpinSides

func (self Instance) SetSpinSides(value int)

func (Instance) SmoothFaces

func (self Instance) SmoothFaces() bool

func (Instance) SpinDegrees

func (self Instance) SpinDegrees() Float.X

func (Instance) SpinSides

func (self Instance) SpinSides() int

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

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

type Mode

type Mode = gdclass.CSGPolygon3DMode //gd:CSGPolygon3D.Mode

const (
	/*The [member polygon] shape is extruded along the negative Z axis.*/
	ModeDepth Mode = 0
	/*The [member polygon] shape is extruded by rotating it around the Y axis.*/
	ModeSpin Mode = 1
	/*The [member polygon] shape is extruded along the [Path3D] specified in [member path_node].*/
	ModePath Mode = 2
)

type PathIntervalType

type PathIntervalType = gdclass.CSGPolygon3DPathIntervalType //gd:CSGPolygon3D.PathIntervalType

const (
	/*When [member mode] is set to [constant MODE_PATH], [member path_interval] will determine the distance, in meters, each interval of the path will extrude.*/
	PathIntervalDistance PathIntervalType = 0
	/*When [member mode] is set to [constant MODE_PATH], [member path_interval] will subdivide the polygons along the path.*/
	PathIntervalSubdivide PathIntervalType = 1
)

type PathRotation

type PathRotation = gdclass.CSGPolygon3DPathRotation //gd:CSGPolygon3D.PathRotation

const (
	/*The [member polygon] shape is not rotated.
	  [b]Note:[/b] Requires the path Z coordinates to continually decrease to ensure viable shapes.*/
	PathRotationPolygon PathRotation = 0
	/*The [member polygon] shape is rotated along the path, but it is not rotated around the path axis.
	  [b]Note:[/b] Requires the path Z coordinates to continually decrease to ensure viable shapes.*/
	PathRotationPath PathRotation = 1
	/*The [member polygon] shape follows the path and its rotations around the path axis.*/
	PathRotationPathFollow PathRotation = 2
)