org.xith3d.ui.swingui
Interface UIOverlayInterface

All Known Subinterfaces:

UIWindowInterface

All Known Implementing Classes:

UIDraggingWindow, UIWindow

public interface UIOverlayInterface

Insert package comments here

Originally Coded by David Yazel on Oct 4, 2003 at 10:01:53 PM.

Method Summary

Node	getRoot()
void	getSize(java.awt.Dimension dim) Gets the dimension of the overlay.
boolean	isOpaque() This method is used by overlay manager to optimize the display of the overlay.
void	update() Called once per frame.

Method Detail

getSize

void getSize(java.awt.Dimension dim)

Gets the dimension of the overlay. This is necessary for the window manager to be able to move the overlay to new positions, as well to detect that the window has been clicked on

update

void update()

Called once per frame. This should not do anything unless absolutely necessary. Specifically it is assumed this will be used to do a texture swap for changing the overlay contents.

getRoot

Node getRoot()

Returns:

the root of the overlay scenegraph

isOpaque

boolean isOpaque()

This method is used by overlay manager to optimize the display of the overlay.