agi.foundation.graphics.advanced

(agi.foundation.graphics-2024r3.jar)

Class MouseOptions

java.lang.Object

agi.foundation.graphics.advanced.MouseOptions

public final class MouseOptions
extends Object

Options for configuring automatic handling of mouse input for controlling the scene's Camera. To disable automatic handling of the mouse, set the AutoHandleMouse (get / set) property to false. If you want to disable just certain mouse buttons, use the HandledButtons (get / set) property or the MouseOptions.setHandledButtons(MouseButtons, boolean) method to turn off handling of individual buttons.

Method Summary

Modifier and Type	Method and Description
void	addZoomComplete(EventHandler<EventArgs> value) Adds a handler for an event that is raised when an area is zoomed to when the Zooming (get / set) property is set to true.
boolean	getAnimateWhileHandling() Gets whether or not mouse events will allow for animation to continue as they are handled.
boolean	getAutoHandleMouse() Gets whether or not mouse events will be handled by the Insight3D control to allow for automatically controlling the scene's Camera with the mouse.
MouseButtons	getHandledButtons() Gets which of the MouseButtons are being handled.
boolean	getPanning() Gets whether holding down shift and dragging the mouse will pan across the surface of the central body.
boolean	getZooming() Gets whether clicking and dragging the mouse will zoom to the defined area.
void	removeZoomComplete(EventHandler<EventArgs> value) Removes a handler for an event that is raised when an area is zoomed to when the Zooming (get / set) property is set to true.
void	setAnimateWhileHandling(boolean value) Sets whether or not mouse events will allow for animation to continue as they are handled.
void	setAutoHandleMouse(boolean value) Sets whether or not mouse events will be handled by the Insight3D control to allow for automatically controlling the scene's Camera with the mouse.
void	setHandledButtons(MouseButtons value) Sets which of the MouseButtons are being handled.
void	setHandledButtons(MouseButtons buttons, boolean value) Sets whether the specified MouseButtons will be handled or not.
void	setPanning(boolean value) Sets whether holding down shift and dragging the mouse will pan across the surface of the central body.
void	setZooming(boolean value) Sets whether clicking and dragging the mouse will zoom to the defined area.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Method Detail

getAutoHandleMouse

public final boolean getAutoHandleMouse()

Gets whether or not mouse events will be handled by the Insight3D control to allow for automatically controlling the scene's Camera with the mouse.

setAutoHandleMouse

public final void setAutoHandleMouse(boolean value)

Sets whether or not mouse events will be handled by the Insight3D control to allow for automatically controlling the scene's Camera with the mouse.

getHandledButtons

@Nonnull
public final MouseButtons getHandledButtons()

Gets which of the MouseButtons are being handled. The MouseButtons enumeration allows combination of its member values. You can also call the MouseOptions.setHandledButtons(MouseButtons, boolean) method to set the handled buttons.

setHandledButtons

public final void setHandledButtons(@Nonnull
                                    MouseButtons value)

Sets which of the MouseButtons are being handled. The MouseButtons enumeration allows combination of its member values. You can also call the MouseOptions.setHandledButtons(MouseButtons, boolean) method to set the handled buttons.

setHandledButtons

public final void setHandledButtons(@Nonnull
                                    MouseButtons buttons,
                                    boolean value)

Sets whether the specified MouseButtons will be handled or not. To turn off mouse handling for all buttons, you can set the AutoHandleMouse (get / set) property to false. The MouseButtons enumeration allows combination of its member values.

Parameters:

buttons - The MouseButtons value to set.

value - true to set the specified buttons to be handled; otherwise, false.

getAnimateWhileHandling

public final boolean getAnimateWhileHandling()

Gets whether or not mouse events will allow for animation to continue as they are handled.

setAnimateWhileHandling

public final void setAnimateWhileHandling(boolean value)

Sets whether or not mouse events will allow for animation to continue as they are handled.

getZooming

public final boolean getZooming()

Gets whether clicking and dragging the mouse will zoom to the defined area. The ZoomComplete (add / remove) event is raised when the zoom is complete.

setZooming

public final void setZooming(boolean value)

Sets whether clicking and dragging the mouse will zoom to the defined area. The ZoomComplete (add / remove) event is raised when the zoom is complete.

getPanning

public final boolean getPanning()

Gets whether holding down shift and dragging the mouse will pan across the surface of the central body.

setPanning

public final void setPanning(boolean value)

Sets whether holding down shift and dragging the mouse will pan across the surface of the central body.

addZoomComplete

public final void addZoomComplete(EventHandler<EventArgs> value)

Adds a handler for an event that is raised when an area is zoomed to when the Zooming (get / set) property is set to true.

Parameters:

value - The handler.

removeZoomComplete

public final void removeZoomComplete(EventHandler<EventArgs> value)

Removes a handler for an event that is raised when an area is zoomed to when the Zooming (get / set) property is set to true.

Parameters:

value - The handler.

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.