Bucket
Defined in: packages/sigma/src/rendering/bucket.ts:32
Bucket class for managing a collection of items at a specific depth level.
Each bucket maintains:
- A set of item keys
- A Float32Array for GPU buffer data
- A dirty flag for rebuild optimization
Constructors
Constructor
new Bucket(
stride):Bucket
Defined in: packages/sigma/src/rendering/bucket.ts:55
Parameters
stride
number
Returns
Bucket
Accessors
count
Get Signature
get count():
number
Defined in: packages/sigma/src/rendering/bucket.ts:69
Returns the number of items in the bucket
Returns
number
isDirty
Get Signature
get isDirty():
boolean
Defined in: packages/sigma/src/rendering/bucket.ts:62
Returns true if the bucket needs to be rebuilt
Returns
boolean
Methods
addItem()
addItem(
key):void
Defined in: packages/sigma/src/rendering/bucket.ts:97
Adds an item to the bucket and marks it as dirty
Parameters
key
string
Returns
void
clear()
clear():
void
Defined in: packages/sigma/src/rendering/bucket.ts:127
Clears all items from the bucket and marks it as dirty
Returns
void
clearDirtyFlag()
clearDirtyFlag():
void
Defined in: packages/sigma/src/rendering/bucket.ts:175
Clears the dirty flag without rebuilding. Use with caution - only when you know the data is up to date.
Returns
void
getFloatArray()
getFloatArray():
Float32Array
Defined in: packages/sigma/src/rendering/bucket.ts:76
Returns the Float32Array containing the buffer data
Returns
Float32Array
getItems()
getItems():
Set<string>
Defined in: packages/sigma/src/rendering/bucket.ts:83
Returns a copy of the item keys set
Returns
Set<string>
hasItem()
hasItem(
key):boolean
Defined in: packages/sigma/src/rendering/bucket.ts:90
Checks if an item is in this bucket
Parameters
key
string
Returns
boolean
markDirty()
markDirty():
void
Defined in: packages/sigma/src/rendering/bucket.ts:137
Marks the bucket as dirty, forcing a rebuild on next render
Returns
void
rebuild()
rebuild(
processItem):void
Defined in: packages/sigma/src/rendering/bucket.ts:147
Rebuilds the Float32Array from the current items. This compacts the buffer (no holes) and clears the dirty flag.
Parameters
processItem
Function that writes item data to the array at the given index
Returns
void
removeItem()
removeItem(
key):void
Defined in: packages/sigma/src/rendering/bucket.ts:107
Removes an item from the bucket and marks it as dirty
Parameters
key
string
Returns
void
updateItem()
updateItem(
key):void
Defined in: packages/sigma/src/rendering/bucket.ts:118
Marks an item for update (marks bucket as dirty). Use this when item attributes change but zIndex stays the same.
Parameters
key
string
Returns
void