WorldLockingManager Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Ultimate manager of World Locking. WorldLockingManager supplies access to the sub-managers, IAnchorManager, IFragmentManager, and IAttachmentPointManager.
public class WorldLockingManager
type WorldLockingManager = class
Public Class WorldLockingManager
- Inheritance
-
WorldLockingManager
Fields
Plugin |
Direct interface to the plugin. It is not generally necessary or desired to directly manipulate the plugin, but may be useful for manual override of some plugin inputs, outputs, or controls. |
Properties
AdjustmentFrame |
The transform at which to apply the camera adjustment. This can't be the camera node, as its transform is overwritten every frame with head pose data. But the camera should be an attached descendant of this node. |
AlignmentManager | |
AnchorManager |
Interface to the Anchor Manager. |
AnchorSettings |
Access to anchor management settings. |
ApplyAdjustment |
Apply the computed adjustment via the AdjustmentFrame transform. |
AttachmentPointManager |
Interface to the attachment point manager. Use for creating and manipulating attachment points. |
AutoLoad |
Automatically load the WorldLocking state from disk at startup. |
AutoMerge |
Automatically trigger a fragment merge whenever the FrozenWorld engine indicates that one would be appropriate. |
AutoRefreeze |
Automatically trigger a refreeze whenever the FrozenWorld engine indicates that one would be appropriate. |
AutoSave |
Periodically save the WorldLocking state to disk. |
CameraFromSpongy |
Inverse of the camera transform (camera from parent). |
CameraParent |
The camera parent node defines the "spongy frame of reference". All raw head based data, such as the spatial mapping, gesture events, and XR head pose data, are relative to this transform. |
DiagnosticsSettings |
Get a copy of the shared diagnostics configuration settings, or set the shared settings to a copy of the input. |
Enabled |
Whether the system is currently active and stabilizing space. |
ErrorStatus |
The current error status of the WorldLockingManager |
FragmentManager |
Interface to the fragment manager. |
FrozenFromLocked | |
FrozenFromPinned |
Any application applied transform above the adjustment node. |
FrozenFromSpongy |
Transform from spongy space to frozen space. Spongy space is that native to XR interfaces. Frozen is Unity's global coordinate space. Transform includes the WorldLocking adjustment to the camera, as well as any other transforms applied to the camera (e.g. teleport). |
HasPendingIO |
Whether the manager is currently asynchronously loading or saving state. |
LinkageSettings |
Access to linkage settings. |
LockedFromFrozen | |
LockedFromPinned |
From pinned space back to the world-locked space. |
LockedFromPlayspace |
Adjustment transform to world-lock the coordinate space. |
LockedFromSpongy | |
MergeIndicated |
Indicator for the FrozenWorld engine internal heuristics of whether a merge should be performed |
PinnedFromFrozen |
Transform from application's frozen space back to space computed by WorldLocking. |
PinnedFromLocked |
Transform from the world locked space computed by WorldLocking to the space pinned in place. |
PlayspaceFromLocked |
Inverse of adjustment transform to world-lock the coordinate space. |
PlayspaceFromSpongy |
Transform applied by (optional) camera parent node (e.g. for teleport). |
RefreezeIndicated |
Indicator for the FrozenWorld engine internal heuristics of whether a refreeze should be performed |
Settings |
The configuration settings may only be set as a block. Get returns a snapshot of current settings, and set copies entire block. |
SpongyFromCamera |
The camera transform (parent from camera). |
SpongyFromFrozen |
Transform from frozen space to XR native spongy space, including other transforms accumulated in the camera's ancestors (e.g. teleport). |
SpongyFromLocked | |
SpongyFromPlayspace |
Inverse of transform applied by (optional) camera parent node (e.g. for teleport). |
Version |
The version of this release. This will be displayed in the WorldLockingContext component in the Unity Inspector, allowing quick visual verification of the version of World Locking Tools for Unity currently installed. It has no effect in code, but serves only as a label. |
Methods
Dispose() |
Dispose of internals on shutdown. |
Finalize() |
Dispose of internals on shutdown. |
GetInstance() |
Get the WorldLockingManager instance. This may be called at any time in program execution, but if called during load its settings may not have been loaded from a new scene yet. |
Load() |
Manually trigger a load operation for the WorldLocking state |
Reset() |
Bring WorldLocking to a well-defined, empty state |
ResetAnchorManager() |
Perform any initialization only appropriate once. This is called after giving the caller a chance to change settings. |
Save() |
Manually trigger a save operation for the WorldLocking state |
SetContext(WorldLockingContext) |
Start using shared settings from given context. |