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

GraphUI Stack Group.Layout. More...

Inheritance diagram for com.jogamp.graph.ui.layout.BoxLayout:
Collaboration diagram for com.jogamp.graph.ui.layout.BoxLayout:

Public Member Functions

 BoxLayout ()
 
 BoxLayout (final Padding padding)
 
 BoxLayout (final float cellWidth, final float cellHeight, final Alignment alignment)
 
 BoxLayout (final float cellWidth, final float cellHeight, final Margin margin)
 
 BoxLayout (final float cellWidth, final float cellHeight, final Padding padding)
 
 BoxLayout (final float cellWidth, final float cellHeight, final Margin margin, final Padding padding)
 
 BoxLayout (final float cellWidth, final float cellHeight, final Alignment alignment, final Margin margin)
 
 BoxLayout (final float cellWidth, final float cellHeight, final Alignment alignment, final Padding padding)
 
 BoxLayout (final float cellWidth, final float cellHeight, final Alignment alignment, final Margin margin, final Padding padding)
 
Vec2f getCellSize ()
 Returns the preset cell size. More...
 
Alignment getAlignment ()
 Returns given Alignment. More...
 
Margin getMargin ()
 Returns given scaled Margin. More...
 
Padding getPadding ()
 Returns given unscaled Padding, may be null if not given via constructor. More...
 
void preValidate (final Shape s)
 Prepare given Shape before validation, e.g. More...
 
void layout (final Group g, final AABBox box, final PMVMatrix4f pmv)
 Performing the layout of Group#getShapes(), called @ Shape#validate(GL2ES2) or Shape#validate(GLProfile). More...
 
String toString ()
 
void preValidate (final Shape s)
 Prepare given Shape before validation, e.g. More...
 
void layout (final Group g, final AABBox box, final PMVMatrix4f pmv)
 Performing the layout of Group#getShapes(), called @ Shape#validate(GL2ES2) or Shape#validate(GLProfile). More...
 

Detailed Description

GraphUI Stack Group.Layout.

A stack of Shapes

Definition at line 53 of file BoxLayout.java.

Constructor & Destructor Documentation

◆ BoxLayout() [1/9]

com.jogamp.graph.ui.layout.BoxLayout.BoxLayout ( )

Definition at line 66 of file BoxLayout.java.

◆ BoxLayout() [2/9]

com.jogamp.graph.ui.layout.BoxLayout.BoxLayout ( final Padding  padding)
Parameters
paddingunscaled Padding applied to each {@Shape} via Shape#setPaddding(Padding) and is scaled if Alignment.Bit#Fill

Definition at line 74 of file BoxLayout.java.

◆ BoxLayout() [3/9]

com.jogamp.graph.ui.layout.BoxLayout.BoxLayout ( final float  cellWidth,
final float  cellHeight,
final Alignment  alignment 
)
Parameters
cellWidthoptional cell width, zero for none
cellHeightoptional cell height, zero for none
alignment

Definition at line 84 of file BoxLayout.java.

◆ BoxLayout() [4/9]

com.jogamp.graph.ui.layout.BoxLayout.BoxLayout ( final float  cellWidth,
final float  cellHeight,
final Margin  margin 
)
Parameters
cellWidthoptional cell width, zero for none
cellHeightoptional cell height, zero for none
marginscaled Margin is applied unscaled and ignored with only center Alignment w/o additional scaling

Definition at line 94 of file BoxLayout.java.

◆ BoxLayout() [5/9]

com.jogamp.graph.ui.layout.BoxLayout.BoxLayout ( final float  cellWidth,
final float  cellHeight,
final Padding  padding 
)
Parameters
cellWidthoptional cell width, zero for none
cellHeightoptional cell height, zero for none
paddingunscaled Padding applied to each {@Shape} via Shape#setPaddding(Padding) and is scaled if Alignment.Bit#Fill

Definition at line 104 of file BoxLayout.java.

◆ BoxLayout() [6/9]

com.jogamp.graph.ui.layout.BoxLayout.BoxLayout ( final float  cellWidth,
final float  cellHeight,
final Margin  margin,
final Padding  padding 
)
Parameters
cellWidthoptional cell width, zero for none
cellHeightoptional cell height, zero for none
marginscaled Margin is applied unscaled and ignored with only center Alignment w/o additional scaling
paddingunscaled Padding applied to each {@Shape} via Shape#setPaddding(Padding) and is scaled if Alignment.Bit#Fill

Definition at line 115 of file BoxLayout.java.

◆ BoxLayout() [7/9]

com.jogamp.graph.ui.layout.BoxLayout.BoxLayout ( final float  cellWidth,
final float  cellHeight,
final Alignment  alignment,
final Margin  margin 
)
Parameters
cellWidthoptional cell width, zero for none
cellHeightoptional cell height, zero for none
marginscaled Margin is applied unscaled

Definition at line 125 of file BoxLayout.java.

◆ BoxLayout() [8/9]

com.jogamp.graph.ui.layout.BoxLayout.BoxLayout ( final float  cellWidth,
final float  cellHeight,
final Alignment  alignment,
final Padding  padding 
)
Parameters
cellWidthoptional cell width, zero for none
cellHeightoptional cell height, zero for none
alignment
paddingunscaled Padding applied to each {@Shape} via Shape#setPaddding(Padding) and is scaled if Alignment.Bit#Fill

Definition at line 136 of file BoxLayout.java.

◆ BoxLayout() [9/9]

com.jogamp.graph.ui.layout.BoxLayout.BoxLayout ( final float  cellWidth,
final float  cellHeight,
final Alignment  alignment,
final Margin  margin,
final Padding  padding 
)
Parameters
cellWidthoptional cell width, zero for none
cellHeightoptional cell height, zero for none
alignment
marginscaled Margin is applied unscaled and ignored with only center Alignment w/o additional scaling
paddingunscaled Padding applied to each {@Shape} via Shape#setPaddding(Padding) and is scaled if Alignment.Bit#Fill

Definition at line 148 of file BoxLayout.java.

Member Function Documentation

◆ getAlignment()

Alignment com.jogamp.graph.ui.layout.BoxLayout.getAlignment ( )

Returns given Alignment.

Definition at line 159 of file BoxLayout.java.

◆ getCellSize()

Vec2f com.jogamp.graph.ui.layout.BoxLayout.getCellSize ( )

Returns the preset cell size.

Definition at line 157 of file BoxLayout.java.

◆ getMargin()

Margin com.jogamp.graph.ui.layout.BoxLayout.getMargin ( )

Returns given scaled Margin.

Definition at line 161 of file BoxLayout.java.

◆ getPadding()

Padding com.jogamp.graph.ui.layout.BoxLayout.getPadding ( )

Returns given unscaled Padding, may be null if not given via constructor.

Definition at line 163 of file BoxLayout.java.

◆ layout()

void com.jogamp.graph.ui.layout.BoxLayout.layout ( final Group  g,
final AABBox  box,
final PMVMatrix4f  pmv 
)

Performing the layout of Group#getShapes(), called @ Shape#validate(GL2ES2) or Shape#validate(GLProfile).

According to the implemented layout, method

Parameters
gthe Group to layout
boxthe bounding box of Group to be updated by this method.
pmva PMVMatrix4f which can be reused.

Implements com.jogamp.graph.ui.Group.Layout.

Definition at line 173 of file BoxLayout.java.

Here is the call graph for this function:

◆ preValidate()

void com.jogamp.graph.ui.layout.BoxLayout.preValidate ( final Shape  s)

Prepare given Shape before validation, e.g.

Shape#setPaddding(Padding).

Implements com.jogamp.graph.ui.Group.Layout.

Definition at line 166 of file BoxLayout.java.

Here is the call graph for this function:

◆ toString()

String com.jogamp.graph.ui.layout.BoxLayout.toString ( )

Definition at line 293 of file BoxLayout.java.

Here is the call graph for this function:

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