harmonic.mz.util
Class DefaultSelectionFilter

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

All Implemented Interfaces:

harmonic.viewer3D.PickingFilter

public class DefaultSelectionFilter

extends java.lang.Object

implements harmonic.viewer3D.PickingFilter

An SelectionFilter may be passed to the object selector to filter mouse selection. This base version filters based on types and an inclusion/exsluson list.

Field Summary

ModelNode[]	exclude If this is not null, any object found in it will be rejected.
java.lang.String[]	filter If this is not null, objects not matching it will be rejected.
ModelNode[]	include If this is not null, any object NOT found in it will be rejected.

Constructor Summary

DefaultSelectionFilter()

Method Summary

java.lang.String

filter(harmonic.viewer3D.PaintStruct paintStruct) Test the tree node agains this filter.

Methods inherited from class java.lang.Object

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

Field Detail

filter

public java.lang.String[] filter

If this is not null, objects not matching it will be rejected. A match is when any of these string elements mathes ModelNode.filerType. "Type Exclusion" is returned on rejection.

exclude

public ModelNode[] exclude

If this is not null, any object found in it will be rejected. "Instance Exclusion" is returned on rejection.

include

public ModelNode[] include

If this is not null, any object NOT found in it will be rejected. "Instance Exclusion" is returned on rejection.

Constructor Detail

DefaultSelectionFilter

public DefaultSelectionFilter()

Method Detail

filter

public java.lang.String filter(harmonic.viewer3D.PaintStruct paintStruct)

Test the tree node agains this filter. Return null if it passes, return a string that explains why id was filtered if id does not.

Specified by:

filter in interface harmonic.viewer3D.PickingFilter