Module com.marginallyclever.ro3

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

Class RotateToolOneAxis

java.lang.Object

com.marginallyclever.ro3.apps.viewport.viewporttool.move.RotateToolOneAxis

All Implemented Interfaces:

ViewportTool

public class RotateToolOneAxis
extends Object
implements ViewportTool

A tool to rotate Pose nodes in the Viewport.

Constructor Summary

Constructors

Constructor	Description
RotateToolOneAxis(Color color)

Method Summary

Modifier and Type	Method	Description
void	activate(SelectedItems 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	drawPivotPoint(com.jogamp.opengl.GL3 gl, ShaderProgram shaderProgram)
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.
boolean	isInUse()	Returns true if the tool is active (was clicked correctly and could be dragged)
void	mouseDragged(MouseEvent event)	called when the mouse is dragged after a successful mousePressed 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.
static double	roundToNearestSnap(double angleRadians, double snapRange, double nearest)
void	setDrawPivotPoint(boolean b)
void	setFrameOfReference(FrameOfReference index)	Sets the frame of reference for the tool.
void	setPivotMatrix(javax.vecmath.Matrix4d pivot)
void	setViewport(Viewport viewport)
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

RotateToolOneAxis

public RotateToolOneAxis(Color color)

Method Details

setDrawPivotPoint

public void setDrawPivotPoint(boolean b)

activate

public void activate(SelectedItems list)

This method is called when the tool is activated. It receives the SelectedItems object containing the selected entities and their initial world poses.

Specified by:

activate in interface ViewportTool

Parameters:

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

setPivotMatrix

public void setPivotMatrix(javax.vecmath.Matrix4d pivot)

deactivate

public void deactivate()

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.

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)

called when the mouse is dragged after a successful mousePressed event. pivotMatrix is already set to the frame of reference such that pivotMatrix Z axis is the axis aroun which we want to rotate

Specified by:

mouseDragged in interface ViewportTool

Parameters:

event - the mouse event

roundToNearestSnap

public static double roundToNearestSnap(double angleRadians,
 double snapRange,
 double nearest)

mouseReleased

public void mouseReleased(MouseEvent event)

Specified by:

mouseReleased in interface ViewportTool

update

public void update(double deltaTime)

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)

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

Specified by:

render in interface ViewportTool

Parameters:

gl3 - The OpenGL systems context.

drawPivotPoint

public void drawPivotPoint(com.jogamp.opengl.GL3 gl,
 ShaderProgram shaderProgram)

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.

setFrameOfReference

public void setFrameOfReference(FrameOfReference index)

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.

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.