Package nl.tudelft.simulation.dsol.animation

Interface Locatable

All Known Subinterfaces:
GisRenderable2d
All Known Implementing Classes:
StaticLocation2d, StaticLocation3d
public interface Locatable
The locatable interface enforces knowledge on position.

Copyright (c) 2002-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://https://simulation.tudelft.nl/dsol/docs/latest/license.html.

Author:
Peter Jacobs

  • Method Summary

    Modifier and Type
    Method
    Description
    Bounds<?,?,?>
    getBounds()
    returns the bounds of the locatable object.
    default double
    getDirZ()
    Return the z-direction of the location in radians, or 0.0 when the location has no direction.
    Point<?>
    getLocation()
    returns the location of an object.
    default double
    getZ()
    Return the z-value of the location, or 0.0 when the location is in 2 dimensions.

  • Method Details

    • getLocation

      Point<?> getLocation() throws RemoteException
      returns the location of an object. This value may be null, e.g., when the object is still being constructed or being destroyed.
      Returns:
      Point<?>; the location
      Throws:
      RemoteException - on network failure

    • getZ

      default double getZ() throws RemoteException
      Return the z-value of the location, or 0.0 when the location is in 2 dimensions.
      Returns:
      double; the z-value of the location, or 0.0 when the location is in 2 dimensions, or when getLocation() returns null
      Throws:
      RemoteException - on network failure

    • getDirZ

      default double getDirZ() throws RemoteException
      Return the z-direction of the location in radians, or 0.0 when the location has no direction.
      Returns:
      double; the z-direction of the location in radians, or 0.0 when the location has no direction, or when getLocation() returns null
      Throws:
      RemoteException - on network failure

    • getBounds

      Bounds<?,?,?> getBounds() throws RemoteException
      returns the bounds of the locatable object. The bounds is the not rotated bounds around [0;0;0]. In contrast to the getLocation() method the getBounds() method should never return null.
      Returns:
      Bounds<?, ?, ?, ?>; the bounds of the object around getLocation() as center of the box.
      Throws:
      RemoteException - on network failure