Package org.opentrafficsim.core.object

Class StaticObject

java.lang.Object

org.djutils.event.EventProducer

org.opentrafficsim.core.object.StaticObject

All Implemented Interfaces:

Serializable, Locatable, EventProducerInterface, Identifiable, Drawable, ObjectInterface

public class StaticObject
extends EventProducer
implements ObjectInterface, Serializable, Identifiable, Drawable

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.

Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Nov 26, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields inherited from class org.djutils.event.EventProducer

eventProducerImpl

Fields inherited from interface org.djutils.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StaticObject(String id, Polygon3d geometry, Length minimumRelativeHeight, Length maximumRelativeHeight)

Method Summary

Modifier and Type	Method	Description
StaticObject	clone(Network newNetwork, boolean animation)	Clone the StaticObject for e.g., copying a network.
static StaticObject	create(String id, Polygon3d geometry)	Make a static object with zero minimumRelativeHeight and zero maximumRelativeHeight and carry out the initialization after it has been fully created.
static StaticObject	create(String id, Polygon3d geometry, Length minimumRelativeHeight, Length maximumRelativeHeight)	Make a static object and carry out the initialization after it has been fully created.
Bounds3d	getBounds()
String	getFullId()	Retrieve the full id that (must be unique within the network).
Polygon3d	getGeometry()
String	getId()
OrientedPoint3d	getLocation()
Length	getMaximumRelativeHeight()	Get the maximum elevation relative to the Z of getLocation.
Length	getMinimumRelativeHeight()	Get the minimum elevation relative to the Z of getLocation.
Serializable	getSourceId()
protected void	init()	Initialize the object after it has been fully created.
String	toString()

Methods inherited from class org.djutils.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, getEventTypesWithListeners, getListenerReferences, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djutils.event.EventProducerInterface

addListener, addListener, addListener, addListener, getEventTypesWithListeners, hasListeners, numberOfListeners, removeListener

Methods inherited from interface nl.tudelft.simulation.dsol.animation.Locatable

getDirZ, getZ

Constructor Detail

StaticObject

protected StaticObject(String id,
                       Polygon3d geometry,
                       Length minimumRelativeHeight,
                       Length maximumRelativeHeight)
                throws NullPointerException,
                       IllegalArgumentException

Parameters:

id - String; the id

geometry - Polygon3d; the top-level 2D outline of the object relative to its location

minimumRelativeHeight - Length; the minimum height of the object, relative to the z-value of its location

maximumRelativeHeight - Length; the maximum height of the object, relative to the z-value of its location

Throws:

NullPointerException - when id, geometry, minimumRelativeHeight, or maximumRelativeHeight is null

IllegalArgumentException - when minimumRelativeHeight exceeds maximumRelativeHeight

Method Detail

init

protected void init()
             throws NetworkException

Initialize the object after it has been fully created.

Throws:

NetworkException - e.g. on error registering the object in the network

create

public static StaticObject create(String id,
                                  Polygon3d geometry,
                                  Length minimumRelativeHeight,
                                  Length maximumRelativeHeight)
                           throws NetworkException

Make a static object and carry out the initialization after it has been fully created.

Parameters:

id - String; the id

geometry - Polygon3d; the top-level 2D outline of the object

minimumRelativeHeight - Length; the minimum height of the object, relative to the z-value of its location

maximumRelativeHeight - Length; the maximum height of the object, relative to the z-value of its location

Returns:

the static object

Throws:

NetworkException - e.g. on error registering the object in the network

create

public static StaticObject create(String id,
                                  Polygon3d geometry)
                           throws NetworkException

Make a static object with zero minimumRelativeHeight and zero maximumRelativeHeight and carry out the initialization after it has been fully created.

Parameters:

id - String; the id

geometry - OTSLine3D; the top-level 2D outline of the object

Returns:

the static object

Throws:

NetworkException - e.g. on error registering the object in the network

getGeometry

public final Polygon3d getGeometry()

Specified by:

getGeometry in interface ObjectInterface

Returns:

the outline geometry of the object.

getMinimumRelativeHeight

public final Length getMinimumRelativeHeight()

Get the minimum elevation relative to the Z of getLocation.

Specified by:

getMinimumRelativeHeight in interface ObjectInterface

Returns:

Length; the minimum elevation relative to the Z of getLocation

getMaximumRelativeHeight

public final Length getMaximumRelativeHeight()

Get the maximum elevation relative to the Z of getLocation.

Specified by:

getMaximumRelativeHeight in interface ObjectInterface

Returns:

Length; the maximum elevation relative to the Z of getLocation

getId

public final String getId()

Specified by:

getId in interface Identifiable

getFullId

public String getFullId()

Retrieve the full id that (must be unique within the network).

Specified by:

getFullId in interface ObjectInterface

Returns:

the full id that makes the id unique in the network

getLocation

public OrientedPoint3d getLocation()

Specified by:

getLocation in interface Locatable

getBounds

public Bounds3d getBounds()

Specified by:

getBounds in interface Locatable

toString

public String toString()

Overrides:

toString in class Object

clone

public StaticObject clone(Network newNetwork,
                          boolean animation)
                   throws NetworkException

Clone the StaticObject for e.g., copying a network.

Parameters:

newNetwork - Network; the new network to which the clone belongs

animation - boolean; whether to (re)create animation or not

Returns:

a clone of this object

Throws:

NetworkException - in case the cloning fails

getSourceId

public Serializable getSourceId()

Specified by:

getSourceId in interface EventProducerInterface

Specified by:

getSourceId in class EventProducer