.. _distributing-agents:

*************
Adding agents
*************

After you have configured your models and variables you are ready to add agents
to the scene. Agents are like actors - placeholders. They connect the model and
its behavior.

**Adding agents**

There are several ways to add agents to your scene:

* You can add one agent.
* You can add several agents using a plane.
* You can add several agents using a circle.
* You can add several agents using a triangle.
* You can add several agents in a grid formation.
* You can add several agents using a mesh.

You can have several of these distributions in your scene. Each distribution
is identified by an Agent Factory object.

**Where**

You can add agents by pressing :kbd:`SHIFT + A`, select `Crowd Sim` from the menu
and then select a distribution.

.. image:: /images/crowdsim-menu.png
  :align: center

**Just an agent**

When selecting this option an agent will be added to your scene.

.. image:: /images/1-agent.png
  :align: center

**Several agents using a Plane**

With this option the agents will be added in a plane. You can scale the plane
to fit the area you want the agents to be placed in.

.. include:: factory-properties-default.rst

.. image:: /images/agents-plane-500x492.png
  :align: center

**Several agents using a Circle**

With this option the agents will be added in a circle. Scale the circle to
fit the area you want the agents to be placed in.

.. include:: factory-properties-default.rst

.. image:: /images/agents-circle-500x500.png
  :align: center


**Several agents using a triangle**

With this option the agents will be added in a triangle. Scale the triangle
to fit the area you want the agents to be placed in.

.. include:: factory-properties-default.rst

.. image:: /images/agents-triangle-500x500.png
  :align: center

  
**Several agents using a grid**

With this option the agents will be added in a grid formation.
You can set the number of columns, rows and distance between
the agents.

.. include:: factory-properties-grid.rst

.. image:: /images/agents-grid.png
  :align: center

**Several agents using a mesh**

With this option the agents will be added using an mesh.
You can attach you own mesh to the factory.

.. include:: factory-properties-mesh.rst

.. image:: /images/agents-mesh.png
  :align: center