maspack.render.GL.GL2

Class GL2Viewer

java.lang.Object

maspack.render.GL.GLViewer

maspack.render.GL.GL2.GL2Viewer

All Implemented Interfaces:

com.jogamp.opengl.GLEventListener, java.util.EventListener, HasProperties, GLRenderer, Renderer, Viewer

public class GL2Viewer
extends GLViewer
implements HasProperties

Author:

John E Lloyd and ArtiSynth team members

Nested Class Summary

Nested classes/interfaces inherited from class maspack.render.GL.GLViewer

GLViewer.BlendFactor, GLViewer.GLVersion

Nested classes/interfaces inherited from interface maspack.render.Viewer

Viewer.RotationMode, Viewer.ViewControlMask

Nested classes/interfaces inherited from interface maspack.render.Renderer

Renderer.AxisDrawStyle, Renderer.ColorInterpolation, Renderer.ColorMixing, Renderer.DrawMode, Renderer.FaceStyle, Renderer.HighlightStyle, Renderer.LineStyle, Renderer.PointStyle, Renderer.Shading

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG

Fields inherited from class maspack.render.GL.GLViewer

AUTO_FIT, DEFAULT_AXIS_RADIUS_RATIO, DEFAULT_DST_BLENDING, DEFAULT_ELLIPTIC_CURSOR_ACTIVE, DEFAULT_ELLIPTIC_CURSOR_SIZE, DEFAULT_ROTATION_MODE, DEFAULT_SRC_BLENDING, DEFAULT_VIEW_CONTROL_MASK, myProps, useGLJPanel

Fields inherited from interface maspack.render.Renderer

HIGHLIGHT, SORT_FACES

Constructor Summary

Constructors

Constructor and Description
GL2Viewer(GL2Viewer shareWith, int width, int height) Creates a new GLViewer with default capabilities that shares resources (e.g., diplay lists and textures) with an existing GLViewer.
GL2Viewer(com.jogamp.opengl.GLCapabilities cap, GL2SharedResources resources, int width, int height) Creates a new GLViewer with specified capabilities and size.
GL2Viewer(int width, int height) Creates a new GLViewer with default capabilities.

Method Summary

Modifier and Type	Method and Description
void	awaitScreenShotCompletion()
void	cleanupScreenShots()
void	clearPickMatrix()
void	display(com.jogamp.opengl.GLAutoDrawable drawable, int flags)
void	dispose() MUST BE CALLED by whatever frame when it is going down, will notify any shared resources that they can be cleared.
void	dispose(com.jogamp.opengl.GLAutoDrawable drawable) Called any time GL context is switched! e.g.
void	drawArrow(float[] pnt0, float[] pnt1, double rad, boolean capped) Draws a solid arrow between two points in model coordinates, using the current shading and material.
void	drawArrow(RenderProps props, float[] pnt0, float[] pnt1, boolean capped, boolean highlight) Draws an arrow between two points in model coordinates, using the radius, line color, and shading specified by the render properties argument props.
void	drawAxes(RigidTransform3d X, double[] lens, int width, boolean highlight) Draws a set of coordinate axes representing a rigid coordinate frame X.
void	drawBox(float[] pnt, double wx, double wy, double wz) Draws an axis-aligned box in model coordinates, using the current shading and material.
void	drawBox(RigidTransform3d TBM, Vector3d widths) Draws a box centered on the specified transform in model coordinates, using the current shading and material.
void	drawCone(float[] pnt0, float[] pnt1, double rad0, double rad1, boolean capped) Draws a cone between two points in model coordinates, using the current shading and material.
void	drawCube(float[] pnt, double w) Draws an axis-aligned cube with a specified width centered at a point in model coordinates, using the current shading and material.
void	drawCylinder(float[] pnt0, float[] pnt1, double rad, boolean capped) Draws a cylinder between two points in model coordinates, using the current shading and material.
void	drawLine(float[] pnt0, float[] pnt1) Draws a single line between two points in model coordinates, using the current line width, material, and shading.
void	drawLine(RenderProps props, float[] pnt0, float[] pnt1, float[] color, boolean capped, boolean highlight) Draws a single line between two points in model coordinates, using the line style, radius, line color, and shading specified by the render properties argument props.
void	drawLines(RenderObject robj, int gidx) Draws all the lines in the specified line group of the render object, using the current material and shading.
void	drawLines(RenderObject robj, int gidx, int offset, int count, Renderer.LineStyle style, double rad) Draws a selection of lines in the specified line group of the supplied render object, using the current material and shading.
void	drawLines(RenderObject robj, int gidx, RenderInstances rinst) Draws the specified group of lines, repeated for each instance in rinst.
void	drawLineStrip(RenderProps props, java.lang.Iterable<float[]> pnts, Renderer.LineStyle style, boolean highlight) Draws a line strip between a series of points in model coordinates, using the radius, line color, and shading specified by the render properties argument props, and the line style specified by style.
void	drawPoint(float[] pnt) Draws a single point located at pnt in model coordinates, using the current point size, material, and shading.
void	drawPoint(RenderProps props, float[] pnt, boolean highlight) Draws a single point located at pnt in model coordinates, using the point style, size, point color, and shading specified by the render properties argument props.
void	drawPoints(RenderObject robj, int gidx) Draws all the points in the specified point group of the supplied render object, using the current material and shading.
void	drawPoints(RenderObject robj, int gidx, int offset, int count, Renderer.PointStyle style, double rad) Draws a selection of points in the specified point group of the supplied render object, using the current material and shading.
void	drawPoints(RenderObject robj, int gidx, RenderInstances rinst) Draws the specified group of points, repeated for each instance in rinst.
void	drawSimpleLines(RenderObject robj, int gidx, int offset, int count)
void	drawSphere(float[] pnt, double rad) Draws a sphere with a specified radius centered at a point in model coordinates, using the current shading and material.
void	drawSphere(float[] centre, float r)
void	drawSpheres(java.lang.Iterable<float[]> centres, float r)
void	drawSpindle(float[] pnt0, float[] pnt1, double rad) Draws a spindle between two points in model coordinates, using the current shading and material.
double	drawText(java.awt.Font font, java.lang.String str, float[] pos, double emSize) Draws text in the x-y plane in model coordinates.
void	drawTriangle(float[] pnt0, float[] pnt1, float[] pnt2) Draw triangular faces, using the current Shading, lighting and material, and computing a single "face" normal from the coordinates (so the current "shading" really matters only if it is Shading.NONE).
void	drawTriangles(RenderObject robj, int gidx, int offset, int count) Draws a selection of triangles in the specified triangle group of the render object, using the current material and shading.
void	drawTriangles(RenderObject robj, int gidx, RenderInstances rinst) Draws the specified group of triangles, repeated for each instance in rinst.
void	drawVertices(RenderObject robj, int[] idxs, Renderer.DrawMode mode)
void	drawVertices(RenderObject robj, Renderer.DrawMode mode) Draws all the vertices associated with the specified RenderObject, using a specified drawing mode and the current material and shading.
void	drawVertices(RenderObject robj, VertexIndexArray idxs, int offset, int count, Renderer.DrawMode mode) Draws a selection of vertices associated with the specified RenderObject, using a specified drawing mode and the current material and shading.
com.jogamp.opengl.GL	getGL()
com.jogamp.opengl.GL2	getGL2()
int	getGLShadeModel()
com.jogamp.opengl.glu.GLU	getGLU()
static int	getNameStackDepth(com.jogamp.opengl.GL2 gl)
GL2Primitive	getPrimitive(com.jogamp.opengl.GL2 gl, GL2Primitive.PrimitiveType type) Return a primitive object
GLTextRenderer	getTextRenderer()
GL2VersionedObject	getVersionedObject(com.jogamp.opengl.GL2 gl, RenderKey key, java.lang.Object fingerPrint, BooleanHolder compile) Gets or allocates a "versioned object" given a key, and a "fingerprint" used to determine if the stored object has different content
boolean	grabPending()
boolean	hasBumpMapping() Queries whether or not this renderer supports bump mapping.
boolean	hasColorMapMixing(Renderer.ColorMixing cmix) Queries whether or not a specified method for combining color map and material coloring is supported by this Renderer.
boolean	hasColorMapping() Queries whether or not this renderer supports color mapping.
boolean	hasNormalMapping() Queries whether or not this renderer supports normal mapping.
boolean	hasVertexColorMixing(Renderer.ColorMixing cmix) Queries whether or not a specified method for combining vertex coloring and material coloring is supported by this Renderer.
void	init(com.jogamp.opengl.GLAutoDrawable drawable) Called any time GL context is switched! e.g.
boolean	isSelecting() Returns true if the renderer is currently performing a selection render.
void	maybeUpdateMaterials()
void	maybeUpdateMaterials(com.jogamp.opengl.GL2 gl)
void	maybeUpdateMatrices(com.jogamp.opengl.GL2 gl)
static void	mulTransform(com.jogamp.opengl.GL2 gl, AffineTransform3d X)
static void	mulTransform(com.jogamp.opengl.GL2 gl, RigidTransform3d X)
boolean	popProjectionMatrix()
void	setPickMatrix(float x, float y, float deltax, float deltay, int[] viewport) Alternative to gluPickMatrix, pre-multiplies by appropriate matrix to reduce size
int	setSurfaceResolution(int nres) Sets the resolution used for creating mesh representations of curved solids.
void	setupScreenShot(int w, int h, java.io.File file, java.lang.String format)
void	setupScreenShot(int w, int h, int samples, java.io.File file, java.lang.String format) Setup for a screenshot during the next render cycle

Methods inherited from class maspack.render.GL.GLViewer

addClipPlane, addClipPlane, addClipPlane, addDragger, addKeyListener, addLight, addLight, addMouseInputListener, addMouseWheelListener, addRenderable, addRenderListener, addSelectionListener, addVertex, addVertex, addVertex, addVertex, autoFit, autoFitOrtho, autoFitPerspective, begin2DRendering, begin2DRendering, begin2DRendering, beginDraw, beginGL, beginSelectionQuery, beginSubSelection, centerDistancePerPixel, clearClipPlanes, clearDraggers, clearRenderables, display, distancePerPixel, draw, drawArrow, drawArrow, drawAxes, drawAxes, drawAxes, drawBox, drawCone, drawCube, drawCylinder, drawLine, drawLine, drawLine, drawLine, drawLine, drawLines, drawLines, drawLines, drawPoint, drawPoint, drawPoint, drawPoints, drawPoints, drawPoints, drawRay, drawSolidAxes, drawSolidAxes, drawSphere, drawSpindle, drawText, drawText, drawText, drawTriangle, drawTriangles, drawTriangles, drawVertices, end2DRendering, endDraw, endGL, endSelectionQuery, endSubSelection, estimateRadiusAndCenter, finish2DRendering, getAllDraggers, getAllPropertyInfo, getAutoSwapBufferMode, getAxialView, getAxisDrawStyle, getAxisLength, getAxisRadiusRatio, getBackColor, getBackgroundColor, getBackgroundColor, getBlendDestFactor, getBlendSourceFactor, getBounds, getBumpMap, getCanvas, getCellDivisions, getCellSize, getCenter, getCenterToWorld, getCenterToWorld, getClipPlane, getClipPlanes, getColor, getColorInterpolation, getColorMap, getComponent, getContext, getDefaultFont, getDepthOffset, getDragBox, getDraggers, getDrawTool, getEllipticCursorActive, getEllipticCursorSize, getEllipticSelection, getEmission, getExternalRenderList, getEye, getEyeToWorld, getEyeZDirection, getFaceStyle, getFarPlaneDistance, getFrontColor, getFrustum, getGrid, getGridVisible, getHighlightColor, getHighlightColor, getHighlighting, getHighlightStyle, getIndexOfLight, getKeyListeners, getLight, getLineWidth, getModelMatrix, getModelMatrix, getModelMatrix, getMouseHandler, getMouseInputListeners, getMouseWheelListeners, getNormalMap, getNumClipPlanes, getPointSize, getProfiling, getProjectionMatrix, getProjectionMatrix, getProperty, getRenderFlags, getRenderListeners, getRotationMode, getRoundedPoints, getScreenCursor, getScreenHeight, getScreenWidth, getScreenX, getScreenY, getSelectingColor, getSelectionEvent, getSelectionFilter, getSelectionListeners, getSelectOnPress, getShading, getShininess, getSpecular, getSurfaceResolution, getTextBounds, getTextureMatrix, getTextureMatrix, getTransparencyBlending, getTransparencyFaceCulling, getUpVector, getVertexColorMixing, getVerticalFieldOfView, getViewControlMask, getViewMatrix, getViewMatrix, getViewMatrix, getViewPlaneDistance, getViewPlaneHeight, getViewPlaneWidth, has2DRendering, hasHighlightStyle, hasSelection, hasTextRendering, hasVertexColoring, is2DRendering, isAutoResizeEnabled, isAutoViewportEnabled, isDepthEnabled, isDepthWriteEnabled, isLightingEnabled, isMultiSampleEnabled, isOrthogonal, isSelectable, isSelectionEnabled, isSpecialRenderFlagsSet, isTextureMappingEnabled, isTransparencyEnabled, isVertexColoringEnabled, maxClipSurfaces, mulModelMatrix, numFreeClipSurfaces, numLights, numMultiSamples, numSelectionQueriesNeeded, paint, popModelMatrix, popTextureMatrix, popViewMatrix, pushModelMatrix, pushProjectionMatrix, pushTextureMatrix, pushViewMatrix, removeClipPlane, removeDragger, removeKeyListener, removeLight, removeLight, removeMouseInputListener, removeMouseWheelListener, removeRenderable, removeRenderListener, removeSelectionListener, repaint, rerender, rerender, resetEllipticCursorSize, reshape, restoreDefaultState, rotate, rotateModelMatrix, scaleModelMatrix, scaleModelMatrix, setAutoResizeEnabled, setAutoSwapBufferMode, setAutoViewportEnabled, setAxialView, setAxisDrawStyle, setAxisLength, setAxisRadiusRatio, setBackColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBlendDestFactor, setBlendSourceFactor, setBumpMap, setCenter, setColor, setColor, setColor, setColor, setColor, setColorInterpolation, setColorMap, setDefaultFont, setDefaultLights, setDepthEnabled, setDepthOffset, setDepthWriteEnabled, setDragBox, setDrawTool, setEdgeColoring, setEllipticCursorActive, setEllipticCursorSize, setEllipticSelection, setEmission, setExternalRenderList, setEye, setEyeToWorld, setEyeToWorld, setFaceColoring, setFaceColoring, setFaceStyle, setFrontAlpha, setFrontColor, setGlobalRenderFlags, setGridSizeAndPosition, setGridVisible, setHighlightColor, setHighlighting, setHighlightStyle, setLightingEnabled, setLineColoring, setLineShading, setLineWidth, setMaterial, setModelMatrix, setModelMatrix2d, setMouseHandler, setMultiSampleEnabled, setNormal, setNormal, setNormal, setNormalMap, setOrthogonal, setOrthogonal, setOrthographicView, setPerspective, setPerspective, setPerspective, setPointColoring, setPointShading, setPointSize, setProfiling, setPropsColoring, setPropsShading, setRotationMode, setRoundedPoints, setScreenCursor, setSelectingColor, setSelectingColor, setSelectionEnabled, setSelectionFilter, setSelectOnPress, setShading, setShininess, setSpecular, setTextureCoord, setTextureCoord, setTextureCoord, setTextureMappingEnabled, setTextureMatrix, setTransparencyBlending, setTransparencyEnabled, setTransparencyFaceCulling, setUpVector, setVertexColoringEnabled, setVertexColorMixing, setVerticalFieldOfView, setViewControlMask, setViewMatrix, setViewport, setViewVolume, translate, translateModelMatrix, translateModelMatrix, zoom

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface maspack.properties.HasProperties

getAllPropertyInfo, getProperty

Field Detail

DEBUG

public static boolean DEBUG

Constructor Detail

GL2Viewer

public GL2Viewer(int width,
                 int height)

Creates a new GLViewer with default capabilities.

Parameters:

width - initial width of the viewer

height - initial height of the viewer

GL2Viewer

public GL2Viewer(GL2Viewer shareWith,
                 int width,
                 int height)

Creates a new GLViewer with default capabilities that shares resources (e.g., diplay lists and textures) with an existing GLViewer.

Parameters:

shareWith - GLViewer with which resources are to be shared

width - initial width of the viewer

height - initial height of the viewer

GL2Viewer

public GL2Viewer(com.jogamp.opengl.GLCapabilities cap,
                 GL2SharedResources resources,
                 int width,
                 int height)

Creates a new GLViewer with specified capabilities and size.

Parameters:

cap - Desired GL capabilities. Can be specified as null, which will create default capabilities.

resources - Resources to be used by the viewer. Can be specified as null, which will create default resources.

width - initial width of the viewer

height - initial height of the viewer

Method Detail

getGL

public com.jogamp.opengl.GL getGL()

Specified by:

getGL in interface GLRenderer

Overrides:

getGL in class GLViewer

init

public void init(com.jogamp.opengl.GLAutoDrawable drawable)

Description copied from class: GLViewer

Called any time GL context is switched! e.g. moving window to new display

Specified by:

init in interface com.jogamp.opengl.GLEventListener

Overrides:

init in class GLViewer

setSurfaceResolution

public int setSurfaceResolution(int nres)

Description copied from interface: Renderer

Sets the resolution used for creating mesh representations of curved solids. The number represents the number of line segments that would be used to approximate a circle. This level of resolution is then employed to create the mesh.

Specified by:

setSurfaceResolution in interface Renderer

Overrides:

setSurfaceResolution in class GLViewer

Parameters:

nres - resolution for curved surfaces

Returns:

previous resolution

getPrimitive

public GL2Primitive getPrimitive(com.jogamp.opengl.GL2 gl,
                                 GL2Primitive.PrimitiveType type)

Return a primitive object

Returns:

primitive

dispose

public void dispose(com.jogamp.opengl.GLAutoDrawable drawable)

Description copied from class: GLViewer

Called any time GL context is switched! e.g. moving window to new display

Specified by:

dispose in interface com.jogamp.opengl.GLEventListener

Overrides:

dispose in class GLViewer

dispose

public void dispose()

Description copied from class: GLViewer

MUST BE CALLED by whatever frame when it is going down, will notify any shared resources that they can be cleared. It is best to add it as a WindowListener

Specified by:

dispose in interface Viewer

Overrides:

dispose in class GLViewer

display

public void display(com.jogamp.opengl.GLAutoDrawable drawable,
                    int flags)

Specified by:

display in class GLViewer

getTextRenderer

public GLTextRenderer getTextRenderer()

Specified by:

getTextRenderer in class GLViewer

drawText

public double drawText(java.awt.Font font,
                       java.lang.String str,
                       float[] pos,
                       double emSize)

Description copied from interface: Renderer

Draws text in the x-y plane in model coordinates.

Specified by:

drawText in interface Renderer

Parameters:

font - the font to use. The font size largely impacts the resolution of the renderer characters. A value of at least 32pt is recommended.

str - string to render

pos - position of the lower left of the text box (model coordinates)

emSize - size of an `em' unit in model coordinates

Returns:

the advance distance in the x-direction (width of text)

getGLShadeModel

public int getGLShadeModel()

getNameStackDepth

public static int getNameStackDepth(com.jogamp.opengl.GL2 gl)

maybeUpdateMaterials

public void maybeUpdateMaterials()

Specified by:

maybeUpdateMaterials in class GLViewer

maybeUpdateMaterials

public void maybeUpdateMaterials(com.jogamp.opengl.GL2 gl)

maybeUpdateMatrices

public void maybeUpdateMatrices(com.jogamp.opengl.GL2 gl)

popProjectionMatrix

public boolean popProjectionMatrix()

Overrides:

popProjectionMatrix in class GLViewer

setPickMatrix

public void setPickMatrix(float x,
                          float y,
                          float deltax,
                          float deltay,
                          int[] viewport)

Description copied from class: GLViewer

Alternative to gluPickMatrix, pre-multiplies by appropriate matrix to reduce size

clearPickMatrix

public void clearPickMatrix()

Overrides:

clearPickMatrix in class GLViewer

mulTransform

public static void mulTransform(com.jogamp.opengl.GL2 gl,
                                RigidTransform3d X)

mulTransform

public static void mulTransform(com.jogamp.opengl.GL2 gl,
                                AffineTransform3d X)

isSelecting

public boolean isSelecting()

Description copied from class: GLViewer

Returns true if the renderer is currently performing a selection render. When this is the case, the application should avoid calls affecting color and lighting.

Specified by:

isSelecting in interface Renderer

Overrides:

isSelecting in class GLViewer

Returns:

true if the renderer is in selection mode.

drawSphere

public void drawSphere(float[] pnt,
                       double rad)

Description copied from interface: Renderer

Draws a sphere with a specified radius centered at a point in model coordinates, using the current shading and material. This method is functionally equivalent to Renderer.drawSphere(Vector3d,double).

Specified by:

drawSphere in interface Renderer

Parameters:

pnt - center of the sphere

rad - radius of the sphere

drawCube

public void drawCube(float[] pnt,
                     double w)

Description copied from interface: Renderer

Draws an axis-aligned cube with a specified width centered at a point in model coordinates, using the current shading and material.

Specified by:

drawCube in interface Renderer

Parameters:

pnt - center of the cube

w - width of the cube

drawBox

public void drawBox(float[] pnt,
                    double wx,
                    double wy,
                    double wz)

Description copied from interface: Renderer

Draws an axis-aligned box in model coordinates, using the current shading and material.

Specified by:

drawBox in interface Renderer

Parameters:

pnt - center of the box

wx - width in x

wy - width in y

wz - width in z

drawBox

public void drawBox(RigidTransform3d TBM,
                    Vector3d widths)

Description copied from interface: Renderer

Draws a box centered on the specified transform in model coordinates, using the current shading and material.

Specified by:

drawBox in interface Renderer

Parameters:

TBM - transform from box to model coordinates on which the box is centered

widths - x,y,z widths of the box

drawSpindle

public void drawSpindle(float[] pnt0,
                        float[] pnt1,
                        double rad)

Description copied from interface: Renderer

Draws a spindle between two points in model coordinates, using the current shading and material. The resolution is specified by Renderer.getSurfaceResolution().

Specified by:

drawSpindle in interface Renderer

Parameters:

pnt0 - first end point

pnt1 - second end point

rad - radius of the spindle

drawArrow

public void drawArrow(float[] pnt0,
                      float[] pnt1,
                      double rad,
                      boolean capped)

Description copied from interface: Renderer

Draws a solid arrow between two points in model coordinates, using the current shading and material. This method is functionally equivalent to Renderer.drawArrow(Vector3d,Vector3d,double,boolean) except that the points are specified using float[].

Specified by:

drawArrow in interface Renderer

Parameters:

pnt0 - first end point

pnt1 - second end point

rad - radius of the cylinder

capped - if true, indicates that the arrow should have a solid cap on the bottom

drawCylinder

public void drawCylinder(float[] pnt0,
                         float[] pnt1,
                         double rad,
                         boolean capped)

Description copied from interface: Renderer

Draws a cylinder between two points in model coordinates, using the current shading and material. The resolution is specified by Renderer.getSurfaceResolution().

Specified by:

drawCylinder in interface Renderer

Parameters:

pnt0 - first end point

pnt1 - second end point

rad - radius of the cylinder

capped - if true, indicates that the cylinder should have a solid cap on each end

drawCone

public void drawCone(float[] pnt0,
                     float[] pnt1,
                     double rad0,
                     double rad1,
                     boolean capped)

Description copied from interface: Renderer

Draws a cone between two points in model coordinates, using the current shading and material. A cone is like a cylinder, except that it can have different radii at the end points. The resolution is specified by Renderer.getSurfaceResolution().

Specified by:

drawCone in interface Renderer

Parameters:

pnt0 - first end point

pnt1 - second end point

rad0 - radius at first end point

rad1 - radius at second end point

capped - if true, indicates that the cone should have a solid cap on each end

drawLine

public void drawLine(RenderProps props,
                     float[] pnt0,
                     float[] pnt1,
                     float[] color,
                     boolean capped,
                     boolean highlight)

Description copied from interface: Renderer

Draws a single line between two points in model coordinates, using the line style, radius, line color, and shading specified by the render properties argument props. This method is functionally equivalent to Renderer.drawLine(RenderProps,float[],float[],boolean), except for the additional control provided by the arguments color and capped.

Specified by:

drawLine in interface Renderer

Parameters:

props - render properties used for drawing the line

pnt0 - first point

pnt1 - second point

color - if not null, specifies an alternate color that should be used in place of the line color specified in props

capped - if true, specifies that the line should have a solid cap on its ends for styles such as Renderer.LineStyle.CYLINDER and @link LineStyle#ARROW}

highlight - if true, indicates that highlighting, if enabled, should be applied to the line

drawArrow

public void drawArrow(RenderProps props,
                      float[] pnt0,
                      float[] pnt1,
                      boolean capped,
                      boolean highlight)

Description copied from interface: Renderer

Draws an arrow between two points in model coordinates, using the radius, line color, and shading specified by the render properties argument props. The method behaves similarly to Renderer.drawArrow(float[],float[],double,boolean), with the cylinder radius determine instead by props.getLineRadius().

Specified by:

drawArrow in interface Renderer

Parameters:

props - render properties used for drawing the arrow

pnt0 - first point

pnt1 - second point

capped - if true, specifies that the arrow should have a solid cap on the bottom

highlight - if true, indicates that highlighting, if enabled, should be applied to the arrow

drawPoint

public void drawPoint(float[] pnt)

Description copied from interface: Renderer

Draws a single point located at pnt in model coordinates, using the current point size, material, and shading. This method is functionally equivalent to Renderer.drawPoint(Vector3d).

Specified by:

drawPoint in interface Renderer

Parameters:

pnt - array (of length 3) giving the point to draw

drawLine

public void drawLine(float[] pnt0,
                     float[] pnt1)

Description copied from interface: Renderer

Draws a single line between two points in model coordinates, using the current line width, material, and shading. This method is functionally equivalent to Renderer.drawLine(Vector3d,Vector3d).

Specified by:

drawLine in interface Renderer

Parameters:

pnt0 - array (of length 3) giving the first point

pnt1 - array (of length 3) giving the second point

drawTriangle

public void drawTriangle(float[] pnt0,
                         float[] pnt1,
                         float[] pnt2)

Draw triangular faces, using the current Shading, lighting and material, and computing a single "face" normal from the coordinates (so the current "shading" really matters only if it is Shading.NONE).

Specified by:

drawTriangle in interface Renderer

Parameters:

pnt0 - first point

pnt1 - second point

pnt2 - third point

drawPoint

public void drawPoint(RenderProps props,
                      float[] pnt,
                      boolean highlight)

Description copied from interface: Renderer

Draws a single point located at pnt in model coordinates, using the point style, size, point color, and shading specified by the render properties argument props. This method is functionally equivalent to Renderer.drawPoint(RenderProps,Vector3d,boolean) except that the point is specified using float[].

Specified by:

drawPoint in interface Renderer

Parameters:

props - render properties used for drawing the point

pnt - location of the point

highlight - if true, indicates that highlighting, if enabled, should be applied to the point

drawSphere

public void drawSphere(float[] centre,
                       float r)

drawSpheres

public void drawSpheres(java.lang.Iterable<float[]> centres,
                        float r)

drawLineStrip

public void drawLineStrip(RenderProps props,
                          java.lang.Iterable<float[]> pnts,
                          Renderer.LineStyle style,
                          boolean highlight)

Description copied from interface: Renderer

Draws a line strip between a series of points in model coordinates, using the radius, line color, and shading specified by the render properties argument props, and the line style specified by style.

If the line style is Renderer.LineStyle.LINE, then the strip is drawn using pixel-based lines with a width given by props.getLineWidth(). For other line styles, the strip is drawn as solids with a nominal radius given by props.getLineRadius(). If highlight is true and the highlight style is Renderer.HighlightStyle.COLOR, then the strip will be drawn using the highlight color rather than the line color specified in props.

Specified by:

drawLineStrip in interface Renderer

Parameters:

props - render properties used for drawing the strip

pnts - list of points used for drawing the strip

style - line style to be used for the strip

highlight - if true, indicates that highlighting, if enabled, should be applied to the strip

drawAxes

public void drawAxes(RigidTransform3d X,
                     double[] lens,
                     int width,
                     boolean highlight)

Description copied from interface: Renderer

Draws a set of coordinate axes representing a rigid coordinate frame X. This method is functionally equivalent to Renderer.drawAxes(RigidTransform3d,double,int,boolean), except that the lengths for each axis are individually specified. Axes with a a specified length of 0 will not be drawn.

Specified by:

drawAxes in interface Renderer

Parameters:

X - coordinate frame defining the axes

lens - lengths for each axis

width - width of each axis (in pixels)

highlight - if true, indicates that the axes should be highlighted.

setupScreenShot

public void setupScreenShot(int w,
                            int h,
                            int samples,
                            java.io.File file,
                            java.lang.String format)

Setup for a screenshot during the next render cycle

Specified by:

setupScreenShot in class GLViewer

Parameters:

w - width of shot

h - height of shot

samples - number of samples to use for the multisample FBO (does antialiasing)

file - file to which the screen shot is to be written

format - format string

setupScreenShot

public void setupScreenShot(int w,
                            int h,
                            java.io.File file,
                            java.lang.String format)

Specified by:

setupScreenShot in class GLViewer

awaitScreenShotCompletion

public void awaitScreenShotCompletion()

Specified by:

awaitScreenShotCompletion in class GLViewer

grabPending

public boolean grabPending()

Specified by:

grabPending in class GLViewer

cleanupScreenShots

public void cleanupScreenShots()

Specified by:

cleanupScreenShots in class GLViewer

getGL2

public com.jogamp.opengl.GL2 getGL2()

getGLU

public com.jogamp.opengl.glu.GLU getGLU()

drawTriangles

public void drawTriangles(RenderObject robj,
                          int gidx,
                          int offset,
                          int count)

Description copied from interface: Renderer

Draws a selection of triangles in the specified triangle group of the render object, using the current material and shading.

Specified by:

drawTriangles in interface Renderer

Parameters:

robj - render object

gidx - triangle group index

offset - triangle offset at which to start rendering

count - number of triangles to draw

drawLines

public void drawLines(RenderObject robj,
                      int gidx)

Description copied from interface: Renderer

Draws all the lines in the specified line group of the render object, using the current material and shading.

Specified by:

drawLines in interface Renderer

Parameters:

robj - render object

gidx - line group index

drawSimpleLines

public void drawSimpleLines(RenderObject robj,
                            int gidx,
                            int offset,
                            int count)

drawLines

public void drawLines(RenderObject robj,
                      int gidx,
                      int offset,
                      int count,
                      Renderer.LineStyle style,
                      double rad)

Description copied from interface: Renderer

Draws a selection of lines in the specified line group of the supplied render object, using the current material and shading. The lines are drawn either as pixel-based lines or as solid primitives, according to the specified line style. For lines drawn using the style Renderer.LineStyle.LINE, the argument rad gives the line width, whereas for solid primitives (Renderer.LineStyle.CYLINDER, Renderer.LineStyle.SOLID_ARROW, Renderer.LineStyle.SPINDLE), it gives the nominal radius.

Specified by:

drawLines in interface Renderer

Parameters:

robj - render object

gidx - line group index

offset - line offset at which to begin drawing

count - number of lines to draw

style - line style to use for drawing

rad - radius for solid lines or width for pixel-based lines

drawPoints

public void drawPoints(RenderObject robj,
                       int gidx)

Description copied from interface: Renderer

Draws all the points in the specified point group of the supplied render object, using the current material and shading.

Specified by:

drawPoints in interface Renderer

Parameters:

robj - render object

gidx - point group index

drawPoints

public void drawPoints(RenderObject robj,
                       int gidx,
                       int offset,
                       int count,
                       Renderer.PointStyle style,
                       double rad)

Description copied from interface: Renderer

Draws a selection of points in the specified point group of the supplied render object, using the current material and shading. The points are drawn either as pixel-based points or as solids, according to the specified points style. For points drawn using the style Renderer.PointStyle.POINT, the argument rad gives the point size, whereas for Renderer.PointStyle.CUBE it gives the cube half-width, and for Renderer.PointStyle.SPHERE it gives the sphere radius.

Specified by:

drawPoints in interface Renderer

Parameters:

robj - render object

gidx - point group index

offset - point offset at which to begin within the point group

count - number of points to draw

style - point style to use for drawing

rad - radius for spheres or width for pixel-based points

drawVertices

public void drawVertices(RenderObject robj,
                         Renderer.DrawMode mode)

Description copied from interface: Renderer

Draws all the vertices associated with the specified RenderObject, using a specified drawing mode and the current material and shading.

Specified by:

drawVertices in interface Renderer

Parameters:

robj - render object

mode - drawing mode to be used for drawing the vertices

drawVertices

public void drawVertices(RenderObject robj,
                         VertexIndexArray idxs,
                         int offset,
                         int count,
                         Renderer.DrawMode mode)

Description copied from interface: Renderer

Draws a selection of vertices associated with the specified RenderObject, using a specified drawing mode and the current material and shading. This version of the method should be favoured for persistent index lists, since the VertexIndexArray can detect whether or not it has been modified, which allows for caching. Additionally, this method allows specification of an offset and vertex count.

Specified by:

drawVertices in interface Renderer

Parameters:

robj - render object

idxs - vertex indices

offset - index offset

count - index count

mode - drawing mode to be used for drawing the vertices

drawVertices

public void drawVertices(RenderObject robj,
                         int[] idxs,
                         Renderer.DrawMode mode)

drawPoints

public void drawPoints(RenderObject robj,
                       int gidx,
                       RenderInstances rinst)

Description copied from interface: Renderer

Draws the specified group of points, repeated for each instance in rinst. Points are drawn as Renderer.PointStyle.POINT and use the current point-size, as determined by Renderer.getPointSize().

Specified by:

drawPoints in interface Renderer

Parameters:

robj - object to draw

gidx - point group to draw

rinst - instance to draw

drawLines

public void drawLines(RenderObject robj,
                      int gidx,
                      RenderInstances rinst)

Description copied from interface: Renderer

Draws the specified group of lines, repeated for each instance in rinst. Lines are drawn as Renderer.LineStyle.LINE and use the current line-width, as determined by Renderer.getLineWidth().

Specified by:

drawLines in interface Renderer

Parameters:

robj - object to draw

gidx - line group to draw

rinst - instance to draw

drawTriangles

public void drawTriangles(RenderObject robj,
                          int gidx,
                          RenderInstances rinst)

Description copied from interface: Renderer

Draws the specified group of triangles, repeated for each instance in rinst.

Specified by:

drawTriangles in interface Renderer

Parameters:

robj - object to draw

gidx - triangle group to draw

rinst - instance to draw

getVersionedObject

public GL2VersionedObject getVersionedObject(com.jogamp.opengl.GL2 gl,
                                             RenderKey key,
                                             java.lang.Object fingerPrint,
                                             BooleanHolder compile)

Gets or allocates a "versioned object" given a key, and a "fingerprint" used to determine if the stored object has different content

Parameters:

key - key for accessing display list

fingerPrint - identification for detecting if display list needs to be updated

compile - outputs true if object needs to be compiled

Returns:

the display list, negative if it needs to be re-compiled

hasVertexColorMixing

public boolean hasVertexColorMixing(Renderer.ColorMixing cmix)

Description copied from interface: Renderer

Queries whether or not a specified method for combining vertex coloring and material coloring is supported by this Renderer.

Specified by:

hasVertexColorMixing in interface Renderer

Specified by:

hasVertexColorMixing in class GLViewer

Returns:

true if the color mixing method is supported

hasColorMapMixing

public boolean hasColorMapMixing(Renderer.ColorMixing cmix)

Description copied from interface: Renderer

Queries whether or not a specified method for combining color map and material coloring is supported by this Renderer.

Specified by:

hasColorMapMixing in interface Renderer

Specified by:

hasColorMapMixing in class GLViewer

Returns:

true if the color mixing method is supported

hasColorMapping

public boolean hasColorMapping()

Description copied from interface: Renderer

Queries whether or not this renderer supports color mapping.

Specified by:

hasColorMapping in interface Renderer

Returns:

true if color mapping is supported.

hasNormalMapping

public boolean hasNormalMapping()

Description copied from interface: Renderer

Queries whether or not this renderer supports normal mapping.

Specified by:

hasNormalMapping in interface Renderer

Returns:

true if normal mapping is supported.

hasBumpMapping

public boolean hasBumpMapping()

Description copied from interface: Renderer

Queries whether or not this renderer supports bump mapping.

Specified by:

hasBumpMapping in interface Renderer

Returns:

true if bump mapping is supported.