Viewer (Artisynth API documentation)

All Superinterfaces:

Renderer

All Known Implementing Classes:

GL2Viewer, GL3Viewer, GLViewer
```
public interface Viewer
extends Renderer
```
A viewer is a component that takes a collection of renderables and renders them for a given viewpoint and set of lighting conditions. It also implements the interface Renderable, which provides the primary functionality by which renderables can render themselves.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Viewer.RotationMode` Controls how the viewer responds to rotation control inputs specified as horizontal and vertical angular displacements in the viewing plane.
`static class`	`Viewer.ViewControlMask` Constrains view control motions along either x or y.

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 inherited from interface maspack.render.Renderer
  HIGHLIGHT, SORT_FACES

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GLClipPlane`	`addClipPlane()` Creates and add a clip plane to this viewer.
`void`	`addClipPlane(GLClipPlane clipPlane)` Adds a clip plane to this viewer.
`GLClipPlane`	`addClipPlane(RigidTransform3d TPW, double size)` Creates and add a clip plane to this viewer.
`void`	`addDragger(Dragger3d d)` Adds an application-defined dragger fixture to this viewer.
`void`	`addKeyListener(java.awt.event.KeyListener l)` Adds a key listener to this viewer.
`int`	`addLight(Light light)` Adds a specified light to this viewer and enables it.
`void`	`addMouseInputListener(javax.swing.event.MouseInputListener l)` Adds a mouse input listener to this viewer.
`void`	`addRenderable(IsRenderable r)` Adds a renderable to this viewer.
`void`	`addRenderListener(RenderListener l)` Adds a render listener to this viewer.
`void`	`addSelectionListener(ViewerSelectionListener l)` Adds a selection listener to this viewer that will fire whenever objects are selected.
`void`	`autoFit()` Calls either `autoFitOrtho()` or `autoFitPerspective()`, depending on whether the current view is orthogonal or perspective.
`void`	`autoFitOrtho()` Auto computes the eye and center positions and an orthogonal viewing frustum to fit the current scence.
`void`	`autoFitPerspective()` Auto computes the eye and center positions and an perpective viewing frustum to fit the current scence.
`void`	`clearClipPlanes()` Removes all clip planes from this viewer.
`void`	`clearDraggers()` Removes all application-defined dragger fixtures from this viewer.
`void`	`clearRenderables()` Removes all renderables from this viewer.
`void`	`dispose()` Disposes of the resources used by this viewer.
`java.util.List<Dragger3d>`	`getAllDraggers()` Returns a list of all draggers currently active for this viewer, including those that are application-defined as well as those those that are created internally.
`AxisAlignedRotation`	`getAxialView()` Returns the current axis-aligned view.
`double`	`getAxisLength()` Queries the length used for rendering coordinate axes in this viewer.
`java.awt.Color`	`getBackgroundColor()` Returns the background color for this viewer.
`float[]`	`getBackgroundColor(float[] rgba)` Returns the background color for this viewer.
`RigidTransform3d`	`getCenterToWorld()` Returns a transform from world coordinates to center coordinates.
`void`	`getCenterToWorld(RigidTransform3d TCW)` Returns a transform from world coordinates to center coordinates, with the axes aligned to match the current eyeToWorld transform.
`GLClipPlane`	`getClipPlane(int idx)` Returns the `idx`-th clip plane held by this viewer.
`GLClipPlane[]`	`getClipPlanes()` Returns all the clip planes currently held by this viewer.
`java.awt.Component`	`getComponent()` Queries the AWT component associated with this viewer.
`java.awt.Rectangle`	`getDragBox()` Queries information about any drag box currently being displayed.
`java.util.LinkedList<Dragger3d>`	`getDraggers()` Returns a list of all application-defined draggers currently added to this viewer.
`Dragger3d`	`getDrawTool()` Queries the draw tool, if any, for this viewer.
`boolean`	`getEllipticCursorActive()` Queries whether an elliptic cursor is active for this viewer.
`Vector2d`	`getEllipticCursorSize()` Queries the elliptic cursor size for this viewer.
`boolean`	`getEllipticSelection()` Queries whether elliptic selection is enabled for this viewer.
`RenderList`	`getExternalRenderList()` Returns the external render list for this viewer, or `null` if the viewer does not have an external render list.
`Point3d`	`getEye()` Returns the eye position.
`void`	`getEyeToWorld(RigidTransform3d TEW)` Gets the eye-to-world transform for this viewer.
`GridPlane`	`getGrid()` Returns this viewer's grid.
`boolean`	`getGridVisible()` Queries whether the viewer grid is visible.
`java.awt.Color`	`getHighlightColor()` Queries the highlight color used by this viewer.
`Renderer.HighlightStyle`	`getHighlightStyle()` Queries the highlighting style for this viewer.
`int`	`getIndexOfLight(Light light)` Get the index of a specified light in this viewer.
`java.awt.event.KeyListener[]`	`getKeyListeners()` Returns the key listeners currently added to this viewer.
`Light`	`getLight(int idx)` Get a specified light by index in this viewer.
`javax.swing.event.MouseInputListener[]`	`getMouseInputListeners()` Returns the mouse input listeners currently added to this viewer.
`int`	`getNumClipPlanes()` Queries the number of clip planes currently held by this viewer.
`RenderListener[]`	`getRenderListeners()` Returns an array of all render listeners held by this viewer.
`Viewer.RotationMode`	`getRotationMode()` Queries the rotation mode that controls how the viewer responds to interactive rotation requests.
`java.awt.Cursor`	`getScreenCursor()` Queries the screen cursor for this viewer.
`int`	`getScreenX()` Returns the x component of the origin of the component implementing this viewer.
`int`	`getScreenY()` Returns the y component of the origin of the component implementing this viewer.
`ViewerSelectionFilter`	`getSelectionFilter()` Returns the current selection filter for the viewer, if any.
`ViewerSelectionListener[]`	`getSelectionListeners()` Returns a list of all the selection listener in this viewer.
`boolean`	`getSelectOnPress()` Returns true if "select on press" is enabled for the viewers.
`Vector3d`	`getUpVector()` Returns the ``up'' vector which this viewer uses in some instances to determine the direction of the y axis of the eye coordinate system.
`double`	`getVerticalFieldOfView()` Returns the default vertical field of view in degrees.
`Viewer.ViewControlMask`	`getViewControlMask()` Queries the view control mask.
`boolean`	`hasHighlightStyle(Renderer.HighlightStyle style)` Returns `true` if this viewer supports the indicated highlighting style.
`boolean`	`isOrthogonal()` Returns true if the current viewing projection is orthogonal.
`boolean`	`isSelectionEnabled()` Returns `true` if viewer-based selection is enabled.
`int`	`maxClipSurfaces()` Queries the maximum number of clip surfaces available to this viewer.
`int`	`numFreeClipSurfaces()` Queries the number of clip surfaces currently available to this viewer.
`int`	`numLights()` Returns the number of lights in this viewer.
`boolean`	`removeClipPlane(GLClipPlane clipPlane)` Removes a clip plane from this viewer.
`void`	`removeDragger(Dragger3d d)` Removes an application-defined dragger fixture from this viewer.
`void`	`removeKeyListener(java.awt.event.KeyListener l)` Removes a key listener from this viewer.
`void`	`removeLight(int idx)` Removes the light with the specified index from this viewer.
`boolean`	`removeLight(Light light)` Removes the indicated light from this viewer.
`void`	`removeMouseInputListener(javax.swing.event.MouseInputListener l)` Removes a mouse input listener from this viewer.
`boolean`	`removeRenderable(IsRenderable r)` Removes a renderable from this viewer.
`boolean`	`removeRenderListener(RenderListener l)` Removes a render listener from this viewer.
`boolean`	`removeSelectionListener(ViewerSelectionListener l)` Removes a selection listener from this viewer.
`void`	`repaint()` Request a repaint operation for this viewer.
`void`	`rerender()` Convenience methods that calls `rerender(int)` with `flags` = 0.
`void`	`rerender(int flags)` Performs a rerender for this viewer.
`void`	`resetEllipticCursorSize()` Resets the elliptic cursor size for this viewer to its default value.
`void`	`rotate(double xang, double yang)` Rotate the eye coordinate frame about the center point.
`void`	`setAxialView(AxisAlignedRotation REW)` Sets an axial (or axis-aligned) view.
`void`	`setAxisLength(double len)` Sets the length used for rendering coordinate axes in this viewer.
`void`	`setBackgroundColor(java.awt.Color color)` Sets the background color for this viewer.
`void`	`setBackgroundColor(float[] rgba)` Sets the background color for this viewer.
`void`	`setBackgroundColor(float r, float g, float b)` Sets the background color for this viewer.
`void`	`setCenter(Point3d center)` Sets the center point for the viewer, and adjusts the eye-to-world transform so that the eye's -z axis is directed at the center point.
`void`	`setDragBox(java.awt.Rectangle box)` Sets a drag box to be displayed by the viewer.
`void`	`setDrawTool(Dragger3d d)` Sets the draw tool for this viewer.
`void`	`setEllipticCursorActive(boolean active)` Sets whether an elliptic cursor is active for this viewer.
`void`	`setEllipticCursorSize(Vector2d size)` Sets the elliptic cursor size for this viewer.
`void`	`setEllipticSelection(boolean enable)` Set whether elliptic selection is enabled for this viewer.
`void`	`setExternalRenderList(RenderList list)` Sets the external render list for this viewer.
`void`	`setEye(Point3d eye)` Sets the eye coordinates to a specified location in world coordinates, and adjusts the eye-to-world transform so that the eye's -z axis is directed at the center point.
`void`	`setEyeToWorld(Point3d eye, Point3d center, Vector3d up)` Sets the eye-to-world transform for this viewer, using the canonical parameters used by the GL `lookat` method.
`void`	`setEyeToWorld(RigidTransform3d TEW)` Sets the eye-to-world transform for this viewer.
`void`	`setGridSizeAndPosition(Point3d pcenter, double r)` Sets the position and minimum size of the viewer grid.1`
`void`	`setGridVisible(boolean visible)` Sets the viewer grid to be visible.
`void`	`setHighlightColor(java.awt.Color color)` Sets the highlight color used by this viewer.
`boolean`	`setHighlightStyle(Renderer.HighlightStyle style)` Sets the highlighting style for this viewer.
`void`	`setOrthogonal(double fieldHeight, double near, double far)` Sets the viewing frustum to an orthogonal projection centered about the -z axis.
`void`	`setOrthogonal(double left, double right, double bottom, double top, double near, double far)` Sets the viewing frustum to a general orthogonal projection.
`void`	`setOrthographicView(boolean enable)` Calls `autoFitOrtho()` or `autoFitPerspective()` depending on whether `enable` is `true` or `false`.
`void`	`setPerspective(double fieldOfView, double near, double far)` Sets the viewing frustum to a perspective projection centered about the -z axis.
`void`	`setPerspective(double left, double right, double bottom, double top, double near, double far)` Sets the viewing frustum to a general perspective projection.
`void`	`setRotationMode(Viewer.RotationMode mode)` Sets the rotation mode that controls how the viewer responds to interactive rotation requests specified as horizontal and vertical angular displacements in the view plane.
`void`	`setScreenCursor(java.awt.Cursor cursor)` Sets the screen cursor for this viewer.
`void`	`setSelectionEnabled(boolean enable)` Enables or disables viewer-based selection.
`void`	`setSelectionFilter(ViewerSelectionFilter filter)` Sets a selection filter for the viewer.
`void`	`setSelectOnPress(boolean enable)` Set whether or not selection is done when the mouse is pressed.
`void`	`setUpVector(Vector3d up)` Sets the ``up'' vector for this viewer to a specified value, and adjusts the eye-to-world transform to account for this new vertical direction, while the eye's -z axis is directed at the center point.
`void`	`setVerticalFieldOfView(double fov)` Sets the default vertical field of view in degrees.
`void`	`setViewControlMask(Viewer.ViewControlMask mask)` Sets the view control mask that constrains view control motions to either the x or y screens axes.
`void`	`setViewMatrix(RigidTransform3d TWE)` Sets the view matrix for this viewer.
`void`	`translate(double delx, double dely)` Translate the eye position with respect to the x-y plane of the eye frame.
`void`	`zoom(double s)` Zoom in or out by a specified scale factor.

Methods inherited from interface maspack.render.Renderer
addVertex, addVertex, addVertex, addVertex, begin2DRendering, begin2DRendering, beginDraw, beginSelectionQuery, beginSubSelection, centerDistancePerPixel, distancePerPixel, draw, drawArrow, drawArrow, drawArrow, drawArrow, drawAxes, drawAxes, drawAxes, drawAxes, drawBox, drawBox, drawBox, drawCone, drawCone, drawCube, drawCube, drawCylinder, drawCylinder, drawLine, drawLine, drawLine, drawLine, drawLine, drawLine, drawLine, drawLines, drawLines, drawLines, drawLines, drawLines, drawLines, drawLineStrip, drawPoint, drawPoint, drawPoint, drawPoint, drawPoint, drawPoints, drawPoints, drawPoints, drawPoints, drawPoints, drawPoints, drawRay, drawSolidAxes, drawSolidAxes, drawSphere, drawSphere, drawSpindle, drawSpindle, drawText, drawText, drawText, drawText, drawTriangle, drawTriangle, drawTriangles, drawTriangles, drawTriangles, drawTriangles, drawVertices, drawVertices, drawVertices, end2DRendering, endDraw, endSelectionQuery, endSubSelection, getAxisRadiusRatio, getBackColor, getBumpMap, getCenter, getColorInterpolation, getColorMap, getDefaultFont, getDepthOffset, getEmission, getEyeZDirection, getFaceStyle, getFarPlaneDistance, getFrontColor, getHighlightColor, getHighlighting, getLineWidth, getModelMatrix, getModelMatrix, getNormalMap, getPointSize, getScreenHeight, getScreenWidth, getShading, getShininess, getSpecular, getSurfaceResolution, getTextBounds, getTextureMatrix, getTextureMatrix, getVertexColorMixing, getViewMatrix, getViewMatrix, getViewPlaneDistance, getViewPlaneHeight, getViewPlaneWidth, has2DRendering, hasBumpMapping, hasColorMapMixing, hasColorMapping, hasNormalMapping, hasSelection, hasTextRendering, hasVertexColorMixing, is2DRendering, isSelectable, isSelecting, mulModelMatrix, popModelMatrix, pushModelMatrix, restoreDefaultState, rotateModelMatrix, scaleModelMatrix, setAxisRadiusRatio, setBackColor, setBumpMap, setColor, setColor, setColor, setColor, setColor, setColorInterpolation, setColorMap, setDefaultFont, setDepthOffset, setEdgeColoring, setEmission, setFaceColoring, setFaceColoring, setFaceStyle, setFrontAlpha, setFrontColor, setHighlighting, setLineColoring, setLineShading, setLineWidth, setModelMatrix, setModelMatrix2d, setNormal, setNormal, setNormal, setNormalMap, setPointColoring, setPointShading, setPointSize, setPropsColoring, setPropsShading, setShading, setShininess, setSpecular, setSurfaceResolution, setTextureCoord, setTextureCoord, setTextureCoord, setTextureMatrix, setVertexColorMixing, translateModelMatrix

- Method Detail
  - addRenderable
```
void addRenderable(IsRenderable r)
```
    Adds a renderable to this viewer.
    
    Parameters:
    
    r - renderable to add
  - removeRenderable
```
boolean removeRenderable(IsRenderable r)
```
    Removes a renderable from this viewer.
    
    Parameters:
    
    r - renderable to remove
    
    Returns:
    
    true if r was present and removed
  - clearRenderables
```
void clearRenderables()
```
    Removes all renderables from this viewer.
  - setExternalRenderList
```
void setExternalRenderList(RenderList list)
```
    Sets the external render list for this viewer. This is a list of renderables that is maintained independently of the set of renderables maintained by addRenderable(maspack.render.IsRenderable), removeRenderable(maspack.render.IsRenderable), etc.
    Generally, if an application specifies an external render list, it should rebuild that list prior to each invocation of this viewer's rerender(int) method. This is typically dones as follows:
```
    RenderList extList;
    ...
    extList.clear();
    for (every external renderable r) {
       extList.addIfVisible (r);
    }
 
```
    The call to addIfVisible() will place r onto the render list (if it is visible) and also call its prerender() method. Note in particular that prerender() will not be called by the viewer.
    External render lists are designed for situations where a set of renderables is being rendered simultaneously by multiple viewers, and consequently we don't want prerender() to be called multiple times by different viewers.
    Parameters:
    
    list - new external render list, or null to clear the external list
  - getExternalRenderList
```
RenderList getExternalRenderList()
```
    Returns the external render list for this viewer, or null if the viewer does not have an external render list.
    
    Returns:
    
    external render list
  - rerender
```
void rerender()
```
    Convenience methods that calls rerender(int) with flags = 0.
  - rerender
```
void rerender(int flags)
```
    Performs a rerender for this viewer. This does the following:
    1. Calls the prerender() method for all renderables in the viewer and collects them into an internal render list;
    2. Requests a repaint for the viewer, during which it will call the render() method for all renderables in both the internal render list and the external render list (if specified).
    The render() methods are called with this viewer as the renderer and the flags argument as the flags.
    Parameters:
    
    flags - rendering flags
  - repaint
```
void repaint()
```
    Request a repaint operation for this viewer.
  - addRenderListener
```
void addRenderListener(RenderListener l)
```
    Adds a render listener to this viewer. Render listeners are fired every time the viewer performs a repaint.
    
    Parameters:
    
    l - render listener to add.
  - removeRenderListener
```
boolean removeRenderListener(RenderListener l)
```
    Removes a render listener from this viewer.
    
    Parameters:
    
    l - render listener to remove
    
    Returns:
    
    true if l was present and removed.
  - getRenderListeners
```
RenderListener[] getRenderListeners()
```
    Returns an array of all render listeners held by this viewer.
    
    Returns:
    
    all render listeners
  - getHighlightStyle
```
Renderer.HighlightStyle getHighlightStyle()
```
    Queries the highlighting style for this viewer.
    
    Specified by:
    
    getHighlightStyle in interface Renderer
    
    Returns:
    
    current highlighting style
  - setHighlightStyle
```
boolean setHighlightStyle(Renderer.HighlightStyle style)
```
    Sets the highlighting style for this viewer. If the style is specified as Renderer.HighlightStyle.NONE, then highlighting is deactivated. Not all highlighting styles may be supported; if the specified style is not supported this method does nothing and returns false.
    
    Parameters:
    
    style - highlighting style to be set
    
    Returns:
    
    true if the highlighting style is supported.
    
    See Also:
    
    hasHighlightStyle(maspack.render.Renderer.HighlightStyle)
  - hasHighlightStyle
```
boolean hasHighlightStyle(Renderer.HighlightStyle style)
```
    Returns true if this viewer supports the indicated highlighting style.
    
    Returns:
    
    true if style is supported
  - setHighlightColor
```
void setHighlightColor(java.awt.Color color)
```
    Sets the highlight color used by this viewer.
    
    Parameters:
    
    color - new highlight color
  - getHighlightColor
```
java.awt.Color getHighlightColor()
```
    Queries the highlight color used by this viewer.
    
    Returns:
    
    viewer highlight color
  - setSelectionEnabled
```
void setSelectionEnabled(boolean enable)
```
    Enables or disables viewer-based selection. If this viewer does not support selection (i.e., if Renderer.hasSelection() returns false, then this method does nothing.
    
    Parameters:
    
    enable - if true, enables selection
  - isSelectionEnabled
```
boolean isSelectionEnabled()
```
    Returns true if viewer-based selection is enabled.
    
    Returns:
    
    false if selection is disabled or not supported.
  - setEllipticSelection
```
void setEllipticSelection(boolean enable)
```
    Set whether elliptic selection is enabled for this viewer. Elliptic selection is selection style in which an elliptic cursor is used to ``paint'' the current set of selected components.
    
    Parameters:
    
    enable - if true, enables elliptic selection
    
    See Also:
    
    getEllipticSelection()
  - getEllipticSelection
```
boolean getEllipticSelection()
```
    Queries whether elliptic selection is enabled for this viewer.
    
    Returns:
    
    true if elliptic selection is enabled
    
    See Also:
    
    setEllipticSelection(boolean)
  - setSelectOnPress
```
void setSelectOnPress(boolean enable)
```
    Set whether or not selection is done when the mouse is pressed. If enabled, this automatically diables "drag selection".
    
    Parameters:
    
    enable - Whether or not selection is enabled.
  - getSelectOnPress
```
boolean getSelectOnPress()
```
    Returns true if "select on press" is enabled for the viewers.
    
    Returns:
    
    true if "select on press" is enabled
  - setSelectionFilter
```
void setSelectionFilter(ViewerSelectionFilter filter)
```
    Sets a selection filter for the viewer. This restricts which objects are actually rendered when a selection render is performed, and therefore restricts which objects can actually be selected. This allows selection of objects that might otherwise be occluded within a scene.
    
    Parameters:
    
    filter - Selection filter to be applied
  - getSelectionFilter
```
ViewerSelectionFilter getSelectionFilter()
```
    Returns the current selection filter for the viewer, if any.
    
    Returns:
    
    current selection filter, or null if there is none.
  - addLight
```
int addLight(Light light)
```
    Adds a specified light to this viewer and enables it. In some cases, the added light may exceed the number of lights supported by the renderer. In that case, the light will still be added but will not be enabled.
    Changes to the lighting caused by adding or removing lights, or by changing the properties of existing lights, will take effect at the beginning of the next repaint step.
    
    Parameters:
    
    light - light to add to the viewer
    
    Returns:
    
    index of the added light
  - numLights
```
int numLights()
```
    Returns the number of lights in this viewer. This number will include both predefined lights as well as those specifically defined by the application.
  - getLight
```
Light getLight(int idx)
```
    Get a specified light by index in this viewer. Lights will include both predefined lights as well as those specifically defined by the application.
    
    Parameters:
    
    idx - index of the light
  - getIndexOfLight
```
int getIndexOfLight(Light light)
```
    Get the index of a specified light in this viewer.
    
    Parameters:
    
    light - light for which an index is sought
    
    Returns:
    
    Index of the light, or -1 if the viewer does not contain the light.
  - removeLight
```
boolean removeLight(Light light)
```
    Removes the indicated light from this viewer.
    Changes to the lighting caused by adding or removing lights, or by changing the properties of existing lights, will take effect at the beginning of the next repaint step.
    
    Parameters:
    
    light - light to be removed
    
    Returns:
    
    true if the viewer contained the light and it was removed
  - removeLight
```
void removeLight(int idx)
```
    Removes the light with the specified index from this viewer.
    Changes to the lighting caused by adding or removing lights, or by changing the properties of existing lights, will take effect at the beginning of the next repaint step.
    
    Parameters:
    
    idx - index of the light to be removed
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the specified index was not in the range 0 to numLights()-1.
  - getBackgroundColor
```
java.awt.Color getBackgroundColor()
```
    Returns the background color for this viewer.
    
    Returns:
    
    background color
  - getBackgroundColor
```
float[] getBackgroundColor(float[] rgba)
```
    Returns the background color for this viewer. The color is returned as a float array describing the color's RGBA values in the range [0,1]. The returned array can be provided through the argument rgba. Otherwise, if this argument is null, an array is allocated internally.
    
    Parameters:
    
    rgba - optional array for returning the values
    
    Returns:
    
    rgba array describing the background color
  - setBackgroundColor
```
void setBackgroundColor(java.awt.Color color)
```
    Sets the background color for this viewer.
    
    Parameters:
    
    color - new background color
  - setBackgroundColor
```
void setBackgroundColor(float r,
                        float g,
                        float b)
```
    Sets the background color for this viewer.
    
    Parameters:
    
    r - red color component
    
    g - red color component
    
    b - red color component
  - setBackgroundColor
```
void setBackgroundColor(float[] rgba)
```
    Sets the background color for this viewer.
    
    Parameters:
    
    rgba - RGB (if length 3) or RGBA values (if length 4) for the background color
  - setEyeToWorld
```
void setEyeToWorld(Point3d eye,
                   Point3d center,
                   Vector3d up)
```
    Sets the eye-to-world transform for this viewer, using the canonical parameters used by the GL lookat method. The eye-to-world transform is the inverse of the view matrix.
    
    Parameters:
    
    eye - position of the eye, in world coordinates
    
    center - point that the eye is looking at, in world coordinates
    
    up - up direction, in world coordinates
  - setEyeToWorld
```
void setEyeToWorld(RigidTransform3d TEW)
```
    Sets the eye-to-world transform for this viewer. This is the inverse of the view matrix.
    
    Parameters:
    
    TEW - new eye-to-world transform
  - getEyeToWorld
```
void getEyeToWorld(RigidTransform3d TEW)
```
    Gets the eye-to-world transform for this viewer. This is the inverse of the view matrix.
    
    Parameters:
    
    TEW - returns the eye-to-world transform
  - getCenterToWorld
```
void getCenterToWorld(RigidTransform3d TCW)
```
    Returns a transform from world coordinates to center coordinates, with the axes aligned to match the current eyeToWorld transform. Seen through the viewer, this will appear centered on the view frame with z pointing toward the view, y pointing up, and x pointing to the right.
    
    Parameters:
    
    TCW - returns the center-to-world transform
  - getCenterToWorld
```
RigidTransform3d getCenterToWorld()
```
    Returns a transform from world coordinates to center coordinates. This performs the same function as getCenterToWorld(RigidTransform3d), only with transform allocated and returned.
    
    Returns:
    
    the center-to-world transform
  - rotate
```
void rotate(double xang,
            double yang)
```
    Rotate the eye coordinate frame about the center point. How the rotation angles are processed depends on the rotation mode controlled using setRotationMode(maspack.render.Viewer.RotationMode) and getRotationMode().
    
    Parameters:
    
    xang - amount of horizontal rotation (in radians)
    
    yang - amount of vertical rotation (in radians)
  - translate
```
void translate(double delx,
               double dely)
```
    Translate the eye position with respect to the x-y plane of the eye frame. The center point is translated by the same amount.
    
    Parameters:
    
    delx - x translation amount
    
    dely - y translation amount
  - zoom
```
void zoom(double s)
```
    Zoom in or out by a specified scale factor. A factor larger than one zooms out, while a factor less than one zooms in. In orthographic projection, zoom is accomplished changing the frustum size. In perspective projection, it is accomplished by moving the eye position along the z axis of the eye frame.
    
    Parameters:
    
    s - scale factor
  - setRotationMode
```
void setRotationMode(Viewer.RotationMode mode)
```
    Sets the rotation mode that controls how the viewer responds to interactive rotation requests specified as horizontal and vertical angular displacements in the view plane. The default rotation mode is Viewer.RotationMode.FIXED_VERTICAL.
    
    Parameters:
    
    mode - new rotation mode
  - getRotationMode
```
Viewer.RotationMode getRotationMode()
```
    Queries the rotation mode that controls how the viewer responds to interactive rotation requests. See setRotationMode(maspack.render.Viewer.RotationMode).
    
    Returns:
    
    current rotation mode
  - setViewControlMask
```
void setViewControlMask(Viewer.ViewControlMask mask)
```
    Sets the view control mask that constrains view control motions to either the x or y screens axes.
    
    Parameters:
    
    mask - new view control mask
  - getViewControlMask
```
Viewer.ViewControlMask getViewControlMask()
```
    Queries the view control mask. See setViewControlMask(maspack.render.Viewer.ViewControlMask).
    
    Returns:
    
    current view control mask
  - setAxialView
```
void setAxialView(AxisAlignedRotation REW)
```
    Sets an axial (or axis-aligned) view. This is done by setting the rotational part of the eye-to-world transform to the axis-aligned rotation REW, and then moving the eye position so that the center position lies along the new -z axis of the eye frame, while maintaining the current distance between the eye and the center.
    The method also sets this viewer's `up'' vector to the y axis of REW, and saves REW itself as the current axis-aligned view, which can be retrieved using getAxialView().
    
    Parameters:
    
    REW - axis-aligned rotational component for the eye-to-world transform
    
    See Also:
    
    getAxialView(), setUpVector(maspack.matrix.Vector3d), getUpVector()
  - getAxialView
```
AxisAlignedRotation getAxialView()
```
    Returns the current axis-aligned view. This is either the one with which the viewer was initialized, or that most recently set by setAxialView(maspack.matrix.AxisAlignedRotation).
    
    Returns:
    
    current axis-aligned view.
    
    See Also:
    
    setAxialView(maspack.matrix.AxisAlignedRotation)
  - setViewMatrix
```
void setViewMatrix(RigidTransform3d TWE)
```
    Sets the view matrix for this viewer. This is the transform from world to eye coordinates.
    
    Parameters:
    
    TWE - transform from world to eye coordinates.
  - getEye
```
Point3d getEye()
```
    Returns the eye position. This corresponds to the translational component of the eye-to-world transform.
    
    Returns:
    
    eye position, in world coordinates
  - setCenter
```
void setCenter(Point3d center)
```
    Sets the center point for the viewer, and adjusts the eye-to-world transform so that the eye's -z axis is directed at the center point. The vertical direction is specified by the current up vector. This is equivalent to
```
 setEyeToWorld (getEye(), center, getUpVector());
 
```
    Parameters:
    
    center - new center location, in world coordinates
    
    See Also:
    
    getUpVector()
  - setEye
```
void setEye(Point3d eye)
```
    Sets the eye coordinates to a specified location in world coordinates, and adjusts the eye-to-world transform so that the eye's -z axis is directed at the center point. The vertical direction is specified by the current up vector. This is equivalent to
```
 setEyeToWorld (eye, getCenter(), getUpVector());
 
```
    Parameters:
    
    eye - new eye location, in world coordinates
    
    See Also:
    
    Renderer.getCenter(), getUpVector()
  - setUpVector
```
void setUpVector(Vector3d up)
```
    Sets the ``up'' vector for this viewer to a specified value, and adjusts the eye-to-world transform to account for this new vertical direction, while the eye's -z axis is directed at the center point. This is equivalent to
```
 setEyeToWorld (getEye(), getCenter(), up);
 
```
    Parameters:
    
    up - new up vector, in world coordinates
    
    See Also:
    
    getEye(), Renderer.getCenter()
  - getUpVector
```
Vector3d getUpVector()
```
    Returns the ``up'' vector which this viewer uses in some instances to determine the direction of the y axis of the eye coordinate system.
    
    Returns:
    
    up vector, in world coordinates
    
    See Also:
    
    setUpVector(maspack.matrix.Vector3d), setCenter(maspack.matrix.Point3d), setEye(maspack.matrix.Point3d)
  - setPerspective
```
void setPerspective(double left,
                    double right,
                    double bottom,
                    double top,
                    double near,
                    double far)
```
    Sets the viewing frustum to a general perspective projection. This is done by specifying the edges locations of the view plane (i.e., the near clipping plane) with respect to the x-y plane of the eye coordinates, while also specifying the distances of the view plane and far clipping plane along the -z axis.
    
    Parameters:
    
    left - left edge position of the view plane
    
    right - right edge position of the view plane
    
    bottom - bottom edge position of the near clipping plane
    
    top - top position of the near clipping plane
    
    near - near clipping plane position (along the -z axis; must be a positive number)
    
    far - far clipping plane position (along the -z axis; must be a positive number)
  - setPerspective
```
void setPerspective(double fieldOfView,
                    double near,
                    double far)
```
    Sets the viewing frustum to a perspective projection centered about the -z axis. This is done by specifying the vertical field of view, along with the distances of the view plane and far clipping plane along the -z axis. The field of view setting is also used to update the value returned by getVerticalFieldOfView.
    
    Parameters:
    
    fieldOfView - vertial field of view (in degrees)
    
    near - near clipping plane position (along the -z axis; must be a positive number)
    
    far - far clipping plane position (along the -z axis; must be a positive number)
  - setOrthogonal
```
void setOrthogonal(double left,
                   double right,
                   double bottom,
                   double top,
                   double near,
                   double far)
```
    Sets the viewing frustum to a general orthogonal projection. This is done by specifying the edges locations of the view plane (i.e., the near clipping plane) with respect to the x-y plane of the eye coordinates, while also specifying the distances of the view plane and far clipping plane along the -z axis.
    
    Parameters:
    
    left - left edge position of the near clipping plane
    
    right - right edge position of the near clipping plane
    
    bottom - bottom edge position of the near clipping plane
    
    top - top position of the near clipping plane
    
    near - near clipping plane position (along the -z axis; must be a positive number)
    
    far - far clipping plane position (along the -z axis; must be a positive number)
  - setOrthogonal
```
void setOrthogonal(double fieldHeight,
                   double near,
                   double far)
```
    Sets the viewing frustum to an orthogonal projection centered about the -z axis. This is done by specifying the vertical height of the field of view, along with the distances of the view plane and far clipping plane along the -z axis.
    
    Parameters:
    
    fieldHeight - vertical height of the field of view
    
    near - near clipping plane position (along the -z axis; must be a positive number)
    
    far - far clipping plane position (along the -z axis; must be a positive number)
  - autoFit
```
void autoFit()
```
    Calls either autoFitOrtho() or autoFitPerspective(), depending on whether the current view is orthogonal or perspective.
  - autoFitOrtho
```
void autoFitOrtho()
```
    Auto computes the eye and center positions and an orthogonal viewing frustum to fit the current scence. This makes use of the IsRenderable.updateBounds(maspack.matrix.Vector3d, maspack.matrix.Vector3d) method of all the renderables to estimate the scene center and an approximate radius r. It then computes a distance d from the center to the eye using r = d tan(fov/2), where fov is the field of view returned by getVerticalFieldOfView() and converted to radians. The eye frame orientation is adjusted so that its $y$ axis is parallel to the current value of the ``up'' vector.
    
    See Also:
    
    setUpVector(maspack.matrix.Vector3d), getUpVector()
  - autoFitPerspective
```
void autoFitPerspective()
```
    Auto computes the eye and center positions and an perpective viewing frustum to fit the current scence. This makes use of the IsRenderable.updateBounds(maspack.matrix.Vector3d, maspack.matrix.Vector3d) method of all the renderables to estimate the scene center and an approximate radius r. It then computes a distance d from the center to the eye using r = d tan(fov/2), where fov is the field of view returned by getVerticalFieldOfView() and converted to radians. This field of view also used to used to compute the perspective frustum. The eye frame orientation is adjusted so that its $y$ axis is parallel to the current value of the ``up'' vector.
    
    See Also:
    
    setUpVector(maspack.matrix.Vector3d), getUpVector()
  - setOrthographicView
```
void setOrthographicView(boolean enable)
```
    Calls autoFitOrtho() or autoFitPerspective() depending on whether enable is true or false.
    
    Parameters:
    
    enable - enables (and auto-fits) orthographic view if true and perspective view if false
  - isOrthogonal
```
boolean isOrthogonal()
```
    Returns true if the current viewing projection is orthogonal.
    
    Specified by:
    
    isOrthogonal in interface Renderer
    
    Returns:
    
    true if viewing projection is orthogonal
  - getVerticalFieldOfView
```
double getVerticalFieldOfView()
```
    Returns the default vertical field of view in degrees. This is used by autoFitOrtho() and autoFitPerspective().
    
    Returns:
    
    default vertical field of view (degrees).
  - setVerticalFieldOfView
```
void setVerticalFieldOfView(double fov)
```
    Sets the default vertical field of view in degrees. This is used by autoFitOrtho() and autoFitPerspective().
    
    Parameters:
    
    fov - new default vertical field of view (degrees).
  - addSelectionListener
```
void addSelectionListener(ViewerSelectionListener l)
```
    Adds a selection listener to this viewer that will fire whenever objects are selected.
    
    Parameters:
    
    l - selection listener to add
    
    See Also:
    
    removeSelectionListener(maspack.render.ViewerSelectionListener)
  - removeSelectionListener
```
boolean removeSelectionListener(ViewerSelectionListener l)
```
    Removes a selection listener from this viewer.
    
    Parameters:
    
    l - selection listener to remove
    
    See Also:
    
    addSelectionListener(maspack.render.ViewerSelectionListener)
  - getSelectionListeners
```
ViewerSelectionListener[] getSelectionListeners()
```
    Returns a list of all the selection listener in this viewer.
    
    Returns:
    
    selection listeners in this viewer
    
    See Also:
    
    addSelectionListener(maspack.render.ViewerSelectionListener), removeSelectionListener(maspack.render.ViewerSelectionListener)
  - getAxisLength
```
double getAxisLength()
```
    Queries the length used for rendering coordinate axes in this viewer.
    
    Returns:
    
    axis rendering length
  - setAxisLength
```
void setAxisLength(double len)
```
    Sets the length used for rendering coordinate axes in this viewer. A length <= 0 implies that coordinate axes will not be rendered.
    
    Parameters:
    
    len - axis rendering length
  - setGridVisible
```
void setGridVisible(boolean visible)
```
    Sets the viewer grid to be visible.
    
    Parameters:
    
    visible - if true, makes the grid visible
  - setGridSizeAndPosition
```
void setGridSizeAndPosition(Point3d pcenter,
                            double r)
```
    Sets the position and minimum size of the viewer grid.1`
    
    Parameters:
    
    pcenter - position of the grid center
    
    r - radius value, which equals 1/4 the minimum size
  - getGridVisible
```
boolean getGridVisible()
```
    Queries whether the viewer grid is visible.
    
    Returns:
    
    true if the grid is visible
  - getGrid
```
GridPlane getGrid()
```
    Returns this viewer's grid.
    
    Returns:
    
    viewer grid
  - maxClipSurfaces
```
int maxClipSurfaces()
```
    Queries the maximum number of clip surfaces available to this viewer. This depends on the underlying graphics implementation. Each clip plane held by the viewer will require one surface if clipping is enabled, or two surfaces if slicing is enabled. Clipping will be curtailed if the total number of required clip surfaces exceeds the maximum.
    
    Returns:
    
    maximum number of clip surfaces
  - numFreeClipSurfaces
```
int numFreeClipSurfaces()
```
    Queries the number of clip surfaces currently available to this viewer. This will equal the value returned by maxClipSurfaces() minus the number required by all the currently held clip planes, with the result set to 0 if negative. Clipping will be curtailed if the number of available surfaces is 0.
    
    Returns:
    
    number of currently available clip surfaces
  - addClipPlane
```
GLClipPlane addClipPlane()
```
    Creates and add a clip plane to this viewer. The pose is centered on the origin and aligned with the current axial view, while this size is set to a default value based on the current viewing frustum. This method is equivalent to calling addClipPlane(null,0).
    
    Returns:
    
    created clip plane
  - addClipPlane
```
GLClipPlane addClipPlane(RigidTransform3d TPW,
                         double size)
```
    Creates and add a clip plane to this viewer.
    
    Parameters:
    
    TPW - transform specifying the clip plane pose with respect to world coordinates. If null, the pose is centered on the origin and aligned with the current axial view.
    
    size - visible width of the clip plane in each direction. If <= 0, this is set to a default value based on the current viewing frustum.
    
    Returns:
    
    created clip plane
  - addClipPlane
```
void addClipPlane(GLClipPlane clipPlane)
```
    Adds a clip plane to this viewer.
    
    Parameters:
    
    clipPlane - clip plane to add
  - getClipPlane
```
GLClipPlane getClipPlane(int idx)
```
    Returns the idx-th clip plane held by this viewer. idx must be < #getNumClipPlanes.
    
    Parameters:
    
    idx - index of the desired clip plane
    
    Returns:
    
    the idx-th clip plane
  - getNumClipPlanes
```
int getNumClipPlanes()
```
    Queries the number of clip planes currently held by this viewer.
    
    Returns:
    
    current number of viewer clip planes
  - getClipPlanes
```
GLClipPlane[] getClipPlanes()
```
    Returns all the clip planes currently held by this viewer.
    
    Returns:
    
    current viewer clip planes
  - removeClipPlane
```
boolean removeClipPlane(GLClipPlane clipPlane)
```
    Removes a clip plane from this viewer.
    
    Parameters:
    
    clipPlane - clip plane to remove
    
    Returns:
    
    true if the clip plane was found and removed
  - clearClipPlanes
```
void clearClipPlanes()
```
    Removes all clip planes from this viewer.
  - addMouseInputListener
```
void addMouseInputListener(javax.swing.event.MouseInputListener l)
```
    Adds a mouse input listener to this viewer.
    
    Parameters:
    
    l - listener to be added
  - removeMouseInputListener
```
void removeMouseInputListener(javax.swing.event.MouseInputListener l)
```
    Removes a mouse input listener from this viewer.
    
    Parameters:
    
    l - listener to be removed
  - getMouseInputListeners
```
javax.swing.event.MouseInputListener[] getMouseInputListeners()
```
    Returns the mouse input listeners currently added to this viewer.
    
    Returns:
    
    current mouse input listeners
  - addKeyListener
```
void addKeyListener(java.awt.event.KeyListener l)
```
    Adds a key listener to this viewer.
    
    Parameters:
    
    l - listener to be added
  - removeKeyListener
```
void removeKeyListener(java.awt.event.KeyListener l)
```
    Removes a key listener from this viewer.
    
    Parameters:
    
    l - listener to be removed
  - getKeyListeners
```
java.awt.event.KeyListener[] getKeyListeners()
```
    Returns the key listeners currently added to this viewer.
    
    Returns:
    
    current key listeners
  - setDrawTool
```
void setDrawTool(Dragger3d d)
```
    Sets the draw tool for this viewer.
    
    Parameters:
    
    d - draw tool to set
  - getDrawTool
```
Dragger3d getDrawTool()
```
    Queries the draw tool, if any, for this viewer.
    
    Returns:
    
    current draw tool, or null if there is none
  - addDragger
```
void addDragger(Dragger3d d)
```
    Adds an application-defined dragger fixture to this viewer.
    
    Parameters:
    
    d - dragger to add
  - removeDragger
```
void removeDragger(Dragger3d d)
```
    Removes an application-defined dragger fixture from this viewer.
    
    Parameters:
    
    d - dragger to remove
  - clearDraggers
```
void clearDraggers()
```
    Removes all application-defined dragger fixtures from this viewer.
  - getDraggers
```
java.util.LinkedList<Dragger3d> getDraggers()
```
    Returns a list of all application-defined draggers currently added to this viewer. The returned list is a copy and may therefore be modified.
    
    Returns:
    
    list of current application-defined draggers
  - getAllDraggers
```
java.util.List<Dragger3d> getAllDraggers()
```
    Returns a list of all draggers currently active for this viewer, including those that are application-defined as well as those those that are created internally. The returned list should not be modified, although the draggers within the list may be.
    This method is intended for use by the mouse input handler that manages dragger activity.
    
    Returns:
    
    list of all currently active draggers
  - getScreenX
```
int getScreenX()
```
    Returns the x component of the origin of the component implementing this viewer.
    
    Returns:
    
    origin x component
  - getScreenY
```
int getScreenY()
```
    Returns the y component of the origin of the component implementing this viewer.
    
    Returns:
    
    origin y component
  - setScreenCursor
```
void setScreenCursor(java.awt.Cursor cursor)
```
    Sets the screen cursor for this viewer.
    
    Parameters:
    
    cursor - new screen cursor
  - getScreenCursor
```
java.awt.Cursor getScreenCursor()
```
    Queries the screen cursor for this viewer.
    
    Returns:
    
    viewer screen cursor
  - getEllipticCursorActive
```
boolean getEllipticCursorActive()
```
    Queries whether an elliptic cursor is active for this viewer.
    
    Returns:
    
    true if an elliptic cursor is active
  - setEllipticCursorActive
```
void setEllipticCursorActive(boolean active)
```
    Sets whether an elliptic cursor is active for this viewer.
    
    Parameters:
    
    active - de true}, activates an elliptic cursor
  - getEllipticCursorSize
```
Vector2d getEllipticCursorSize()
```
    Queries the elliptic cursor size for this viewer.
    
    Returns:
    
    viewer's elliptic cursor size
  - setEllipticCursorSize
```
void setEllipticCursorSize(Vector2d size)
```
    Sets the elliptic cursor size for this viewer.
    
    Parameters:
    
    size - new elliptic cursor size
  - resetEllipticCursorSize
```
void resetEllipticCursorSize()
```
    Resets the elliptic cursor size for this viewer to its default value.
  - setDragBox
```
void setDragBox(java.awt.Rectangle box)
```
    Sets a drag box to be displayed by the viewer. This is a rectangular screen area that is usually selected by a drag operaion. Specifying a null value means that no drag box should be displayed.
    
    Parameters:
    
    box - drag box in screen coordinates, or null if the drag box is to be removed
  - getDragBox
```
java.awt.Rectangle getDragBox()
```
    Queries information about any drag box currently being displayed.
    
    Returns:
    
    rectangle describing the screen coordinates of the current drag box, or null if no box is currently being displayed.
  - getComponent
```
java.awt.Component getComponent()
```
    Queries the AWT component associated with this viewer.
    
    Returns:
    
    viewer AWT component
  - dispose
```
void dispose()
```
    Disposes of the resources used by this viewer.

Interface Viewer

Nested Class Summary

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

Field Summary

Fields inherited from interface maspack.render.Renderer

Method Summary

Methods inherited from interface maspack.render.Renderer

Method Detail

addRenderable

removeRenderable

clearRenderables

setExternalRenderList

getExternalRenderList

rerender

rerender

repaint

addRenderListener

removeRenderListener

getRenderListeners

getHighlightStyle

setHighlightStyle

hasHighlightStyle

setHighlightColor

getHighlightColor

setSelectionEnabled

isSelectionEnabled

setEllipticSelection

getEllipticSelection

setSelectOnPress

getSelectOnPress

setSelectionFilter

getSelectionFilter

addLight

numLights

getLight

getIndexOfLight

removeLight

removeLight

getBackgroundColor

getBackgroundColor

setBackgroundColor

setBackgroundColor

setBackgroundColor

setEyeToWorld

setEyeToWorld

getEyeToWorld

getCenterToWorld

getCenterToWorld

rotate

translate

zoom

setRotationMode

getRotationMode

setViewControlMask

getViewControlMask

setAxialView

getAxialView

setViewMatrix

getEye

setCenter

setEye

setUpVector

getUpVector

setPerspective

setPerspective

setOrthogonal

setOrthogonal

autoFit

autoFitOrtho

autoFitPerspective

setOrthographicView

isOrthogonal

getVerticalFieldOfView

setVerticalFieldOfView

addSelectionListener

removeSelectionListener

getSelectionListeners

getAxisLength

setAxisLength

setGridVisible