Type:RootSpace

From Resonite Wiki
Revision as of 17:14, 23 October 2024 by 989onan (talk | contribs) (add and generalize the info on this type because it's used in a lot of places.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Root Space is a type that specifies the coordinate space of transform data (position, rotation, scale, delta, offset) provided to a component.

Coordinate spaces is a page that explains the general idea of coordinate spaces in more depth. Please look at that page if you don't understand coordinate spaces at a basic level or you may become lost here.

Fields

Fields
Name Type Description
LocalSpace Slot This is the slot that the transform data is a coordinate space of (Local Space). If it isn't specified, then the transform data is the space specified by Default instead.
UseParentSpace Bool If this is turned on, then the transform data will be part of the coordinate space of the slot above LocalSpace. if the slot above is Root, then the space is automatically Global Space.
Default DefaultSpace The space to use if there is no specified LocalSpace slot.
OverrideRootSpace direct RelayRef`1<RootSpace> Override all the settings of this RootSpace to match the target OverrideRootSpace instead.


DefaultSpace

Enum
Name: DefaultSpace
Type: FrooxEngine.RootSpace+DefaultSpace

Default space controls the behavior of RootSpace when LocalSpace is null, acting as a virtual autofiller of LocalSpace.

Values
Name Value Description
WorldRoot 0 The transform data is Global Spaced. (When LocalSpace is null)
LocalUserSpace 1 Use the Local User's parent slot as the LocalSpace instead. (no this doesn't autofill LocalSpace with the user's parent slot, but makes the type act like it is) (When LocalSpace is null)
LocalUserRoot 2 Use the Local User's UserSlot as the LocalSpace instead. (no this doesn't autofill LocalSpace with the user's UserSlot, but makes the type act like it is) (When LocalSpace is null)