package org.opentrafficsim.core.object;
   
   import java.io.Serializable;
   
   import org.djunits.value.vdouble.scalar.Length;
   import org.djutils.event.LocalEventProducer;
   import org.djutils.exceptions.Throw;
   import org.opentrafficsim.base.Identifiable;
   import org.opentrafficsim.core.animation.Drawable;
  import org.opentrafficsim.core.geometry.Bounds;
  import org.opentrafficsim.core.geometry.DirectedPoint;
  import org.opentrafficsim.core.geometry.OtsLine3d;
  import org.opentrafficsim.core.network.NetworkException;
  
  /**
   * A static object with a height that a GTU might have to avoid, or which can cause occlusion for perception. All objects are
   * potential event producers, which allows them to signal that their state has changed.
   * <p>
   * Copyright (c) 2013-2023 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
   * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
   * </p>
   * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
   * @author <a href="https://tudelft.nl/staff/p.knoppers-1">Peter Knoppers</a>
   */
  public class StaticObject extends LocalEventProducer implements LocatedObject, Serializable, Identifiable, Drawable
  {
      /** */
      private static final long serialVersionUID = 20160400L;
  
      /** the id. */
      private final String id;
  
      /** The top-level 2D outline of the object. */
      private final OtsLine3d geometry;
  
      /** The height of the object. */
      private final Length height;
  
      /**
       * @param id String; the id
       * @param geometry OtsLine3d; the top-level 2D outline of the object
       * @param height Length; the height of the object
       */
      protected StaticObject(final String id, final OtsLine3d geometry, final Length height)
      {
          Throw.whenNull(id, "object id cannot be null");
          Throw.whenNull(geometry, "geometry cannot be null");
          Throw.whenNull(height, "height cannot be null");
  
          this.id = id;
          this.geometry = geometry;
          this.height = height;
      }
  
      /**
       * Initialize the object after it has been fully created.
       * @throws NetworkException e.g. on error registering the object in the network
       */
      @SuppressWarnings("checkstyle:designforextension")
      protected void init() throws NetworkException
      {
          // notify the potential animation of the existence of a StaticObject
          // These next events are fired by the Network when the object is registered in the Network.
          // fireTimedEvent(Network.OBJECT_ADD_EVENT, this.id);
          // fireTimedEvent(Network.ANIMATION_OBJECT_ADD_EVENT, this);
      }
  
      /**
       * Make a static object and carry out the initialization after it has been fully created.
       * @param id String; the id
       * @param geometry OtsLine3d; the top-level 2D outline of the object
       * @param height Length; the height of the object
       * @return the static object
       * @throws NetworkException e.g. on error registering the object in the network
       */
      public static StaticObject create(final String id, final OtsLine3d geometry, final Length height) throws NetworkException
      {
          StaticObject staticObject = new StaticObject(id, geometry, height);
          staticObject.init();
          return staticObject;
      }
  
      /**
       * Make a static object with zero height and carry out the initialization after it has been fully created.
       * @param id String; the id
       * @param geometry OtsLine3d; the top-level 2D outline of the object
       * @return the static object
       * @throws NetworkException e.g. on error registering the object in the network
       */
      public static StaticObject create(final String id, final OtsLine3d geometry) throws NetworkException
      {
          return create(id, geometry, Length.ZERO);
      }
  
      /** {@inheritDoc} */
      @Override
      public final OtsLine3d getGeometry()
      {
          return this.geometry;
     }
 
     /** {@inheritDoc} */
     @Override
     public final Length getHeight()
     {
         return this.height;
     }
 
     /** {@inheritDoc} */
     @Override
     public final String getId()
     {
         return this.id;
     }
 
     /** {@inheritDoc} */
     @Override
     @SuppressWarnings("checkstyle:designforextension")
     public String getFullId()
     {
         return this.id;
     }
 
     /** {@inheritDoc} */
     @Override
     @SuppressWarnings("checkstyle:designforextension")
     public DirectedPoint getLocation()
     {
         return this.geometry.getLocation();
     }
 
     /** {@inheritDoc} */
     @Override
     @SuppressWarnings("checkstyle:designforextension")
     public Bounds getBounds()
     {
         return this.geometry.getBounds();
     }
 
     /** {@inheritDoc} */
     @Override
     @SuppressWarnings("checkstyle:designforextension")
     public String toString()
     {
         return "StaticObject [geometry=" + getGeometry() + ", height=" + this.height + "]";
     }
 
 }