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.
A layer clip that will be played the first time the content has a placement in space.
A layer clip that will be played when this component leaves user placement mode.
A layer clip that will be played when, during placement mode, the user is not pointing at a valid location to place the content.
A layer clip that will be played when, during placement mode, the user is pointing at a valid location to place the content.
A layer clip that will be played when this component enters user placement mode.
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:
Use this property to preview the appearance of placement mode during design time.
If true, placement will be possible on a 'ground' plane detected in the world around the user.
If true, placement will be possible on planes detected in the world around the user.
If true, a the children of this component will be shown during placement mode. Otherwise it will be hidden.
If true, this component will be in a mode that allows the user to choose a placement location when the experience starts. If false, the content will be placed at the center of the first detected plane after the experience starts.
If true, a visual representation of any planes detected in the world around the user will be shown on-screen.
If true, the long press instruction message will be shown when the user has completed placement
Determines if the user can long press on the screen to enter placement mode. There are two modes available: 'hold' allows the user to move the anchor while the keep their finger held on the screen, while 'toggle' enters placement mode allowing the user to release their finger.
If true, the long press instruction message will be shown when the user has completed placement
OptionalanchorReadonlybehaviorsThe behaviors attached to this component.
ReadonlychildrenThe children of this component.
ReadonlycontextOptionalcustomReadonlyenabledThis 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.
OptionalparentThe parent of this component.
The horiztonal alignment of the restart placement button
Set to a text string to display on the place button.
The vertical alignment of the restart placement button
If true, a button will be shown during placement mode for the user to confirm their chosen position.
If true, a tick icon will be displayed in the place button.
The horiztonal alignment of the restart placement button
Set to a text string to display on the restart placement button.
The vertical alignment of the restart placement button
If true, a button will be shown to allow the user to return to placement mode.
If true, an icon will be displayed in the restart placement button.
Zicon
location_on
Ztag
three/Object3D/Group/Zappar/UserPlacementAnchorGroup
Zlabel
three/Object3D/Group/Zappar/UserPlacementAnchorGroup
Zparents
three/Zappar/WorldTracker