Package org.graphstream.ui.graphicGraph

Class GraphicSprite

java.lang.Object
org.graphstream.graph.implementations.AbstractElement
org.graphstream.ui.graphicGraph.GraphicElement
org.graphstream.ui.graphicGraph.GraphicSprite
All Implemented Interfaces:
Element
public class GraphicSprite
extends GraphicElement
A small gentle sprite.

  • Field Details

  • Constructor Details

    • GraphicSprite

      public GraphicSprite​(String id, GraphicGraph graph)
      New sprite.
      Parameters:
      id - The sprite unique identifier.
      graph - The graph containing this sprite.

  • Method Details

    • getNodeAttachment

      public GraphicNode getNodeAttachment()
      The node this sprite is attached to or null if not attached to an edge.
      Returns:
      A graphic node.

    • getEdgeAttachment

      public GraphicEdge getEdgeAttachment()
      The edge this sprite is attached to or null if not attached to an edge.
      Returns:
      A graphic edge.

    • getAttachment

      public GraphicElement getAttachment()
      Return the graphic object this sprite is attached to or null if not attached.
      Returns:
      A graphic object or null if no attachment.

    • isAttached

      public boolean isAttached()
      True if the sprite is attached to a node or edge.

    • isAttachedToNode

      public boolean isAttachedToNode()
      True if the sprite is attached to a node.

    • isAttachedToEdge

      public boolean isAttachedToEdge()
      True if the node is attached to an edge.

    • getSelectorType

      public Selector.Type getSelectorType()
      Description copied from class: GraphicElement
      Type of selector for the graphic element (Node, Edge, Sprite ?).
      Specified by:
      getSelectorType in class GraphicElement

    • getX

      public double getX()
      Description copied from class: GraphicElement
      Abscissa of the element, always in GU (graph units). For edges this is the X of the "from" node.
      Specified by:
      getX in class GraphicElement

    • getY

      public double getY()
      Description copied from class: GraphicElement
      Ordinate of the element, always in GU (graph units). For edges this is the Y of the "from" node.
      Specified by:
      getY in class GraphicElement

    • getZ

      public double getZ()
      Description copied from class: GraphicElement
      Depth of the element, always in GU (graph units). For edges this is the Z of the "from" node.
      Specified by:
      getZ in class GraphicElement

    • getUnits

      public StyleConstants.Units getUnits()

    • move

      public void move​(double x, double y, double z)
      Description copied from class: GraphicElement
      Try to force the element to move at the give location in graph units (GU). For edges, this may move the two attached nodes.
      Specified by:
      move in class GraphicElement
      Parameters:
      x - The new X.
      y - The new Y.
      z - the new Z.

    • attachToNode

      public void attachToNode​(GraphicNode node)
      Attach this sprite to the given node.
      Parameters:
      node - A graphic node.

    • attachToEdge

      public void attachToEdge​(GraphicEdge edge)
      Attach this sprite to the given edge.
      Parameters:
      edge - A graphic edge.

    • detach

      public void detach()
      Detach this sprite from the edge or node it was attached to.

    • setPosition

      public void setPosition​(double value)
      Reposition this sprite.
      Parameters:
      value - The coordinate.

    • setPosition

      public void setPosition​(double x, double y, double z, StyleConstants.Units units)
      Reposition this sprite.
      Parameters:
      x - First coordinate.
      y - Second coordinate.
      z - Third coordinate.
      units - The units to use for lengths and radii, null means "unchanged".

    • setPosition

      public void setPosition​(Values values)