IlvRotationSymbolInteractor (Perforce JViews 10.0 API)

java.lang.Object
- javax.swing.AbstractAction
- - ilog.views.symbology.interactor.IlvSymbolInteractor
  - - ilog.views.symbology.interactor.IlvRangeSymbolInteractor
    - - ilog.views.symbology.interactor.IlvRotationSymbolInteractor

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action
```
public class IlvRotationSymbolInteractor
extends IlvRangeSymbolInteractor
```
This interaction allows user to rotate a subcomponent of the composite around a rotation center. The rotation center can either be relative to the composite (the parent of the rotating part) or relative to the rotating part itself. This class does not modify the graphic representation of the object. It detects the mouse motion event and according to the mouse position, to a start angle, to an end angle, to minimum and maximum value, it computes the new current value corresponding to the angle made between start angle and mouse position. If those values (start and end angle, maximum and minimum) are not defined (all set to 0) the behavior of the interactor if to rotate from 0 to 360 and to send a value corresponding to the current angle. This new value is then send into the model. The graphical representation of the composites will changed if the CSS of the model has rules to change the position of a subcomponent of the composite according to this value.

Since:

JViews 8.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BOTTOM_CENTER` the rotation center is on the center of the bottom side of the bounding box either of the base or of the rotating part
`static String`	`BOTTOM_LEFT` the rotation center is on the bottom left corner of the bounding box either of the base or of the rotating part
`static String`	`BOTTOM_RIGHT` the rotation center is on the bottom right corner of the bounding box either of the base or of the rotating part
`static String`	`CENTER` the rotation center is the center of the bounding box either of the base or of the rotating part
`static String`	`LEFT_CENTER` the rotation center is on the center of the left side of the bounding box either of the base or of the rotating part
`static String`	`RIGHT_CENTER` the rotation center is on the center of the right side of the bounding box either of the base or of the rotating part
`static String`	`TOP_CENTER` the rotation center is on the center of the top side of the bounding box either of the base or of the rotating part
`static String`	`TOP_LEFT` the rotation center is on the top left corner of the bounding box either of the base or of the rotating part
`static String`	`TOP_RIGHT` the rotation center is on the top right corner of the bounding box either of the base or of the rotating part

Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled

Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors
Constructor and Description
`IlvRotationSymbolInteractor()` Default constructor, creates the interactor and set default value for start angle, end angle, minimum and maximum value to 0.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)` Computes the angle made by mouse pointer and start angle, relatively to rotation center.
`double`	`getEndAngle()` Returns the end angle allowed for the rotation
`String`	`getRotationCenter()` Returns the position of the rotation center.
`double`	`getStartAngle()` Returns the start angle
`IlvMouseGesture[]`	`getSupportedMouseGestures()` Returns the mouse gesture supported by this interactor.
`boolean`	`isRotationCenterRelativeToBase()` Indicates if the rotation center is relative to the base (the first child of the composite parent of the rotating part) or relative to the rotating part itself.
`void`	`setEndAngle(double endAngle)` Sets the ending angle allowed for the rotation.
`void`	`setRotationCenter(String rotationCenter)` Set the position of the rotation center.
`void`	`setRotationCenterRelativeToBase(boolean centerRelativeToBase)` Indicates if the rotation center should be relative to the base (the first child of the composite parent of the rotating part) or relative to the rotating part itself.
`void`	`setStartAngle(double start)` Set the start angle that corresponds to the minimum value.

Methods inherited from class ilog.views.symbology.interactor.IlvRangeSymbolInteractor
applyStep, getMaximum, getMinimum, getStep, setMaximum, setMinimum, setStep

Methods inherited from class ilog.views.symbology.interactor.IlvSymbolInteractor
getCSSValue, getLogger, getParameterToModify, getParameterType, setParameterToModify

Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

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

- Field Detail
  - CENTER
```
public static final String CENTER
```
    the rotation center is the center of the bounding box either of the base or of the rotating part
    
    See Also:
    
    Constant Field Values
  - TOP_CENTER
```
public static final String TOP_CENTER
```
    the rotation center is on the center of the top side of the bounding box either of the base or of the rotating part
    
    See Also:
    
    Constant Field Values
  - BOTTOM_CENTER
```
public static final String BOTTOM_CENTER
```
    the rotation center is on the center of the bottom side of the bounding box either of the base or of the rotating part
    
    See Also:
    
    Constant Field Values
  - LEFT_CENTER
```
public static final String LEFT_CENTER
```
    the rotation center is on the center of the left side of the bounding box either of the base or of the rotating part
    
    See Also:
    
    Constant Field Values
  - RIGHT_CENTER
```
public static final String RIGHT_CENTER
```
    the rotation center is on the center of the right side of the bounding box either of the base or of the rotating part
    
    See Also:
    
    Constant Field Values
  - TOP_LEFT
```
public static final String TOP_LEFT
```
    the rotation center is on the top left corner of the bounding box either of the base or of the rotating part
    
    See Also:
    
    Constant Field Values
  - TOP_RIGHT
```
public static final String TOP_RIGHT
```
    the rotation center is on the top right corner of the bounding box either of the base or of the rotating part
    
    See Also:
    
    Constant Field Values
  - BOTTOM_LEFT
```
public static final String BOTTOM_LEFT
```
    the rotation center is on the bottom left corner of the bounding box either of the base or of the rotating part
    
    See Also:
    
    Constant Field Values
  - BOTTOM_RIGHT
```
public static final String BOTTOM_RIGHT
```
    the rotation center is on the bottom right corner of the bounding box either of the base or of the rotating part
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvRotationSymbolInteractor
```
public IlvRotationSymbolInteractor()
```
    Default constructor, creates the interactor and set default value for start angle, end angle, minimum and maximum value to 0.
- Method Detail
  - getSupportedMouseGestures
```
public IlvMouseGesture[] getSupportedMouseGestures()
```
    Returns the mouse gesture supported by this interactor. This interactor responds to mouse dragged event (button 1 pressed and mouse move).
    
    Specified by:
    
    getSupportedMouseGestures in class IlvSymbolInteractor
    
    Returns:
    
    an array of mouse gesture containing IlvMouseGesture.MOUSE_DRAGGED
  - getEndAngle
```
public double getEndAngle()
```
    Returns the end angle allowed for the rotation
  - setEndAngle
```
public void setEndAngle(double endAngle)
```
    Sets the ending angle allowed for the rotation. It is defined clockwise relatively to the trigonometric 0 and expressed in degrees
    
    Parameters:
    
    endAngle - the end angle in degrees.
  - getStartAngle
```
public double getStartAngle()
```
    Returns the start angle
    
    See Also:
    
    setStartAngle(double start)
  - setStartAngle
```
public void setStartAngle(double start)
```
    Set the start angle that corresponds to the minimum value. This angle is defined clockwise, relatively to the trigonometric 0 and expressed in degrees
    
    Parameters:
    
    start - the start angle in degrees.
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Computes the angle made by mouse pointer and start angle, relatively to rotation center. And then computes the value corresponding to this angle in the range [minimum, maximum]
    
    Specified by:
    
    actionPerformed in interface ActionListener
    
    Overrides:
    
    actionPerformed in class IlvSymbolInteractor
  - isRotationCenterRelativeToBase
```
public boolean isRotationCenterRelativeToBase()
```
    Indicates if the rotation center is relative to the base (the first child of the composite parent of the rotating part) or relative to the rotating part itself.
    
    Returns:
    
    true if the rotation center is relative to the base.
  - setRotationCenterRelativeToBase
```
public void setRotationCenterRelativeToBase(boolean centerRelativeToBase)
```
    Indicates if the rotation center should be relative to the base (the first child of the composite parent of the rotating part) or relative to the rotating part itself.
  - getRotationCenter
```
public String getRotationCenter()
```
    Returns the position of the rotation center.
    
    Returns:
    
    one of following values: CENTER : center of the bounding box TOP_CENTER : centered on top side of the bounding box BOTTOM_CENTER: center of the bottom side LEFT_CENTER : center on the left side RIGHT_CENTER : centered on the right side TOP_LEFT : on the top left corner TOP_RIGHT : on the top right corner BOTTOM_LEFT : on the bottom left corner BOTTOM_RIGHT : on the bottom right corner
  - setRotationCenter
```
public void setRotationCenter(String rotationCenter)
```
    Set the position of the rotation center. This position will be relative to the bounds of the base or to the bounds of the rotating part of the symbol.
    
    Parameters:
    
    rotationCenter - It can be one of the following values :
    CENTER : center of the bounding box TOP_CENTER : centered on top side of the bounding box BOTTOM_CENTER: center of the bottom side LEFT_CENTER : center on the left side RIGHT_CENTER : centered on the right side TOP_LEFT : on the top left corner TOP_RIGHT : on the top right corner BOTTOM_LEFT : on the bottom left corner BOTTOM_RIGHT : on the bottom right corner

Class IlvRotationSymbolInteractor

Field Summary

Fields inherited from class javax.swing.AbstractAction

Fields inherited from interface javax.swing.Action

Constructor Summary

Method Summary

Methods inherited from class ilog.views.symbology.interactor.IlvRangeSymbolInteractor

Methods inherited from class ilog.views.symbology.interactor.IlvSymbolInteractor

Methods inherited from class javax.swing.AbstractAction

Methods inherited from class java.lang.Object

Field Detail

CENTER

TOP_CENTER

BOTTOM_CENTER

LEFT_CENTER

RIGHT_CENTER

TOP_LEFT

TOP_RIGHT

BOTTOM_LEFT

BOTTOM_RIGHT

Constructor Detail

IlvRotationSymbolInteractor

Method Detail

getSupportedMouseGestures

getEndAngle

setEndAngle

getStartAngle

setStartAngle

actionPerformed

isRotationCenterRelativeToBase

setRotationCenterRelativeToBase

getRotationCenter

setRotationCenter