FPrismaticJoint (fisica 1.0.0-SNAPSHOT API)

java.lang.Object
- fisica.FDrawable
- - fisica.FJoint
  - - fisica.FPrismaticJoint

```
public class FPrismaticJoint
extends FJoint
```
Represents a prismatic joint that restricts the movement of one body with respect to another to a translation along a given axis. Often this joint is used with one of the bodies being static in order to only allow translation of the other body along a given axis. This translation can also be bounded given lower and upper translation limits.

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.jbox2d.common.Vec2`	`m_anchor`
`protected org.jbox2d.common.Vec2`	`m_axis`
`protected FBody`	`m_body1`
`protected FBody`	`m_body2`
`protected boolean`	`m_enableLimit` A flag to enable joint limits.
`protected boolean`	`m_enableMotor` A flag to enable the joint motor.
`protected float`	`m_force`
`protected float`	`m_limitForce`
`protected float`	`m_limitPositionImpulse`
`protected org.jbox2d.common.Vec2`	`m_localAnchor1` The local anchor point relative to body1's origin.
`protected org.jbox2d.common.Vec2`	`m_localAnchor2` The local anchor point relative to body2's origin.
`protected org.jbox2d.common.Vec2`	`m_localAxis1`
`protected float`	`m_lowerTranslation` The lower translation for the joint limit (world coords).
`protected float`	`m_maxMotorForce`
`protected float`	`m_maxMotorTorque` The maximum motor torque used to achieve the desired motor speed.
`protected float`	`m_motorForce`
`protected float`	`m_motorSpeed` The desired motor speed.
`protected float`	`m_referenceAngle` The body2 angle minus body1 angle in the reference state (radians).
`protected float`	`m_torque`
`protected float`	`m_upperTranslation` The upper translation for the joint limit (world coords).

Fields inherited from class fisica.FJoint
m_collideConnected, m_joint, m_world

Fields inherited from class fisica.FDrawable
m_drawable, m_fill, m_fillColor, m_image, m_imageAlpha, m_mask, m_stroke, m_strokeColor, m_strokeWeight

Constructor Summary

Constructors
Constructor and Description

FPrismaticJoint(FBody body1, FBody body2)
Construct a prismatic joint between two bodies.

Constructors
Constructor and Description
`FPrismaticJoint(FBody body1, FBody body2)` Construct a prismatic joint between two bodies.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw(def.processing.core.PGraphics applet)` This method is called when calling `world.draw()`.
`void`	`drawDebug(def.processing.core.PGraphics applet)` This method is called when calling `world.drawDebug()`.
`float`	`getAnchorX()` Get the horizontal coordinate of the anchor of the joint.
`float`	`getAnchorY()` Get the vertical coordinate of the anchor of the joint.
`protected org.jbox2d.dynamics.joints.JointDef`	`getJointDef(FWorld world)`
`void`	`setAnchor(float x, float y)` Sets the position of the anchor of the joint.
`void`	`setAxis(float x, float y)` Sets the axis of movement of the joint.
`void`	`setEnableLimit(boolean value)` Set limits to the allowed translation of one body respect to the other.
`void`	`setLowerTranslation(float translation)` Set the lowest translation allowed.
`void`	`setUpperTranslation(float translation)` Set the highest translation allowed.
`protected void`	`updateLocalAnchors()`
`protected void`	`updateLocalAxis()`

Methods inherited from class fisica.FJoint
addToWorld, getBody1, getBody2, getBox2dJoint, getReactionForceX, getReactionForceY, getReactionTorque, postDraw, postDrawDebug, preDraw, preDrawDebug, processJoint, removeFromWorld, setCollideConnected

Methods inherited from class fisica.FDrawable
appletFill, appletFillStroke, appletStroke, attachImage, dettachImage, drawImage, getFillColor, getImageAlpha, isDrawable, setDrawable, setFill, setFill, setFill, setFill, setFillColor, setImageAlpha, setNoFill, setNoStroke, setStroke, setStroke, setStroke, setStroke, setStrokeColor, setStrokeWeight, updateStyle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_body1
```
protected FBody m_body1
```
  - m_body2
```
protected FBody m_body2
```
  - m_anchor
```
protected org.jbox2d.common.Vec2 m_anchor
```
  - m_axis
```
protected org.jbox2d.common.Vec2 m_axis
```
  - m_localAxis1
```
protected org.jbox2d.common.Vec2 m_localAxis1
```
  - m_force
```
protected float m_force
```
  - m_torque
```
protected float m_torque
```
  - m_motorForce
```
protected float m_motorForce
```
  - m_limitForce
```
protected float m_limitForce
```
  - m_limitPositionImpulse
```
protected float m_limitPositionImpulse
```
  - m_maxMotorForce
```
protected float m_maxMotorForce
```
  - m_localAnchor1
```
protected org.jbox2d.common.Vec2 m_localAnchor1
```
    The local anchor point relative to body1's origin.
  - m_localAnchor2
```
protected org.jbox2d.common.Vec2 m_localAnchor2
```
    The local anchor point relative to body2's origin.
  - m_referenceAngle
```
protected float m_referenceAngle
```
    The body2 angle minus body1 angle in the reference state (radians).
  - m_enableLimit
```
protected boolean m_enableLimit
```
    A flag to enable joint limits.
  - m_lowerTranslation
```
protected float m_lowerTranslation
```
    The lower translation for the joint limit (world coords).
  - m_upperTranslation
```
protected float m_upperTranslation
```
    The upper translation for the joint limit (world coords).
  - m_enableMotor
```
protected boolean m_enableMotor
```
    A flag to enable the joint motor.
  - m_motorSpeed
```
protected float m_motorSpeed
```
    The desired motor speed. Usually in radians per second.
  - m_maxMotorTorque
```
protected float m_maxMotorTorque
```
    The maximum motor torque used to achieve the desired motor speed. Usually in N-m.
- Constructor Detail
  - FPrismaticJoint
```
public FPrismaticJoint(FBody body1,
                       FBody body2)
```
    Construct a prismatic joint between two bodies. The constructor automatically sets the anchor of the joint to the center of the second body.
    
    Parameters:
    
    body1 - first body of the joint
    
    body2 - second body of the joint
- Method Detail
  - updateLocalAnchors
```
protected void updateLocalAnchors()
```
  - updateLocalAxis
```
protected void updateLocalAxis()
```
  - getJointDef
```
protected org.jbox2d.dynamics.joints.JointDef getJointDef(FWorld world)
```
    Overrides:
    
    getJointDef in class FJoint
  - setAxis
```
public void setAxis(float x,
                    float y)
```
    Sets the axis of movement of the joint. This is only axis alog which the bodies can translate with relation to each other. The axis is given global coordinates, relative to the center of the canvas. This property must be set before adding the joint to the world.
    
    Parameters:
    
    x - the horizontal component of the axis in global coordinates, relative to the center of the canvas
    
    y - the vertical coordinate of the axis in global coordinates, relative to the center of the canvas
  - setAnchor
```
public void setAnchor(float x,
                      float y)
```
    Sets the position of the anchor of the joint. This position is given global coordinates, relative to the center of the canvas.
    
    Parameters:
    
    x - the horizontal coordinate of the anchor in global coordinates, relative to the center of the canvas
    
    y - the vertical coordinate of the anchor in global coordinates, relative to the center of the canvas
  - getAnchorX
```
public float getAnchorX()
```
    Get the horizontal coordinate of the anchor of the joint. This position is given global coordinates, relative to the center of the canvas.
    
    Returns:
    
    the horizontal coordinate of the anchor in global coordinates, relative to the center of the canvas
  - getAnchorY
```
public float getAnchorY()
```
    Get the vertical coordinate of the anchor of the joint. This position is given global coordinates, relative to the center of the canvas.
    
    Returns:
    
    the vertical coordinate of the anchor in global coordinates, relative to the center of the canvas
  - setLowerTranslation
```
public void setLowerTranslation(float translation)
```
    Set the lowest translation allowed. This property only has effect if the enableLimit has been set to true using setEnableLimit(boolean).
    
    Parameters:
    
    translation - lowest translation position in pixels
  - setUpperTranslation
```
public void setUpperTranslation(float translation)
```
    Set the highest translation allowed. This property only has effect if the enableLimit has been set to true using setEnableLimit(boolean).
    
    Parameters:
    
    translation - highest translation position in pixels
  - setEnableLimit
```
public void setEnableLimit(boolean value)
```
    Set limits to the allowed translation of one body respect to the other. If set to true the limits imposed using setLowerTranslation and setLowerTranslation are enforced.
    
    Parameters:
    
    value - if true the bodies will be able to translate along the axis only between certain limits
  - draw
```
public void draw(def.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(def.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.

Class FPrismaticJoint

Field Summary

Fields inherited from class fisica.FJoint

Fields inherited from class fisica.FDrawable

Constructor Summary

Method Summary

Methods inherited from class fisica.FJoint

Methods inherited from class fisica.FDrawable

Methods inherited from class java.lang.Object

Field Detail

m_body1

m_body2

m_anchor

m_axis

m_localAxis1

m_force

m_torque

m_motorForce

m_limitForce

m_limitPositionImpulse

m_maxMotorForce

m_localAnchor1

m_localAnchor2

m_referenceAngle

m_enableLimit

m_lowerTranslation

m_upperTranslation

m_enableMotor

m_motorSpeed

m_maxMotorTorque

Constructor Detail

FPrismaticJoint

Method Detail

updateLocalAnchors

updateLocalAxis

getJointDef

setAxis

setAnchor

getAnchorX

getAnchorY

setLowerTranslation

setUpperTranslation

setEnableLimit

draw

drawDebug