com.tenio.engine.ecs.system.implement.Systems Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tenio-engine Show documentation
TenIO is a java NIO (Non-blocking I/O) based server specifically designed for multiplayer games. It supports UDP and TCP transports which are handled by Netty for high-speed network transmission. This is the engine module for the game related handlers of the framework.
There is a newer version: 0.6.0
Show newest version
/*
The MIT License

Copyright (c) 2016-2021 kong 

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

package com.tenio.engine.ecs.system.implement;

import com.tenio.engine.ecs.system.ExecuteSystem;
import com.tenio.engine.ecs.system.InitializeSystem;
import com.tenio.engine.ecs.system.RenderSystem;
import com.tenio.engine.ecs.system.System;
import com.tenio.engine.ecs.system.TearDownSystem;
import com.tenio.engine.physic2d.graphic.Paint;
import java.util.ArrayList;
import java.util.List;

/**
 * Systems provide a convenient way to group systems. You can add
 * {@link InitializeSystem}, {@link ExecuteSystem}, {@link RenderSystem},
 * {@link TearDownSystem}, initialized and executed based on the order you added
 * them.
 */
public final class Systems
    implements InitializeSystem, ExecuteSystem, RenderSystem, TearDownSystem {

  private final List initializeSystems;
  private final List executeSystems;
  private final List renderSystems;
  private final List tearDownSystems;

  /**
   * Check if systems is running or not.
   */
  private boolean flagRunning = true;

  /**
   * Creates a new systems instance.
   */
  public Systems() {
    initializeSystems = new ArrayList();
    executeSystems = new ArrayList();
    renderSystems = new ArrayList();
    tearDownSystems = new ArrayList();
  }

  /**
   * Adds the system instance to the systems list.
   *
   * @param system new adding system
   * @return the current system instance
   */
  public Systems add(System system) {
    if (system != null) {
      if (system instanceof InitializeSystem) {
        initializeSystems.add((InitializeSystem) system);
      }
      if (system instanceof ExecuteSystem) {
        executeSystems.add((ExecuteSystem) system);
      }
      if (system instanceof RenderSystem) {
        renderSystems.add((RenderSystem) system);
      }
      if (system instanceof TearDownSystem) {
        tearDownSystems.add((TearDownSystem) system);
      }
    }
    return this;
  }

  /**
   * Calls {@code initialize()} on all {@link InitializeSystem} and other nested
   * systems instances in the order you added them.
   *
   * @see InitializeSystem#initialize()
   */
  public void initialize() {
    for (var system : initializeSystems) {
      system.initialize();
    }
  }

  /**
   * Calls {@code execute()} on all {@link ExecuteSystem} and other nested systems
   * instances in the order you added them.
   *
   * @param deltaTime the delta time
   * @see ExecuteSystem#execute(float)
   */
  public void execute(float deltaTime) {
    if (flagRunning) {
      for (var system : executeSystems) {
        system.execute(deltaTime);
      }
    }
  }

  /**
   * Calls {@code render()} on all {@link RenderSystem} and other nested systems
   * instances in the order you added them.
   *
   * @param paint the renderer object
   * @see RenderSystem#render(Paint)
   */
  @Override
  public void render(Paint paint) {
    if (flagRunning) {
      for (var system : renderSystems) {
        system.render(paint);
      }
    }
  }

  /**
   * Calls {@code tearDown()} on all {@link TearDownSystem} and other nested
   * Systems instances in the order you added them.
   *
   * @see TearDownSystem#tearDown()
   */
  public void tearDown() {
    for (var system : tearDownSystems) {
      system.tearDown();
    }
  }

  /**
   * Remove all systems.
   */
  public void clearSystems() {
    initializeSystems.clear();
    executeSystems.clear();
    renderSystems.clear();
    tearDownSystems.clear();
  }

  /**
   * Pause the systems running.
   *
   * @param flagPause true for pausing, false otherwise
   * @see #executeSystems
   * @see #renderSystems
   */
  public void paused(boolean flagPause) {
    flagRunning = !flagPause;
  }

  /**
   * Retrieves the systems status.
   *
   * @return true if systems are running, false otherwise
   */
  public boolean isRunning() {
    return flagRunning;
  }
}