renamed editing controls to painting controls.

Author: JavaSaBr

src/main/java/com/ss/editor/control/editing/EditingControl.java

@@ -0,0 +1,74 @@
+package com.ss.editor.control.painting;
+
+import com.jme3.math.Vector3f;
+import com.jme3.scene.Spatial;
+import com.jme3.scene.control.Control;
+import com.ss.editor.annotation.JmeThread;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * The interface to implement a painting control.
+ *
+ * @author JavaSaBr
+ */
+public interface PaintingControl extends Control {
+
+    /**
+     * Get the painted model.
+     *
+     * @return the painted model.
+     */
+    @JmeThread
+    default @Nullable Spatial getPaintedModel() {
+        return null;
+    }
+
+    /**
+     * Start painting.
+     *
+     * @param paintingInput the type of input.
+     * @param contactPoint  the contact point.
+     */
+    @JmeThread
+    default void startPainting(@NotNull final PaintingInput paintingInput, @NotNull final Vector3f contactPoint) {
+    }
+
+    /**
+     * Get the current painting input.
+     *
+     * @return the current painting input.
+     */
+    @JmeThread
+    default @Nullable PaintingInput getCurrentInput() {
+        return null;
+    }
+
+    /**
+     * Finish painting.
+     *
+     * @param contactPoint the contact point.
+     */
+    @JmeThread
+    default void finishPainting(@NotNull final Vector3f contactPoint) {
+    }
+
+    /**
+     * Update painting.
+     *
+     * @param contactPoint the contact point.
+     */
+    @JmeThread
+    default void updateEditing(@NotNull final Vector3f contactPoint) {
+    }
+
+    /**
+     * Return true of this control was started painting.
+     *
+     * @return true if this control started painting.
+     */
+    @JmeThread
+    default boolean isStartedPainting() {
+        return false;
+    }
+}

src/main/java/com/ss/editor/control/painting/PaintingControl.java

@@ -1,11 +1,11 @@
-package com.ss.editor.control.editing;
+package com.ss.editor.control.painting;
 
 /**
- * The enum with list of editing inputs.
+ * The enum with list of painting inputs.
  *
  * @author JavaSaBr
  */
-public enum EditingInput {
+public enum PaintingInput {
     /**
      * Mouse primary editing input.
      */

src/main/java/com/ss/editor/control/editing/EditingInput.java renamed to src/main/java/com/ss/editor/control/painting/PaintingInput.java

@@ -1,4 +1,4 @@
-package com.ss.editor.control.editing.impl;
+package com.ss.editor.control.painting.impl;
 
 import com.jme3.material.Material;
 import com.jme3.math.ColorRGBA;
@@ -9,32 +9,33 @@
 import com.jme3.scene.Spatial;
 import com.jme3.scene.control.AbstractControl;
 import com.ss.editor.annotation.JmeThread;
-import com.ss.editor.control.editing.EditingControl;
-import com.ss.editor.control.editing.EditingInput;
+import com.ss.editor.control.painting.PaintingControl;
+import com.ss.editor.control.painting.PaintingInput;
 import com.ss.editor.util.EditorUtil;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 /**
- * The base implementation of an editing control.
+ * The base implementation of {@link PaintingControl}.
  *
  * @author JavaSaBr
  */
-public class AbstractEditingControl extends AbstractControl implements EditingControl {
+public class AbstractPaintingControl extends AbstractControl implements PaintingControl {
 
     /**
-     * The current editing input.
+     * The current painting input.
      */
     @Nullable
-    private EditingInput editingInput;
+    private PaintingInput paintingInput;
 
     /**
-     * The flag of editing state.
+     * The flag of painting state.
      */
-    private boolean editing;
+    private boolean painting;
 
     @Override
-    public void setSpatial(final Spatial spatial) {
+    @JmeThread
+    public void setSpatial(@Nullable final Spatial spatial) {
 
         final Spatial prev = getSpatial();
         if (prev instanceof Node) {
@@ -49,30 +50,28 @@ public void setSpatial(final Spatial spatial) {
     }
 
     /**
-     * Create wireframe material material.
+     * Create a colored wireframe material.
      *
-     * @param color the color
-     * @return the material
+     * @param color the color.
+     * @return the colored wireframe material.
      */
     @JmeThread
     protected @NotNull Material createWireframeMaterial(@NotNull final ColorRGBA color) {
-        final Material material = createMaterial(color);
+        final Material material = createColoredMaterial(color);
         material.getAdditionalRenderState().setWireframe(true);
         return material;
     }
 
     /**
-     * Create material material.
+     * Create a colored material.
      *
-     * @param color the color
-     * @return the material
+     * @param color the color.
+     * @return the colored material.
      */
     @JmeThread
-    protected @NotNull Material createMaterial(@NotNull final ColorRGBA color) {
-
+    protected @NotNull Material createColoredMaterial(@NotNull final ColorRGBA color) {
         final Material material = new Material(EditorUtil.getAssetManager(), "Common/MatDefs/Misc/Unshaded.j3md");
         material.setColor("Color", color);
-
         return material;
     }
 
@@ -88,51 +87,53 @@ protected void controlRender(@NotNull final RenderManager renderManager, @NotNul
 
     @Override
     @JmeThread
-    public boolean isStartedEditing() {
-        return editing;
+    public boolean isStartedPainting() {
+        return painting;
     }
 
     /**
-     * Sets editing.
+     * Set the painting state.
      *
-     * @param editing the flag of editing state.
+     * @param painting the flag of painting state.
      */
     @JmeThread
-    protected void setEditing(final boolean editing) {
-        this.editing = editing;
+    protected void setPainting(final boolean painting) {
+        this.painting = painting;
     }
 
     @Override
     @JmeThread
-    public void startEditing(@NotNull final EditingInput editingInput, @NotNull final Vector3f contactPoint) {
-        setEditing(true);
-        setEditingInput(editingInput);
+    public void startPainting(@NotNull final PaintingInput input, @NotNull final Vector3f contactPoint) {
+        setPainting(true);
+        setPaintingInput(input);
     }
 
     @Override
     @JmeThread
-    public void finishEditing(@NotNull final Vector3f contactPoint) {
-        setEditing(false);
+    public void finishPainting(@NotNull final Vector3f contactPoint) {
+        setPainting(false);
     }
 
     /**
-     * @param editingInput the current editing input.
+     * Set the painting input,
+     *
+     * @param input the current painting input.
      */
     @JmeThread
-    private void setEditingInput(@Nullable final EditingInput editingInput) {
-        this.editingInput = editingInput;
+    private void setPaintingInput(@Nullable final PaintingInput input) {
+        this.paintingInput = input;
     }
 
     @Override
     @JmeThread
-    public @Nullable EditingInput getCurrentInput() {
-        return editingInput;
+    public @Nullable PaintingInput getCurrentInput() {
+        return paintingInput;
     }
 
     /**
      * Notify about that this control was attached.
      *
-     * @param node the node
+     * @param node the node.
      */
     @JmeThread
     protected void onAttached(@NotNull final Node node) {
@@ -141,7 +142,7 @@ protected void onAttached(@NotNull final Node node) {
     /**
      * Notify about that this control was detached.
      *
-     * @param node the node
+     * @param node the node.
      */
     @JmeThread
     protected void onDetached(@NotNull final Node node) {