|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.cult3d.world.Tooltip
This class provides a Java representation of a Cult3D Tooltip that exists in the scene graph of the Cult3D
Designer.
Here is an example for getting all registered CultObject for a certain Tooltip.
Tooltip tooltip = new ToolTip("ToolTip1"); Vector associatedObjects = tooltip.getAssociatedObjects();
Constructor Summary | |
Tooltip(java.lang.String name)
Constructs a Java representation of a Cult3D Tooltip that exists in the scene graph of the Cult3D Designer. |
Method Summary | |
void |
addObject(CultObject object)
Add the given CultObject to this Tooltips list over associated objects. |
java.util.Vector |
getAssociatedObjects()
Gets a list of all registered/associated objects for this Tooltip. |
CultObject |
getFirstAssociatedObject()
Gets the first object which are registed/associated for this Tooltip. |
Vector2 |
getFixedPosition()
Gets the X Y coordinates where this Tooltip are in the Cult3D window. |
java.lang.String |
getInfo()
Returns a string representation of the values of this object. |
java.lang.String |
getName()
This method gets the name of this toolitp |
CultObject |
getNextAssociatedObject()
Gets the next associated object for this Tooltip. |
Texture |
getTexture()
Gets this Tooltips texture. |
boolean |
isActive()
Checks if this Tooltip are active. |
boolean |
isTrackingMouse()
Checks whether this Tooltips are following the mouse. |
void |
removeObject(CultObject object)
Removes the given CultObject from this Tooltip's list over associated objects. |
void |
setActive(boolean state)
Activates or deactivates this Tooltip depending on the value of parameter state. |
void |
setFixedPosition(int x,
int y)
Show this Tooltip on a specific coordinate in the Cult3D window. 0.0 coordinate is at the leftmost upper corner. |
void |
setFixedPosition(Vector2 position)
Show this Tooltip on a specific coordinate in the Cult3D Window. |
java.lang.String |
toString()
This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementation and versions of Cult3D. |
void |
trackMouse(boolean status)
Activates or deactivates the option to let this Tooltip folllow the mouse. |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public Tooltip(java.lang.String name)
name
- The name of the object.Method Detail |
public Texture getTexture()
public boolean isActive()
public void setActive(boolean state)
state
- Set to true to activate this Tooltip, set to false to deactivate.public Vector2 getFixedPosition()
trackMouse(boolean)
public void setFixedPosition(int x, int y)
x
- The x coordinate for this Tooltip.y
- The y coordinate for this Tooltip.trackMouse(boolean)
public void setFixedPosition(Vector2 position)
position
- The vector which contains the X Y values for the coordinates.trackMouse(boolean)
public boolean isTrackingMouse()
trackMouse(boolean)
,
getFixedPosition()
,
setFixedPosition(int, int)
,
setFixedPosition(Vector2)
public void trackMouse(boolean status)
status
- If this Tooltip should follow the mouse set this to true, otherwise false.isTrackingMouse()
,
getFixedPosition()
,
setFixedPosition(int, int)
,
setFixedPosition(Vector2)
public java.util.Vector getAssociatedObjects()
public CultObject getFirstAssociatedObject()
getNextAssociatedObject()
public CultObject getNextAssociatedObject()
getFirstAssociatedObject()
public void removeObject(CultObject object)
object
- The CultObject to be removed.addObject(CultObject)
public void addObject(CultObject object)
object
- The CultObject to be added to this Tooltip's list over associated objects.removeObject(CultObject)
public java.lang.String getName()
public java.lang.String getInfo()
Returns a string representation of the values of this object.
This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations and versions of Cult3D.
public java.lang.String toString()
This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementation and versions of Cult3D.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |