|
||||||||||
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(java.lang.Object obj)
|
java.lang.String |
fullDescription()
|
java.util.List<InputSlot> |
getActivationSlots()
If the result is empty, then the tool is always active. |
java.util.List<InputSlot> |
getCurrentSlots()
This method will only be called for active tools. |
java.lang.String |
getDescription()
Gives an overall description of this Tool. |
java.lang.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(java.lang.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 java.util.List<InputSlot> getActivationSlots()
Tool
InputSlot
s must be associated to
AxisState
s, otherwise the Tool will never become active.
AxisState.RELEASED
.
Tool
s down the path.
The result must remain constant.
getActivationSlots
in interface Tool
public java.util.List<InputSlot> getCurrentSlots()
Tool
activate(..)
or perform(..)
.
getCurrentSlots
in interface Tool
public void addCurrentSlot(InputSlot slot)
public void removeCurrentSlot(InputSlot slot)
public void activate(ToolContext tc)
Tool
activate
in interface Tool
tc
- The current tool contextpublic void perform(ToolContext tc)
Tool
perform
in interface Tool
tc
- The current tool contextpublic void deactivate(ToolContext tc)
Tool
deactivate
in interface Tool
tc
- The current tool contextpublic java.lang.String fullDescription()
public java.lang.String getDescription(InputSlot slot)
Tool
getDescription
in interface Tool
slot
- to describe
public java.lang.String getDescription()
Tool
getDescription
in interface Tool
public void setDescription(java.lang.String description)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |