|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectde.jreality.scene.tool.AbstractTool
public abstract class AbstractTool
| Constructor Summary | |
|---|---|
AbstractTool(InputSlot... activationSlots)
|
|
| Method Summary | |
|---|---|
void |
activate(ToolContext tc)
This method is called when the tool gets activated. |
void |
addCurrentSlot(InputSlot slot)
|
void |
deactivate(ToolContext tc)
this method is called when the tool was activate and the AxisState of the activation slot changes to AxisState.RELEASED - to zero. |
boolean |
equals(Object obj)
|
String |
fullDescription()
|
List<InputSlot> |
getActivationSlots()
If the result is empty, then the tool is always active. |
List<InputSlot> |
getCurrentSlots()
This method will only be called for active tools. |
String |
getDescription()
Gives an overall description of this Tool. |
String |
getDescription(InputSlot slot)
Gives a description of the meaning of the given InputSlot. |
int |
hashCode()
|
void |
perform(ToolContext tc)
This method is called when the tool is activated and any AxisState or TransformationMatrix of the current slots changes. |
void |
removeCurrentSlot(InputSlot slot)
|
void |
setDescription(String description)
|
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AbstractTool(InputSlot... activationSlots)
| Method Detail |
|---|
public List<InputSlot> getActivationSlots()
ToolInputSlots must be associated to
AxisStates, otherwise the Tool will never become active.
AxisState.RELEASED.
Tools down the path.
The result must remain constant.
getActivationSlots in interface Toolpublic List<InputSlot> getCurrentSlots()
Toolactivate(..)
or perform(..).
getCurrentSlots in interface Toolpublic void addCurrentSlot(InputSlot slot)
public void removeCurrentSlot(InputSlot slot)
public void activate(ToolContext tc)
Tool
activate in interface Tooltc - The current tool contextpublic void perform(ToolContext tc)
Tool
perform in interface Tooltc - The current tool contextpublic void deactivate(ToolContext tc)
Tool
deactivate in interface Tooltc - The current tool contextpublic String fullDescription()
public String getDescription(InputSlot slot)
Tool
getDescription in interface Toolslot - to describe
public String getDescription()
Tool
getDescription in interface Toolpublic void setDescription(String description)
public int hashCode()
hashCode in class Objectpublic boolean equals(Object obj)
equals in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||