Splat
Description​
This component establishes a Gaussian Splat on an entity.
Properties​
Property | Type | Default | Description |
---|---|---|---|
url | string | '' | The source url. |
Functions​
Get​
Returns a read-only reference.
Example
ecs.Splat.get(world, component.eid)
Set​
Ensures the component exists on the entity, then assigns the (optional) data to the component.
Example
ecs.Splat.set(world, component.eid, {
url: './assets/splat.spz'
})
Mutate​
Perform an update to the component within a callback function. Return true
to indicate no changes made.
Example
ecs.Splat.mutate(world, component.eid, (cursor) => {
cursor.url = './assets/new_splat.spz';
return false;
})
Remove​
Removes the component from the entity.
Example
ecs.Splat.remove(world, component.eid)
Has​
Returns true
if the component is present on the entity.
Example
ecs.Splat.has(world, component.eid)
Reset​
Adds, or resets the component to its default state.
Example
ecs.Splat.reset(world, component.eid)
Advanced Functions​
Cursor​
Returns a mutable reference. Cursors are reused so only one cursor for each component can exist at a time.
Example
ecs.Splat.cursor(world, component.eid)
Acquire​
Same behavior as cursor, but commit must be called after the cursor is done being used.
Example
ecs.Splat.acquire(world, component.eid)
Commit​
Called after acquire. An optional third argument determines whether the cursor was mutated or not.
Example
ecs.Splat.commit(world, component.eid)
ecs.Splat.commit(world, component.eid, false)
Dirty​
Mark the entity as having been mutated. Only needed in a specific case where systems are mutating data.
Example
ecs.Splat.dirty(world, component.eid)