Package com.j3d.engine.interact.input.mouse

Enum Class MOwner

java.lang.Object

java.lang.Enum<MOwner>

com.j3d.engine.interact.input.mouse.MOwner

All Implemented Interfaces:

Serializable, Comparable<MOwner>, Constable

public enum MOwner
extends Enum<MOwner>

MOwner is an enum which represents the different types of mouse owners in the sceneManager. It is used to determine which MouseOwner is the owner of the mouse input in the sceneManager and to allow for easy switching between different MouseOwners.

Author:

Lehlogonolo Poole

See Also:

• SceneManager
• EngineFrame

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Mouse owner that always exists
NONE	No mouse owner
ORBIT	Owner for orbit the camera
QTRANS	Owner for quick translate
ROTATE_HANDLE	Owner for rotation actions
SCALE_HANDLE	Owner for scaling actions
SELECTION	Owner for selection actions
TRANSLATE_HANDLE	Owner for translation actions

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MOwner()

Method Summary

Modifier and Type	Method	Description
static MOwner	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MOwner[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final MOwner NONE

No mouse owner

SELECTION

public static final MOwner SELECTION

Owner for selection actions

TRANSLATE_HANDLE

public static final MOwner TRANSLATE_HANDLE

Owner for translation actions

ROTATE_HANDLE

public static final MOwner ROTATE_HANDLE

Owner for rotation actions

SCALE_HANDLE

public static final MOwner SCALE_HANDLE

Owner for scaling actions

ORBIT

public static final MOwner ORBIT

Owner for orbit the camera

ALWAYS

public static final MOwner ALWAYS

Mouse owner that always exists

QTRANS

public static final MOwner QTRANS

Owner for quick translate

Constructor Details

MOwner

private MOwner()

Method Details

values

public static MOwner[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MOwner valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null