Package eu.svjatoslav.sixth.e3d.gui

Class GuiComponent

java.lang.Object

eu.svjatoslav.sixth.e3d.renderer.raster.shapes.AbstractShape

eu.svjatoslav.sixth.e3d.renderer.raster.shapes.composite.base.AbstractCompositeShape

eu.svjatoslav.sixth.e3d.gui.GuiComponent

All Implemented Interfaces:

KeyboardInputHandler, MouseInteractionController

Direct Known Subclasses:

TextEditComponent

public class GuiComponent
extends AbstractCompositeShape
implements KeyboardInputHandler, MouseInteractionController

Base class for interactive GUI components rendered in 3D space.

GuiComponent combines a composite shape with keyboard and mouse interaction handling. When clicked, it acquires keyboard focus (via the KeyboardFocusStack), and a red wireframe border is displayed to indicate focus. Pressing ESC releases focus.

This class is the foundation for interactive widgets like the TextEditComponent.

Usage example - creating a custom GUI component:

 GuiComponent myWidget = new GuiComponent(
     new Transform(new Point3D(0, 0, 300)),
     viewPanel,
     new Point3D(400, 300, 0)  // width, height, depth
 );

 // Add visual content to the widget
 myWidget.addShape(someTextCanvas);

 // Add to the scene
 viewPanel.getRootShapeCollection().addShape(myWidget);
 

See Also:

• manages which component has keyboard focus
• a full text editor built on this class

Field Summary

Fields

Modifier and Type	Field	Description
final ViewPanel	viewPanel	The view panel this component is attached to.

Fields inherited from class eu.svjatoslav.sixth.e3d.renderer.raster.shapes.AbstractShape

mouseInteractionController

Constructor Summary

Constructors

Constructor	Description
GuiComponent(Transform transform, ViewPanel viewPanel, Point3D size)	Creates a GUI component with the specified transform, view panel, and bounding box size.

Method Summary

Modifier and Type	Method	Description
boolean	focusLost(ViewPanel viewPanel)
boolean	focusReceived(ViewPanel viewPanel)
WireframeBox	getBorders()
int	getDepth()
int	getHeight()
int	getWidth()
void	hideBorder()
boolean	keyPressed(KeyEvent event, ViewPanel viewPanel)
boolean	keyReleased(KeyEvent event, ViewPanel viewPanel)
boolean	mouseClicked(int button)	Called when mouse is clicked on component.
boolean	mouseEntered()	Called when mouse gets over given component.
boolean	mouseExited()	Called when mouse leaves screen area occupied by component.

Methods inherited from class eu.svjatoslav.sixth.e3d.renderer.raster.shapes.composite.base.AbstractCompositeShape

addShape, addShape, beforeTransformHook, getGroup, getLocation, getOriginalSubShapes, getViewSpaceTracker, hideGroup, removeGroup, setBackfaceCulling, setColor, setGroupForUngrouped, setLightingManager, setMouseInteractionController, setShadingEnabled, setTransform, showGroup, transform

Methods inherited from class java.lang.Object

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

Field Details

viewPanel

public final ViewPanel viewPanel

The view panel this component is attached to.

Constructor Details

GuiComponent

public GuiComponent(Transform transform,
 ViewPanel viewPanel,
 Point3D size)

Creates a GUI component with the specified transform, view panel, and bounding box size.

Parameters:

transform - the position and orientation of the component in 3D space

viewPanel - the view panel this component belongs to

size - the bounding box dimensions (width, height, depth)

Method Details

focusLost

public boolean focusLost(ViewPanel viewPanel)

Specified by:

focusLost in interface KeyboardInputHandler

Returns:

true if view needs to be re-rendered.

focusReceived

public boolean focusReceived(ViewPanel viewPanel)

Specified by:

focusReceived in interface KeyboardInputHandler

Returns:

true if view needs to be re-rendered.

getBorders

public WireframeBox getBorders()

getDepth

public int getDepth()

getHeight

public int getHeight()

getWidth

public int getWidth()

hideBorder

public void hideBorder()

keyPressed

public boolean keyPressed(KeyEvent event,
 ViewPanel viewPanel)

Specified by:

keyPressed in interface KeyboardInputHandler

Returns:

true if view needs to be re-rendered.

keyReleased

public boolean keyReleased(KeyEvent event,
 ViewPanel viewPanel)

Specified by:

keyReleased in interface KeyboardInputHandler

Returns:

true if view needs to be re-rendered.

mouseClicked

public boolean mouseClicked(int button)

Description copied from interface: MouseInteractionController

Called when mouse is clicked on component.

Specified by:

mouseClicked in interface MouseInteractionController

Returns:

true if view update is needed as a consequence of this mouse click.

mouseEntered

public boolean mouseEntered()

Description copied from interface: MouseInteractionController

Called when mouse gets over given component.

Specified by:

mouseEntered in interface MouseInteractionController

Returns:

true if view update is needed as a consequence of this mouse enter.

mouseExited

public boolean mouseExited()

Description copied from interface: MouseInteractionController

Called when mouse leaves screen area occupied by component.

Specified by:

mouseExited in interface MouseInteractionController

Returns:

true if view update is needed as a consequence of this mouse exit.