JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.graph.ui.widgets.RangeSlider Class Reference

RangeSlider Widget either utilizing a simple positional round knob or a rectangular page-sized knob. More...

Inheritance diagram for com.jogamp.graph.ui.widgets.RangeSlider:
Collaboration diagram for com.jogamp.graph.ui.widgets.RangeSlider:

Classes

interface  ChangeListener
 RangeSlider slider value changed listener More...
 
interface  PeekListener
 RangeSlider slider value peek listener More...
 

Public Member Functions

 RangeSlider (final int renderModes, final Vec2f size, final float knobScale, final Vec2f minMax, final float unitSize, final float value)
 Constructs a RangeSlider, i.e. More...
 
 RangeSlider (final int renderModes, final Vec2f size, final Vec2f minMax, final float unitSize, final float pageSize, final float value)
 Constructs a RangeSlider, i.e. More...
 
void receiveKeyEvents (final Shape source)
 Forward KeyListener events to this Shape from source using a ForwardKeyListener. More...
 
void receiveMouseEvents (final Shape source)
 Forward MouseGestureListener events to this Shape from source using a ForwardMouseListener. More...
 
final RangeSlider addChangeListener (final ChangeListener l)
 
final RangeSlider removeChangeListener (final ChangeListener l)
 
final RangeSlider addPeekListener (final PeekListener l)
 
final RangeSlider removePeekListener (final PeekListener l)
 
Rectangle getBar ()
 
GraphShape getKnob ()
 
Group getMarks ()
 
RangeSlider clearMarks (final GL2ES2 gl, final RegionRenderer renderer)
 
Shape addMark (final float value, final Vec4f color)
 
final Vec2f getSize ()
 Returns spatial dimension of this slider. More...
 
final float getKnobThickness ()
 Returns spatial knob thickness orthogonal to sliding direction. More...
 
final float getKnobLength ()
 Returns spatial knob length in sliding direction. More...
 
Vec2f getMinMax ()
 Returns slider value range, see setMinMax(Vec2f, float). More...
 
float getRange ()
 Returns getMinMax() range. More...
 
float getValue ()
 Returns current slider value. More...
 
float getValuePct ()
 Returns current slider value in percentage of getRange(),. More...
 
RangeSlider setPageSize (final float pageSz)
 Sets the page-size if a rectangular knob is being used, i.e. More...
 
float getPageSize ()
 Returns the page-size if a rectangular knob is being used, i.e. More...
 
float getPageSizePct (final float minPct)
 Returns the page-size percentage if a rectangular knob is being used, i.e. More...
 
RangeSlider setUnitSize (final float v)
 Sets the size of one unit (element) in sliding direction. More...
 
float getUnitSize ()
 Returns the size of one unit (element) in sliding direction. More...
 
RangeSlider setInverted (final boolean v)
 Sets whether this slider uses an inverted value range, e.g. More...
 
boolean isInverted ()
 See setInverted(boolean). More...
 
RangeSlider setMinMax (final Vec2f minMax, final float value)
 Sets slider value range and current value, also updates related pageSize parameter if used. More...
 
RangeSlider setMinMax (final Vec2f minMax)
 Sets slider value range, also updates related pageSize parameter if used. More...
 
RangeSlider setMinMaxPgSz (final Vec2f minMax, final float value, final float pageSz)
 Calls setMinMax(Vec2f, float) and setPageSize(float). More...
 
RangeSlider setMinMaxPgSz (final Vec2f minMax, final float pageSz)
 Calls setMinMax(Vec2f, float) and setPageSize(float). More...
 
RangeSlider setValue (final float v)
 Sets slider value. More...
 
final Shape setColor (final float r, final float g, final float b, final float a)
 Sets the slider knob color. More...
 
Shape setColor (final Vec4f c)
 Sets the slider knob color. More...
 
Shape setActiveKnobColorMod (final Vec4f c)
 Sets the knob active modulation color. More...
 
Shape setBackgroundBarColor (final float r, final float g, final float b, final float a)
 Sets the slider background bar color, if this slider comprises only a positional round knob. More...
 
Shape setBackgroundBarColor (final Vec4f c)
 Sets the slider background bar color, if this slider comprises only a positional round knob. More...
 
final Shape setPressedColorMod (final float r, final float g, final float b, final float a)
 Set pressed color, modulating getColor() if isPressed().Default pressed color, modulation -factor w/o color channel, modulated base-color. ~0.65 (due to alpha) Default RGBA value is 0.70f, 0.70f, 0.70f, 0.8f More...
 
String getDescription ()
 Return string description of current slider setting. More...
 
String getSubString ()
 
- Public Member Functions inherited from com.jogamp.graph.ui.widgets.Widget
 Widget ()
 Create a Widget group of Shapes w/o Group.Layout. More...
 
 Widget (final Layout l)
 Create a Widget group of Shapes w/ given Group.Layout. More...
 
- Public Member Functions inherited from com.jogamp.graph.ui.Group
 Group ()
 Create a group of Shapes w/o Group.Layout. More...
 
 Group (final Layout l)
 Create a group of Shapes w/ given Group.Layout. More...
 
 Group (final String name, final Layout l, final Vec2f fixedSize, final Shape s)
 Create a group of Shapes w/ given Group.Layout and Shape. More...
 
final boolean isGroup ()
 Returns true if this shape denotes a Group, otherwise false. More...
 
Layout getLayout ()
 Return current Group.Layout. More...
 
Group setLayout (final Layout l)
 Set Group.Layout. More...
 
Group setFixedSize (final Vec3f v)
 Enforce size of this group for all given 3 dimensions getBounds() without adjusting 3D z-axis like setFixedSize(Vec2f). More...
 
Group setFixedSize (final Vec2f v)
 Enforce size of this group to given 2 dimensions, adjusting the 3D z-axis getBounds() giving room for potential clipping via setClipOnBounds(boolean) or setClipMvFrustum(Frustum). More...
 
Vec3f getFixedSize ()
 Returns borrowed fixed size instance, see setFixedSize(Vec3f) and setFixedSize(Vec2f). More...
 
Vec2f getFixedSize (final Vec2f out)
 Returns given Vec2f instance set with 2 dimensions, see setFixedSize(Vec2f). More...
 
Group setClipOnBounds (final boolean v)
 Enable Modelview (Mv) Frustum clipping on getBounds() for this group and its shapes as follows. More...
 
boolean getClipOnBounds ()
 Returns setClipOnBounds(boolean) value. More...
 
Group setClipMvFrustum (final Frustum v)
 Enable Modelview (Mv) Frustum clipping on explicit given pre-multiplied w/ Mv-matrix clip-box for this group and its shapes as follows. More...
 
Frustum getClipMvFrustum ()
 Returns setClipMvFrustum(Frustum) value. More...
 
int getShapeCount ()
 Returns number of Shapes, see getShapes(). More...
 
List< ShapegetShapes ()
 Returns added Shapes. More...
 
List< ShapegetRenderedShapes ()
 Returns added shapes which are rendered and sorted by z-axis in ascending order toward z-near. More...
 
void addShape (final Shape s)
 Adds a Shape. More...
 
boolean replaceShape (final Shape remove, final Shape replacement)
 Atomic replacement of the given Shape remove with Shape replacement. More...
 
Shape removeShape (final Shape s)
 Removes given shape, w/o Shape#destroy(GL2ES2, RegionRenderer). More...
 
void removeShapes (final Collection<? extends Shape > shapes)
 Removes all given shapes, w/o Shape#destroy(GL2ES2, RegionRenderer). More...
 
boolean removeShape (final GL2ES2 gl, final RegionRenderer renderer, final Shape s)
 Removes given shape with Shape#destroy(GL2ES2, RegionRenderer), if contained. More...
 
void addShapes (final Collection<? extends Shape > shapes)
 
void removeShapes (final GL2ES2 gl, final RegionRenderer renderer, final Collection<? extends Shape > shapes)
 Removes all given shapes with Shape#destroy(GL2ES2, RegionRenderer). More...
 
void removeAllShapes (final GL2ES2 gl, final RegionRenderer renderer)
 Removes all contained shapes with Shape#destroy(GL2ES2, RegionRenderer). More...
 
boolean hasColorChannel ()
 Returns true if implementation uses an extra color channel or texture which will be modulated with the passed rgba color drawImpl0(GL2ES2, RegionRenderer, float[]). More...
 
final void setPMvCullingEnabled (final boolean v)
 Enable or disable Project-Modelview (PMv) frustum culling per Shape for this container. More...
 
final boolean isPMvCullingEnabled ()
 Return whether Project-Modelview (PMv) frustum culling is enabled for this container. More...
 
final boolean isCullingEnabled ()
 Return whether Project-Modelview (PMv) frustum culling or Group's Modelview (Mv) frustum clipping is enabled for this container. More...
 
final boolean isOutside (final PMVMatrix4f pmv, final Shape shape)
 Returns whether the given Shape is completely outside of this container. More...
 
boolean isOutside2 (final Matrix4f mvCont, final Shape shape, final PMVMatrix4f pmvShape)
 Returns whether the given Shape is completely outside of this container. More...
 
void setRelayoutOnDirtyShapes (final boolean v)
 Set relayout on dirty shapes mode, defaults to true. More...
 
boolean getRelayoutOnDirtyShapes ()
 
final Group enableTopLevelWidget (final Scene scene)
 Enables top-level widget behavior for this group, default is disabled. More...
 
final Group disableTopLevelWidget ()
 Disables top-level widget behavior as potentially set via enableTopLevelWidget(Scene). More...
 
final boolean isTopLevelWidget ()
 Returns whether setTopLevelWidget(boolean) is enabled or disabled. More...
 
boolean contains (final Shape s)
 
Shape getShapeByIdx (final int id)
 
Shape getShapeByID (final int id)
 
Shape getShapeByName (final String name)
 
AABBox getBounds (final PMVMatrix4f pmv, final Shape shape)
 Returns AABBox dimension of given Shape from this container's perspective, i.e. More...
 
String getSubString ()
 
- Public Member Functions inherited from com.jogamp.graph.ui.Shape
Group getParent ()
 Returns the last parent container Group this shape has been added to or null. More...
 
final Shape setID (final int id)
 Set a symbolic ID for this shape for identification. More...
 
final int getID ()
 Return the optional symbolic ID for this shape. More...
 
Shape setName (final String name)
 Set a symbolic name for this shape for identification. More...
 
final String getName ()
 Return the optional symbolic name for this shape, defaults to noname. More...
 
boolean isGroup ()
 Returns true if this shape denotes a Group, otherwise false. More...
 
final boolean isVisible ()
 Returns true if this shape is set visible by the user, otherwise false. More...
 
final Shape setVisible (final boolean v)
 Enable (default) or disable this shape's visibility. More...
 
final Shape setPaddding (final Padding padding)
 Sets the unscaled padding for this shape, which is included in unscaled getBounds() and also includes the border. More...
 
Padding getPadding ()
 Returns unscaled Padding of this shape, which is included in unscaled getBounds() and also includes the border. More...
 
boolean hasPadding ()
 Returns true if setPaddding(Padding) added a non Padding#zeroSize() spacing to this shape. More...
 
final Shape setBorder (final float thickness)
 Sets the thickness of the border, which is included in getBounds() and is outside of getPadding(). More...
 
final boolean hasBorder ()
 Returns true if a border has been enabled via setBorder(float, Padding). More...
 
final float getBorderThickness ()
 Returns the border thickness, see setBorder(float, Padding). More...
 
final void runSynced (final Runnable action)
 Perform given Runnable action synchronized. More...
 
final void clear (final GL2ES2 gl, final RegionRenderer renderer)
 Clears all data and reset all states as if this instance was newly created. More...
 
final void destroy (final GL2ES2 gl, final RegionRenderer renderer)
 Destroys all data. More...
 
final void onDraw (final DrawListener l)
 Set a user one-shot initializer callback or custom draw(GL2ES2, RegionRenderer) hook. More...
 
final void onHover (final PointerListener l)
 Set user callback to be notified when a pointer/mouse is moving over this shape. More...
 
final void onMove (final MoveListener l)
 Set user callback to be notified when shape is move(Vec3f)'ed. More...
 
final void onToggle (final Listener l)
 Set user callback to be notified when shape toggle()'ed. More...
 
final void onClicked (final PointerListener l)
 Set user callback to be notified when shape is clicked. More...
 
final Shape addActivationListener (final Listener l)
 Add user callback to be notified when shape is activated (pointer-over and/or click) or de-activated (pointer left). More...
 
final Shape removeActivationListener (final Listener l)
 
final Shape moveTo (final float tx, final float ty, final float tz)
 Move to scaled position. More...
 
final Shape moveTo (final Vec3f t)
 Move to scaled position. More...
 
final Shape move (final float dtx, final float dty, final float dtz)
 Move about scaled distance. More...
 
final Shape move (final Vec3f dt)
 Move about scaled distance. More...
 
final Vec3f getPosition ()
 Returns position Vec3f reference, i.e. More...
 
final Quaternion getRotation ()
 Returns Quaternion for rotation. More...
 
final Shape setRotation (final Quaternion q)
 Sets the rotation Quaternion. More...
 
final Vec3f getRotationPivot ()
 Return unscaled rotation origin Vec3f reference, aka pivot. More...
 
final Shape setRotationPivot (final float px, final float py, final float pz)
 Set unscaled rotation origin, aka pivot. More...
 
final Shape setRotationPivot (final Vec3f pivot)
 Set unscaled rotation origin, aka pivot. More...
 
final Shape setScale (final Vec3f s)
 Set scale factor to given scale. More...
 
final Shape setScale (final float sx, final float sy, final float sz)
 Set scale factor to given scale. More...
 
final Shape scale (final Vec3f s)
 Multiply current scale factor by given scale. More...
 
final Shape scale (final float sx, final float sy, final float sz)
 Multiply current scale factor by given scale. More...
 
final Vec3f getScale ()
 Returns scale Vec3f reference. More...
 
final void markShapeDirty ()
 Marks the shape dirty, causing next draw() to recreate the Graph shape and reset the region. More...
 
final void markStateDirty ()
 Marks the rendering state dirty, causing next draw() to notify the Graph region to reselect shader and repaint potentially used FBOs. More...
 
final AABBox getBounds ()
 Returns the unscaled bounding AABBox for this shape, borrowing internal instance. More...
 
final float getScaledWidth ()
 Returns the scaled width of the bounding AABBox for this shape. More...
 
final float getScaledHeight ()
 Returns the scaled height of the bounding AABBox for this shape. More...
 
final float getScaledDepth ()
 
final AABBox getBounds (final GLProfile glp)
 Returns the unscaled bounding AABBox for this shape. More...
 
void drawToSelect (final GL2ES2 gl, final RegionRenderer renderer)
 Experimental selection draw command used by Scene. More...
 
void draw (final GL2ES2 gl, final RegionRenderer renderer)
 Renders the shape. More...
 
final Shape validate (final GL2ES2 gl)
 Validates the shape's underlying GLRegion. More...
 
final Shape validate (final GLProfile glp)
 Validates the shape's underlying GLRegion w/o a current GL2ES2 object. More...
 
final Shape validate (final GL2ES2 gl, final GLProfile glp)
 Validate the shape via validate(GL2ES2) if gl is not null, otherwise uses validate(GLProfile). More...
 
final void applyMatToMv (final PMVMatrix4f pmv)
 Applies the internal Matrix4f to the given modelview matrix, i.e. More...
 
final Matrix4f getMat ()
 Returns the internal Matrix4f reference. More...
 
final Matrix4f getMat (final Matrix4f out)
 Returns a copy of the internal Matrix4f to out. More...
 
final boolean isMatIdentity ()
 Returns true if getMat() has not been mutated, i.e. More...
 
final void updateMat ()
 Updates the internal Matrix4f with local position, rotation and scale. More...
 
final PMVMatrix4f setPMVMatrix (final Scene.PMVMatrixSetup pmvMatrixSetup, final Recti viewport, final PMVMatrix4f pmv)
 Setup the given PMVMatrix4f and apply this shape's transformation. More...
 
final PMVMatrix4f setPMVMatrix (final Scene scene, final PMVMatrix4f pmv)
 Setup the given PMVMatrix4f and apply this shape's transformation. More...
 
final Recti getSurfacePort (final PMVMatrix4f pmv, final Recti viewport, final Recti surfacePort)
 Retrieve surface (view) port of this shape, i.e. More...
 
final int[] getSurfaceSize (final PMVMatrix4f pmv, final Recti viewport, final int[] surfaceSize)
 Retrieve surface (view) size in pixels of this shape. More...
 
final int[] getSurfaceSize (final Scene.PMVMatrixSetup pmvMatrixSetup, final Recti viewport, final PMVMatrix4f pmv, final int[] surfaceSize)
 Retrieve surface (view) size in pixels of this shape. More...
 
final int[] getSurfaceSize (final Scene scene, final PMVMatrix4f pmv, final int[] surfaceSize)
 Retrieve surface (view) size in pixels of this shape. More...
 
final float[] getPixelPerShapeUnit (final int[] shapeSizePx, final float[] pixPerShape)
 Retrieve pixel per scaled shape-coordinate unit, i.e. More...
 
final float[] getPixelPerShapeUnit (final PMVMatrix4f pmv, final Recti viewport, final float[] pixPerShape)
 Retrieve pixel per scaled shape-coordinate unit, i.e. More...
 
final float[] getPixelPerShapeUnit (final Scene scene, final PMVMatrix4f pmv, final float[] pixPerShape)
 Retrieve pixel per scaled shape-coordinate unit, i.e. More...
 
final int[] shapeToWinCoord (final PMVMatrix4f pmv, final Recti viewport, final Vec3f objPos, final int[] glWinPos)
 Map given object coordinate relative to this shape to window coordinates. More...
 
final int[] shapeToWinCoord (final Scene.PMVMatrixSetup pmvMatrixSetup, final Recti viewport, final Vec3f objPos, final PMVMatrix4f pmv, final int[] glWinPos)
 Map given object coordinate relative to this shape to window coordinates. More...
 
final int[] shapeToWinCoord (final Scene scene, final Vec3f objPos, final PMVMatrix4f pmv, final int[] glWinPos)
 Map given object coordinate relative to this shape to window coordinates. More...
 
final Vec3f winToShapeCoord (final PMVMatrix4f pmv, final Recti viewport, final int glWinX, final int glWinY, final Vec3f objPos)
 Map given gl-window-coordinates to object coordinates relative to this shape and its z-coordinate. More...
 
final Vec3f winToShapeCoord (final Scene.PMVMatrixSetup pmvMatrixSetup, final Recti viewport, final int glWinX, final int glWinY, final PMVMatrix4f pmv, final Vec3f objPos)
 Map given gl-window-coordinates to object coordinates relative to this shape and its z-coordinate. More...
 
final Vec3f winToShapeCoord (final Scene scene, final int glWinX, final int glWinY, final PMVMatrix4f pmv, final Vec3f objPos)
 Map given gl-window-coordinates to object coordinates relative to this shape and its z-coordinate. More...
 
final Vec4f getColor ()
 Returns base-color w/o color channel, will be modulated w/ getPressedColorMod(), getToggleOnColorMod(), getToggleOffColorMod() and getActiveColorMod(). More...
 
final Vec4f getPressedColorMod ()
 Returns modulation color when isPressed(). More...
 
final Vec4f getToggleOnColorMod ()
 Returns modulation color when isToggleOn(). More...
 
final Vec4f getToggleOffColorMod ()
 Returns modulation color when not isToggleOn(). More...
 
final Vec4f getActiveColorMod ()
 Returns modulation color when isActive(). More...
 
Shape setColor (final float r, final float g, final float b, final float a)
 Set base color. More...
 
Shape setColor (final Vec4f c)
 Set base color. More...
 
Shape setPressedColorMod (final float r, final float g, final float b, final float a)
 Set pressed color, modulating getColor() if isPressed(). More...
 
final Shape setToggleOnColorMod (final float r, final float g, final float b, final float a)
 Set toggle-on color, modulating getColor() if isToggleOn() and setToggleable(boolean). More...
 
final Shape setToggleOffColorMod (final float r, final float g, final float b, final float a)
 Set toggle-off color, modulating getColor() if !isToggleOn() and setToggleable(boolean). More...
 
final Shape setActiveColorMod (final Vec4f c)
 Enable active color, modulation getColor() if isActive() with passing c != null, disable with passing c == null. More...
 
final Vec4f getBorderColor ()
 
final Shape setBorderColor (final float r, final float g, final float b, final float a)
 Set border color. More...
 
final Shape setBorderColor (final Vec4f c)
 Set border color. More...
 
final String toString ()
 
String getSubString ()
 
final Shape setPressed (final boolean b)
 
final boolean isPressed ()
 
final Shape setToggleable (final boolean toggleable)
 Set this shape toggleable, default is off. More...
 
boolean isToggleable ()
 Returns true if this shape is toggable, i.e. More...
 
final Shape setToggle (final boolean v)
 Set this shape's toggle state, default is off. More...
 
final Shape toggle ()
 
final boolean isToggleOn ()
 Returns true this shape's toggle state. More...
 
final boolean isActive ()
 Returns true of this shape is active. More...
 
final float getAdjustedZ ()
 
Tooltip setToolTip (final Tooltip newTooltip)
 Set's a new Tooltip for this shape. More...
 
void removeToolTip ()
 
Tooltip getTooltip ()
 
final Shape setInteractive (final boolean v)
 Set whether this shape is interactive in general, i.e. More...
 
final boolean isInteractive ()
 Returns if this shape allows user interaction in general, see setInteractive(boolean). More...
 
final Shape setActivable (final boolean v)
 Set whether this shape is allowed to be activated, i.e become isActive(). More...
 
final boolean isActivable ()
 Returns if this shape is allowed to be activated, i.e become isActive(). More...
 
final Shape setDiscarded (final boolean v)
 Set whether this shape is discarded in last draw(GL2ES2, RegionRenderer), i.e. More...
 
final boolean isDiscarded ()
 Returns whether this shape is discarded in last draw(GL2ES2, RegionRenderer), i.e. More...
 
final Shape setDraggable (final boolean draggable)
 Set whether this shape is draggable, i.e. More...
 
final boolean isDraggable ()
 Returns if this shape is draggable, a user interaction. More...
 
final Shape setResizable (final boolean resizable)
 Set whether this shape is resizable, i.e. More...
 
final boolean isResizable ()
 Returns if this shape is resizable, a user interaction. More...
 
final boolean isFixedARatioResize ()
 Returns if aspect-ratio shall be kept at resize, if isResizable(). More...
 
final Shape setFixedARatioResize (final boolean v)
 Sets whether aspect-ratio shall be kept at resize, if isResizable(). More...
 
final Shape setDragAndResizable (final boolean v)
 Set whether this shape is draggable and resizable. More...
 
final Shape addMouseListener (final MouseGestureListener l)
 
final Shape removeMouseListener (final MouseGestureListener l)
 
void receiveMouseEvents (final Shape source)
 Forward MouseGestureListener events to this Shape from source using a ForwardMouseListener. More...
 
final Shape addKeyListener (final KeyListener l)
 
final Shape removeKeyListener (final KeyListener l)
 
void receiveKeyEvents (final Shape source)
 Forward KeyListener events to this Shape from source using a ForwardKeyListener. More...
 
abstract boolean hasColorChannel ()
 Returns true if implementation uses an extra color channel or texture which will be modulated with the passed rgba color drawImpl0(GL2ES2, RegionRenderer, float[]). More...
 
int getShapeCount ()
 Returns number of Shapes, see getShapes(). More...
 
List< ShapegetShapes ()
 Returns added Shapes. More...
 
List< ShapegetRenderedShapes ()
 Returns added shapes which are rendered and sorted by z-axis in ascending order toward z-near. More...
 
void addShape (Shape s)
 Adds a Shape. More...
 
Shape removeShape (final Shape s)
 Removes given shape, w/o Shape#destroy(GL2ES2, RegionRenderer). More...
 
void removeShapes (Collection<? extends Shape > shapes)
 Removes all given shapes, w/o Shape#destroy(GL2ES2, RegionRenderer). More...
 
boolean removeShape (final GL2ES2 gl, final RegionRenderer renderer, final Shape s)
 Removes given shape with Shape#destroy(GL2ES2, RegionRenderer), if contained. More...
 
void addShapes (Collection<? extends Shape > shapes)
 
void removeShapes (final GL2ES2 gl, final RegionRenderer renderer, final Collection<? extends Shape > shapes)
 Removes all given shapes with Shape#destroy(GL2ES2, RegionRenderer). More...
 
void removeAllShapes (final GL2ES2 gl, final RegionRenderer renderer)
 Removes all contained shapes with Shape#destroy(GL2ES2, RegionRenderer). More...
 
boolean contains (Shape s)
 
Shape getShapeByIdx (final int id)
 
Shape getShapeByID (final int id)
 
Shape getShapeByName (final String name)
 
AABBox getBounds (final PMVMatrix4f pmv, Shape shape)
 Returns AABBox dimension of given Shape from this container's perspective, i.e. More...
 
void setPMvCullingEnabled (final boolean v)
 Enable or disable Project-Modelview (PMv) frustum culling per Shape for this container. More...
 
boolean isPMvCullingEnabled ()
 Return whether Project-Modelview (PMv) frustum culling is enabled for this container. More...
 
boolean isCullingEnabled ()
 Return whether Project-Modelview (PMv) frustum culling or Group's Modelview (Mv) frustum clipping is enabled for this container. More...
 
boolean isOutside (final PMVMatrix4f pmv, final Shape shape)
 Returns whether the given Shape is completely outside of this container. More...
 
boolean isOutside2 (final Matrix4f mvCont, final Shape shape, final PMVMatrix4f pmvShape)
 Returns whether the given Shape is completely outside of this container. More...
 

Protected Member Functions

void clearImpl0 (final GL2ES2 gl, final RegionRenderer renderer)
 Custom clear(GL2ES2, RegionRenderer) task, called 1st. More...
 
void destroyImpl0 (final GL2ES2 gl, final RegionRenderer renderer)
 Custom destroy(GL2ES2, RegionRenderer) task, called 1st. More...
 
void validateImpl (final GL2ES2 gl, final GLProfile glp)
 
- Protected Member Functions inherited from com.jogamp.graph.ui.Group
void clearImpl0 (final GL2ES2 gl, final RegionRenderer renderer)
 Custom clear(GL2ES2, RegionRenderer) task, called 1st. More...
 
void destroyImpl0 (final GL2ES2 gl, final RegionRenderer renderer)
 Custom destroy(GL2ES2, RegionRenderer) task, called 1st. More...
 
void drawImpl0 (final GL2ES2 gl, final RegionRenderer renderer, final Vec4f rgba)
 Actual draw implementation, called by draw(GL2ES2, RegionRenderer). More...
 
final void drawToSelectImpl0 (final GL2ES2 gl, final RegionRenderer renderer)
 Actual draw implementation, called by drawToSelect(GL2ES2, RegionRenderer). More...
 
boolean isShapeDirty ()
 Returns the shape's dirty state, see markShapeDirty(). More...
 
void validateImpl (final GL2ES2 gl, final GLProfile glp)
 
- Protected Member Functions inherited from com.jogamp.graph.ui.Shape
 Shape ()
 Create a generic UI Shape. More...
 
void setParent (final Group c)
 
final void dispatchActivationEvent (final Shape s)
 Dispatch activation event event to this shape. More...
 
boolean isShapeDirty ()
 Returns the shape's dirty state, see markShapeDirty(). More...
 
final boolean isStateDirty ()
 Returns the rendering dirty state, see markStateDirty(). More...
 
final String getDirtyString ()
 
void toggleNotify (final boolean on)
 
final boolean setActive (final boolean v, final float zOffset)
 
abstract void validateImpl (final GL2ES2 gl, final GLProfile glp)
 
abstract void drawImpl0 (final GL2ES2 gl, final RegionRenderer renderer, final Vec4f rgba)
 Actual draw implementation, called by draw(GL2ES2, RegionRenderer). More...
 
abstract void drawToSelectImpl0 (final GL2ES2 gl, final RegionRenderer renderer)
 Actual draw implementation, called by drawToSelect(GL2ES2, RegionRenderer). More...
 
abstract void clearImpl0 (final GL2ES2 gl, final RegionRenderer renderer)
 Custom clear(GL2ES2, RegionRenderer) task, called 1st. More...
 
abstract void destroyImpl0 (final GL2ES2 gl, final RegionRenderer renderer)
 Custom destroy(GL2ES2, RegionRenderer) task, called 1st. More...
 

Additional Inherited Members

- Static Public Attributes inherited from com.jogamp.graph.ui.Shape
static Comparator< ShapeZAscendingComparator
 
static Comparator< ShapeZDescendingComparator
 
- Protected Attributes inherited from com.jogamp.graph.ui.Shape
final AABBox box = new AABBox()
 
final Vec4f rgbaColor = new Vec4f(0.60f, 0.60f, 0.60f, 1.0f)
 Default base-color w/o color channel, will be modulated w/ pressed- and toggle color. More...
 
final Vec4f pressedRGBAModulate = new Vec4f(0.70f, 0.70f, 0.70f, 0.8f)
 Default pressed color-factor (darker and slightly transparent), modulates base-color. More...
 
final Vec4f toggleOnRGBAModulate = new Vec4f(0.83f, 0.83f, 0.83f, 1.0f)
 Default toggle color-factor (darker), modulates base-color. More...
 
final Vec4f toggleOffRGBAModulate = new Vec4f(1.00f, 1.00f, 1.00f, 1.0f)
 Default toggle color-factor (original), modulates base-color. More...
 
final Vec4f activeRGBAModulate = new Vec4f(0.25f, 0.25f, 0.25f, 1.0f)
 Default active color-factor (dark), modulates base-color. More...
 
boolean activeRGBAModulateOn = false
 
- Static Protected Attributes inherited from com.jogamp.graph.ui.Shape
static final boolean DEBUG_DRAW = false
 

Detailed Description

RangeSlider Widget either utilizing a simple positional round knob or a rectangular page-sized knob.

See also
RangeSlider(int, Vec2f, float, Vec2f, float, float)
RangeSlider(int, Vec2f, Vec2f, float, float, float)

Definition at line 60 of file RangeSlider.java.

Constructor & Destructor Documentation

◆ RangeSlider() [1/2]

com.jogamp.graph.ui.widgets.RangeSlider.RangeSlider ( final int  renderModes,
final Vec2f  size,
final float  knobScale,
final Vec2f  minMax,
final float  unitSize,
final float  value 
)

Constructs a RangeSlider, i.e.

its shapes and controls.

This slider comprises a background bar and a positional round knob, with getValue() at center position.

The spatial size gets automatically updated at validate(GL2ES2)

Parameters
renderModesGraph's Region render modes, see create(..).
sizespatial dimension of this slider box. A horizontal slider has width >= height.
knobScalemultiple of slider-bar height for getKnobThickness()
minMaxminimum- and maximum-value of slider
unitSizesize of one unit (element) in sliding direction
valuecurrent value of slider

Definition at line 137 of file RangeSlider.java.

◆ RangeSlider() [2/2]

com.jogamp.graph.ui.widgets.RangeSlider.RangeSlider ( final int  renderModes,
final Vec2f  size,
final Vec2f  minMax,
final float  unitSize,
final float  pageSize,
final float  value 
)

Constructs a RangeSlider, i.e.

its shapes and controls.

This slider comprises a framing bar and a rectangular page-sized knob, with getValue() at page-start position.

The spatial size and pageSize gets automatically updated at validate(GL2ES2)

Parameters
renderModesGraph's Region render modes, see create(..).
sizespatial dimension of this slider box. A horizontal slider has width >= height.
minMaxminimum- and maximum-value of slider
unitSizesize of one unit (element) in sliding direction
pageSizesize of one virtual-page, triggers rendering mode from knob to rectangle
valuecurrent value of slider

Definition at line 157 of file RangeSlider.java.

Member Function Documentation

◆ addChangeListener()

final RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.addChangeListener ( final ChangeListener  l)

Definition at line 397 of file RangeSlider.java.

Here is the caller graph for this function:

◆ addMark()

Shape com.jogamp.graph.ui.widgets.RangeSlider.addMark ( final float  value,
final Vec4f  color 
)

Definition at line 455 of file RangeSlider.java.

Here is the call graph for this function:

◆ addPeekListener()

final RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.addPeekListener ( final PeekListener  l)

Definition at line 424 of file RangeSlider.java.

◆ clearImpl0()

void com.jogamp.graph.ui.widgets.RangeSlider.clearImpl0 ( final GL2ES2  gl,
final RegionRenderer  renderer 
)
protected

Custom clear(GL2ES2, RegionRenderer) task, called 1st.

Reimplemented from com.jogamp.graph.ui.Group.

Definition at line 385 of file RangeSlider.java.

◆ clearMarks()

RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.clearMarks ( final GL2ES2  gl,
final RegionRenderer  renderer 
)

Definition at line 454 of file RangeSlider.java.

Here is the call graph for this function:

◆ destroyImpl0()

void com.jogamp.graph.ui.widgets.RangeSlider.destroyImpl0 ( final GL2ES2  gl,
final RegionRenderer  renderer 
)
protected

Custom destroy(GL2ES2, RegionRenderer) task, called 1st.

Reimplemented from com.jogamp.graph.ui.Group.

Definition at line 391 of file RangeSlider.java.

◆ getBar()

Rectangle com.jogamp.graph.ui.widgets.RangeSlider.getBar ( )

Definition at line 451 of file RangeSlider.java.

Here is the caller graph for this function:

◆ getDescription()

String com.jogamp.graph.ui.widgets.RangeSlider.getDescription ( )

Return string description of current slider setting.

Definition at line 844 of file RangeSlider.java.

Here is the caller graph for this function:

◆ getKnob()

GraphShape com.jogamp.graph.ui.widgets.RangeSlider.getKnob ( )

Definition at line 452 of file RangeSlider.java.

Here is the caller graph for this function:

◆ getKnobLength()

final float com.jogamp.graph.ui.widgets.RangeSlider.getKnobLength ( )

Returns spatial knob length in sliding direction.

Definition at line 482 of file RangeSlider.java.

◆ getKnobThickness()

final float com.jogamp.graph.ui.widgets.RangeSlider.getKnobThickness ( )

Returns spatial knob thickness orthogonal to sliding direction.

Definition at line 480 of file RangeSlider.java.

◆ getMarks()

Group com.jogamp.graph.ui.widgets.RangeSlider.getMarks ( )

Definition at line 453 of file RangeSlider.java.

◆ getMinMax()

Vec2f com.jogamp.graph.ui.widgets.RangeSlider.getMinMax ( )

Returns slider value range, see setMinMax(Vec2f, float).

Definition at line 485 of file RangeSlider.java.

Here is the caller graph for this function:

◆ getPageSize()

float com.jogamp.graph.ui.widgets.RangeSlider.getPageSize ( )

Returns the page-size if a rectangular knob is being used, i.e.

RangeSlider(int, Vec2f, Vec2f, float, float, float), otherwise returns Float#NaN.

See also
setPageSize(float)
RangeSlider(int, Vec2f, Vec2f, float, float, float)

Definition at line 586 of file RangeSlider.java.

◆ getPageSizePct()

float com.jogamp.graph.ui.widgets.RangeSlider.getPageSizePct ( final float  minPct)

Returns the page-size percentage if a rectangular knob is being used, i.e.

RangeSlider(int, Vec2f, Vec2f, float, float, float), otherwise returns Float#NaN.

Parameters
minPctminimum percentage to be returned, should be >= 0
See also
setPageSize(float)
RangeSlider(int, Vec2f, Vec2f, float, float, float)

Definition at line 595 of file RangeSlider.java.

Here is the call graph for this function:

◆ getRange()

float com.jogamp.graph.ui.widgets.RangeSlider.getRange ( )

Returns getMinMax() range.

Definition at line 487 of file RangeSlider.java.

◆ getSize()

final Vec2f com.jogamp.graph.ui.widgets.RangeSlider.getSize ( )

Returns spatial dimension of this slider.

Definition at line 478 of file RangeSlider.java.

◆ getSubString()

String com.jogamp.graph.ui.widgets.RangeSlider.getSubString ( )

Reimplemented from com.jogamp.graph.ui.Group.

Definition at line 864 of file RangeSlider.java.

◆ getUnitSize()

float com.jogamp.graph.ui.widgets.RangeSlider.getUnitSize ( )

Returns the size of one unit (element) in sliding direction.

Definition at line 607 of file RangeSlider.java.

◆ getValue()

float com.jogamp.graph.ui.widgets.RangeSlider.getValue ( )

Returns current slider value.

Definition at line 490 of file RangeSlider.java.

◆ getValuePct()

float com.jogamp.graph.ui.widgets.RangeSlider.getValuePct ( )

Returns current slider value in percentage of getRange(),.

Definition at line 492 of file RangeSlider.java.

◆ isInverted()

boolean com.jogamp.graph.ui.widgets.RangeSlider.isInverted ( )

See setInverted(boolean).

Definition at line 616 of file RangeSlider.java.

Here is the caller graph for this function:

◆ receiveKeyEvents()

void com.jogamp.graph.ui.widgets.RangeSlider.receiveKeyEvents ( final Shape  source)

Forward KeyListener events to this Shape from source using a ForwardKeyListener.

This source Shape must be setInteractive(boolean) to receive and forward the events.

This receiver Shape must be setInteractive(boolean) to have the events forwarded.

See also
receiveMouseEvents(Shape)

Reimplemented from com.jogamp.graph.ui.Shape.

Definition at line 372 of file RangeSlider.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ receiveMouseEvents()

void com.jogamp.graph.ui.widgets.RangeSlider.receiveMouseEvents ( final Shape  source)

Forward MouseGestureListener events to this Shape from source using a ForwardMouseListener.

This source Shape must be setInteractive(boolean) to receive and forward the events.

This receiver Shape must be setInteractive(boolean) to have the events forwarded.

See also
receiveKeyEvents(Shape)

Reimplemented from com.jogamp.graph.ui.Shape.

Definition at line 377 of file RangeSlider.java.

Here is the call graph for this function:

◆ removeChangeListener()

final RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.removeChangeListener ( final ChangeListener  l)

Definition at line 407 of file RangeSlider.java.

◆ removePeekListener()

final RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.removePeekListener ( final PeekListener  l)

Definition at line 434 of file RangeSlider.java.

◆ setActiveKnobColorMod()

Shape com.jogamp.graph.ui.widgets.RangeSlider.setActiveKnobColorMod ( final Vec4f  c)

Sets the knob active modulation color.

Default RGBA value is 0.1f, 0.1f, 0.1f, 1f

Definition at line 797 of file RangeSlider.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setBackgroundBarColor() [1/2]

Shape com.jogamp.graph.ui.widgets.RangeSlider.setBackgroundBarColor ( final float  r,
final float  g,
final float  b,
final float  a 
)

Sets the slider background bar color, if this slider comprises only a positional round knob.

Default RGBA value is 0.60f, 0.60f, 0.60f, 0.5f

Definition at line 810 of file RangeSlider.java.

Here is the call graph for this function:

◆ setBackgroundBarColor() [2/2]

Shape com.jogamp.graph.ui.widgets.RangeSlider.setBackgroundBarColor ( final Vec4f  c)

Sets the slider background bar color, if this slider comprises only a positional round knob.

Default RGBA value is 0.60f, 0.60f, 0.60f, 0.5f

Definition at line 822 of file RangeSlider.java.

Here is the call graph for this function:

◆ setColor() [1/2]

final Shape com.jogamp.graph.ui.widgets.RangeSlider.setColor ( final float  r,
final float  g,
final float  b,
final float  a 
)

Sets the slider knob color.

If this slider comprises a rectangular page-sized knob, its rectangular frame also shares the same color with alpha 1.0f.

Base color w/o color channel, will be modulated w/ pressed- and toggle color

Default RGBA value is 0.80f, 0.80f, 0.80f, 0.7f

Reimplemented from com.jogamp.graph.ui.Shape.

Definition at line 759 of file RangeSlider.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setColor() [2/2]

Shape com.jogamp.graph.ui.widgets.RangeSlider.setColor ( final Vec4f  c)

Sets the slider knob color.

If this slider comprises a rectangular page-sized knob, its rectangular frame also shares the same color with alpha 1.0f.

Base color w/o color channel, will be modulated w/ pressed- and toggle color

Default RGBA value is 0.80f, 0.80f, 0.80f, 0.7f

Reimplemented from com.jogamp.graph.ui.Shape.

Definition at line 782 of file RangeSlider.java.

Here is the call graph for this function:

◆ setInverted()

RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.setInverted ( final boolean  v)

Sets whether this slider uses an inverted value range, e.g.

top 0% and bottom 100% for an vertical inverted slider instead of bottom 0% and top 100% for a vertical non-inverted slider.

Definition at line 614 of file RangeSlider.java.

Here is the caller graph for this function:

◆ setMinMax() [1/2]

RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.setMinMax ( final Vec2f  minMax)

Sets slider value range, also updates related pageSize parameter if used.

Parameters
minMaxminimum- and maximum-value of slider
Returns
this instance of chaining

Definition at line 633 of file RangeSlider.java.

◆ setMinMax() [2/2]

RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.setMinMax ( final Vec2f  minMax,
final float  value 
)

Sets slider value range and current value, also updates related pageSize parameter if used.

Parameters
minMaxminimum- and maximum-value of slider
valuenew value of slider, clipped against getMinMax()
Returns
this instance of chaining

Definition at line 624 of file RangeSlider.java.

Here is the caller graph for this function:

◆ setMinMaxPgSz() [1/2]

RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.setMinMaxPgSz ( final Vec2f  minMax,
final float  pageSz 
)

Calls setMinMax(Vec2f, float) and setPageSize(float).

Parameters
minMaxminimum- and maximum-value of slider
pageSzthe page-size, which will be clipped to minMax
Returns
this instance of chaining

Definition at line 654 of file RangeSlider.java.

◆ setMinMaxPgSz() [2/2]

RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.setMinMaxPgSz ( final Vec2f  minMax,
final float  value,
final float  pageSz 
)

Calls setMinMax(Vec2f, float) and setPageSize(float).

Parameters
minMaxminimum- and maximum-value of slider
valuenew value of slider, clipped against minMax
pageSzthe page-size, which will be clipped to minMax
Returns
this instance of chaining

Definition at line 644 of file RangeSlider.java.

◆ setPageSize()

RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.setPageSize ( final float  pageSz)

Sets the page-size if a rectangular knob is being used, i.e.

RangeSlider(int, Vec2f, Vec2f, float, float, float), otherwise does nothing.

Parameters
pageSzthe page-size, which will be clipped to getMinMax().
Returns
this instance of chaining
See also
getPageSize()
RangeSlider(int, Vec2f, Vec2f, float, float, float)

Definition at line 502 of file RangeSlider.java.

◆ setPressedColorMod()

final Shape com.jogamp.graph.ui.widgets.RangeSlider.setPressedColorMod ( final float  r,
final float  g,
final float  b,
final float  a 
)

Set pressed color, modulating getColor() if isPressed().Default pressed color, modulation -factor w/o color channel, modulated base-color. ~0.65 (due to alpha) Default RGBA value is 0.70f, 0.70f, 0.70f, 0.8f

Sets the slider bar and knob pressed color modulation.

Reimplemented from com.jogamp.graph.ui.Shape.

Definition at line 836 of file RangeSlider.java.

Here is the call graph for this function:

◆ setUnitSize()

RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.setUnitSize ( final float  v)

Sets the size of one unit (element) in sliding direction.

Definition at line 605 of file RangeSlider.java.

◆ setValue()

RangeSlider com.jogamp.graph.ui.widgets.RangeSlider.setValue ( final float  v)

Sets slider value.

Parameters
vnew value of slider, clipped against getMinMax()
Returns
this instance of chaining

Definition at line 668 of file RangeSlider.java.

Here is the call graph for this function:

◆ validateImpl()

void com.jogamp.graph.ui.widgets.RangeSlider.validateImpl ( final GL2ES2  gl,
final GLProfile  glp 
)
protected

Reimplemented from com.jogamp.graph.ui.Group.

Definition at line 868 of file RangeSlider.java.


The documentation for this class was generated from the following file: