Documentation
¶
Overview ¶
RibbonTrailMesh represents a straight ribbon-shaped mesh with variable width. The ribbon is composed of a number of flat or cross-shaped sections, each with the same SectionLength and number of SectionSegments. A Curve is sampled along the total length of the ribbon, meaning that the curve determines the size of the ribbon along its length.
This primitive mesh is usually used for particle trails.
Index ¶
- type Advanced
- type Any
- type Extension
- 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
- func (self *Extension[T]) AsRibbonTrailMesh() Instance
- type ID
- type 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) AsRibbonTrailMesh() Instance
- func (self Instance) Curve() Curve.Instance
- func (self Instance) ID() ID
- func (self Instance) SectionLength() Float.X
- func (self Instance) SectionSegments() int
- func (self Instance) Sections() int
- func (self Instance) SetCurve(value Curve.Instance)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetSectionLength(value Float.X)
- func (self Instance) SetSectionSegments(value int)
- func (self Instance) SetSections(value int)
- func (self Instance) SetShape(value Shape)
- func (self Instance) SetSize(value Float.X)
- func (self Instance) Shape() Shape
- func (self Instance) Size() Float.X
- func (self Instance) Virtual(name string) reflect.Value
- type Shape
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 Extension ¶
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]) 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 (*Extension[T]) AsRibbonTrailMesh ¶
type 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.
type Instance ¶
type Instance [1]gdclass.RibbonTrailMesh
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 (Instance) AsPrimitiveMesh ¶
func (self Instance) AsPrimitiveMesh() PrimitiveMesh.Instance
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsRibbonTrailMesh ¶
func (Instance) Curve ¶
Determines the size of the ribbon along its length. The size of a particular section segment is obtained by multiplying the baseline Size by the value of this curve at the given distance. For values smaller than 0, the faces will be inverted. Should be a unit Curve.
func (Instance) SectionLength ¶
The length of a section of the ribbon.
func (Instance) SectionSegments ¶
The number of segments in a section. The Curve is sampled on each segment to determine its size. Higher values result in a more detailed ribbon at the cost of performance.
func (Instance) SetSectionLength ¶
SetSectionLength sets the property returned by [GetSectionLength].
func (Instance) SetSectionSegments ¶
SetSectionSegments sets the property returned by [GetSectionSegments].
func (Instance) SetSections ¶
SetSections sets the property returned by [GetSections].
Source Files