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.
Constructs a new line basic material.
Context manager.
Properties.
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.
Optional
type: 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: ArgsOptional
options: RegisterOptionsOptional
options: RegisterOptionsReadonly
tagsAn 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.
Readonly
enabledIf 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:
Blending destination. The material's blending must be set to CustomBlending for this to have any effect.
The transparency of the .blendDst. Uses .blendDst value if null.
Blending equation to use when applying blending. Default is AddEquation.
The material's blending must be set to CustomBlending for this to have any effect.
The transparency of the .blendEquation.
Uses .blendEquation value if null. Default is null.
Blending Source.
The material's blending must be set to CustomBlending
for this to have any effect.
The transparency of the .blendSrc. Uses .blendSrc value if null. Default is null.
Sets the alpha value to be used when running an alpha test. The material will not be rendered if the opacity is lower than this value. Default is 0.
The name of a material in the parent node for this node to attach to. Use this if you're overriding a named material in a GLTF component, for example.
Whether to render the material's color.
This can be used in conjunction with a mesh's renderOrder property to create invisible objects that occlude other objects.
Which depth function to use.
Whether to have depth test enabled when rendering this material.
When the depth test is disabled, the depth write will also be implicitly disabled.
Whether rendering this material has any effect on the depth buffer.
When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.
Float in the range of 0.0 - 1.0 indicating how transparent the material is.
A value of 0.0 indicates fully transparent, 1.0 is fully opaque. If the material's transparent property is not set to true, the material will remain fully opaque and this value will only affect its color.
Defines which side of faces will be rendered - front, back or both.
Defines whether this material is transparent.
This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects. When set to true, the extent to which the material is transparent is controlled by setting its opacity property.
Defines whether this material is visible.
Enables alpha to coverage. Can only be used with MSAA-enabled contexts (meaning when the renderer was created with antialias parameter set to true). Default is false.
Blending destination. The material's blending must be set to CustomBlending for this to have any effect.
Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union.
Defines whether to clip shadows according to the clipping planes specified on this material.
Whether to apply dithering to the color to remove the appearance of banding.
Whether to use polygon offset.
This corresponds to the GL_POLYGON_OFFSET_FILL
WebGL feature.
Sets the polygon offset factor.
Sets the polygon offset units
Whether to premultiply the alpha (transparency) value.
Defines which side of faces cast shadows.
Whether stencil operations are performed against the stencil buffer.
In order to perform writes or comparisons against the stencil buffer this value must be true.
The bit mask to use when writing to the stencil buffer.
Defines whether this material is tone mapped according to the renderer's toneMapping setting.
Defines whether vertex coloring is used.
The engine supports RGB and RGBA vertex colors depending on whether a three (RGB) or four (RGBA) component color buffer attribute is used.
Readonly
behaviorsThe behaviors attached to this component.
Readonly
childrenThe children of this component.
Readonly
contextReadonly
enabledThis 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).
Optional
lockedIf true, this component can't be selected at design time in the 3D preview.
Readonly
onAn event that is fired as the last act of this entity being destroyed.
Optional
parentThe parent of this component.
The color of the material.
Whether the material is affected by fog. Default is true.
The size of the points in pixels.
If the points' size should be affected by the camera's distance.
A material for drawing point-style geometries.
Root element: THREE.PointsMaterial
Zicon
material
Ztag
three/Material/Points/PointsMaterial
Zparents
three/Object3D/Points/**