aboutsummaryrefslogtreecommitdiffstats
path: root/src/graphui/classes/com/jogamp/graph/ui/shapes/BaseButton.java
blob: 83835a9134025e5f7442dd43f8fc8675a94d7339 (plain)
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/**
 * Copyright 2010-2023 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.shapes;

import com.jogamp.graph.curve.OutlineShape;
import com.jogamp.graph.curve.Region;
import com.jogamp.graph.curve.opengl.GLRegion;
import com.jogamp.graph.ui.GraphShape;
import com.jogamp.graph.ui.Shape;
import com.jogamp.opengl.GL2ES2;
import com.jogamp.opengl.GLProfile;
import com.jogamp.opengl.util.texture.TextureSequence;

/**
 * An abstract GraphUI filled base button {@link GraphShape},
 * usually used as a backdrop or base shape for more informative button types.
 * <p>
 * GraphUI is GPU based and resolution independent.
 * </p>
 * <p>
 * This button is rendered with a round oval shape {@link #ROUND_CORNER by default},
 * but can be set to any roundness or {@link #PERP_CORNER rectangular shape} via {#link {@link #setCorner(float)} or {@link #setPerp()}.
 * </p>
 */
public class BaseButton extends GraphShape {

    /** {@link #setCorner(float) Round corner}, value {@value}. This is the default value. */
    public static final float ROUND_CORNER = 1f;
    /** {@link #setCorner(float) Perpendicular corner} for a rectangular shape, value {@value}. */
    public static final float PERP_CORNER = 0f;

    protected float width;
    protected float height;
    protected float corner = ROUND_CORNER;

    /**
     * Create a base button Graph based {@link GLRegion} UI {@link Shape} with a {@link #ROUND_CORNER}.
     * <p>
     * Call {#link {@link #setCorner(float)} or {@link #setPerp()} to modify the corner shape.
     * </p>
     * @param renderModes Graph's {@link Region} render modes, see {@link GLRegion#create(GLProfile, int, TextureSequence) create(..)}.
     * @param width
     * @param height
     */
    public BaseButton(final int renderModes, final float width, final float height) {
        super(renderModes);
        this.width = width;
        this.height = height;
    }

    public final float getWidth() { return width; }

    public final float getHeight() { return height; }

    public final float getCorner() { return corner; }

    /**
     * Set corner size with range [0.01 .. 1.00] for round corners
     * or `zero` for perpendicular corners.
     * <p>
     * Default is {@link #ROUND_CORNER round corner},
     * alternative a {@link #PERP_CORNER perpendicular corner} for a rectangular shape is available.
     * </p>
     * @param corner corner size with range [0.01 .. 1.00 ] for round corners or `zero` for perpendicular corners.
     * @return this instance for chaining
     * @see #ROUND_CORNER
     * @see #PERP_CORNER
     * @see #setPerp()
     */
    public BaseButton setCorner(final float corner) {
        if( corner > 1.0f ){
            this.corner = ROUND_CORNER;
        } else if( corner < 0.01f ){
            this.corner = PERP_CORNER;
        } else {
            this.corner = corner;
        }
        markShapeDirty();
        return this;
    }
    /**
     * Sets a {@link #PERP_CORNER perpendicular} {@link #setCorner(float) corner}.
     * @return this instance for chaining
     * @see #setCorner(float)
     */
    public BaseButton setPerp() {
        this.corner = PERP_CORNER;
        markShapeDirty();
        return this;
    }

    public BaseButton setSize(final float width, final float height) {
        this.width = width;
        this.height = height;
        markShapeDirty();
        return this;
    }

    @Override
    protected void addShapeToRegion(final GLProfile glp, final GL2ES2 gl) {
        final OutlineShape shape = createBaseShape(0f);
        resetGLRegion(glp, gl, null, shape);
        region.addOutlineShape(shape, null, rgbaColor);
        box.resize(shape.getBounds());
        setRotationPivot( box.getCenter() );
    }

    protected OutlineShape createBaseShape(final float zOffset) {
        final OutlineShape shape = new OutlineShape();
        if(corner == 0.0f) {
            createSharpOutline(shape, zOffset);
        } else {
            createCurvedOutline(shape, zOffset);
        }
        shape.setIsQuadraticNurbs();
        shape.setSharpness(oshapeSharpness);
        if( DEBUG_DRAW ) {
            System.err.println("GraphShape.RoundButton: Shape: "+shape+", "+box);
        }
        return shape;
    }

    protected void createSharpOutline(final OutlineShape shape, final float zOffset) {
        final float tw = getWidth();
        final float th = getHeight();

        final float minX = 0;
        final float minY = 0;
        final float minZ = zOffset;

        shape.addVertex(minX, minY, minZ,  true);
        shape.addVertex(minX+tw, minY,  minZ, true);
        shape.addVertex(minX+tw, minY + th, minZ,  true);
        shape.addVertex(minX, minY + th, minZ,  true);
        shape.closeLastOutline(true);
    }

    protected void createCurvedOutline(final OutlineShape shape, final float zOffset) {
        final float tw = getWidth();
        final float th = getHeight();
        final float dC = 0.5f*corner*Math.min(tw, th);

        final float minX = 0;
        final float minY = 0;
        final float minZ = zOffset;

        shape.addVertex(minX,           minY + dC,      minZ, true);
        shape.addVertex(minX,           minY,           minZ, false);

        shape.addVertex(minX + dC,      minY,           minZ, true);

        shape.addVertex(minX + tw - dC, minY,           minZ, true);
        shape.addVertex(minX + tw,      minY,           minZ, false);
        shape.addVertex(minX + tw,      minY + dC,      minZ, true);
        shape.addVertex(minX + tw,      minY + th- dC,  minZ, true);
        shape.addVertex(minX + tw,      minY + th,      minZ, false);
        shape.addVertex(minX + tw - dC, minY + th,      minZ, true);
        shape.addVertex(minX + dC,      minY + th,      minZ, true);
        shape.addVertex(minX,           minY + th,      minZ, false);
        shape.addVertex(minX,           minY + th - dC, minZ, true);

        shape.closeLastOutline(true);
    }

    @Override
    public String getSubString() {
        return super.getSubString()+", dim "+getWidth() + " x " + getHeight() + ", corner " + corner;
    }
}