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

GraphUI Grid Group.Layout. More...

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

Classes

enum  Order
 Layout order for Group#getShapes()} after population. More...
 

Public Member Functions

 GridLayout (final int column_limit, final float cellWidth, final float cellHeight, final Alignment alignment)
 Default layout order of Group#getShapes()} is Order#COLUMN. More...
 
 GridLayout (final int column_limit, final float cellWidth, final float cellHeight, final Alignment alignment, final Gap gap)
 Default layout order of Group#getShapes()} is Order#COLUMN. More...
 
 GridLayout (final int column_limit, final float cellWidth, final float cellHeight, final Alignment alignment, final Gap gap, final Padding padding)
 Default layout order of Group#getShapes()} is Order#COLUMN. More...
 
 GridLayout (final float cellWidth, final float cellHeight, final Alignment alignment, final int row_limit)
 Default layout order of Group#getShapes()} is Order#ROW. More...
 
 GridLayout (final float cellWidth, final float cellHeight, final Alignment alignment, final Gap gap, final int row_limit)
 Default layout order of Group#getShapes()} is Order#ROW. More...
 
 GridLayout (final float cellWidth, final float cellHeight, final Alignment alignment, final Gap gap, final Padding padding, final int row_limit)
 Default layout order of Group#getShapes()} is Order#ROW. More...
 
Order getOrder ()
 Returns given Order. More...
 
int getColumnCount ()
 Returns column count after layout(Group, AABBox, PMVMatrix4f). More...
 
int getRowCount ()
 Returns row count after layout(Group, AABBox, PMVMatrix4f). More...
 
Vec2f getCellSize ()
 Returns the preset cell size. More...
 
Alignment getAlignment ()
 Returns given Alignment. More...
 
Gap getGap ()
 Returns given scaled Gap. 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 Grid Group.Layout.

A grid of Shapes

Definition at line 56 of file GridLayout.java.

Constructor & Destructor Documentation

◆ GridLayout() [1/6]

com.jogamp.graph.ui.layout.GridLayout.GridLayout ( final int  column_limit,
final float  cellWidth,
final float  cellHeight,
final Alignment  alignment 
)

Default layout order of Group#getShapes()} is Order#COLUMN.

Parameters
column_limit[1..inf)
cellWidth
cellHeight
alignmentTODO

Definition at line 84 of file GridLayout.java.

◆ GridLayout() [2/6]

com.jogamp.graph.ui.layout.GridLayout.GridLayout ( final int  column_limit,
final float  cellWidth,
final float  cellHeight,
final Alignment  alignment,
final Gap  gap 
)

Default layout order of Group#getShapes()} is Order#COLUMN.

Parameters
column_limit[1..inf)
cellWidth
cellHeight
alignmentTODO
gapscaled Gap value is applied w/o additional scaling

Definition at line 96 of file GridLayout.java.

◆ GridLayout() [3/6]

com.jogamp.graph.ui.layout.GridLayout.GridLayout ( final int  column_limit,
final float  cellWidth,
final float  cellHeight,
final Alignment  alignment,
final Gap  gap,
final Padding  padding 
)

Default layout order of Group#getShapes()} is Order#COLUMN.

Parameters
column_limit[1..inf)
cellWidth
cellHeight
alignmentTODO
gapscaled Gap value is applied w/o additional scaling
paddingunscaled Padding applied to each {@Shape} via Shape#setPaddding(Padding) and is scaled if Alignment.Bit#Fill

Definition at line 109 of file GridLayout.java.

◆ GridLayout() [4/6]

com.jogamp.graph.ui.layout.GridLayout.GridLayout ( final float  cellWidth,
final float  cellHeight,
final Alignment  alignment,
final int  row_limit 
)

Default layout order of Group#getShapes()} is Order#ROW.

Parameters
cellWidth
cellHeight
alignmentTODO
row_limit[1..inf)

Definition at line 120 of file GridLayout.java.

◆ GridLayout() [5/6]

com.jogamp.graph.ui.layout.GridLayout.GridLayout ( final float  cellWidth,
final float  cellHeight,
final Alignment  alignment,
final Gap  gap,
final int  row_limit 
)

Default layout order of Group#getShapes()} is Order#ROW.

Parameters
cellWidth
cellHeight
alignmentTODO
gapscaled Gap value is applied w/o additional scaling
row_limit[1..inf)

Definition at line 132 of file GridLayout.java.

◆ GridLayout() [6/6]

com.jogamp.graph.ui.layout.GridLayout.GridLayout ( final float  cellWidth,
final float  cellHeight,
final Alignment  alignment,
final Gap  gap,
final Padding  padding,
final int  row_limit 
)

Default layout order of Group#getShapes()} is Order#ROW.

Parameters
cellWidth
cellHeight
alignmentTODO
gapscaled Gap value is applied w/o additional scaling
paddingunscaled Padding applied to each {@Shape} via Shape#setPaddding(Padding) and is scaled if Alignment.Bit#Fill
row_limit[1..inf)

Definition at line 145 of file GridLayout.java.

Member Function Documentation

◆ getAlignment()

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

Returns given Alignment.

Definition at line 171 of file GridLayout.java.

◆ getCellSize()

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

Returns the preset cell size.

Definition at line 169 of file GridLayout.java.

◆ getColumnCount()

int com.jogamp.graph.ui.layout.GridLayout.getColumnCount ( )

Returns column count after layout(Group, AABBox, PMVMatrix4f).

Definition at line 165 of file GridLayout.java.

◆ getGap()

Gap com.jogamp.graph.ui.layout.GridLayout.getGap ( )

Returns given scaled Gap.

Definition at line 173 of file GridLayout.java.

◆ getOrder()

Order com.jogamp.graph.ui.layout.GridLayout.getOrder ( )

Returns given Order.

Definition at line 163 of file GridLayout.java.

◆ getPadding()

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

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

Definition at line 175 of file GridLayout.java.

◆ getRowCount()

int com.jogamp.graph.ui.layout.GridLayout.getRowCount ( )

Returns row count after layout(Group, AABBox, PMVMatrix4f).

Definition at line 167 of file GridLayout.java.

◆ layout()

void com.jogamp.graph.ui.layout.GridLayout.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 185 of file GridLayout.java.

Here is the call graph for this function:

◆ preValidate()

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

Prepare given Shape before validation, e.g.

Shape#setPaddding(Padding).

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

Definition at line 178 of file GridLayout.java.

Here is the call graph for this function:

◆ toString()

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

Definition at line 397 of file GridLayout.java.

Here is the call graph for this function:

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