Documentation
¶
Overview ¶
Package Curve3D provides methods for working with Curve3D object instances.
Index ¶
- type Advanced
- type Any
- type Instance
- func (self Instance) AddPoint(position Vector3.XYZ)
- func (self Instance) AsCurve3D() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) BakeInterval() Float.X
- func (self Instance) ClearPoints()
- func (self Instance) GetBakedLength() Float.X
- func (self Instance) GetBakedPoints() []Vector3.XYZ
- func (self Instance) GetBakedTilts() []float32
- func (self Instance) GetBakedUpVectors() []Vector3.XYZ
- func (self Instance) GetClosestOffset(to_point Vector3.XYZ) Float.X
- func (self Instance) GetClosestPoint(to_point Vector3.XYZ) Vector3.XYZ
- func (self Instance) GetPointIn(idx int) Vector3.XYZ
- func (self Instance) GetPointOut(idx int) Vector3.XYZ
- func (self Instance) GetPointPosition(idx int) Vector3.XYZ
- func (self Instance) GetPointTilt(idx int) Float.X
- func (self Instance) PointCount() int
- func (self Instance) RemovePoint(idx int)
- func (self Instance) Sample(idx int, t Float.X) Vector3.XYZ
- func (self Instance) SampleBaked() Vector3.XYZ
- func (self Instance) SampleBakedUpVector(offset Float.X) Vector3.XYZ
- func (self Instance) SampleBakedWithRotation() Transform3D.BasisOrigin
- func (self Instance) Samplef(fofs Float.X) Vector3.XYZ
- func (self Instance) SetBakeInterval(value Float.X)
- func (self Instance) SetPointCount(value int)
- func (self Instance) SetPointIn(idx int, position Vector3.XYZ)
- func (self Instance) SetPointOut(idx int, position Vector3.XYZ)
- func (self Instance) SetPointPosition(idx int, position Vector3.XYZ)
- func (self Instance) SetPointTilt(idx int, tilt Float.X)
- func (self Instance) SetUpVectorEnabled(value bool)
- func (self Instance) Tessellate() []Vector3.XYZ
- func (self Instance) TessellateEvenLength() []Vector3.XYZ
- func (self *Instance) UnsafePointer() unsafe.Pointer
- func (self Instance) UpVectorEnabled() bool
- func (self Instance) Virtual(name string) reflect.Value
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 Instance ¶
This class describes a Bézier curve in 3D space. It is mainly used to give a shape to a [Path3D], but can be manually sampled for other purposes. It keeps a cache of precalculated points along the curve, to speed up further calculations.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AddPoint ¶
Adds a point with the specified [param position] relative to the curve's own position, with control points [param in] and [param out]. Appends the new point at the end of the point list. If [param index] is given, the new point is inserted before the existing point identified by index [param index]. Every existing point starting from [param index] is shifted further down the list of points. The index must be greater than or equal to [code]0[/code] and must not exceed the number of existing points in the line. See [member point_count].
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) BakeInterval ¶
func (Instance) GetBakedLength ¶
Returns the total length of the curve, based on the cached points. Given enough density (see [member bake_interval]), it should be approximate enough.
func (Instance) GetBakedPoints ¶
Returns the cache of points as a [PackedVector3Array].
func (Instance) GetBakedTilts ¶
Returns the cache of tilts as a [PackedFloat32Array].
func (Instance) GetBakedUpVectors ¶
Returns the cache of up vectors as a [PackedVector3Array]. If [member up_vector_enabled] is [code]false[/code], the cache will be empty.
func (Instance) GetClosestOffset ¶
Returns the closest offset to [param to_point]. This offset is meant to be used in [method sample_baked] or [method sample_baked_up_vector]. [param to_point] must be in this curve's local space.
func (Instance) GetClosestPoint ¶
Returns the closest point on baked segments (in curve's local space) to [param to_point]. [param to_point] must be in this curve's local space.
func (Instance) GetPointIn ¶
Returns the position of the control point leading to the vertex [param idx]. The returned position is relative to the vertex [param idx]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
func (Instance) GetPointOut ¶
Returns the position of the control point leading out of the vertex [param idx]. The returned position is relative to the vertex [param idx]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
func (Instance) GetPointPosition ¶
Returns the position of the vertex [param idx]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
func (Instance) GetPointTilt ¶
Returns the tilt angle in radians for the point [param idx]. If the index is out of bounds, the function sends an error to the console, and returns [code]0[/code].
func (Instance) PointCount ¶
func (Instance) RemovePoint ¶
Deletes the point [param idx] from the curve. Sends an error to the console if [param idx] is out of bounds.
func (Instance) Sample ¶
Returns the position between the vertex [param idx] and the vertex [code]idx + 1[/code], where [param t] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [param t] outside the range ([code]0.0 >= t <=1[/code]) give strange, but predictable results. If [param idx] is out of bounds it is truncated to the first or last vertex, and [param t] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
func (Instance) SampleBaked ¶
Returns a point within the curve at position [param offset], where [param offset] is measured as a distance in 3D units along the curve. To do that, it finds the two cached points where the [param offset] lies between, then interpolates the values. This interpolation is cubic if [param cubic] is set to [code]true[/code], or linear if set to [code]false[/code]. Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
func (Instance) SampleBakedUpVector ¶
Returns an up vector within the curve at position [param offset], where [param offset] is measured as a distance in 3D units along the curve. To do that, it finds the two cached up vectors where the [param offset] lies between, then interpolates the values. If [param apply_tilt] is [code]true[/code], an interpolated tilt is applied to the interpolated up vector. If the curve has no up vectors, the function sends an error to the console, and returns [code](0, 1, 0)[/code].
func (Instance) SampleBakedWithRotation ¶
func (self Instance) SampleBakedWithRotation() Transform3D.BasisOrigin
Returns a [Transform3D] with [code]origin[/code] as point position, [code]basis.x[/code] as sideway vector, [code]basis.y[/code] as up vector, [code]basis.z[/code] as forward vector. When the curve length is 0, there is no reasonable way to calculate the rotation, all vectors aligned with global space axes. See also [method sample_baked].
func (Instance) Samplef ¶
Returns the position at the vertex [param fofs]. It calls [method sample] using the integer part of [param fofs] as [code]idx[/code], and its fractional part as [code]t[/code].
func (Instance) SetBakeInterval ¶
func (Instance) SetPointCount ¶
func (Instance) SetPointIn ¶
Sets the position of the control point leading to the vertex [param idx]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex.
func (Instance) SetPointOut ¶
Sets the position of the control point leading out of the vertex [param idx]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex.
func (Instance) SetPointPosition ¶
Sets the position for the vertex [param idx]. If the index is out of bounds, the function sends an error to the console.
func (Instance) SetPointTilt ¶
Sets the tilt angle in radians for the point [param idx]. If the index is out of bounds, the function sends an error to the console. The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow3D], this tilt is an offset over the natural tilt the [PathFollow3D] calculates.
func (Instance) SetUpVectorEnabled ¶
func (Instance) Tessellate ¶
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. [param max_stages] controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! [param tolerance_degrees] controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.
func (Instance) TessellateEvenLength ¶
Returns a list of points along the curve, with almost uniform density. [param max_stages] controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! [param tolerance_length] controls the maximal distance between two neighboring points, before the segment has to be subdivided.
Source Files