Module com.marginallyclever.robotoverlord

Package com.marginallyclever.ro3.node.nodes

Class LinearJoint

java.lang.Object

com.marginallyclever.ro3.node.Node

com.marginallyclever.ro3.node.nodes.LinearJoint

public class LinearJoint
extends Node

a LinearJoint is a joint that can translate along the local Z axis.

a LinearJoint should be attached to a child Pose referenced as the car. In this way the car's parent Pose can be thought of as the initial pose at zero mm. This helps prevent drift over time.

Constructor Summary

Constructors

Constructor	Description
LinearJoint()
LinearJoint(String name)

Method Summary

Modifier and Type	Method	Description
void	fromJSON(org.json.JSONObject from)	Deserialize this node and its children from a JSON object and its children.
double	getAcceleration()
Pose	getCar()
void	getComponents(List<JPanel> list)	Build a Swing Component that represents this Node.
Icon	getIcon()	Set a custom icon for this node.
double	getMaxPosition()
double	getMinPosition()
double	getPosition()
double	getVelocity()
void	setAcceleration(double acceleration)
void	setCar(Pose subject)
void	setMaxPosition(double v)
void	setMinPosition(double v)
void	setPosition(double degrees)
void	setVelocity(double velocity)
org.json.JSONObject	toJSON()	Serialize this node and its children to a JSON object and its children.
void	update(double dt)	Called every frame.

Methods inherited from class com.marginallyclever.ro3.node.Node

addAttachListener, addChild, addChild, addDetachListener, addReadyListener, addRenameListener, findByPath, findChild, findChild, findFirstChild, findFirstSibling, findNodeByID, findParent, findParent, getAbsolutePath, getChildren, getName, getParent, getRootNode, getUniqueID, hasParent, isNameUsedBySibling, removeAttachListener, removeChild, removeDetachListener, removeReadyListener, removeRenameListener, setName, witnessProtection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LinearJoint

public LinearJoint()

LinearJoint

public LinearJoint(String name)

Method Details

getComponents

public void getComponents(List<JPanel> list)

Description copied from class: Node

Build a Swing Component that represents this Node.

Overrides:

getComponents in class Node

Parameters:

list - the list to add components to.

update

public void update(double dt)

Description copied from class: Node

Called every frame.

Overrides:

update in class Node

Parameters:

dt - the time since the last frame.

toJSON

public org.json.JSONObject toJSON()

Description copied from class: Node

Serialize this node and its children to a JSON object and its children. Classes that override this method should call super.toJSON() first, then add to the object returned.

Overrides:

toJSON in class Node

Returns:

the JSON object.

fromJSON

public void fromJSON(org.json.JSONObject from)

Description copied from class: Node

Deserialize this node and its children from a JSON object and its children. Classes that override this method should call super.fromJSON(). When they do it will trigger the creation of child nodes. The child nodes will then call their own fromJSON() methods.

Overrides:

fromJSON in class Node

Parameters:

from - the JSON object to read from.

getPosition

public double getPosition()

setPosition

public void setPosition(double degrees)

getMinPosition

public double getMinPosition()

setMinPosition

public void setMinPosition(double v)

getMaxPosition

public double getMaxPosition()

setMaxPosition

public void setMaxPosition(double v)

getVelocity

public double getVelocity()

setVelocity

public void setVelocity(double velocity)

getAcceleration

public double getAcceleration()

setAcceleration

public void setAcceleration(double acceleration)

getCar

public Pose getCar()

setCar

public void setCar(Pose subject)

getIcon

public Icon getIcon()

Description copied from class: Node

Set a custom icon for this node.

Overrides:

getIcon in class Node

Returns:

the icon, or null if none.