Documentation
¶
Overview ¶
Stores information about screen drag events. See Node.Input.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsInputEvent() InputEvent.Instance
- func (self *Extension[T]) AsInputEventFromWindow() InputEventFromWindow.Instance
- func (self *Extension[T]) AsInputEventScreenDrag() Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
- func (self *Extension[T]) AsResource() Resource.Instance
- type ID
- type Instance
- func (self Instance) AsInputEvent() InputEvent.Instance
- func (self Instance) AsInputEventFromWindow() InputEventFromWindow.Instance
- func (self Instance) AsInputEventScreenDrag() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) ID() ID
- func (self Instance) Index() int
- func (self Instance) PenInverted() bool
- func (self Instance) Position() Vector2.XY
- func (self Instance) Pressure() Float.X
- func (self Instance) Relative() Vector2.XY
- func (self Instance) ScreenRelative() Vector2.XY
- func (self Instance) ScreenVelocity() Vector2.XY
- func (self Instance) SetIndex(value int)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPenInverted(value bool)
- func (self Instance) SetPosition(value Vector2.XY)
- func (self Instance) SetPressure(value Float.X)
- func (self Instance) SetRelative(value Vector2.XY)
- func (self Instance) SetScreenRelative(value Vector2.XY)
- func (self Instance) SetScreenVelocity(value Vector2.XY)
- func (self Instance) SetTilt(value Vector2.XY)
- func (self Instance) SetVelocity(value Vector2.XY)
- func (self Instance) Tilt() Vector2.XY
- func (self Instance) Velocity() Vector2.XY
- 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 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]) AsInputEvent ¶
func (self *Extension[T]) AsInputEvent() InputEvent.Instance
func (*Extension[T]) AsInputEventFromWindow ¶
func (self *Extension[T]) AsInputEventFromWindow() InputEventFromWindow.Instance
func (*Extension[T]) AsInputEventScreenDrag ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
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.InputEventScreenDrag
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) AsInputEvent ¶
func (self Instance) AsInputEvent() InputEvent.Instance
func (Instance) AsInputEventFromWindow ¶
func (self Instance) AsInputEventFromWindow() InputEventFromWindow.Instance
func (Instance) AsInputEventScreenDrag ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) PenInverted ¶
Returns true when using the eraser end of a stylus pen.
func (Instance) Position ¶
The drag position in the viewport the node is in, using the coordinate system of this viewport.
func (Instance) Pressure ¶
Represents the pressure the user puts on the pen. Ranges from 0.0 to 1.0.
func (Instance) Relative ¶
The drag position relative to the previous position (position at the last frame).
Note: Relative is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means touch sensitivity will appear different depending on resolution when using Relative in a script that handles touch aiming. To avoid this, use ScreenRelative instead.
func (Instance) ScreenRelative ¶
The unscaled drag position relative to the previous position in screen coordinates (position at the last frame). This position is not scaled according to the content scale factor or calls to InputEvent.XformedBy. This should be preferred over Relative for touch aiming regardless of the project's stretch mode.
func (Instance) ScreenVelocity ¶
The unscaled drag velocity in pixels per second in screen coordinates. This velocity is not scaled according to the content scale factor or calls to InputEvent.XformedBy. This should be preferred over Velocity for touch aiming regardless of the project's stretch mode.
func (Instance) SetPenInverted ¶
SetPenInverted sets the property returned by [GetPenInverted].
func (Instance) SetPosition ¶
SetPosition sets the property returned by [GetPosition].
func (Instance) SetPressure ¶
SetPressure sets the property returned by [GetPressure].
func (Instance) SetRelative ¶
SetRelative sets the property returned by [GetRelative].
func (Instance) SetScreenRelative ¶
SetScreenRelative sets the property returned by [GetScreenRelative].
func (Instance) SetScreenVelocity ¶
SetScreenVelocity sets the property returned by [GetScreenVelocity].
func (Instance) SetVelocity ¶
SetVelocity sets the property returned by [GetVelocity].
func (Instance) Tilt ¶
Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from -1.0 to 1.0 for both axes.
func (Instance) Velocity ¶
The drag velocity.
Note: Velocity is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means touch sensitivity will appear different depending on resolution when using Velocity in a script that handles touch aiming. To avoid this, use ScreenVelocity instead.
Source Files