1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
/**
* Copyright 2023-2024 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.jogamp.graph.ui;
import com.jogamp.common.os.Clock;
import com.jogamp.math.util.PMVMatrix4f;
/** A HUD tooltip for {@link Shape}, see {@link Shape#setToolTip(Tooltip)}. */
public abstract class Tooltip {
/** Default tooltip delay is {@value}ms */
public static final long DEFAULT_DELAY = 1000;
private final long delayMS;
/** Delay t1, time to show tooltip, i.e. t0 + delayMS */
private volatile long delayT1;
/** Shape 'tool' owning this tooltip. */
private Shape tool;
protected Tooltip(final long delayMS) {
this.delayMS = delayMS;
this.delayT1 = 0;
this.tool = null;
}
/* pp */ final void setToolOwner(final Shape owner) { tool = owner; }
/** Returns {@link Shape} 'tool' owning this tooltip, set after {@link Shape#setToolTip(Tooltip)}. */
public final Shape getTool() {
return tool;
}
/** Stops the timer. */
public final void stop() {
this.delayT1 = 0;
}
/** Starts the timer. */
public final void start() {
this.delayT1 = Clock.currentMillis() + delayMS;
}
/**
* Send tick to this tooltip
* @return true if timer has been reached to {@link #createTip(PMVMatrix4f)}, otherwise false
*/
public final boolean tick() {
if( 0 == delayT1 ) {
return false;
}
if( Clock.currentMillis() < delayT1 ) {
return false;
}
this.delayT1 = 0;
return true;
}
/**
* Create a new HUD tip shape, usually called by {@link Scene}
* @param scene the {@link Scene} caller for which this HUD tip shape is created
* @param pmv {@link PMVMatrix4f}, which shall be properly initialized, e.g. via {@link Scene#setupMatrix(PMVMatrix4f)}
* @return newly created HUD tip shape
*/
public abstract Shape createTip(final Scene scene, final PMVMatrix4f pmv);
}
|
