View Categories

Environment

Table of Contents

Create Floor #

The CreateFloor component allows users to define a floor within the simulation environment based on boundary lines. This is essential for setting up the environment where agents will move.

  • Component Name: Create Floor
  • Description: Creates a FlowFloor from a set of boundary line segments.
  • Category: Flow > Environment

Inputs: #
  • Segments (S): A list of line segments that define the boundary of the floor. These lines form the edges of the simulated environment where agents can move. (Type: List<Line>)
  • Label (L): An optional label to assign to the floor, useful for identification in the simulation. (Type: string, default is an empty string)
Outputs: #
  • FlowFloor (F): The generated FlowFloor object, which represents the floor boundary in the simulation. This can be connected to other components for further processing. (Type: FlowFloor)

Create Obstacle #

The CreateObstacle component allows users to define obstacles within the simulation environment based on boundary line segments. Obstacles are essential for creating barriers or restricted areas where agents cannot move.

  • Component Name: Create Obstacle
  • Description: Creates a FlowObstacle from a set of boundary line segments, used to define barriers in the environment.
  • Category: Flow > Environment

Inputs: #
  • Segments (S): A list of line segments that define the boundary of the obstacle. These lines form the edges of the area agents should avoid. (Type: List<Line>)
  • Label (L): An optional label to assign to the obstacle for easier identification within the simulation. (Type: string, default is an empty string)
Outputs: #
  • FlowObstacle (O): The generated FlowObstacle object, which represents the obstacle boundary in the simulation. It can be connected to other components or further processed. (Type: List<FlowObstacle>)

Create Exit #

The CreateExit component defines key points in the simulation environment, which can function as exit points, stair entrances, or stair exits. These points are essential for guiding agents toward their goals or navigating through multi-level environments.

  • Component Name: Create Exit
  • Description: Creates a FlowExit from a specified point and radius. The mode can be selected via a dropdown menu to define whether the point serves as an exit, a stair entrance, or a stair exit.
  • Category: Flow > Environment

Inputs: #
  • Point (P): The position of the exit point, stair entrance, or stair exit. Agents will navigate toward this point. (Type: Point3d)
  • Radius (R): The radius around the point that defines the effective zone for agents. (Type: double)
  • Type Selection (Dropdown): Users can choose the mode (Exit, Stair Entrance, or Stair Exit) via the component’s dropdown menu.
Outputs: #
  • Exit (E): The generated FlowExit object, representing the selected mode (exit point, stair entrance, or stair exit) and its associated radius. (Type: FlowExit)

Create FlowField #

The CreateFlowField component generates a flow field within the simulation environment.
Note:
This component takes into account the defined floor, obstacles, and exit points to create a navigable space for agents, considering the directions of the segments of the floors and obstacles.
Additionally, the segments of the floors must be split at the points of the exits and stairs to ensure accurate navigation.

  • Component Name: Create FlowField
  • Description: Creates a FlowField based on the provided floor, obstacles, and exit points. The flow field guides agent movement throughout the environment by factoring in the directions of the floor and obstacle segments.
  • Category: Flow > Environment

Inputs: #
  • Floor (F): The FlowFloor object that defines the navigable area for agents. (Type: FlowFloor)
  • Obstacle (O): A list of FlowObstacle objects representing barriers within the environment that agents need to navigate around. (Type: List<FlowObstacle>, optional)
  • Exit (E): A list of FlowExit objects that indicate where agents can exit the environment. (Type: List<FlowExit>)
  • Label (L): An optional label for the flow field, useful for identification in the simulation. (Type: string, default is an empty string)
Outputs: #
  • FlowField (FF): The generated FlowField object, which represents the navigable area for agents. (Type: FlowField)

Create Stair #

The CreateStair component defines a stair element within the simulation environment, providing agents with pathways to navigate between different levels. This component creates a FlowStair based on an input mesh and a path curve that determines the stair’s direction.

  • Component Name: Create Stair
  • Description: Creates a FlowStair from a specified mesh and path curve, defining how agents can traverse between levels in the simulation.
  • Category: Flow > Environment

Inputs: #
  • Mesh (M): The input mesh that represents the physical structure of the stair. (Type: Mesh)
  • Path Curve (C): The curve that defines the direction and layout of the stair, guiding agent movement between different levels. (Type: Curve)
  • Label (L): An optional label for the stair, useful for identification in the simulation. (Type: string, default is an empty string)
Outputs: #
  • FlowStair (S): The generated FlowStair object, representing the stair within the simulation environment. This object can be utilized to direct agent behavior and movement. (Type: FlowStair)

Create Source #

The CreateSource component defines a source point in the simulation environment from which agents are generated. This component allows users to specify various parameters related to the timing and characteristics of agent creation.

  • Component Name: Create Source
  • Description: Creates a FlowSource from a specified point, allowing for the generation of agents based on defined parameters such as timing, capacity, and color.
  • Category: Flow > Environment

Inputs: #
  • Point (P): The input point that serves as the location for agent generation. (Type: Point3d)
  • Start Time (sT): The time at which agent creation starts. (Type: double, optional, default is 0)
  • End Time (eT): The time at which agent creation ends. (Type: double, optional, default is double.MaxValue)
  • Agents Cap (C): The maximum number of agents that can be generated from this source. (Type: int, optional, default is int.MaxValue)
  • Creation Interval (I): The interval between agent creations. (Type: double)
  • Target Combinations (C): The target combinations that agents should aim for during their behavior. (Type: string, optional)
  • Target Weights (W): The weights associated with the target combinations, influencing agent behavior. (Type: string, optional)
  • Label (L): An optional label for the source, useful for identification in the simulation. (Type: string, optional)
  • FlowAgent Color (C): The color of the FlowAgent generated from this source. (Type: Color, optional, default is AntiqueWhite)
Outputs: #
  • FlowSource (S): The generated FlowSource object, which represents the point of agent creation within the simulation. This object can be used to manage and control agent generation. (Type: FlowSource)

Create Gate  #

The CreateGate component defines a gate within the simulation environment, allowing for controlled entry and exit points for agents. This component utilizes polylines to create a FlowGate that facilitates agent movement through various paths.

  • Component Name: Create Gate
  • Description: Creates a FlowGate from specified polylines, defining the main path, secondary paths, exit paths, and gate boundaries to manage agent flow in the simulation.
  • Category: Flow > Environment

Inputs: #
  • Path (P): The main path for agent movement through the gate. (Type: Curve)
  • Branches (B): A list of secondary paths that agents can take. (Type: List<Curve>)
  • Exit (E): A list of exit paths for agents to leave the gate area. (Type: List<Curve>)
  • Gate Boundary (GB): The boundary defining the area of the gate. (Type: Curve)
  • Waiting Time (wT): The time agents are required to wait at the gate before proceeding. (Type: double)
  • Label (L): An optional label for the gate, useful for identification in the simulation. (Type: string, optional)
Outputs: #
  • FlowGate (G): The generated FlowGate object, which represents the gate within the simulation. This object can be utilized to control agent entry and exit behavior. (Type: FlowGate)

Create Waiting Area #

The CreateWaitingArea component defines a moving obstacle in the simulation environment. This allows for the specification of the obstacle’s shape, movement path, timing, speed, and interaction with agents. Dynamic obstacles can represent vehicles, moving barriers, or other time-dependent elements that influence agent movement.

  • Component Name: Create Dynamic Obstacle
  • Description: Creates a FlowDynamicObs object from a mesh and movement parameters, including path, direction, timing, and speed. This allows the simulation to include time-based moving obstacles that interact with agents.
  • Category: Flow > Environment

Inputs: #

  • Mesh (M): The mesh representing the physical shape of the dynamic obstacle.
  • Direction (D): A curve representing the orientation or directional vector of the obstacle
  • Path (P): A curve along which the obstacle moves during the simulation.
  • Speed (S): The movement speed of the obstacle in meters per second. (Default: 1.2)
  • Start Time (sT): The simulation time (in seconds) when the obstacle begins moving. (Default: 0)
  • End Time (eT): The simulation time (in seconds) when the obstacle stops moving. (Default: ∞)
  • Obstacles Cap (C): The maximum number of obstacles that the agent can interact with or affect at once. (Default: unlimited)
  • Label (L): An optional identifier for the obstacle, useful for managing or tracking specific elements in the simulation.

Outputs: #

  • Dynamic Obstacle (DO): The generated FlowDynamicObs object, representing the configured moving obstacle. It can be connected to the simulation solver to influence agent behavior.

Create Dynamic Obstacle #

The CreateDynamicObstacle component defines a Dynamic Obstacle within the simulation environment, where agents can pause before proceeding. This component allows for the specification of entrance and exit points, waiting times, capacity limits, and agent exit modes.

  • Component Name: Create Waiting Area
  • Description: Creates a FlowWaitingArea from boundary lines, defining the segments, entrance, and exit points, along with waiting times and capacity limits for agents.
  • Category: Flow > Environment

Inputs: #
  • Segments (S): A list of lines that define the boundaries of the waiting area. (Type: List<Line>)
  • Entrance Point (enP): The point where agents enter the waiting area. (Type: Point3d)
  • Exit Point (exP): The point where agents exit the waiting area. (Type: Point3d)
  • Waiting Time (wT): The time agents are required to wait in the area before proceeding. (Type: double)
  • Max Capacity (maxC): The maximum number of agents allowed in the waiting area at any time. (Type: int, optional)
  • Label (L): An optional label for the waiting area, useful for identification in the simulation. (Type: string, optional`)
Modes: #
  • Direct: Each agent exits the waiting area independently as soon as the waiting time expires.
  • Full Capacity: The waiting time countdown starts only when the maximum capacity of agents is reached.

Note: The mode can be selected via a dropdown menu on the component.

Outputs: #
  • Waiting Area (WA): The generated FlowWaitingArea object, which represents the waiting area within the simulation environment. This object can be used to manage agent behavior related to waiting. (Type: FlowWaitingArea)
What are your Feelings