View source for Slot transforms

<languages />

<translate>
<!--T:1-->
Every [[slot]] in a [[world]] has an associated set of position, rotation and scale values, even if there is no visual component associated with it. Since space is three dimensional in Resonite, position is encoded as a [[Type:float3|float3]] [[:Category:Type|type]], which is a [https://en.wikipedia.org/wiki/Euclidean_vector 3D vector] of coordinates along X, Y, and Z axes. Rotations can also be expressed as angular displacements about these three axes and this is how it is displayed in the slot [[Scene Inspector|inspector panel]]. However, rotations are internally managed as a [[Type:floatQ|floatQ]] type, or a [https://en.wikipedia.org/wiki/Quaternion quaternion]. Scale works similarly to position and is encoded as a float3.
</translate>

<translate>
== Directions ==
</translate>

<translate>
<!--T:3-->
[[File:Resonite Inspector Axis Directions.png|thumb|498x498px|The [[scene inspector]] shows a reference of directions in Resonite.]]
</translate>

<translate>
Resonite has a convention mapping direction words to numerical directions in game. This mapping is as follows:
</translate>

<translate>
{| class="wikitable"
! Relative direction !! In-game direction !! Vector
|-
| Right || Positive X (+X) || <code>[1; 0; 0]</code>
|-
| Left || Negative X (-X) || <code>[-1; 0; 0]</code>
|-
| Up || Positive Y (+Y) || <code>[0; 1; 0]</code>
|-
| Down || Negative Y (-Y) || <code>[0; -1; 0]</code>
|-
| Forwards || Positive Z (+Z) || <code>[0; 0; 1]</code>
|-
| Backwards || Negative Z (-Z) || <code>[0; 0; -1]</code>
|}
</translate>

<translate>
This makes Resonite's coordinate system follow the same convention as [https://docs.unity3d.com/6000.0/Documentation/Manual/QuaternionAndEulerRotationsInUnity.html Unity].
</translate>

== <translate><!--T:5--> Coordinate spaces</translate> ==

<translate>
<!--T:6-->
In Resonite, a '''coordinate space''' refers to the orientation of the X, Y, and Z axes for a given transform. There are two different kinds of coordinate spaces that you work with in Resonite:
</translate>

* <translate><!--T:7--> The '''global''' coordinate space is the base coordinate space and is measured relative to the world [[Root|root]]. It can not be changed.</translate>
* <translate><!--T:8--> A '''local''' coordinate space, which is measured relative to some slot in the slot hierarchy.</translate>

<translate>
<!--T:9-->
The <code>Position</code>, <code>Rotation</code>, and <code>Scale</code> fields on slots in the [[scene inspector]] are shown and managed in a local coordinate space to the slot's immediate parent.
</translate>

<translate>
<!--T:10-->
The world's root slot is unique and always at the top of the world slot hierarchy. It has a fixed position at <code>[0; 0; 0]</code>, fixed identity rotation, and <code>[1; 1; 1]</code> scale. This means that, for a slot parented directly under the world root, global and local coordinate measures will be equivalent. This is also true if the combined transform of all of a slot's parents result in <code>[0; 0; 0]</code> position, <code>[0; 0; 0; 1]</code> rotation, and <code>[1; 1; 1]</code> scale.
</translate>

<translate>
<!--T:11-->
For example, if a slot, Slot_A, is parented under the world root and has global position <code>[1; 0; 0]</code>, its local position, as shown in the inspector, will be <code>[1; 0; 0]</code>. If another slot, Slot_B, is parented under Slot_A and also has local position <code>[1; 0; 0]</code>, its global position is <code>[2; 0; 0]</code>. If Slot_A is now moved to <code>[1; 1; 0]</code>, Slot_B will move with Slot_A and its global position will now be <code>[2; 1; 0]</code>.
</translate>

<translate>
== Transformations ==
</translate>

<translate>
<!--T:13-->
In principle one could calculate a slot's global position by summing its local position vector with those of all of its parents. However it is much easier to use the [[ProtoFlux:Global Transform|Global Transform]] ProtoFlux node for this purpose. The same goes for global rotation and scale, although those would require the element-wise product of parent local rotations or scales due to how those quantities are combined.
</translate>

<translate>
<!--T:14-->
There are many ProtoFlux nodes which are particularly useful for moving, rotating and scaling slots in the [[:Category:ProtoFlux:Transform|Transform]] category of the ProtoFlux node browser. When applying a transformation (movement, rotation or scale) to a slot, such as via a Drive or a Tween, one usually wants the input value to be in the target slot's local coordinate space. Initially calculating transformations using global coordinates may be useful if the intended effect should not depend on the slot's current context. Conversely, typically one wants transformations to happen relative to the slot's current state which requires the use of local coordinates. There are a several nodes for converting positions, directions, rotations and scales between global and local coordinates. There are also ones for converting between the local coordinate spaces of two slots with different parents.
</translate>

<translate>
<!--T:15-->
It is possible to scale objects non-uniformly (i.e. having different X, Y and Z scale values), though this should be done with care as child slots inherit scaling from their parents. This can cause hard-to-debug issues where a visual component of a child slot displays strangely due to a non-uniformly scaled parent somewhere above in the hierarchy. The requirement for non-uniform scaling to achieve the desired look with primitive meshes (boxes, spheres, cones, quads etc.) can, and should, usually be avoided by instead changing the parameters of the respective mesh component.
</translate>

<translate>
<!--T:16-->
In addition to ProtoFlux, slots can be made to move or transform in various ways using components under the [[:Category:Components:Transform|Transform]] component category (e.g. [[Component:Spinner|Spinner]], [[Component:Wiggler|Wiggler]], [[Component:Wobbler3D|Wobbler]] etc.).
</translate>

== <translate><!--T:17--> Tools</translate> ==

* <translate><!--T:18--> The [[Dev Tool]] is extremely useful since it gives access to the transform gizmos and slot inspector panels which enable setting coordinates precisely.</translate>
* <translate><!--T:19--> The [[ProtoFlux Tool]] is required for interacting with coordinate values via ProtoFlux nodes.</translate>
* <translate><!--T:20--> The [[Meter Tool]] can be useful for measuring distances in various ways.</translate>

== <translate><!--T:21--> See also</translate> ==

* [https://en.wikipedia.org/wiki/Three-dimensional_space <translate><!--T:22--> 3D Space on Wikipedia</translate>]
* [https://en.wikipedia.org/wiki/Euclidean_vector <translate><!--T:23--> 3D Vectors on Wikipedia</translate>]
* [https://en.wikipedia.org/wiki/Quaternion <translate><!--T:24--> Quaternions on Wikipedia</translate>]