Package com.j3d.engine.interact.cmd.commands.camera.orbit

Class OrbitCmd

java.lang.Object

com.j3d.engine.interact.cmd.base.Command

com.j3d.engine.interact.cmd.args.Subcommand

com.j3d.engine.interact.cmd.commands.camera.orbit.OrbitCmd

All Implemented Interfaces:

Argument, SemiStatefulCommand, StatefulCommand<Pair<Vector3,Rotation>>

public class OrbitCmd
extends Subcommand
implements StatefulCommand<Pair<Vector3,Rotation>>

A no-args stateful command which orbits the camera around (itself) using OrbitMouseOwner to enable dragging capabilities.

As a StatefulCommand, orbit registers KeyEvent.VK_ENTER to finalise the rotation change and KeyEvent.VK_ESCAPE to abort the rotation change.

Aliases: orbit, rot, o

Author:

Lehlogonolo Poole

See Also:

• OrbitMouseOwner
• StatefulCommand
• CommandsManager
• Command

Field Summary

Fields

Modifier and Type	Field	Description
UUID	orbitCmdUUID	The UUID which the orbit command uses to identify stuff registered by it. i.e. events or keybinds
static OrbitMouseOwner	orbitMouseOwner	The mouse owner for OrbitCmd to function

Fields inherited from class com.j3d.engine.interact.cmd.base.Command

aliases, args, description, usages

Constructor Summary

Constructors

Constructor	Description
OrbitCmd()

Method Summary

Modifier and Type	Method	Description
void	cleanup(SafeJLabel label)
void	onEnter(Pair<Vector3,Rotation> object, SafeJLabel label)	Called when the 'Enter' key is pressed.
void	onEsc(Pair<Vector3,Rotation> object, SafeJLabel label)	Called when the 'Escape' key is pressed.
void	onStart(Pair<Vector3,Rotation> object, SafeJLabel label)	Called when the command is first started.
void	run(Invoker invoker, SafeJLabel logLabel, String aliasUsed, Object[] args, ArrayList<TaggedArgValue<?>> taggedArgs)	The method to be overridden by subclasses to implement command functionality.

Methods inherited from class com.j3d.engine.interact.cmd.args.Subcommand

getDescription, getName, isOptional

Methods inherited from class com.j3d.engine.interact.cmd.base.Command

addNoArgUsage, aliases, aliasStream, args, dispatchToSubcommands, getUsages, hasNoArgs, parseUsages, usages, varTaggedArgs

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.j3d.engine.interact.cmd.base.SemiStatefulCommand

fire

Methods inherited from interface com.j3d.engine.interact.cmd.base.StatefulCommand

run, run

Field Details

orbitMouseOwner

public static OrbitMouseOwner orbitMouseOwner

The mouse owner for OrbitCmd to function

orbitCmdUUID

public UUID orbitCmdUUID

The UUID which the orbit command uses to identify stuff registered by it. i.e. events or keybinds

Constructor Details

OrbitCmd

public OrbitCmd()

Method Details

run

public void run(Invoker invoker,
 SafeJLabel logLabel,
 String aliasUsed,
 Object[] args,
 ArrayList<TaggedArgValue<?>> taggedArgs)

Description copied from class: Command

The method to be overridden by subclasses to implement command functionality.

Overrides:

run in class Command

Parameters:

invoker - The invoker of this command

logLabel - The JLabel to display log messages.

aliasUsed - The alias of the command that was used to invoke it.

args - The arguments passed to the command.

taggedArgs - Tagged arguments passed to the command.

onStart

public void onStart(Pair<Vector3,Rotation> object,
 SafeJLabel label)

Description copied from interface: StatefulCommand

Called when the command is first started.

Specified by:

onStart in interface StatefulCommand<Pair<Vector3,Rotation>>

Parameters:

object - The object that the command operates on.

label - The SafeJLabel instance.

cleanup

public void cleanup(SafeJLabel label)

onEnter

public void onEnter(Pair<Vector3,Rotation> object,
 SafeJLabel label)

Description copied from interface: StatefulCommand

Called when the 'Enter' key is pressed.

Specified by:

onEnter in interface StatefulCommand<Pair<Vector3,Rotation>>

Parameters:

object - The object that the command operates on.

label - The SafeJLabel instance.

onEsc

public void onEsc(Pair<Vector3,Rotation> object,
 SafeJLabel label)

Description copied from interface: StatefulCommand

Called when the 'Escape' key is pressed.

Specified by:

onEsc in interface StatefulCommand<Pair<Vector3,Rotation>>

Parameters:

object - The object that the command operates on.

label - The SafeJLabel instance.