Skip to content

Class: MeshPickMaterial ​

Experimental

Pick material for one generic mesh: writes base + element and mirrors the source material's side, depth test/write, wireframe, and opaque/transparent bucket (so three.js orders the pick pass like the visible frame). occluder: true makes a depth-only material for non-pickable objects that must still hide pickables behind them.

Implements ​

Constructors ​

Constructor ​

ts
new MeshPickMaterial(
   source,
   element,
   occluder?
): MeshPickMaterial;

Experimental

Parameters ​

ParameterTypeDefault value
sourceMeshundefined
elementMeshPickElementundefined
occluderbooleanfalse

Returns ​

MeshPickMaterial

Properties ​

PropertyModifierTypeDescription
materialreadonlyShaderMaterialExperimental

Methods ​

dispose() ​

ts
dispose(): void;

Experimental

Returns ​

void

Implementation of ​

PickMaterialHandle.dispose


prepare() ​

ts
prepare(state): void;

Experimental

Sync uniforms/defines/state from the source before a pick pass.

Parameters ​

ParameterType
stateReadonly<PickRenderState>

Returns ​

void

Implementation of ​

PickMaterialHandle.prepare


setElement() ​

ts
setElement(element): void;

Experimental

Change the requested element mode (applied on the next pick).

Parameters ​

ParameterType
elementMeshPickElement

Returns ​

void

Released under the MIT License.