Package com.jogamp.graph.ui

Public Graph UI Package

Disclaimer

The API of the namespace com.jogamp.graph.ui.** is experimental and subject to change until further notice.

Part of It's implementation jogamp.graph.ui.** may change at any time as it is natural with all other API implementations.

We are currently refining and completing this new API and it's implementation. Feel free to comment and help using our public channels.

Revision History

• Early Draft Review, March 10th 2023

Interface Summary

Interface	Description
AnimGroup.LerpFunc	Linear interpolation (LERP) function to evaluate the next animated frame for each AnimGroup.ShapeData of a AnimGroup.Set.
AnimGroup.ShapeSetup	AnimGroup.ShapeData setup function for animation using its enclosing AnimGroup.Set and other data points
Container	Container interface of UI Shapes
Group.Layout	Layout for the GraphUI Group, called @ Shape.validate(GL2ES2) or Shape.validate(GLProfile).
Scene.PMVMatrixSetup	Interface providing a method to setup PMVMatrix4f's GLMatrixFunc.GL_PROJECTION and GLMatrixFunc.GL_MODELVIEW.
Shape.DrawListener	Shape draw listener action returning a boolean value
Shape.Listener	General Shape listener action
Shape.MouseGestureListener	Combining MouseListener and GestureHandler.GestureListener
Shape.MoveListener	Shape move listener
Shape.PointerListener	Shape pointer listener, e.g.
Shape.Visitor1	General Shape visitor
Shape.Visitor2	General Shape visitor
TooltipShape.DestroyCallback	Optional HUD tip destroy callback for the user provided Shape, see Tooltip.destroyTip(GL2ES2, RegionRenderer, Shape).

Class Summary

Class	Description
AnimGroup	Group of animated Shapes including other static Shapes, optionally utilizing a Group.Layout.
AnimGroup.ScrollLerp	Scrolling AnimGroup.LerpFunc, approaching AnimGroup.ShapeData's target position over and over.
AnimGroup.Set	Animation-Set covering its AnimGroup.ShapeData elements, AnimGroup.LerpFunc and animation parameter.
AnimGroup.ShapeData	Animation Shapes data covering one Shape of AnimGroup.Set.
AnimGroup.SineLerp	Sine target AnimGroup.LerpFunc, approaching AnimGroup.ShapeData's target position utilizing the angular value for sine amplitude towards the given normalized direction vector.
AnimGroup.TargetLerp	Default target AnimGroup.LerpFunc, approaching AnimGroup.ShapeData's target position inclusive angular rotation around given normalized axis.
GraphShape	Graph based GLRegion Shape
Group	Group of Shapes, optionally utilizing a Group.Layout.
Scene	GraphUI Scene
Scene.DefaultPMVMatrixSetup	Default implementation of Scene.PMVMatrixSetup, implementing Scene.PMVMatrixSetup.set(PMVMatrix4f, Recti) as follows: GLMatrixFunc.GL_PROJECTION Matrix Identity Perspective Scene.DefaultPMVMatrixSetup.getAngle() with Scene.DefaultPMVMatrixSetup.getZNear() and Scene.DefaultPMVMatrixSetup.getZFar() Translated to given Scene.DefaultPMVMatrixSetup.getSceneDist() GLMatrixFunc.GL_MODELVIEW Matrix identity
Shape	Generic Shape, potentially using a Graph via GraphShape or other means of representing content.
Shape.EventInfo	Shape event info for propagated NEWTEvents containing reference of the intended shape as well as the rotated relative position to this shape.
Shape.ForwardKeyListener	Forward KeyListener, to be attached to a key event source forwarded to the receiver set at constructor.
Shape.ForwardMouseListener	Forward Shape.MouseGestureListener, to be attached to a mouse event source forwarded to the receiver set at constructor.
Shape.MouseGestureAdapter	Convenient adapter combining dummy implementation for MouseListener and GestureHandler.GestureListener
Tooltip	A HUD tooltip for Shape, see Shape.setToolTip(Tooltip).
TooltipShape	A HUD Shape Tooltip for client Shape, see Shape.setToolTip(Tooltip).
TooltipText	A round HUD text Tooltip for Shape, see Shape.setToolTip(Tooltip).