CapsuleMesh

Documentation

Overview

Class representing a capsule-shaped PrimitiveMesh.

Index

• type Advanced
• type Any
• type Extension
  • func (self *Extension[T]) AsCapsuleMesh() Instance
  • func (self *Extension[T]) AsMesh() Mesh.Instance
  • func (self *Extension[T]) AsObject() [1]gd.Object
  • func (self *Extension[T]) AsPrimitiveMesh() PrimitiveMesh.Instance
  • func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
  • func (self *Extension[T]) AsResource() Resource.Instance
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) AsCapsuleMesh() Instance
  • func (self Instance) AsMesh() Mesh.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsPrimitiveMesh() PrimitiveMesh.Instance
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) Height() Float.X
  • func (self Instance) ID() ID
  • func (self Instance) RadialSegments() int
  • func (self Instance) Radius() Float.X
  • func (self Instance) Rings() int
  • func (self Instance) SetHeight(value Float.X)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) SetRadialSegments(value int)
  • func (self Instance) SetRadius(value Float.X)
  • func (self Instance) SetRings(value int)
  • 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
	AsCapsuleMesh() 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]) AsCapsuleMesh

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

func (*Extension[T]) AsMesh

func (self *Extension[T]) AsMesh() Mesh.Instance

func (*Extension[T]) AsObject

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

func (*Extension[T]) AsPrimitiveMesh

func (self *Extension[T]) AsPrimitiveMesh() PrimitiveMesh.Instance

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.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.CapsuleMesh

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

func (self Instance) AsCapsuleMesh() Instance

func (Instance) AsMesh

func (self Instance) AsMesh() Mesh.Instance

func (Instance) AsObject

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

func (Instance) AsPrimitiveMesh

func (self Instance) AsPrimitiveMesh() PrimitiveMesh.Instance

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) Height

func (self Instance) Height() Float.X

Total height of the capsule mesh (including the hemispherical ends).

Note: The Height of a capsule must be at least twice its Radius. Otherwise, the capsule becomes a circle. If the Height is less than twice the Radius, the properties adjust to a valid value.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) RadialSegments

func (self Instance) RadialSegments() int

Number of radial segments on the capsule mesh.

func (Instance) Radius

func (self Instance) Radius() Float.X

Radius of the capsule mesh.

Note: The Radius of a capsule cannot be greater than half of its Height. Otherwise, the capsule becomes a circle. If the Radius is greater than half of the Height, the properties adjust to a valid value.

func (Instance) Rings

func (self Instance) Rings() int

Number of rings along the height of the capsule.

func (Instance) SetHeight

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

SetHeight sets the property returned by [GetHeight].

func (*Instance) SetObject

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

func (Instance) SetRadialSegments

func (self Instance) SetRadialSegments(value int)

SetRadialSegments sets the property returned by [GetRadialSegments].

func (Instance) SetRadius

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

SetRadius sets the property returned by [GetRadius].

func (Instance) SetRings

func (self Instance) SetRings(value int)

SetRings sets the property returned by [GetRings].

func (Instance) Virtual

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