Gets the disposed status of the entity.
The disposed status.
An array of the elements that this component instance exposes. In the case that this component does not expose any elements of its own, this will be an array of the elements exposed by this component's children.
Returns true if this component, or any of its parents, are marked as locked.
Gets a behavior of a specific type from the component.
The type of behavior to get.
The behavior of the specified type, or undefined if no such behavior exists.
Gets all behaviors of a specific type from the component.
The type of behaviors to get.
An array of behaviors of the specified type.
Get the instance of the ZComponent that constructed this entity.
If you pass the class of a ZComponent as the type parameter, this function will ensure that it
returns an instance of that ZComponent. If this component or behavior was constructed by a different
ZComponent class, or by a different entity altogether, the function with throw an error.
Optionaltype: ConstructorForComponent<T>The ZComponent class that you are expecting to receive
The instance of the ZComponent that constructed this component or behavior
Register a function to be called when an Event is fired, or an Observable's value changes. The function will only be bound to the underlying Event or Observable while this entity is enabled.
Using this function, rather than attaching your handler directly to the Event or Observable, ensures your handler is automatically released when this entity is disposed.
Rest...args: ArgsOptionaloptions: RegisterOptionsOptionaloptions: RegisterOptionsReadonlytagsAn array of string 'tags' assocated with this component.
The getComponentsByTag(mgr, tag) function can be used to get an array of components
with the supplied tag.
By default, tags are scoped to the ZComponent instance that a component is constructed by.
Tags that begin with global: are scoped to the experience as a whole.
Determines if this object casts shadows.
Determines if this object receives shadows.
Determines if this object and its children are rendered to the screen.
ReadonlyenabledIf false, this entity and its children will no longer participate in the experience.
Note - to read this value, you may wish to use enabledResolved which will be false if
this entity, or any of its parents, have enabled set to false.
The precise implications of enabled being false will vary between entities,
but in general disabled entities:
How regularly that relocalization will occur when continuousLocalization is set to true.
If true, the node will regularly localize the latest camera image with the Immersal map. This can help prevent drift and ensure the device is correctly positioned within the map at all times.
The minimum distance (in meters) that the camera must move before the component will attempt another Immersal localization.
If true, the 3D preview of the Immersal map will be shown in wireframe.
OptionalanchorReadonlybehaviorsThe behaviors attached to this component.
ReadonlychildrenThe children of this component.
ReadonlycontextReadonlyenabledThis will have value false if this entity, or any of its parents, have enabled set to false.
To change the enabled status of this entity, use the enabled property instead.
The precise implications of enabled being false will vary between entities,
but in general disabled entities:
Disabled entities will typically remain visible (if they have a visible appearance).
OptionallockedIf true, this component can't be selected at design time in the 3D preview.
ReadonlyonAn event that is fired as the last act of this entity being destroyed.
Emitted for each successful localization.
Emitted the first time the map has been successfully localized.
OptionalparentThe parent of this component.
Content places within this group will be localized with Immersal's best-in-class Visual Positioning System technology.
To make use of this component, you must have an account in the Immersal Developer Portal
Zicon
location_on
Ztag
three/Object3D/Group/ImmersalAnchorGroup
Zparents
three/Zappar/WorldTracker