View Javadoc

1   package net.sf.josceleton.core.api.entity.joint;
2   
3   /**
4    * This class represents joints in the human body at which two parts of the skeleton are fitted together.
5    * 
6    * Available joints (until now) are:
7    * <ul>
8    *   <li>Head</li>
9    *   <li>Neck</li>
10   *   <li>Torso</li>
11   *   <li>Left/Right Shoulder</li>
12   *   <li>Left/Right Elbow</li>
13   *   <li>Left/Right Hand</li>
14   *   <li>Left/Right Hip</li>
15   *   <li>Left/Right Knee</li>
16   *   <li>Left/Right Ankle</li>
17   *   <li>Left/Right Foot</li>
18   * </ul>
19   * 
20   * @see Joints
21   */
22  public interface Joint {
23  	
24  	/** @return a user display friendly text representation of this joint; e.g.: "Head" or "Left Hand". */
25  	String getLabel();
26  	
27  	/** @return the unique name of a joint as known from osceleton; e.g.: "head" or "l_hand". */
28  	String getOsceletonId();
29  	
30  }