harmonic.mz.util
Class Selector

java.lang.Object
  |
  +--harmonic.mz.util.Selector

All Implemented Interfaces:

harmonic.viewer3D.Task, harmonic.viewer3D.event.ViewportMouseListener

public class Selector

extends java.lang.Object

implements harmonic.viewer3D.Task, harmonic.viewer3D.event.ViewportMouseListener

This is a tool for selecting objects off the viewport. This makes use of viewport.Picking, a low level math utility. This handles mouse messages and selectes objects accordingly. This may be used by anything that is interested in getting a selection. Alternativly, the viewport.Picking can be used directly. Another option is to use import.NodeSetEntry, which makes use of this.

The famous object selector has some options:

• Basic Mode: Alows seleciton of all objects in database.

Field Summary

static int	ADD_MODE
boolean	bNoNeedSelect
static Selector	defSelector
static int	REMOVE_MODE

Constructor Summary

Selector()
Constructs a Selector

Method Summary

void	_keyPressed(java.awt.event.KeyEvent e)
void	addSelection(ModelNode node) Add node to current selection set
static void	addSelectionListener_Static(SelectionListener listener) Add selection listener that will be notified by all Selector objects
void	addSelectionListener(SelectionListener listener) Add a listener of selection changes
void	addTentativeSelection(ModelNode node)
void	applyFilter(java.util.Vector set, boolean bUnselect)
void	beginTask(harmonic.viewer3D.Task parent) This does nothing.
void	beginWithModelViewports(harmonic.viewer3D.Task parentTask) Start this selector listening to all ModelViewport's
void	beginWithViewport(harmonic.viewer3D.Task parentTask, harmonic.viewer3D.Viewport viewport) Start this selector listening to given viewport
void	cancelTask()
void	cleanTask()
void	finishTask()
static Selector	getActiveSelector() Return the selector with the mouse right now
int	getAddRemoveMode() Returns whether picking an object is removing it from selection set
java.util.Vector	getContextSelection_V() Return selection for context menu
ModelNode[]	getContextSelection() Return selection for context menu
static Selector	getDefaultSelector()
ShapeNode	getHandle()
static Selector	getModelSelector()
harmonic.viewer3D.Picking	getPicker() Return Picking object used by this Selector
int	getPickMode() Call through to Picking
java.util.Vector	getSelection_V() Returns the current selection
ModelNode[]	getSelection() Returns the current selection
java.util.Vector	getShapeSelection_V() Returns the current selection of ShapeDef's
ShapeNode[]	getShapeSelection() Returns the current selection of ShapeDef's
java.lang.String	getTaskName()
java.util.Vector	getTentativeSelection_V() Returns the current tentative selection
ModelNode[]	getTentativeSelection() Returns the current tentative selection
boolean	maybePostContextMenu(harmonic.viewer3D.event.ViewportMouseEvent e)
void	mouseClicked(harmonic.viewer3D.event.ViewportMouseEvent e)
void	mouseDragged(harmonic.viewer3D.event.ViewportMouseEvent e)
void	mouseEntered(harmonic.viewer3D.event.ViewportMouseEvent e)
void	mouseExited(harmonic.viewer3D.event.ViewportMouseEvent e)
void	mouseMoved(harmonic.viewer3D.event.ViewportMouseEvent e)
void	mousePressed(harmonic.viewer3D.event.ViewportMouseEvent e)
void	mouseReleased(harmonic.viewer3D.event.ViewportMouseEvent e)
void	notifyListeners(SelectionEvent event)
void	processMouseDragged(ShapeNode underMouse, harmonic.viewer3D.event.ViewportMouseEvent e) Selector calls ShapeNode.processMouseDragged().
void	processMousePressed(ShapeNode underMouse, harmonic.viewer3D.event.ViewportMouseEvent e) Selector calls ShapeNode.processMousePressed().
void	processMouseReleased(ShapeNode underMouse, harmonic.viewer3D.event.ViewportMouseEvent e) Selector calls ShapeNode.processMouseReleased().
void	removeSelection(ModelNode node) Remove node from current selection set
static void	removeSelectionListener_Static(SelectionListener listener) Remove selection listener that will be notified by all Selector objects
void	removeSelectionListener(SelectionListener listener) Remove a listener of selection changes
void	removeTentativeSelection(ModelNode node)
void	selectAllVisibleShapes()
void	selectForMenu(DataNode[] set)
void	selectNone() Un-select all currently selected shapes, and remove parts from view
void	selectPrev() Recall previous selection set
void	setAddRemoveMode(int x) Sets whether picking an object should add it of remove it from selection set
void	setExclude(ShapeNode[] exclude) Set objects to exclude
void	setFilter(java.lang.String[] typeFilter) Set types to include
void	setHandle(ShapeNode handle)
void	setInclude(ShapeNode[] include) Set objects to include
void	setPickInvisible(boolean b) Call through to Picking
void	setPickMode(int x) Call through to Picking
void	setSelection(java.util.Vector selection) Sets current selection set
void	updateListeners()

Methods inherited from class java.lang.Object

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

Field Detail

ADD_MODE

public static final int ADD_MODE

See Also:

Constant Field Values

REMOVE_MODE

public static final int REMOVE_MODE

See Also:

Constant Field Values

bNoNeedSelect

public boolean bNoNeedSelect

defSelector

public static Selector defSelector

Constructor Detail

Selector

public Selector()

Constructs a Selector

Method Detail

getDefaultSelector

public static Selector getDefaultSelector()

beginTask

public void beginTask(harmonic.viewer3D.Task parent)

This does nothing. Call beginWithViewport() to make Selector listen to viewport

Specified by:

beginTask in interface harmonic.viewer3D.Task

finishTask

public void finishTask()

Specified by:

finishTask in interface harmonic.viewer3D.Task

cancelTask

public void cancelTask()

Specified by:

cancelTask in interface harmonic.viewer3D.Task

cleanTask

public void cleanTask()

Specified by:

cleanTask in interface harmonic.viewer3D.Task

getTaskName

public java.lang.String getTaskName()

Specified by:

getTaskName in interface harmonic.viewer3D.Task

beginWithViewport

public void beginWithViewport(harmonic.viewer3D.Task parentTask,
                              harmonic.viewer3D.Viewport viewport)

Start this selector listening to given viewport

beginWithModelViewports

public void beginWithModelViewports(harmonic.viewer3D.Task parentTask)

Start this selector listening to all ModelViewport's

addSelectionListener

public void addSelectionListener(SelectionListener listener)

Add a listener of selection changes

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Remove a listener of selection changes

addSelectionListener_Static

public static void addSelectionListener_Static(SelectionListener listener)

Add selection listener that will be notified by all Selector objects

removeSelectionListener_Static

public static void removeSelectionListener_Static(SelectionListener listener)

Remove selection listener that will be notified by all Selector objects

notifyListeners

public void notifyListeners(SelectionEvent event)

updateListeners

public void updateListeners()

setSelection

public void setSelection(java.util.Vector selection)

Sets current selection set

addSelection

public void addSelection(ModelNode node)

Add node to current selection set

removeSelection

public void removeSelection(ModelNode node)

Remove node from current selection set

addTentativeSelection

public void addTentativeSelection(ModelNode node)

removeTentativeSelection

public void removeTentativeSelection(ModelNode node)

getActiveSelector

public static Selector getActiveSelector()

Return the selector with the mouse right now

getModelSelector

public static Selector getModelSelector()

getTentativeSelection_V

public java.util.Vector getTentativeSelection_V()

Returns the current tentative selection

getTentativeSelection

public ModelNode[] getTentativeSelection()

Returns the current tentative selection

getSelection_V

public java.util.Vector getSelection_V()

Returns the current selection

getSelection

public ModelNode[] getSelection()

Returns the current selection

getShapeSelection_V

public java.util.Vector getShapeSelection_V()

Returns the current selection of ShapeDef's

getShapeSelection

public ShapeNode[] getShapeSelection()

Returns the current selection of ShapeDef's

getContextSelection_V

public java.util.Vector getContextSelection_V()

Return selection for context menu

getContextSelection

public ModelNode[] getContextSelection()

Return selection for context menu

setExclude

public void setExclude(ShapeNode[] exclude)

Set objects to exclude

setFilter

public void setFilter(java.lang.String[] typeFilter)

Set types to include

setInclude

public void setInclude(ShapeNode[] include)

Set objects to include

setPickMode

public void setPickMode(int x)

Call through to Picking

getPickMode

public int getPickMode()

Call through to Picking

setPickInvisible

public void setPickInvisible(boolean b)

Call through to Picking

setAddRemoveMode

public void setAddRemoveMode(int x)

Sets whether picking an object should add it of remove it from selection set

getAddRemoveMode

public int getAddRemoveMode()

Returns whether picking an object is removing it from selection set

getPicker

public harmonic.viewer3D.Picking getPicker()

Return Picking object used by this Selector

selectPrev

public void selectPrev()

Recall previous selection set

selectNone

public void selectNone()

Un-select all currently selected shapes, and remove parts from view

selectAllVisibleShapes

public void selectAllVisibleShapes()

applyFilter

public void applyFilter(java.util.Vector set,
                        boolean bUnselect)

setHandle

public void setHandle(ShapeNode handle)

getHandle

public ShapeNode getHandle()

mouseDragged

public void mouseDragged(harmonic.viewer3D.event.ViewportMouseEvent e)

Specified by:

mouseDragged in interface harmonic.viewer3D.event.ViewportMouseListener

processMouseDragged

public void processMouseDragged(ShapeNode underMouse,
                                harmonic.viewer3D.event.ViewportMouseEvent e)

Selector calls ShapeNode.processMouseDragged(). The default behaviour is to call this function.

mouseReleased

public void mouseReleased(harmonic.viewer3D.event.ViewportMouseEvent e)

Specified by:

mouseReleased in interface harmonic.viewer3D.event.ViewportMouseListener

processMouseReleased

public void processMouseReleased(ShapeNode underMouse,
                                 harmonic.viewer3D.event.ViewportMouseEvent e)

Selector calls ShapeNode.processMouseReleased(). The default behaviour is to call this function.

mouseMoved

public void mouseMoved(harmonic.viewer3D.event.ViewportMouseEvent e)

Specified by:

mouseMoved in interface harmonic.viewer3D.event.ViewportMouseListener

mouseExited

public void mouseExited(harmonic.viewer3D.event.ViewportMouseEvent e)

Specified by:

mouseExited in interface harmonic.viewer3D.event.ViewportMouseListener

mousePressed

public void mousePressed(harmonic.viewer3D.event.ViewportMouseEvent e)

Specified by:

mousePressed in interface harmonic.viewer3D.event.ViewportMouseListener

mouseEntered

public void mouseEntered(harmonic.viewer3D.event.ViewportMouseEvent e)

Specified by:

mouseEntered in interface harmonic.viewer3D.event.ViewportMouseListener

mouseClicked

public void mouseClicked(harmonic.viewer3D.event.ViewportMouseEvent e)

Specified by:

mouseClicked in interface harmonic.viewer3D.event.ViewportMouseListener

processMousePressed

public void processMousePressed(ShapeNode underMouse,
                                harmonic.viewer3D.event.ViewportMouseEvent e)

Selector calls ShapeNode.processMousePressed(). The default behaviour is to call this function.

_keyPressed

public void _keyPressed(java.awt.event.KeyEvent e)

selectForMenu

public void selectForMenu(DataNode[] set)

maybePostContextMenu

public boolean maybePostContextMenu(harmonic.viewer3D.event.ViewportMouseEvent e)