mirror
/
fireblade-ecs
mirror of https://github.com/fireblade-engine/ecs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Refine entity identifier generator

This commit is contained in:
Christian Treffs 2020-08-21 10:53:32 +02:00
parent af81c88a51
commit fcf5f4eaf3
No known key found for this signature in database
GPG Key ID: 49A4B4B460BE3ED4
1 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Sources/FirebladeECS/EntityIdentifierGenerator.swift
View File

@ -5,18 +5,23 @@
// Created by Christian Treffs on 26.06.20. // Created by Christian Treffs on 26.06.20.
// //
/// An entity identifier generator provides new entity /// **Entity Identifier Generator**
/// identifiers on entity creation. ///
/// It also allows entity ids to be marked for re-use. /// An entity identifier generator provides new entity identifiers on entity creation.
/// Entity identifiers must be unique. /// It also allows entity ids to be marked as unused (to be re-usable).
///
/// You should strive to keep entity ids tightly packed around `EntityIdentifier.Identifier.min` since it has an influence on the underlying memory layout.
public protocol EntityIdentifierGenerator { public protocol EntityIdentifierGenerator {
/// Initialize the generator with entity ids already in use. /// Initialize the generator providing entity ids to begin with when creating new entities.
/// - Parameter entityIds: The entity ids already in use. Default should be an empty array. ///
init(inUse entityIds: [EntityIdentifier]) /// Entity ids provided should be passed to `nextId()` in last out order up until the collection is empty.
/// The default is an empty collection.
/// - Parameter initialEntityIds: The entity ids to start providing up until the collection is empty (in last out order).
init<EntityIds>(startProviding initialEntityIds: EntityIds) where EntityIds: BidirectionalCollection, EntityIds.Element == EntityIdentifier
/// Provides the next unused entity identifier. /// Provides the next unused entity identifier.
/// ///
/// The provided entity identifier is at least unique during runtime. /// The provided entity identifier must be unique during runtime.
func nextId() -> EntityIdentifier func nextId() -> EntityIdentifier
/// Marks the given entity identifier as free and ready for re-use. /// Marks the given entity identifier as free and ready for re-use.
@ -36,8 +41,8 @@ public struct DefaultEntityIdGenerator: EntityIdentifierGenerator {
@usableFromInline var count: Int { stack.count } @usableFromInline var count: Int { stack.count }
@usableFromInline @usableFromInline
init(inUse entityIds: [EntityIdentifier]) { init<EntityIds>(startProviding initialEntityIds: EntityIds) where EntityIds: BidirectionalCollection, EntityIds.Element == EntityIdentifier {
stack = entityIds.reversed().map(\.id) stack = initialEntityIds.map { $0.id }
} }
@usableFromInline @usableFromInline
@ -57,25 +62,24 @@ public struct DefaultEntityIdGenerator: EntityIdentifierGenerator {
} }
@usableFromInline let storage: Storage @usableFromInline let storage: Storage
@usableFromInline var count: Int { storage.count } @usableFromInline var count: Int { storage.count }
@inlinable
public init<EntityIds>(startProviding initialEntityIds: EntityIds) where EntityIds: BidirectionalCollection, EntityIds.Element == EntityIdentifier {
self.storage = Storage(startProviding: initialEntityIds)
}
@inlinable @inlinable
public init() { public init() {
self.init(inUse: [EntityIdentifier(0)]) self.init(startProviding: [EntityIdentifier(0)])
} }
@inlinable @inline(__always)
public init(inUse entityIds: [EntityIdentifier]) {
self.storage = Storage(inUse: entityIds)
}
@inlinable
public func nextId() -> EntityIdentifier { public func nextId() -> EntityIdentifier {
storage.nextId() storage.nextId()
} }
@inlinable @inline(__always)
public func markUnused(entityId: EntityIdentifier) { public func markUnused(entityId: EntityIdentifier) {
storage.markUnused(entityId: entityId) storage.markUnused(entityId: entityId)
} }