Module com.marginallyclever.robotoverlord

Package com.marginallyclever.ro3.apps.viewport.viewporttool

Class Compass3D

java.lang.Object

com.marginallyclever.ro3.apps.viewport.viewporttool.Compass3D

All Implemented Interfaces:

ViewportTool

public class Compass3D
extends Object
implements ViewportTool

Draw a compass to show the orientation of the camera. If the user clicks on the handles for the compasss, orbit the camera to face that world axis.

Constructor Summary

Constructors

Constructor	Description
Compass3D()

Method Summary

Modifier and Type	Method	Description
void	activate(List<Node> list)	This method is called when the tool is activated.
void	cancelUse()	Force cancel the tool.
void	deactivate()	This method is called when the tool is deactivated.
void	dispose(com.jogamp.opengl.GL3 gl3)	This is called when the OpenGL context is destroyed.
void	getComponents(List<JPanel> list)	Build a Swing Component that represents this Tool.
javax.vecmath.Point3d	getStartPoint()	Returns the point on the tool clicked by the user.
void	handleMouseEvent(MouseEvent event)	Handles mouse input events for the tool.
void	init(com.jogamp.opengl.GL3 gl3)	This is called when the OpenGL context is created.
boolean	isInUse()	Returns true if the tool is active (was clicked correctly and could be dragged)
void	mouseDragged(MouseEvent event)
void	mouseMoved(MouseEvent event)
void	mousePressed(MouseEvent event)
void	mouseReleased(MouseEvent event)
void	render(com.jogamp.opengl.GL3 gl3, ShaderProgram shaderProgram)	Renders any tool-specific visuals to the 3D scene.
void	setFrameOfReference(FrameOfReference index)	Sets the frame of reference for the tool.
void	setViewport(Viewport viewport)
void	turnCameraAccordingToHandle()	Turn the camera to face the direction of the handle under the cursor.
void	update(double deltaTime)	Updates the tool's internal state, if necessary.

Methods inherited from class java.lang.Object

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

Constructor Details

Compass3D

public Compass3D()

Method Details

activate

public void activate(List<Node> list)

Description copied from interface: ViewportTool

This method is called when the tool is activated. It receives a list containing the selected nodes and their initial world poses.

Specified by:

activate in interface ViewportTool

Parameters:

list - The selected items to be manipulated by the tool.

deactivate

public void deactivate()

Description copied from interface: ViewportTool

This method is called when the tool is deactivated. It allows the tool to perform any necessary cleanup actions before another tool takes over.

Specified by:

deactivate in interface ViewportTool

handleMouseEvent

public void handleMouseEvent(MouseEvent event)

Description copied from interface: ViewportTool

Handles mouse input events for the tool.

Specified by:

handleMouseEvent in interface ViewportTool

Parameters:

event - The MouseEvent object representing the input event.

update

public void update(double deltaTime)

Description copied from interface: ViewportTool

Updates the tool's internal state, if necessary.

Specified by:

update in interface ViewportTool

Parameters:

deltaTime - Time elapsed since the last update.

render

public void render(com.jogamp.opengl.GL3 gl3,
 ShaderProgram shaderProgram)

Description copied from interface: ViewportTool

Renders any tool-specific visuals to the 3D scene.

Specified by:

render in interface ViewportTool

Parameters:

gl3 - The OpenGL context.

setViewport

public void setViewport(Viewport viewport)

Specified by:

setViewport in interface ViewportTool

isInUse

public boolean isInUse()

Description copied from interface: ViewportTool

Returns true if the tool is active (was clicked correctly and could be dragged)

Specified by:

isInUse in interface ViewportTool

Returns:

true if the tool is active (was clicked correctly and could be dragged)

cancelUse

public void cancelUse()

Description copied from interface: ViewportTool

Force cancel the tool. useful if two viewporttools are activated at once.

Specified by:

cancelUse in interface ViewportTool

getStartPoint

public javax.vecmath.Point3d getStartPoint()

Description copied from interface: ViewportTool

Returns the point on the tool clicked by the user. This is used to determine which tool is closer to the user.

Specified by:

getStartPoint in interface ViewportTool

Returns:

the point on the tool clicked by the user.

mouseMoved

public void mouseMoved(MouseEvent event)

Specified by:

mouseMoved in interface ViewportTool

mousePressed

public void mousePressed(MouseEvent event)

Specified by:

mousePressed in interface ViewportTool

mouseDragged

public void mouseDragged(MouseEvent event)

Specified by:

mouseDragged in interface ViewportTool

mouseReleased

public void mouseReleased(MouseEvent event)

Specified by:

mouseReleased in interface ViewportTool

turnCameraAccordingToHandle

public void turnCameraAccordingToHandle()

Turn the camera to face the direction of the handle under the cursor.

setFrameOfReference

public void setFrameOfReference(FrameOfReference index)

Description copied from interface: ViewportTool

Sets the frame of reference for the tool.

Specified by:

setFrameOfReference in interface ViewportTool

Parameters:

index - 0 for world, 1 for local, 2 for camera.

init

public void init(com.jogamp.opengl.GL3 gl3)

Description copied from interface: ViewportTool

This is called when the OpenGL context is created. It should create any resources.

Specified by:

init in interface ViewportTool

Parameters:

gl3 - the OpenGL context.

dispose

public void dispose(com.jogamp.opengl.GL3 gl3)

Description copied from interface: ViewportTool

This is called when the OpenGL context is destroyed. It should release any resources.

Specified by:

dispose in interface ViewportTool

Parameters:

gl3 - the OpenGL context.

getComponents

public void getComponents(List<JPanel> list)

Description copied from interface: ViewportTool

Build a Swing Component that represents this Tool.

Specified by:

getComponents in interface ViewportTool

Parameters:

list - the list to add components to.