plugins.big.bigsnakeutils.icy.snake3D
Class Snake3DNode

java.lang.Object
  extended by javax.vecmath.Tuple3d
      extended by javax.vecmath.Point3d
          extended by plugins.big.bigsnakeutils.icy.snake3D.Snake3DNode
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Snake3DNode>

public class Snake3DNode
extends javax.vecmath.Point3d
implements java.lang.Comparable<Snake3DNode>

This class is used to store the snake-defining parameters. It extends the capabilities of the class Point3d by additional state variables.

Version:
May 3, 2014
Author:
Ricard Delgado-Gonzalo (ricard.delgado@gmail.com), Nicolas Chenouard (nicolas.chenouard@gmail.com), Philippe Thévenaz (philippe.thevenaz@epfl.ch)
See Also:
Serialized Form

Field Summary
static java.lang.String ID_FROZEN
           
static java.lang.String ID_HIDDEN
           
static java.lang.String ID_X
           
static java.lang.String ID_Y
           
static java.lang.String ID_Z
           
 
Fields inherited from class javax.vecmath.Tuple3d
x, y, z
 
Constructor Summary
Snake3DNode(double x, double y, double z)
          This constructor builds a point that is initially neither frozen nor hidden.
Snake3DNode(double x, double y, double z, boolean frozen, boolean hidden)
          This constructor builds a point with the given initial values.
 
Method Summary
 int compareTo(Snake3DNode node)
          Comparator that organizes the points by their first component.
 void freeze()
          Sets the frozen state of the node to .
 void hide()
          Sets the hidden state of the node to .
 boolean isFrozen()
          Returns the frozen state of the node.
 boolean isHidden()
          Returns the hidden state of the node.
 void loadFromXML(org.w3c.dom.Node node)
           
 void saveToXML(org.w3c.dom.Element node)
           
 java.lang.String toString()
          This method returns text-based information about this object.
 void unfreeze()
          Sets the frozen state of the node to .
 void unhide()
          Sets the hidden state of the node to .
 
Methods inherited from class javax.vecmath.Point3d
distance, distanceL1, distanceLinf, distanceSquared, project
 
Methods inherited from class javax.vecmath.Tuple3d
absolute, absolute, add, add, clamp, clamp, clamp, clamp, clampMax, clampMax, clampMax, clampMax, clampMin, clampMin, clampMin, clampMin, clone, epsilonEquals, equals, equals, get, get, hashCode, interpolate, interpolate, interpolate, interpolate, negate, negate, scale, scale, scaleAdd, scaleAdd, scaleAdd, set, set, set, set, sub, sub
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID_X

public static final java.lang.String ID_X
See Also:
Constant Field Values

ID_Y

public static final java.lang.String ID_Y
See Also:
Constant Field Values

ID_Z

public static final java.lang.String ID_Z
See Also:
Constant Field Values

ID_FROZEN

public static final java.lang.String ID_FROZEN
See Also:
Constant Field Values

ID_HIDDEN

public static final java.lang.String ID_HIDDEN
See Also:
Constant Field Values
Constructor Detail

Snake3DNode

public Snake3DNode(double x,
                   double y,
                   double z)
This constructor builds a point that is initially neither frozen nor hidden.


Snake3DNode

public Snake3DNode(double x,
                   double y,
                   double z,
                   boolean frozen,
                   boolean hidden)
This constructor builds a point with the given initial values.

Method Detail

loadFromXML

public void loadFromXML(org.w3c.dom.Node node)

saveToXML

public void saveToXML(org.w3c.dom.Element node)

toString

public java.lang.String toString()
This method returns text-based information about this object.

Overrides:
toString in class javax.vecmath.Tuple3d

compareTo

public int compareTo(Snake3DNode node)
Comparator that organizes the points by their first component.

Specified by:
compareTo in interface java.lang.Comparable<Snake3DNode>

hide

public void hide()
Sets the hidden state of the node to .


unhide

public void unhide()
Sets the hidden state of the node to .


isHidden

public boolean isHidden()
Returns the hidden state of the node.


freeze

public void freeze()
Sets the frozen state of the node to .


unfreeze

public void unfreeze()
Sets the frozen state of the node to .


isFrozen

public boolean isFrozen()
Returns the frozen state of the node.