fisica
Class FDistanceJoint

java.lang.Object
  extended by fisica.FDrawable
      extended by fisica.FJoint
          extended by fisica.FDistanceJoint

public class FDistanceJoint
extends FJoint

Represents a distance joint that tries to keep two bodies at a constant distance. This joint is similar to connecting both bodies by a spring.


Constructor Summary
FDistanceJoint(FBody body1, FBody body2)
          Construct a distance joint between two bodies.
 
Method Summary
 void calculateLength()
          Sets the length of the joint to the current distance between the bodies.
 void draw(processing.core.PGraphics applet)
          This method is called when calling world.draw().
 void drawDebug(processing.core.PGraphics applet)
          This method is called when calling world.drawDebug().
 float getAnchor1X()
          Get the horizontal coordinate of the first anchor point on the first body.
 float getAnchor1Y()
          Get the vertical coordinate of the first anchor point on the first body.
 float getAnchor2X()
          Get the horizontal coordinate of the second anchor point on the second body.
 float getAnchor2Y()
          Get the vertical coordinate of the second anchor point on the second body.
 void setAnchor1(float x, float y)
          Sets the position of the anchor of the first end of the joint on the first body.
 void setAnchor2(float x, float y)
          Sets the position of the anchor of the second end of the joint on the second body.
 void setDamping(float damping)
          Sets the damping of the spring used to maintain the distance between the bodies constant.
 void setFrequency(float frequency)
          Sets the frequency of the spring used to maintain the distance between the bodies constant.
 void setLength(float length)
          Sets the target distance for the joint.
 
Methods inherited from class fisica.FJoint
addToWorld, getBody1, getBody2, getBox2dJoint, getReactionForceX, getReactionForceY, getReactionTorque, removeFromWorld, setCollideConnected
 
Methods inherited from class fisica.FDrawable
attachImage, dettachImage, draw, drawDebug, getFillColor, getImageAlpha, isDrawable, setDrawable, setFill, setFill, setFill, setFill, setFillColor, setImageAlpha, setNoFill, setNoStroke, setStroke, setStroke, setStroke, setStroke, setStrokeColor, setStrokeWeight
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FDistanceJoint

public FDistanceJoint(FBody body1,
                      FBody body2)
Construct a distance joint between two bodies. The constructor automatically sets the anchors of the joint to the centers of each body, and the length of the joint to the current distance between the bodies.

Parameters:
body1 - first body of the joint
body2 - second body of the joint
Method Detail

setDamping

public void setDamping(float damping)
Sets the damping of the spring used to maintain the distance between the bodies constant.

Parameters:
damping - the damping of the spring

setFrequency

public void setFrequency(float frequency)
Sets the frequency of the spring used to maintain the distance between the bodies constant.

Parameters:
frequency - the frequency of the spring

calculateLength

public void calculateLength()
Sets the length of the joint to the current distance between the bodies.


setLength

public void setLength(float length)
Sets the target distance for the joint. This is the distance that the joint will try to maintain between the two bodies. If you want to use as length the current distance between the two bodies, use the method calculateLength.

Parameters:
length - the length of the joint

setAnchor2

public void setAnchor2(float x,
                       float y)
Sets the position of the anchor of the second end of the joint on the second body. This position must be given relative to the center of the second body. The anchor point is the point used to calculate the distance and to apply forces in order to move the body.

Parameters:
x - the horizontal coordinate of the second anchor relative to the center of the second body
y - the vertical coordinate of the second anchor relative to the center of the second body

setAnchor1

public void setAnchor1(float x,
                       float y)
Sets the position of the anchor of the first end of the joint on the first body. This position must be given relative to the center of the first body. The anchor point is the point used to calculate the distance and to apply forces in order to move the body.

Parameters:
x - the horizontal coordinate of the first anchor relative to the center of the first body
y - the vertical coordinate of the first anchor relative to the center of the first body

getAnchor1X

public float getAnchor1X()
Get the horizontal coordinate of the first anchor point on the first body. This position is given relative to the center of the first body.

Returns:
the horizontal coordinate of the first anchor relative to the center of the first body

getAnchor1Y

public float getAnchor1Y()
Get the vertical coordinate of the first anchor point on the first body. This position is given relative to the center of the first body.

Returns:
the vertical coordinate of the first anchor relative to the center of the first body

getAnchor2X

public float getAnchor2X()
Get the horizontal coordinate of the second anchor point on the second body. This position is given relative to the center of the second body.

Returns:
the horizontal coordinate of the second anchor relative to the center of the second body

getAnchor2Y

public float getAnchor2Y()
Get the vertical coordinate of the second anchor point on the second body. This position is given relative to the center of the second body.

Returns:
the vertical coordinate of the second anchor relative to the center of the second body

draw

public void draw(processing.core.PGraphics applet)
Description copied from class: FDrawable
This method is called when calling world.draw(). This method may be overriden to allow custom drawing of the object.

Overrides:
draw in class FDrawable
Parameters:
applet - the graphics onto which the object must be drawn.

drawDebug

public void drawDebug(processing.core.PGraphics applet)
Description copied from class: FDrawable
This method is called when calling world.drawDebug(). This method may be overriden to allow custom debug drawing of the object.

Overrides:
drawDebug in class FDrawable
Parameters:
applet - the graphics onto which the object must be drawn.


processing library fisica by Ricard Marxer. (c) 2009-2013