Documentation
¶
Overview ¶
Package Generic6DOFJoint3D provides methods for working with Generic6DOFJoint3D object instances.
Index ¶
- type Advanced
- type Any
- type Extension
- type Flag
- type ID
- type Instance
- func (self Instance) AsGeneric6DOFJoint3D() Instance
- func (self Instance) AsJoint3D() Joint3D.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) GetFlagX(flag Flag) bool
- func (self Instance) GetFlagY(flag Flag) bool
- func (self Instance) GetFlagZ(flag Flag) bool
- func (self Instance) GetParamX(param Param) Float.X
- func (self Instance) GetParamY(param Param) Float.X
- func (self Instance) GetParamZ(param Param) Float.X
- func (self Instance) ID() ID
- func (self Instance) SetFlagX(flag Flag, value bool)
- func (self Instance) SetFlagY(flag Flag, value bool)
- func (self Instance) SetFlagZ(flag Flag, value bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetParamX(param Param, value Float.X)
- func (self Instance) SetParamY(param Param, value Float.X)
- func (self Instance) SetParamZ(param Param, value Float.X)
- func (self Instance) Virtual(name string) reflect.Value
- type Param
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]) AsGeneric6DOFJoint3D ¶
type Flag ¶
type Flag int //gd:Generic6DOFJoint3D.Flag
const ( /*If enabled, linear motion is possible within the given limits.*/ FlagEnableLinearLimit Flag = 0 /*If enabled, rotational motion is possible within the given limits.*/ FlagEnableAngularLimit Flag = 1 FlagEnableLinearSpring Flag = 3 FlagEnableAngularSpring Flag = 2 /*If enabled, there is a rotational motor across these axes.*/ FlagEnableMotor Flag = 4 /*If enabled, there is a linear motor across these axes.*/ FlagEnableLinearMotor Flag = 5 /*Represents the size of the [enum Flag] enum.*/ FlagMax Flag = 6 )
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.Generic6DOFJoint3D
The [Generic6DOFJoint3D] (6 Degrees Of Freedom) joint allows for implementing custom types of joints by locking the rotation and translation of certain axes. The first 3 DOF represent the linear motion of the physics bodies and the last 3 DOF represent the angular motion of the physics bodies. Each axis can be either locked, or limited.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsGeneric6DOFJoint3D ¶
type Param ¶
type Param int //gd:Generic6DOFJoint3D.Param
const ( /*The minimum difference between the pivot points' axes.*/ ParamLinearLowerLimit Param = 0 /*The maximum difference between the pivot points' axes.*/ ParamLinearUpperLimit Param = 1 /*A factor applied to the movement across the axes. The lower, the slower the movement.*/ ParamLinearLimitSoftness Param = 2 /*The amount of restitution on the axes' movement. The lower, the more momentum gets lost.*/ ParamLinearRestitution Param = 3 /*The amount of damping that happens at the linear motion across the axes.*/ ParamLinearDamping Param = 4 /*The velocity the linear motor will try to reach.*/ ParamLinearMotorTargetVelocity Param = 5 /*The maximum force the linear motor will apply while trying to reach the velocity target.*/ ParamLinearMotorForceLimit Param = 6 ParamLinearSpringStiffness Param = 7 ParamLinearSpringDamping Param = 8 ParamLinearSpringEquilibriumPoint Param = 9 /*The minimum rotation in negative direction to break loose and rotate around the axes.*/ ParamAngularLowerLimit Param = 10 /*The minimum rotation in positive direction to break loose and rotate around the axes.*/ ParamAngularUpperLimit Param = 11 /*The speed of all rotations across the axes.*/ ParamAngularLimitSoftness Param = 12 /*The amount of rotational damping across the axes. The lower, the more damping occurs.*/ ParamAngularDamping Param = 13 /*The amount of rotational restitution across the axes. The lower, the more restitution occurs.*/ ParamAngularRestitution Param = 14 /*The maximum amount of force that can occur, when rotating around the axes.*/ ParamAngularForceLimit Param = 15 /*When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.*/ ParamAngularErp Param = 16 /*Target speed for the motor at the axes.*/ ParamAngularMotorTargetVelocity Param = 17 /*Maximum acceleration for the motor at the axes.*/ ParamAngularMotorForceLimit Param = 18 ParamAngularSpringStiffness Param = 19 ParamAngularSpringDamping Param = 20 ParamAngularSpringEquilibriumPoint Param = 21 /*Represents the size of the [enum Param] enum.*/ ParamMax Param = 22 )