Dragger3dBase (Artisynth API documentation)

java.lang.Object
- maspack.render.DragToolBase
- - maspack.render.Dragger3dBase

All Implemented Interfaces:

Dragger3d, IsRenderable, IsSelectable

Direct Known Subclasses:

ConstrainedTranslator3d, Jack3d, Rotator3d, Scaler3d, Translator3d, Transrotator3d
```
public abstract class Dragger3dBase
extends DragToolBase
```

Nested Class Summary
- Nested classes/interfaces inherited from interface maspack.render.Dragger3d
  Dragger3d.DraggerType, Dragger3d.DragMode

Field Summary
- Fields inherited from interface maspack.render.Dragger3d
  CONSTRAIN, REPOSITION
- Fields inherited from interface maspack.render.IsRenderable
  TRANSPARENT, TWO_DIMENSIONAL

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(Dragger3dListener l)`
`void`	`fireDraggerAddedListeners()`
`void`	`fireDraggerBeginListeners(AffineTransform3dBase X, AffineTransform3dBase Xinc, int modifiersEx)`
`void`	`fireDraggerEndListeners(AffineTransform3dBase X, AffineTransform3dBase Xinc, int modifiersEx)`
`void`	`fireDraggerMoveListeners(AffineTransform3dBase X, AffineTransform3dBase Xinc, int modifiersEx)`
`void`	`fireDraggerRemovedListeners()`
`RigidTransform3d`	`getDraggerToWorld()`
`int`	`getLineWidth()` Queries the line width of this dragger.
`double`	`getNetSize()`
`int`	`getRenderHints()` Returns a bit code giving rendering hints about this renderable.
`double`	`getSize()`
`double`	`getSizeScale()`
`GLViewer`	`getViewer()` Returns a reference to the viewer which is handling this dragger.
`boolean`	`isSelectable()` Returns true if this object is in fact selectable.
`boolean`	`isVisible()`
`boolean`	`mouseClicked(MouseRayEvent e)`
`boolean`	`mouseDragged(MouseRayEvent e)`
`boolean`	`mouseMoved(MouseRayEvent e)`
`boolean`	`mousePressed(MouseRayEvent e)`
`boolean`	`mouseReleased(MouseRayEvent e)`
`int`	`numSelectionQueriesNeeded()` If this selectable manages its own selection (by issuing selection queries within its `render` method), then this method should return the maximum number of selection queries that will be required.
`void`	`prerender(RenderList list)` Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates).
`boolean`	`removeListener(Dragger3dListener l)`
`void`	`scaleSize(double s)`
`void`	`setDraggerToWorld(RigidTransform3d X)`
`void`	`setLineWidth(int w)` Sets the line width of this dragger.
`void`	`setPosition(Vector3d pos)`
`void`	`setSize(double s)`
`void`	`setSizeScale(double s)`
`void`	`setViewer(GLViewer viewer)` Used by the viewer to set a reference to itself when the dragger is added.
`void`	`setVisible(boolean visible)`
`void`	`updateBounds(Vector3d pmin, Vector3d pmax)` Update the minimum and maximum points for this object.

Methods inherited from class maspack.render.DragToolBase
clearFlags, getDragMode, getFlags, isDragging, setDragMode, setFlags

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

Methods inherited from interface maspack.render.IsSelectable
getSelection

Methods inherited from interface maspack.render.IsRenderable
render

- Method Detail
  - addListener
```
public void addListener(Dragger3dListener l)
```
  - removeListener
```
public boolean removeListener(Dragger3dListener l)
```
  - fireDraggerAddedListeners
```
public void fireDraggerAddedListeners()
```
  - fireDraggerBeginListeners
```
public void fireDraggerBeginListeners(AffineTransform3dBase X,
                                      AffineTransform3dBase Xinc,
                                      int modifiersEx)
```
  - fireDraggerMoveListeners
```
public void fireDraggerMoveListeners(AffineTransform3dBase X,
                                     AffineTransform3dBase Xinc,
                                     int modifiersEx)
```
  - fireDraggerEndListeners
```
public void fireDraggerEndListeners(AffineTransform3dBase X,
                                    AffineTransform3dBase Xinc,
                                    int modifiersEx)
```
  - fireDraggerRemovedListeners
```
public void fireDraggerRemovedListeners()
```
  - isVisible
```
public boolean isVisible()
```
  - setVisible
```
public void setVisible(boolean visible)
```
  - setSize
```
public void setSize(double s)
```
  - getSize
```
public double getSize()
```
  - scaleSize
```
public void scaleSize(double s)
```
  - getSizeScale
```
public double getSizeScale()
```
  - setSizeScale
```
public void setSizeScale(double s)
```
  - getNetSize
```
public double getNetSize()
```
  - mouseClicked
```
public boolean mouseClicked(MouseRayEvent e)
```
  - mousePressed
```
public boolean mousePressed(MouseRayEvent e)
```
  - mouseReleased
```
public boolean mouseReleased(MouseRayEvent e)
```
  - mouseDragged
```
public boolean mouseDragged(MouseRayEvent e)
```
  - mouseMoved
```
public boolean mouseMoved(MouseRayEvent e)
```
  - getDraggerToWorld
```
public RigidTransform3d getDraggerToWorld()
```
  - setDraggerToWorld
```
public void setDraggerToWorld(RigidTransform3d X)
```
  - setPosition
```
public void setPosition(Vector3d pos)
```
  - setLineWidth
```
public void setLineWidth(int w)
```
    Sets the line width of this dragger.
    
    Parameters:
    
    w - new line width
  - getLineWidth
```
public int getLineWidth()
```
    Queries the line width of this dragger.
    
    Returns:
    
    current line width
  - updateBounds
```
public void updateBounds(Vector3d pmin,
                         Vector3d pmax)
```
    Description copied from interface: IsRenderable
    
    Update the minimum and maximum points for this object. In an x-y-z coordinate system with x directed to the right and y directed upwards, the minimum and maximum points can be thought of as defining the left-lower-far and right-upper-near corners of a bounding cube. This method should only reduce the elements of the minimum point and increase the elements of the maximum point, since it may be used as part of an iteration to determine the bounding cube for several different objects.
    
    Parameters:
    
    pmin - minimum point
    
    pmax - maximum point
  - isSelectable
```
public boolean isSelectable()
```
    Returns true if this object is in fact selectable.
    
    Returns:
    
    true if this object is selectable
  - numSelectionQueriesNeeded
```
public int numSelectionQueriesNeeded()
```
    Description copied from interface: IsSelectable
    
    If this selectable manages its own selection (by issuing selection queries within its render method), then this method should return the maximum number of selection queries that will be required. Otherwise, this method should return -1.
    
    Returns:
    
    maximum number of selection queries needed by this component, or -1 if this component does not manage its own selection.
  - prerender
```
public void prerender(RenderList list)
```
    Description copied from interface: IsRenderable
    
    Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates). The object may add internal objects to the list of objects being rendered, by calling
    list.addIfVisible (obj);
    for each of the objects in question.
    
    Parameters:
    
    list - list of objects to be rendered
  - getRenderHints
```
public int getRenderHints()
```
    Description copied from interface: IsRenderable
    
    Returns a bit code giving rendering hints about this renderable. Current bit codes include TRANSPARENT and TWO_DIMENSIONAL.
    
    Returns:
    
    bit code of rendering hints.
  - setViewer
```
public void setViewer(GLViewer viewer)
```
    Used by the viewer to set a reference to itself when the dragger is added.
  - getViewer
```
public GLViewer getViewer()
```
    Returns a reference to the viewer which is handling this dragger. Used mainly to determine the size and alignment of constrained motions. Should not be modified in any way.

Class Dragger3dBase

Nested Class Summary

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

Field Summary

Fields inherited from interface maspack.render.Dragger3d

Fields inherited from interface maspack.render.IsRenderable

Method Summary

Methods inherited from class maspack.render.DragToolBase

Methods inherited from class java.lang.Object

Methods inherited from interface maspack.render.IsSelectable

Methods inherited from interface maspack.render.IsRenderable

Method Detail

addListener

removeListener

fireDraggerAddedListeners

fireDraggerBeginListeners

fireDraggerMoveListeners

fireDraggerEndListeners

fireDraggerRemovedListeners

isVisible

setVisible

setSize

getSize

scaleSize

getSizeScale

setSizeScale

getNetSize

mouseClicked

mousePressed

mouseReleased

mouseDragged

mouseMoved

getDraggerToWorld

setDraggerToWorld

setPosition

setLineWidth

getLineWidth

updateBounds

isSelectable

numSelectionQueriesNeeded

prerender

getRenderHints

setViewer

getViewer