fdubath.entrelacs
Class Rope

java.lang.Object
  extended by fdubath.entrelacs.Rope

public class Rope
extends java.lang.Object

A 'Rope' is a path on the Backgroung Geometry, it is defined as an ordered list of Vertex.

See Also:
Vertex, BackgroundGeometry

Method Summary
 Vertex getFirstDot()
          Retrive the first vertex of the Rope
 double getIntersectionGap()
          Getter for the Rope gap in unit of the Background Geometry fundamental length.
 Vertex getLastDot()
          Retrive the last vertex of the Rope
 int[] getLineRGBColor()
          Getter for the color of the Ropes border.
 double getLineWidth()
          Getter for the Rope width in unit of the Background Geometry fundamental length.
 java.util.List getReadonlyVertices()
          Exposes the list of vertices defining the Rope.
 int[] getRopeRGBCcolor()
          Getter for the color of the Rope.
 void setIntersectionGap(double newGap)
          Setter for the Rope gap in unit of the Background Geometry fundamental length.
 void setLineRGBColor(int[] newRGBColor)
          Setter for the color of the Ropes border.
 void setLineWidth(double newLineWidth)
          Setter for the Rope width in unit of the Background Geometry fundamental length.
 void setRopeRGBColor(int[] newRGBColor)
          Setter for the color of the Rope.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getReadonlyVertices

public java.util.List getReadonlyVertices()
Exposes the list of vertices defining the Rope. This allow to retrive vertices (as exemple in order to move them). However modifying this list requiere to use the Background Geometry methodes.

Returns:
Unmodifiable list of Vertex definig the Rope path.
See Also:
BackgroundGeometry, Vertex

getFirstDot

public Vertex getFirstDot()
Retrive the first vertex of the Rope

Returns:
Ropes starting vertex
See Also:
Vertex

getLastDot

public Vertex getLastDot()
Retrive the last vertex of the Rope

Returns:
Ropes last vertex
See Also:
Vertex

setRopeRGBColor

public void setRopeRGBColor(int[] newRGBColor)
Setter for the color of the Rope. This color is used for the bulk of the rope design.

Parameters:
newRGBColor - the color define by 3 integer [Red, Gree, Blue] each one ranging in 0-255.

getRopeRGBCcolor

public int[] getRopeRGBCcolor()
Getter for the color of the Rope. This color is used for the bulk of the rope design.

Returns:
newRGBColor the color define by 3 integer [Red, Gree, Blue] each one ranging in 0-255.

setLineRGBColor

public void setLineRGBColor(int[] newRGBColor)
Setter for the color of the Ropes border. This color is used for framing the rope design.

Parameters:
newRGBColor - the color define by 3 integer [Red, Gree, Blue] each one ranging in 0-255.

getLineRGBColor

public int[] getLineRGBColor()
Getter for the color of the Ropes border. This color is used for the bulk of the rope design.

Returns:
newRGBColor the color define by 3 integer [Red, Gree, Blue] each one ranging in 0-255.

setLineWidth

public void setLineWidth(double newLineWidth)
Setter for the Rope width in unit of the Background Geometry fundamental length.

Parameters:
newLineWidth -

getLineWidth

public double getLineWidth()
Getter for the Rope width in unit of the Background Geometry fundamental length.

Returns:
Rope width

setIntersectionGap

public void setIntersectionGap(double newGap)
Setter for the Rope gap in unit of the Background Geometry fundamental length. Rope gap is an interval for wich a rope stops before an intersection.

Parameters:
newGap -

getIntersectionGap

public double getIntersectionGap()
Getter for the Rope gap in unit of the Background Geometry fundamental length. Rope gap is an interval for wich a rope stops before an intersection.

Returns:
gap length