VertexPicker
A class that provides functionality for picking vertices in a 3D scene.
Extends
Implements
Properties
components
components:
Components
A reference to the Components instance associated with this VertexPicker.
Overrides
Component.components
onDisposed
readonlyonDisposed:Event<unknown>
Implementation of
onEnabled
readonlyonEnabled:Event<boolean>
An event that is triggered when the picker is enabled or disabled
onVertexFound
readonlyonVertexFound:Event<Vector3>
An event that is triggered when a vertex is found. The event passes a THREE.Vector3 representing the position of the found vertex.
onVertexLost
readonlyonVertexLost:Event<Vector3>
An event that is triggered when a vertex is lost. The event passes a THREE.Vector3 representing the position of the lost vertex.
workingPlane
workingPlane:
null|Plane=null
A reference to the working plane used for vertex picking. This plane is used to determine which vertices are considered valid for picking. If this value is null, all vertices are considered valid.
Accessors
config
getconfig():Partial<VertexPickerConfig>
Gets the current configuration for the VertexPicker component.
Example
const currentConfig = vertexPicker.config;
console.log(currentConfig.snapDistance); // Output: 0.25
setconfig(value):void
Sets the configuration for the VertexPicker component.
Example
vertexPicker.config = {
snapDistance: 0.5,
showOnlyVertex: true,
};
Parameters
| Parameter | Type | Description |
|---|---|---|
value | Partial <VertexPickerConfig> | A Partial object containing the configuration properties to update. |
| The properties not provided in the value object will retain their current values. |
Returns
Partial <VertexPickerConfig>
A copy of the current VertexPickerConfig object.
enabled
getenabled():boolean
Gets the current enabled state of the VertexPicker.
setenabled(value):void
Sets the enabled state of the VertexPicker. When enabled, the VertexPicker will actively search for vertices in the 3D scene. When disabled, the VertexPicker will stop searching for vertices and reset the picked point.
Parameters
| Parameter | Type | Description |
|---|---|---|
value | boolean | The new enabled state. |
Returns
boolean
The current enabled state.
Methods
dispose()
dispose():
void
Returns
void
Implementation of
get()
get(
world):Promise<null|Vector3>
Performs the vertex picking operation based on the current state of the VertexPicker.
Parameters
| Parameter | Type | Description |
|---|---|---|
world | World | The World instance to use for raycasting. |
Returns
Promise<null | Vector3>
The current picked point, or null if no point is picked.
Remarks
This method checks if the VertexPicker is enabled. If not, it returns the current picked point.
If enabled, it performs raycasting to find the closest intersecting object.
It then determines the closest vertex or point on the face, based on the configuration settings.
If the picked point is on the working plane (if defined), it triggers the onVertexFound event and updates the pickedPoint.
If the picked point is not on the working plane, it resets the pickedPoint.
If no intersecting object is found, it triggers the onVertexLost event and resets the pickedPoint.
isConfigurable()
isConfigurable():
this is Configurable<any, any>
Whether is component is Configurable.
Returns
this is Configurable<any, any>
Inherited from
isDisposeable()
isDisposeable():
this is Disposable
Whether is component is Disposable.
Returns
this is Disposable
Inherited from
isHideable()
isHideable():
this is Hideable
Whether is component is Hideable.
Returns
this is Hideable
Inherited from
isResizeable()
isResizeable():
this is Resizeable
Whether is component is Resizeable.
Returns
this is Resizeable
Inherited from
isSerializable()
isSerializable():
this is Serializable<any, Record<string, any>>
Whether is component is Serializable.
Returns
this is Serializable<any, Record<string, any>>
Inherited from
isUpdateable()
isUpdateable():
this is Updateable
Whether is component is Updateable.
Returns
this is Updateable