Module com.marginallyclever.robotoverlord

Package com.marginallyclever.ro3.node.nodes.pose.poses

Class AttachmentPoint

java.lang.Object

com.marginallyclever.ro3.node.Node

com.marginallyclever.ro3.node.nodes.pose.Pose

com.marginallyclever.ro3.node.nodes.pose.poses.AttachmentPoint

All Implemented Interfaces:

PoseChangeListener, EventListener

public class AttachmentPoint
extends Pose

AttachmentPoint is a point on a Pose that can be used to attach other Poses.

Users can click the attach button in the control panel. Developers can use the attemptAttach() method. If this AttachmentPoint finds another Pose within radius, it will move the other Pose to be a child of this AttachmentPoint.

Things in reach must be Pose items within radius of AttachmentPoint. They must also be immediate children of the Scene root.

The attached item will move from the Scene root and become a child of AttachmentPoint. On release all children of AttachmentPoint will be moved back to the Scene root. In both cases their relative pose will be adjusted so they do not teleport.

Constructor Summary

Constructors

Constructor	Description
AttachmentPoint()
AttachmentPoint(String name)

Method Summary

Modifier and Type	Method	Description
void	attach(List<Pose> list)	Attach a list of Pose nodes to this node and adjust their world transform to compensate.
void	attemptAttach()
void	fromJSON(org.json.JSONObject from)	Deserialize this node and its children from a JSON object and its children.
void	getComponents(List<JPanel> list)	Build a Swing Component that represents this Node.
Icon	getIcon()	Set a custom icon for this node.
boolean	getIsAttached()
double	getRadius()
void	release()	Release all attached nodes.
void	setIsAttached(boolean isAttached)
void	setRadius(double radius)
org.json.JSONObject	toJSON()	Serialize this node and its children to a JSON object and its children.

Methods inherited from class com.marginallyclever.ro3.node.nodes.pose.Pose

addPoseChangeListener, getLocal, getParentPose, getPosition, getRotationEuler, getRotationIndex, getWorld, onPoseChange, removePoseChangeListener, setLocal, setPosition, setRotationEuler, setRotationIndex, setWorld

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, update, witnessProtection

Methods inherited from class java.lang.Object

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

Constructor Details

AttachmentPoint

public AttachmentPoint()

AttachmentPoint

public AttachmentPoint(String name)

Method Details

attach

public void attach(List<Pose> list)

Attach a list of Pose nodes to this node and adjust their world transform to compensate.

Parameters:

list - list of nodes to attach.

release

public void release()

Release all attached nodes. Move them to the scene root and adjust their world transform to compensate.

attemptAttach

public void attemptAttach()

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 Pose

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 Pose

Parameters:

from - the JSON object to read from.

getComponents

public void getComponents(List<JPanel> list)

Description copied from class: Pose

Build a Swing Component that represents this Node.

Overrides:

getComponents in class Pose

Parameters:

list - the list to add components to.

getRadius

public double getRadius()

setRadius

public void setRadius(double radius)

getIsAttached

public boolean getIsAttached()

setIsAttached

public void setIsAttached(boolean isAttached)

getIcon

public Icon getIcon()

Description copied from class: Node

Set a custom icon for this node.

Overrides:

getIcon in class Pose

Returns:

the icon, or null if none.