ViewerManager (Artisynth API documentation)

java.lang.Object
- artisynth.core.driver.SettingsBase
- - artisynth.core.driver.ViewerManager

All Implemented Interfaces:

HasProperties
```
public class ViewerManager
extends SettingsBase
```
Manages all the viewers used for model rendering.

Field Summary

Fields
Modifier and Type	Field and Description
`static AxisAlignedRotation`	`DEFAULT_AXIAL_VIEW`
`static Renderer.AxisDrawStyle`	`DEFAULT_AXIS_DRAW_STYLE`
`static double`	`DEFAULT_AXIS_RADIUS_RATIO`
`static java.awt.Color`	`DEFAULT_BACKGROUND_COLOR`
`static GLViewer.BlendFactor`	`DEFAULT_BLEND_DEST_FACTOR`
`static GLViewer.BlendFactor`	`DEFAULT_BLEND_SOURCE_FACTOR`
`static boolean`	`DEFAULT_BLENDING`
`static boolean`	`DEFAULT_DRAW_AXES`
`static boolean`	`DEFAULT_DRAW_GRID`
`static Vector2d`	`DEFAULT_ELLIPTIC_CURSOR_SIZE`
`static double`	`DEFAULT_MOUSE_WHEEL_ZOOM_SCALE`
`static boolean`	`DEFAULT_ORTHOGRAPHIC_VIEW`
`static int`	`DEFAULT_REFRESH_FLAGS`
`static Viewer.RotationMode`	`DEFAULT_ROTATION_MODE`
`static java.awt.Color`	`DEFAULT_SELECTION_COLOR`
`static int`	`DEFAULT_SURFACE_RESOLUTION`
`static boolean`	`DEFAULT_TRANSPARENCY_FACE_CULLING`
`static PropertyList`	`myProps`

Constructor Summary

Constructors
Constructor and Description

ViewerManager(boolean createGui)

Constructors
Constructor and Description
`ViewerManager(boolean createGui)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDragger(Dragger3d d)`
`void`	`addKeyListener(java.awt.event.KeyListener listener)` Add a key listener to each of the viewers.
`void`	`addMouseListener(javax.swing.event.MouseInputListener listener)` Add a mouse input listener to each of the viewers.
`void`	`addRenderable(IsRenderable r)`
`void`	`addViewer(GLViewer viewer)`
`void`	`clearDraggers()`
`void`	`clearRenderables()`
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`Renderer.AxisDrawStyle`	`getAxisDrawStyle()`
`double`	`getAxisRadiusRatio()`
`java.awt.Color`	`getBackgroundColor()`
`GLViewer.BlendFactor`	`getBlendDestFactor()`
`GLViewer.BlendFactor`	`getBlendSourceFactor()`
`AxisAlignedRotation`	`getDefaultAxialView()`
`double`	`getDefaultAxisLength()`
`boolean`	`getDefaultDrawAxes()`
`boolean`	`getDefaultDrawGrid()`
`boolean`	`getDefaultOrthographicView()`
`MouseBindings`	`getEffectiveMouseBindings()` Effective mouse bindings are those which are actually passed to the viewers.
`Vector2d`	`getEllipticCursorSize()`
`boolean`	`getEllipticSelection()` Returns true if elliptic selection is enabled for the viewers.
`java.util.ArrayList<java.awt.event.KeyListener>`	`getKeyListeners()`
`MouseBindings`	`getMouseBindings()` Returns the mouse bindings specified using `setMouseBindings(maspack.widgets.MouseBindings)`.
`java.util.ArrayList<javax.swing.event.MouseInputListener>`	`getMouseListeners()`
`double`	`getMouseWheelZoomScale()`
`Property`	`getProperty(java.lang.String name)` Returns a property associated with a specified path name.
`RenderList`	`getRenderList()`
`Viewer.RotationMode`	`getRotationMode()`
`java.awt.Color`	`getSelectionColor()`
`Renderer.HighlightStyle`	`getSelectionHighlightStyle()`
`boolean`	`getSelectOnPress()` Returns true if "select on press" is enabled for the viewers.
`int`	`getSurfaceResolution()`
`boolean`	`getTransparencyBlending()`
`boolean`	`getTransparencyFaceCulling()`
`GLViewer`	`getViewer(int idx)`
`static GLViewer`	`getViewerFromComponent(java.awt.Component comp)` Find the Viewer (if any) associated with a particular component
`boolean`	`isSelectionEnabled()` Returns true if viewer selection is enabled.
`int`	`numViewers()`
`void`	`removeDragger(Dragger3d d)`
`void`	`removeKeyListener(java.awt.event.KeyListener listener)` Remove the specified key listener from each of the viewers.
`void`	`removeMouseListener(javax.swing.event.MouseInputListener listener)` Remove the specified mouse input listener from each of the viewers.
`void`	`removeRenderable(IsRenderable r)`
`boolean`	`removeViewer(Viewer viewer)`
`void`	`render()`
`void`	`repaint()` causes the repaint of the viewers
`void`	`resetEllipticCursorSize()`
`void`	`resetViewer(GLViewer viewer)`
`void`	`resetViewers(AxisAlignedRotation axialView)`
`void`	`resetViewers(AxisAngle frontView)`
`void`	`setAxisDrawStyle(Renderer.AxisDrawStyle style)`
`void`	`setAxisRadiusRatio(double ratio)`
`void`	`setBackgroundColor(java.awt.Color color)`
`void`	`setBlendDestFactor(GLViewer.BlendFactor factor)`
`void`	`setBlendSourceFactor(GLViewer.BlendFactor factor)`
`void`	`setCursor(java.awt.Cursor cursor)` Set the cursor on all the viewers.
`void`	`setDefaultAxialView(AxisAlignedRotation axialView)`
`void`	`setDefaultAxisLength(double l)`
`void`	`setDefaultDrawAxes(boolean drawAxes)`
`void`	`setDefaultDrawGrid(boolean drawGrid)`
`void`	`setDefaultOrthographicView(boolean ortho)`
`void`	`setEllipticCursorSize(Vector2d size)`
`void`	`setEllipticSelection(boolean enable)` Set whether or not elliptic selection is enabled in all the viewers.
`void`	`setMouseBindings(MouseBindings bindings)` Sets the mouse bindings to be used by the viewers.
`void`	`setMouseWheelZoomScale(double scale)`
`void`	`setRotationMode(Viewer.RotationMode mode)`
`void`	`setSelectionColor(java.awt.Color color)`
`void`	`setSelectionEnabled(boolean selection)` Set whether or not selection is being allowed on all the existing viewers.
`void`	`setSelectionHighlightStyle(Renderer.HighlightStyle mode)`
`void`	`setSelectOnPress(boolean enable)` Set whether or not selection is done when the mouse is pressed.
`void`	`setSurfaceResolution(int res)`
`void`	`setTransparencyBlending(boolean enable)`
`void`	`setTransparencyFaceCulling(boolean enable)`

Methods inherited from class artisynth.core.driver.SettingsBase
createDialog, getDialog, getPreferences, setPreferences

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_BACKGROUND_COLOR
```
public static java.awt.Color DEFAULT_BACKGROUND_COLOR
```
  - DEFAULT_SELECTION_COLOR
```
public static java.awt.Color DEFAULT_SELECTION_COLOR
```
  - DEFAULT_AXIS_DRAW_STYLE
```
public static Renderer.AxisDrawStyle DEFAULT_AXIS_DRAW_STYLE
```
  - DEFAULT_AXIS_RADIUS_RATIO
```
public static double DEFAULT_AXIS_RADIUS_RATIO
```
  - DEFAULT_ROTATION_MODE
```
public static Viewer.RotationMode DEFAULT_ROTATION_MODE
```
  - DEFAULT_AXIAL_VIEW
```
public static final AxisAlignedRotation DEFAULT_AXIAL_VIEW
```
  - DEFAULT_ELLIPTIC_CURSOR_SIZE
```
public static Vector2d DEFAULT_ELLIPTIC_CURSOR_SIZE
```
  - DEFAULT_SURFACE_RESOLUTION
```
public static int DEFAULT_SURFACE_RESOLUTION
```
  - DEFAULT_TRANSPARENCY_FACE_CULLING
```
public static boolean DEFAULT_TRANSPARENCY_FACE_CULLING
```
  - DEFAULT_BLENDING
```
public static boolean DEFAULT_BLENDING
```
  - DEFAULT_BLEND_SOURCE_FACTOR
```
public static GLViewer.BlendFactor DEFAULT_BLEND_SOURCE_FACTOR
```
  - DEFAULT_BLEND_DEST_FACTOR
```
public static GLViewer.BlendFactor DEFAULT_BLEND_DEST_FACTOR
```
  - DEFAULT_REFRESH_FLAGS
```
public static final int DEFAULT_REFRESH_FLAGS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MOUSE_WHEEL_ZOOM_SCALE
```
public static final double DEFAULT_MOUSE_WHEEL_ZOOM_SCALE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DRAW_AXES
```
public static final boolean DEFAULT_DRAW_AXES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ORTHOGRAPHIC_VIEW
```
public static final boolean DEFAULT_ORTHOGRAPHIC_VIEW
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DRAW_GRID
```
public static final boolean DEFAULT_DRAW_GRID
```
    See Also:
    
    Constant Field Values
  - myProps
```
public static PropertyList myProps
```
- Constructor Detail
  - ViewerManager
```
public ViewerManager(boolean createGui)
```
- Method Detail
  - getAllPropertyInfo
```
public PropertyList getAllPropertyInfo()
```
    Description copied from interface: HasProperties
    
    Returns a list giving static information about all properties exported by this object.
    
    Returns:
    
    static information for all exported properties
  - getProperty
```
public Property getProperty(java.lang.String name)
```
    Returns a property associated with a specified path name. All properties exported by this object must have a name which is a valid Java identifier. Specifying one of these names causes the corresponding Property to be returned. Handles to subproperties can also be obtained by delimiting the sub-property name(s) by '.' characters. A sub-property exists if the value of a property is itself an object which exports properties. It is only possible to obtain a sub-property handle if each of its ancestor properties exports their values by reference.
    
    Specified by:
    
    getProperty in interface HasProperties
    
    Overrides:
    
    getProperty in class SettingsBase
    
    Parameters:
    
    name - name of the desired property or sub-property
    
    Returns:
    
    handle to the property
  - setDefaultDrawAxes
```
public void setDefaultDrawAxes(boolean drawAxes)
```
  - getDefaultDrawAxes
```
public boolean getDefaultDrawAxes()
```
  - setDefaultDrawGrid
```
public void setDefaultDrawGrid(boolean drawGrid)
```
  - getDefaultDrawGrid
```
public boolean getDefaultDrawGrid()
```
  - setDefaultOrthographicView
```
public void setDefaultOrthographicView(boolean ortho)
```
  - getDefaultOrthographicView
```
public boolean getDefaultOrthographicView()
```
  - setDefaultAxisLength
```
public void setDefaultAxisLength(double l)
```
  - getDefaultAxisLength
```
public double getDefaultAxisLength()
```
  - getEffectiveMouseBindings
```
public MouseBindings getEffectiveMouseBindings()
```
    Effective mouse bindings are those which are actually passed to the viewers. These will equal those specified using setMouseBindings(maspack.widgets.MouseBindings), unless the specified binding are equal to MouseBindings.Default, in which case the effective bindings are determined automatically based on the number of available mouse buttons.
  - getMouseBindings
```
public MouseBindings getMouseBindings()
```
    Returns the mouse bindings specified using setMouseBindings(maspack.widgets.MouseBindings).
  - setMouseBindings
```
public void setMouseBindings(MouseBindings bindings)
```
    Sets the mouse bindings to be used by the viewers. If the bindings are equal to MouseBindings.Default, then the effective bindings passed to the viewers are determined automatically based on the number of available mouse buttons.
  - getMouseWheelZoomScale
```
public double getMouseWheelZoomScale()
```
  - setMouseWheelZoomScale
```
public void setMouseWheelZoomScale(double scale)
```
  - addRenderable
```
public void addRenderable(IsRenderable r)
```
  - removeRenderable
```
public void removeRenderable(IsRenderable r)
```
  - clearRenderables
```
public void clearRenderables()
```
  - getRenderList
```
public RenderList getRenderList()
```
  - addDragger
```
public void addDragger(Dragger3d d)
```
  - removeDragger
```
public void removeDragger(Dragger3d d)
```
  - clearDraggers
```
public void clearDraggers()
```
  - addViewer
```
public void addViewer(GLViewer viewer)
```
  - setSelectionHighlightStyle
```
public void setSelectionHighlightStyle(Renderer.HighlightStyle mode)
```
  - getSelectionHighlightStyle
```
public Renderer.HighlightStyle getSelectionHighlightStyle()
```
  - removeViewer
```
public boolean removeViewer(Viewer viewer)
```
  - numViewers
```
public int numViewers()
```
  - getViewer
```
public GLViewer getViewer(int idx)
```
  - resetViewer
```
public void resetViewer(GLViewer viewer)
```
  - setBackgroundColor
```
public void setBackgroundColor(java.awt.Color color)
```
  - getBackgroundColor
```
public java.awt.Color getBackgroundColor()
```
  - setSelectionColor
```
public void setSelectionColor(java.awt.Color color)
```
  - getSelectionColor
```
public java.awt.Color getSelectionColor()
```
  - setAxisDrawStyle
```
public void setAxisDrawStyle(Renderer.AxisDrawStyle style)
```
  - getAxisDrawStyle
```
public Renderer.AxisDrawStyle getAxisDrawStyle()
```
  - setAxisRadiusRatio
```
public void setAxisRadiusRatio(double ratio)
```
  - getAxisRadiusRatio
```
public double getAxisRadiusRatio()
```
  - setRotationMode
```
public void setRotationMode(Viewer.RotationMode mode)
```
  - getRotationMode
```
public Viewer.RotationMode getRotationMode()
```
  - setDefaultAxialView
```
public void setDefaultAxialView(AxisAlignedRotation axialView)
```
  - getDefaultAxialView
```
public AxisAlignedRotation getDefaultAxialView()
```
  - setEllipticCursorSize
```
public void setEllipticCursorSize(Vector2d size)
```
  - getEllipticCursorSize
```
public Vector2d getEllipticCursorSize()
```
  - setSurfaceResolution
```
public void setSurfaceResolution(int res)
```
  - getSurfaceResolution
```
public int getSurfaceResolution()
```
  - setTransparencyFaceCulling
```
public void setTransparencyFaceCulling(boolean enable)
```
  - getTransparencyFaceCulling
```
public boolean getTransparencyFaceCulling()
```
  - setTransparencyBlending
```
public void setTransparencyBlending(boolean enable)
```
  - getTransparencyBlending
```
public boolean getTransparencyBlending()
```
  - setBlendSourceFactor
```
public void setBlendSourceFactor(GLViewer.BlendFactor factor)
```
  - getBlendSourceFactor
```
public GLViewer.BlendFactor getBlendSourceFactor()
```
  - setBlendDestFactor
```
public void setBlendDestFactor(GLViewer.BlendFactor factor)
```
  - getBlendDestFactor
```
public GLViewer.BlendFactor getBlendDestFactor()
```
  - resetViewers
```
public void resetViewers(AxisAngle frontView)
```
  - resetViewers
```
public void resetViewers(AxisAlignedRotation axialView)
```
  - render
```
public void render()
```
  - repaint
```
public void repaint()
```
    causes the repaint of the viewers
  - setCursor
```
public void setCursor(java.awt.Cursor cursor)
```
    Set the cursor on all the viewers.
    
    Parameters:
    
    cursor - The type of cursor to display.
  - removeMouseListener
```
public void removeMouseListener(javax.swing.event.MouseInputListener listener)
```
    Remove the specified mouse input listener from each of the viewers.
  - addMouseListener
```
public void addMouseListener(javax.swing.event.MouseInputListener listener)
```
    Add a mouse input listener to each of the viewers.
    
    Parameters:
    
    listener - listener to add
  - getMouseListeners
```
public java.util.ArrayList<javax.swing.event.MouseInputListener> getMouseListeners()
```
  - removeKeyListener
```
public void removeKeyListener(java.awt.event.KeyListener listener)
```
    Remove the specified key listener from each of the viewers.
  - addKeyListener
```
public void addKeyListener(java.awt.event.KeyListener listener)
```
    Add a key listener to each of the viewers.
    
    Parameters:
    
    listener - listener to add
  - getKeyListeners
```
public java.util.ArrayList<java.awt.event.KeyListener> getKeyListeners()
```
  - setSelectionEnabled
```
public void setSelectionEnabled(boolean selection)
```
    Set whether or not selection is being allowed on all the existing viewers. Iterates through the viewers setting thier specific selection values to that of the ViewerManager.
    
    Parameters:
    
    selection - Whether or not selection is enabled.
  - isSelectionEnabled
```
public boolean isSelectionEnabled()
```
    Returns true if viewer selection is enabled.
    
    Returns:
    
    true if viewer selection is enabled
  - setSelectOnPress
```
public 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
```
public boolean getSelectOnPress()
```
    Returns true if "select on press" is enabled for the viewers.
    
    Returns:
    
    true if "select on press" is enabled
  - resetEllipticCursorSize
```
public void resetEllipticCursorSize()
```
  - setEllipticSelection
```
public void setEllipticSelection(boolean enable)
```
    Set whether or not elliptic selection is enabled in all the viewers.
    
    Parameters:
    
    enable - Whether or not elliptic selection is enabled.
  - getEllipticSelection
```
public boolean getEllipticSelection()
```
    Returns true if elliptic selection is enabled for the viewers.
    
    Returns:
    
    true if elliptic selection is enabled.
  - getViewerFromComponent
```
public static GLViewer getViewerFromComponent(java.awt.Component comp)
```
    Find the Viewer (if any) associated with a particular component

Class ViewerManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.driver.SettingsBase

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BACKGROUND_COLOR

DEFAULT_SELECTION_COLOR

DEFAULT_AXIS_DRAW_STYLE

DEFAULT_AXIS_RADIUS_RATIO

DEFAULT_ROTATION_MODE

DEFAULT_AXIAL_VIEW

DEFAULT_ELLIPTIC_CURSOR_SIZE

DEFAULT_SURFACE_RESOLUTION

DEFAULT_TRANSPARENCY_FACE_CULLING

DEFAULT_BLENDING

DEFAULT_BLEND_SOURCE_FACTOR

DEFAULT_BLEND_DEST_FACTOR

DEFAULT_REFRESH_FLAGS

DEFAULT_MOUSE_WHEEL_ZOOM_SCALE

DEFAULT_DRAW_AXES

DEFAULT_ORTHOGRAPHIC_VIEW

DEFAULT_DRAW_GRID

myProps

Constructor Detail

ViewerManager

Method Detail

getAllPropertyInfo

getProperty

setDefaultDrawAxes

getDefaultDrawAxes

setDefaultDrawGrid

getDefaultDrawGrid

setDefaultOrthographicView

getDefaultOrthographicView

setDefaultAxisLength

getDefaultAxisLength

getEffectiveMouseBindings

getMouseBindings

setMouseBindings

getMouseWheelZoomScale

setMouseWheelZoomScale

addRenderable

removeRenderable

clearRenderables

getRenderList

addDragger

removeDragger

clearDraggers

addViewer

setSelectionHighlightStyle

getSelectionHighlightStyle

removeViewer

numViewers

getViewer

resetViewer

setBackgroundColor

getBackgroundColor

setSelectionColor

getSelectionColor

setAxisDrawStyle

getAxisDrawStyle

setAxisRadiusRatio

getAxisRadiusRatio

setRotationMode

getRotationMode

setDefaultAxialView

getDefaultAxialView

setEllipticCursorSize

getEllipticCursorSize

setSurfaceResolution

getSurfaceResolution

setTransparencyFaceCulling

getTransparencyFaceCulling

setTransparencyBlending

getTransparencyBlending

setBlendSourceFactor

getBlendSourceFactor

setBlendDestFactor