Interface: SphereSet

Experimental

Instanced lit sphere impostors (see the module docs): one draw call, pickCount = number of spheres, pick ids are data indices.

Implements

• Primitive<SphereData>
• PickablePrimitive

Properties

Property	Modifier	Type	Default value	Description
material	readonly	ShaderMaterial	undefined	Experimental
object	readonly	Mesh<InstancedBufferGeometry, ShaderMaterial>	undefined	Experimental Root object to add to a viewport's scene.
pickKind	readonly	PickElementKind	'point'	Experimental What a pick id offset counts (e.g. 'point' for markers).

Accessors

count

Get Signature

get count(): number;

Experimental

Number of drawn spheres.

Returns

number

---

opaque

Get Signature

get opaque(): boolean;

Experimental

Whether the set is drawn opaque (depth-writing, see blend3d.ts).

Returns

boolean

---

origin

Get Signature

get origin(): readonly [number, number, number];

Experimental

Current float64 RTC origin.

Returns

readonly [number, number, number]

---

pickCount

Get Signature

get pickCount(): number;

Experimental

Number of pick ids (one per sphere).

Returns

number

Implementation of

PickablePrimitive.pickCount;

Methods

createPickMaterial()

createPickMaterial(): PickMaterialHandle;

Experimental

Pick material (E2.13): the same shaders with PICKING, writing data indices; shares every uniform except the resolution (the pick window's) and the pick id base.

Returns

PickMaterialHandle

Implementation of

PickablePrimitive.createPickMaterial;

---

dispose()

dispose(): void;

Experimental

Release GPU resources. The primitive must not be used afterwards.

Returns

void

Implementation of

Primitive.dispose;

---

setLighting()

setLighting(lighting): void;

Experimental

Change the lighting (omitted fields take the defaults).

Parameters

Parameter	Type
lighting	Partial<SphereLighting>

Returns

void

---

setTransform()

setTransform(transform): void;

Experimental

Set the data → world transform (cheap: uniforms only, no buffer uploads).

Parameters

Parameter	Type
transform	DataTransform

Returns

void

Implementation of

Primitive.setTransform;

---

setViewport()

setViewport(size): void;

Experimental

Update viewport-dependent uniforms (resolution, pixel ratio).

Parameters

Parameter	Type
size	ViewportSize

Returns

void

Implementation of

Primitive.setViewport;

---

sourceIndex()

sourceIndex(slot): number;

Experimental

Data index drawn in instance slot slot (differs from slot only while depth-sorted).

Parameters

Parameter	Type
slot	number

Returns

number

---

update()

update(data): void;

Experimental

Replace or patch the primitive's data. Omitted fields keep their previous values.

Parameters

Parameter	Type
data	Partial<SphereData>

Returns

void

Implementation of

Primitive.update;