IlvChart3DViewInteractor (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.IlvChartInteractor
- - ilog.views.chart.interactor.IlvChart3DViewInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable
```
public class IlvChart3DViewInteractor
extends IlvChartInteractor
```
An interactor to change the view angles and the zooming factor of a 3D chart.

Since:

JViews 5.5

See Also:

IlvChart.get3DView(), IlvChart.is3D(), Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int NONE
No action type.

static int ROTATE
Rotate action type.

static int ZOOM
Zoom action type.
- Fields inherited from class ilog.views.chart.IlvChartInteractor
  INTERNAL_HIGH, INTERNAL_LOW, NORMAL

Fields
Modifier and Type	Field and Description
`static int`	`NONE` No action type.
`static int`	`ROTATE` Rotate action type.
`static int`	`ZOOM` Zoom action type.

Constructor Summary

Constructors
Constructor and Description
`IlvChart3DViewInteractor()` Creates a new `IlvChart3DViewInteractor` object.
`IlvChart3DViewInteractor(int angleEventMask, int zoomEventMask)` Creates a new `IlvChart3DViewInteractor` object associated with the specified mouse button masks.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`abort()` Called when the interaction is aborted.
`protected void`	`adjustView(Point oldPos, Point newPos, int action)` Adjusts the view point.
`protected void`	`endOperation(MouseEvent event)` Called when the interaction ends.
`protected int`	`getAction()` Returns the current action.
`int`	`getAngleEventMask()` Returns the event mask used for rotating the view.
`int`	`getAngleEventMaskEx()` Returns the event mask used for rotating the view, according to the conventions of `java.awt.event.InputEvent.getModifiersEx()`.
`protected Cursor`	`getCursor()` Returns the cursor associated with this interactor.
`static String`	`getLocalizedName(Locale locale)` Returns a localized name for this interactor class.
`int`	`getZoomEventMask()` Returns the event mask used for zooming the view.
`int`	`getZoomEventMaskEx()` Returns the event mask used for zooming the view, according to the conventions of `java.awt.event.InputEvent.getModifiersEx()`.
`boolean`	`isHandling(int x, int y)` Returns whether the mouse event occurred at the specified location should be handled by the interactor.
`void`	`processMouseEvent(MouseEvent event)` Handles the mouse events.
`void`	`processMouseMotionEvent(MouseEvent event)` Handles the mouse motion events.
`void`	`setAngleEventMask(int angleEventMask)` Sets the event mask used for rotating the view.
`void`	`setZoomEventMask(int zoomEventMask)` Sets the event mask used for zooming the view.
`protected void`	`startOperation(MouseEvent event)` Called when the interaction starts.

Methods inherited from class ilog.views.chart.IlvChartInteractor
addChartInteractionListener, chartConnected, create, create, disableEvents, drawGhost, drawGhost, enableEvents, fireChartInteractionEvent, getAWTEventMask, getChart, getCoordinateSystem, getData, getData, getEventMask, getEventMaskEx, getGhostBounds, getGhostColor, getInteractorClassByName, getLocalizedName, getPriority, getRegisteredInteractorsByName, getShortName, getXAxis, getXORColor, getYAxis, getYAxisIndex, handleExpose, has3DSupport, initGhostGraphics, interactionStarted, isAborted, isAllowDrawGhost, isConsumeEvents, isInOperation, isXORGhost, processKeyEvent, register, removeChartInteractionListener, setAborted, setAllowDrawGhost, setChart, setConsumeEvents, setCursor, setEventMask, setGhostColor, setInOperation, setPriority, setXORColor, setXORGhost, setYAxisIndex, toDisplay

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

- Field Detail
  - NONE
```
public static final int NONE
```
    No action type.
    
    See Also:
    
    getAction(), Constant Field Values
  - ROTATE
```
public static final int ROTATE
```
    Rotate action type.
    
    See Also:
    
    getAction(), Constant Field Values
  - ZOOM
```
public static final int ZOOM
```
    Zoom action type.
    
    See Also:
    
    getAction(), Constant Field Values
- Constructor Detail
  - IlvChart3DViewInteractor
```
public IlvChart3DViewInteractor()
```
    Creates a new IlvChart3DViewInteractor object.
    The default event masks are set to:
    - CTRL + BUTTON1 for changing the view angles (elevation and rotation).
    - SHIFT + BUTTON1 for zooming the view.
  - IlvChart3DViewInteractor
```
public IlvChart3DViewInteractor(int angleEventMask,
                                int zoomEventMask)
```
    Creates a new IlvChart3DViewInteractor object associated with the specified mouse button masks.
    
    Parameters:
    
    angleEventMask - The event mask used for changing the view angles.
    
    zoomEventMask - The event mask used for zooming the view.
- Method Detail
  - getLocalizedName
```
public static String getLocalizedName(Locale locale)
```
    Returns a localized name for this interactor class.
    
    Since:
    
    JViews 7.5
  - getZoomEventMask
```
public final int getZoomEventMask()
```
    Returns the event mask used for zooming the view.
    
    See Also:
    
    setZoomEventMask(int)
  - getZoomEventMaskEx
```
public final int getZoomEventMaskEx()
```
    Returns the event mask used for zooming the view, according to the conventions of java.awt.event.InputEvent.getModifiersEx(). This mask is computed from getZoomEventMask().
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    getZoomEventMask(), setZoomEventMask(int)
  - setZoomEventMask
```
public void setZoomEventMask(int zoomEventMask)
```
    Sets the event mask used for zooming the view.
    Note: In the mask, InputEvent.BUTTON2_DOWN_MASK should be used instead of InputEvent.BUTTON2_MASK, and InputEvent.BUTTON3_DOWN_MASK should be used instead of InputEvent.BUTTON3_MASK, because the values of ALT_MASK/BUTTON2_MASK and META_MASK/BUTTON3_MASK overlap.
    
    See Also:
    
    getZoomEventMask()
  - getAngleEventMask
```
public final int getAngleEventMask()
```
    Returns the event mask used for rotating the view.
    
    See Also:
    
    setAngleEventMask(int)
  - getAngleEventMaskEx
```
public final int getAngleEventMaskEx()
```
    Returns the event mask used for rotating the view, according to the conventions of java.awt.event.InputEvent.getModifiersEx(). This mask is computed from getZoomEventMask().
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    getAngleEventMask(), setAngleEventMask(int)
  - setAngleEventMask
```
public void setAngleEventMask(int angleEventMask)
```
    Sets the event mask used for rotating the view.
    Note: In the mask, InputEvent.BUTTON2_DOWN_MASK should be used instead of InputEvent.BUTTON2_MASK, and InputEvent.BUTTON3_DOWN_MASK should be used instead of InputEvent.BUTTON3_MASK, because the values of ALT_MASK/BUTTON2_MASK and META_MASK/BUTTON3_MASK overlap.
    
    See Also:
    
    getAngleEventMask()
  - getAction
```
protected int getAction()
```
    Returns the current action.
    
    Returns:
    
    ROTATE if the interactor is currently used to modify the view angles, ZOOM if the interactor is currently used to zoom the view, or NONE if the interactor is not active.
  - getCursor
```
protected Cursor getCursor()
```
    Returns the cursor associated with this interactor.
  - isHandling
```
public boolean isHandling(int x,
                          int y)
```
    Returns whether the mouse event occurred at the specified location should be handled by the interactor.
    
    Overrides:
    
    isHandling in class IlvChartInteractor
  - processMouseEvent
```
public void processMouseEvent(MouseEvent event)
```
    Handles the mouse events.
    
    Overrides:
    
    processMouseEvent in class IlvChartInteractor
  - processMouseMotionEvent
```
public void processMouseMotionEvent(MouseEvent event)
```
    Handles the mouse motion events.
    
    Overrides:
    
    processMouseMotionEvent in class IlvChartInteractor
  - adjustView
```
protected void adjustView(Point oldPos,
                          Point newPos,
                          int action)
```
    Adjusts the view point.
    
    Parameters:
    
    oldPos - The previous position of the mouse.
    
    newPos - The new position of the mouse.
    
    action - The type of the action: ROTATE or ZOOM.
  - startOperation
```
protected void startOperation(MouseEvent event)
```
    Called when the interaction starts.
    
    Overrides:
    
    startOperation in class IlvChartInteractor
    
    Parameters:
    
    event - The event that starts the interaction.
    
    See Also:
    
    IlvChartInteractor.interactionStarted(ilog.views.chart.IlvChartInteractor, java.awt.event.MouseEvent)
  - endOperation
```
protected void endOperation(MouseEvent event)
```
    Called when the interaction ends.
    
    Overrides:
    
    endOperation in class IlvChartInteractor
    
    Parameters:
    
    event - The event that ends the interaction.
  - abort
```
protected void abort()
```
    Called when the interaction is aborted.
    
    Overrides:
    
    abort in class IlvChartInteractor

Class IlvChart3DViewInteractor

Field Summary

Fields inherited from class ilog.views.chart.IlvChartInteractor

Constructor Summary

Method Summary

Methods inherited from class ilog.views.chart.IlvChartInteractor

Methods inherited from class java.lang.Object

Field Detail

NONE

ROTATE

ZOOM

Constructor Detail

IlvChart3DViewInteractor

IlvChart3DViewInteractor

Method Detail

getLocalizedName

getZoomEventMask

getZoomEventMaskEx

setZoomEventMask

getAngleEventMask

getAngleEventMaskEx

setAngleEventMask

getAction

getCursor

isHandling

processMouseEvent

processMouseMotionEvent

adjustView

startOperation

endOperation

abort