JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
UISceneDemo01.java
Go to the documentation of this file.
1/**
2 * Copyright 2010-2023 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28package com.jogamp.opengl.demos.graph.ui;
29
30import java.io.IOException;
31
32import com.jogamp.common.os.Clock;
33import com.jogamp.graph.curve.Region;
34import com.jogamp.graph.font.Font;
35import com.jogamp.graph.font.FontFactory;
36import com.jogamp.graph.font.FontSet;
37import com.jogamp.graph.ui.Scene;
38import com.jogamp.graph.ui.Shape;
39import com.jogamp.graph.ui.shapes.GLButton;
40import com.jogamp.math.Recti;
41import com.jogamp.math.geom.AABBox;
42import com.jogamp.math.util.PMVMatrix4f;
43import com.jogamp.newt.event.MouseEvent;
44import com.jogamp.newt.event.WindowAdapter;
45import com.jogamp.newt.event.WindowEvent;
46import com.jogamp.newt.opengl.GLWindow;
47import com.jogamp.opengl.GL;
48import com.jogamp.opengl.GLCapabilities;
49import com.jogamp.opengl.demos.es2.GearsES2;
50import com.jogamp.opengl.demos.util.CommandlineOptions;
51import com.jogamp.opengl.util.Animator;
52
53/**
54 * Res independent Shape, Scene attached to GLWindow showing simple linear Shape movement.
55 * <p>
56 * This variation of {@link UISceneDemo00} uses a {@link GLButton} shape with animating and rotating gears
57 * and sets up an own {@link Scene.PMVMatrixSetup} with a plane dimension of 100.
58 * </p>
59 * <p>
60 * Pass '-keep' to main-function to keep running after animation,
61 * then user can test Shape drag-move and drag-resize w/ 1-pointer.
62 * </p>
63 */
64public class UISceneDemo01 {
65 static CommandlineOptions options = new CommandlineOptions(1280, 720, Region.VBAA_RENDERING_BIT);
66
67 public static void main(final String[] args) throws IOException {
68 options.parse(args);
69 System.err.println(options);
70 final GLCapabilities reqCaps = options.getGLCaps();
71 System.out.println("Requested: " + reqCaps);
72
73 //
74 // Resolution independent, no screen size
75 //
77 System.err.println("Font: "+font.getFullFamilyName());
78
79 final Shape shape = makeShape(font, options.renderModes);
80 System.err.println("Shape bounds "+shape.getBounds(reqCaps.getGLProfile()));
81 System.err.println("Shape "+shape);
82
83 final Scene scene = new Scene(options.graphAASamples);
84 scene.setClearParams(new float[] { 1f, 1f, 1f, 1f}, GL.GL_COLOR_BUFFER_BIT | GL.GL_DEPTH_BUFFER_BIT);
85 scene.setPMVMatrixSetup(new MyPMVMatrixSetup());
86 scene.addShape(shape);
87 scene.setAAQuality(options.graphAAQuality);
88
89 final Animator animator = new Animator(0 /* w/o AWT */);
90
91 final GLWindow window = GLWindow.create(reqCaps);
92 window.setSize(options.surface_width, options.surface_height);
93 window.setTitle(UISceneDemo01.class.getSimpleName()+": "+window.getSurfaceWidth()+" x "+window.getSurfaceHeight());
94 window.setVisible(true);
95 window.addGLEventListener(scene);
96 window.addWindowListener(new WindowAdapter() {
97 @Override
98 public void windowResized(final WindowEvent e) {
99 window.setTitle(UISceneDemo01.class.getSimpleName()+": "+window.getSurfaceWidth()+" x "+window.getSurfaceHeight());
100 }
101 @Override
102 public void windowDestroyNotify(final WindowEvent e) {
103 animator.stop();
104 }
105 });
106
107 scene.attachInputListenerTo(window);
108
109 animator.setUpdateFPSFrames(1*60, null); // System.err);
110 animator.add(window);
111 animator.start();
112
113 //
114 // After initial display we can use screen resolution post initial Scene.reshape(..)
115 // However, in this example we merely use the resolution to
116 // - Compute the animation values with DPI
117 scene.waitUntilDisplayed();
118
119 final AABBox sceneBox = scene.getBounds();
120 System.err.println("SceneBox "+sceneBox);
121 System.err.println("Shape "+shape);
122 try { Thread.sleep(1000); } catch (final InterruptedException e1) { }
123
124 //
125 // Compute the metric animation values -> shape obj-velocity
126 //
127 final float min_obj = sceneBox.getMinX();
128 final float max_obj = sceneBox.getMaxX() - shape.getScaledWidth();
129
130 final int[] shapeSizePx = shape.getSurfaceSize(scene, new PMVMatrix4f(), new int[2]); // [px]
131 final float[] pixPerShapeUnit = shape.getPixelPerShapeUnit(shapeSizePx, new float[2]); // [px]/[shapeUnit]
132
133 final float pixPerMM = window.getPixelsPerMM(new float[2])[0]; // [px]/[mm]
134 final float dist_px = scene.getWidth() - shapeSizePx[0]; // [px]
135 final float dist_m = dist_px/pixPerMM/1e3f; // [m]
136 final float velocity = 50/1e3f; // [m]/[s]
137 final float velocity_px = velocity * 1e3f * pixPerMM; // [px]/[s]
138 final float velocity_obj = velocity_px / pixPerShapeUnit[0]; // [shapeUnit]/[s]
139 final float exp_dur_s = dist_m / velocity; // [s]
140
141 System.err.println();
142 System.err.printf("Shape: %d x %d [pixel], %.4f px/shape_unit%n", shapeSizePx[0], shapeSizePx[1], pixPerShapeUnit[0]);
143 System.err.printf("Shape: %s%n", shape);
144 System.err.println();
145 System.err.printf("Distance: %.0f pixel @ %.3f px/mm, %.3f mm%n", dist_px, pixPerMM, dist_m*1e3f);
146 System.err.printf("Velocity: %.3f mm/s, %.3f px/s, %.6f obj/s, expected travel-duration %.3f s%n",
147 velocity*1e3f, velocity_px, velocity_obj, exp_dur_s);
148
149 final long t0_us = Clock.currentNanos() / 1000; // [us]
150 long t1_us = t0_us;
151 shape.moveTo(min_obj, 0f, 0f); // move shape to min start position
152 while( shape.getPosition().x() < max_obj && window.isNativeValid() ) {
153 final long t2_us = Clock.currentNanos() / 1000;
154 final float dt_s = ( t2_us - t1_us ) / 1e6f;
155 t1_us = t2_us;
156
157 final float dx = velocity_obj * dt_s; // [shapeUnit]
158 // System.err.println("move ")
159
160 // Move on GL thread to have vsync for free
161 // Otherwise we would need to employ a sleep(..) w/ manual vsync
162 window.invoke(true, (drawable) -> {
163 shape.move(dx, 0f, 0f);
164 return true;
165 });
166 }
167 final float has_dur_s = ( ( Clock.currentNanos() / 1000 ) - t0_us ) / 1e6f; // [us]
168 System.err.printf("Actual travel-duration %.3f s, delay %.3f s%n", has_dur_s, has_dur_s-exp_dur_s);
169 try { Thread.sleep(1000); } catch (final InterruptedException e1) { }
170 if( !options.stayOpen ) {
171 window.destroy();
172 }
173 }
174
175 static class MyPMVMatrixSetup extends Scene.DefaultPMVMatrixSetup {
176 @Override
177 public void set(final PMVMatrix4f pmv, final Recti viewport) {
178 super.set(pmv, viewport);
179
180 // Scale (back) to have normalized plane dimensions, 100 for the greater of width and height.
181 final AABBox planeBox0 = new AABBox();
182 setPlaneBox(planeBox0, pmv, viewport);
183 final float sx = planeBox0.getWidth();
184 final float sy = planeBox0.getHeight();
185 final float sxy = sx > sy ? sx : sy;
186 pmv.scaleP(sxy / 100f, sxy / 100f, 1f);
187 }
188 };
189
190 static Shape makeShape(final Font font, final int renderModes) {
191 final float sw = 25;
192 final float sh = sw / 2.5f;
193
194 final GearsES2 gears = new GearsES2(0);
195 gears.setVerbose(false);
196 gears.setClearColor(new float[] { 0.9f, 0.9f, 0.9f, 1f } );
197 final boolean[] animate = { true };
198 new Thread(new Runnable() {
199 @Override
200 public void run() {
201 System.err.println("Gears Anim: Waiting");
202 try {
203 gears.waitForInit(true);
204 } catch (final InterruptedException e) { }
205 System.err.println("Gears Anim: Started");
206 while( gears.isInit() ) {
207 if( animate[0] ) {
208 final float ry = ( gears.getRotY() + 1 ) % 360;
209 gears.setRotY(ry);
210 }
211 try {
212 Thread.sleep(15);
213 } catch (final InterruptedException e) { }
214 }
215 System.err.println("Gears Anim: End");
216 }
217 }).start();
218 final int texUnit = 1;
219 final GLButton b = new GLButton(renderModes, sw,
220 sh, texUnit, gears, false /* useAlpha */);
221 b.setToggleable(true);
222 b.setToggle(true); // toggle == true -> animation
223 b.setAnimate(true);
224 b.addMouseListener(new Shape.MouseGestureAdapter() {
225 @Override
226 public void mouseClicked(final MouseEvent e) {
227 b.setAnimate( b.isToggleOn() );
228 animate[0] = b.getAnimate();
229 } } );
230 return b;
231 }
232
233}
Abstract Outline shape representation define the method an OutlineShape(s) is bound and rendered.
Definition: Region.java:62
static final int VBAA_RENDERING_BIT
Rendering-Mode bit for Region.
Definition: Region.java:115
The optional property jogamp.graph.font.ctor allows user to specify the FontConstructor implementatio...
static final FontSet get(final int font)
static final int UBUNTU
Ubuntu is the default font family, {@value}.
GraphUI Scene.
Definition: Scene.java:102
void addShape(final Shape s)
Adds a Shape.
Definition: Scene.java:287
final void setClearParams(final float[] clearColor, final int clearMask)
Sets the clear parameter for glClearColor(..) and glClear(..) to be issued at display(GLAutoDrawable)...
Definition: Scene.java:221
int setAAQuality(final int v)
Sets RegionRenderer#setAAQuality(int).
Definition: Scene.java:383
void waitUntilDisplayed()
Blocks until first display(GLAutoDrawable) has completed after construction or dispose(GLAutoDrawable...
Definition: Scene.java:584
final void setPMVMatrixSetup(final PMVMatrixSetup setup)
Set a custom PMVMatrixSetup.
Definition: Scene.java:745
int getWidth()
Returns the getViewport()'s width, set after initial reshape(GLAutoDrawable, int, int,...
Definition: Scene.java:774
AABBox getBounds(final PMVMatrix4f pmv, final Shape shape)
Returns AABBox dimension of given Shape from this container's perspective, i.e.
Definition: Scene.java:676
synchronized void attachInputListenerTo(final GLWindow window)
Definition: Scene.java:246
Generic Shape, potentially using a Graph via GraphShape or other means of representing content.
Definition: Shape.java:87
final Shape move(final float dtx, final float dty, final float dtz)
Move about scaled distance.
Definition: Shape.java:557
final Shape moveTo(final float tx, final float ty, final float tz)
Move to scaled position.
Definition: Shape.java:543
final float getScaledWidth()
Returns the scaled width of the bounding AABBox for this shape.
Definition: Shape.java:745
final Vec3f getPosition()
Returns position Vec3f reference, i.e.
Definition: Shape.java:587
final float[] getPixelPerShapeUnit(final int[] shapeSizePx, final float[] pixPerShape)
Retrieve pixel per scaled shape-coordinate unit, i.e.
Definition: Shape.java:1165
final AABBox getBounds()
Returns the unscaled bounding AABBox for this shape, borrowing internal instance.
Definition: Shape.java:732
final int[] getSurfaceSize(final PMVMatrix4f pmv, final Recti viewport, final int[] surfaceSize)
Retrieve surface (view) size in pixels of this shape.
Definition: Shape.java:1100
Rectangle with x, y, width and height integer components.
Definition: Recti.java:34
Axis Aligned Bounding Box.
Definition: AABBox.java:54
final float getWidth()
Definition: AABBox.java:879
final float getHeight()
Definition: AABBox.java:883
PMVMatrix4f implements the basic computer graphics Matrix4f pack using projection (P),...
NEWT Window events are provided for notification purposes ONLY.
An implementation of GLAutoDrawable and Window interface, using a delegated Window instance,...
Definition: GLWindow.java:121
final int getSurfaceHeight()
Returns the height of this GLDrawable's surface client area in pixel units.
Definition: GLWindow.java:466
final void setTitle(final String title)
Definition: GLWindow.java:297
final float[] getPixelsPerMM(final float[] ppmmStore)
Returns the pixels per millimeter of this window's NativeSurface according to the main monitor's curr...
Definition: GLWindow.java:520
final int getSurfaceWidth()
Returns the width of this GLDrawable's surface client area in pixel units.
Definition: GLWindow.java:461
final void setSize(final int width, final int height)
Sets the size of the window's client area in window units, excluding decorations.
Definition: GLWindow.java:625
final void setVisible(final boolean visible)
Calls setVisible(true, visible), i.e.
Definition: GLWindow.java:615
final void addWindowListener(final WindowListener l)
Appends the given com.jogamp.newt.event.WindowListener to the end of the list.
Definition: GLWindow.java:882
final void destroy()
Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext.
Definition: GLWindow.java:605
static GLWindow create(final GLCapabilitiesImmutable caps)
Creates a new GLWindow attaching a new Window referencing a new default Screen and default Display wi...
Definition: GLWindow.java:169
Specifies a set of OpenGL capabilities.
final GLProfile getGLProfile()
Returns the GL profile you desire or used by the drawable.
Res independent Shape, Scene attached to GLWindow showing simple linear Shape movement.
static void main(final String[] args)
int graphAASamples
Sample count for Graph Region AA render-modes: Region#VBAA_RENDERING_BIT or Region#MSAA_RENDERING_BIT...
int graphAAQuality
Pass2 AA-quality rendering for Graph Region AA render-modes: VBAA_RENDERING_BIT.
final synchronized void add(final GLAutoDrawable drawable)
Adds a drawable to this animator's list of rendering drawables.
final void setUpdateFPSFrames(final int frames, final PrintStream out)
final synchronized boolean start()
Starts this animator, if not running.
Definition: Animator.java:344
final synchronized boolean stop()
Stops this animator.
Definition: Animator.java:368
static final int FAMILY_LIGHT
Font family LIGHT, {@value}.
Definition: FontSet.java:39
Font get(int family, int stylebits)
static final int STYLE_SERIF
SERIF style/family bit flag.
Definition: FontSet.java:54
Interface wrapper for font implementation.
Definition: Font.java:60
String getFullFamilyName()
Shall return the family and subfamily name, separated a dash.
boolean invoke(boolean wait, GLRunnable glRunnable)
Enqueues a one-shot GLRunnable, which will be executed within the next display() call after all regis...
void addGLEventListener(GLEventListener listener)
Adds the given listener to the end of this drawable queue.
static final int GL_DEPTH_BUFFER_BIT
GL_ES_VERSION_2_0, GL_VERSION_1_1, GL_VERSION_1_0, GL_VERSION_ES_1_0 Define "GL_DEPTH_BUFFER_BIT" wit...
Definition: GL.java:738