Flutter身份识别插件dentity的使用

Dentity 是一个强大的、灵活的实体组件系统（ECS）框架，适用于Dart应用程序。本README提供了基本示例以帮助你开始使用 Dentity 包。

简介

本示例演示了如何使用 Dentity 创建一个简单的ECS世界，在该世界中实体具有 Position 和 Velocity 组件，并且一个 MovementSystem 根据它们的速度更新它们的位置。

安装

在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  dentity: ^1.0.0

然后运行以下命令来安装包：

dart pub get

创建组件

组件是表示实体不同方面的数据容器。在这个示例中，我们定义了 Position 和 Velocity 组件。

class Position extends Component {
  double x;
  double y;

  Position(this.x, this.y);

  @override
  Position clone() => Position(x, y);

  @override
  int compareTo(other) {
    if (other is Position) {
      return x.compareTo(other.x) + y.compareTo(other.y);
    }
    return -1;
  }
}

class Velocity extends Component {
  double x;
  double y;

  Velocity(this.x, this.y);

  @override
  Velocity clone() => Velocity(x, y);

  @override
  int compareTo(other) {
    if (other is Velocity) {
      return x.compareTo(other.x) + y.compareTo(other.y);
    }
    return -1;
  }
}

定义组件序列化器

为了启用组件的序列化，你需要为每个组件类型定义序列化器。

class PositionJsonSerializer extends ComponentSerializer<Position> {
  static const type = 'Position';
  
  @override
  ComponentRepresentation? serialize(Position component) {
    return {
      'x': component.x,
      'y': component.y,
      EntitySerialiserJson.typeField: type,
    };
  }

  @override
  Position deserialize(ComponentRepresentation data) {
    final positionData = data as Map<String, dynamic>;
    return Position(positionData['x'] as double, positionData['y'] as double);
  }
}

class VelocityJsonSerializer extends ComponentSerializer<Velocity> {
  static const type = 'Velocity';

  @override
  ComponentRepresentation? serialize(Velocity component) {
    return {
      'x': component.x,
      'y': component.y,
      EntitySerialiserJson.typeField: type,
    };
  }

  @override
  Velocity deserialize(ComponentRepresentation data) {
    final velocityData = data as Map<String, dynamic>;
    return Velocity(velocityData['x'] as double, velocityData['y'] as double);
  }
}

创建系统

系统包含对具有特定组件的实体的操作逻辑。MovementSystem 根据速度更新实体的位置。

class MovementSystem extends EntitySystem {
  @override
  Set<Type> get filterTypes => const {Position, Velocity};

  @override
  void processEntity(Entity entity, Map<Type, SparseList<Component>> componentLists, Duration delta) {
    final position = componentLists[Position]?[entity] as Position;
    final velocity = componentLists[Velocity]?[entity] as Velocity;
    position.x += velocity.x;
    position.y += velocity.y;
  }
}

设置世界

World 类将所有东西结合起来。它管理实体、组件和系统。

World createBasicExampleWorld() {
  final componentManager = ComponentManager(
    archetypeManagerFactory: (types) => ArchetypeManagerBigInt(types),
    componentArrayFactories: {
      Position: () => ContiguousSparseList<Position>(),
      Velocity: () => ContiguousSparseList<Velocity>(),
      OtherComponent: () => ContiguousSparseList<OtherComponent>(),
    },
  );
  
  final entityManager = EntityManager(componentManager);
  final movementSystem = MovementSystem();

  return World(
    componentManager,
    entityManager,
    [movementSystem],
  );
}

示例用法

以下是上述设置的使用方法：

void main() {
  final world = createBasicExampleWorld();

  // 创建一个具有 Position 和 Velocity 组件的实体
  final entity = world.createEntity({
    Position(0, 0),
    Velocity(1, 1),
  });

  // 运行系统以根据速度更新位置
  world.process();

  // 检查更新后的位置
  final position = world.componentManager.getComponent<Position>(entity);
  print('Updated position: (${position?.x}, ${position?.y})'); // 应输出 (1, 1)
}

序列化示例

为了序列化和反序列化实体：

void main() {
  final world = createBasicExampleWorld();
  
  // 创建一个实体
  final entity = world.createEntity({
    Position(0, 0),
    Velocity(1, 1),
  });

  // 设置序列化器
  final entitySerialiser = EntitySerialiserJson(
    world.entityManager,
    {
      Position: PositionJsonSerializer(),
      Velocity: VelocityJsonSerializer(),
    },
  );

  // 序列化实体
  final serialized = entitySerialiser.serializeEntityComponents(entity, [
    Position(0, 0),
    Velocity(1, 1),
  ]);
  print(serialized);

  // 反序列化实体
  final deserializedEntity = entitySerialiser.deserializeEntity(serialized);
  final deserializedPosition = world.componentManager.getComponent<Position>(deserializedEntity);
  print('Deserialized position: (${deserializedPosition?.x}, ${deserializedPosition?.y})');
}