Commit 0088d6f3 authored by Mario Chromik's avatar Mario Chromik
Browse files

adding documentation

parent 78365960

GeometryEngines/src/main/java/cz/fidentis/analyst/engines/interactivemask/MaskProjector.java

+13 −1
Original line number Diff line number Diff line
@@ -9,9 +9,12 @@ import cz.fidentis.analyst.data.shapes.SurfaceMask; 
import cz.fidentis.analyst.data.shapes.SurfaceMask2D;

import cz.fidentis.analyst.engines.raycasting.RayIntersectionConfig;

import cz.fidentis.analyst.engines.raycasting.RayIntersectionServices;

import javax.swing.JOptionPane;

import java.awt.Point;



/**

 * Visits meshes and returns intersections with projection of SurfaceMask2D

 * @author Mario Chromik

 */

public class MaskProjector implements MeshVisitor {



    private final SurfaceMask2D surfaceMask;
@@ -20,6 +23,11 @@ public class MaskProjector implements MeshVisitor { 


    private final MaskProjectorConfig config;



    /**

     * Constructor using configuration and surface mask

     * @param config configuration for visitor

     * @param surfaceMask mask to project

     */

    public MaskProjector(MaskProjectorConfig config, SurfaceMask2D surfaceMask) {

        this.config = config;

        this.surfaceMask = surfaceMask;
@@ -45,6 +53,10 @@ public class MaskProjector implements MeshVisitor { 
        return ray;

    }



    /**

     * Gets the result from visitor

     * @return

     */

    public SurfaceMask getResult() {

        return projectedMask;

    }

GeometryEngines/src/main/java/cz/fidentis/analyst/engines/interactivemask/MaskProjectorConfig.java

+26 −1
Original line number Diff line number Diff line
@@ -4,6 +4,18 @@ import cz.fidentis.analyst.data.octree.Octree; 


import javax.vecmath.Vector3d;



/**

 *  Configuration for MAskPRojector

 * @param canvasWidth

 * @param canvasHeight

 * @param panelWidth

 * @param panelHeight

 * @param fov

 * @param cameraPosition

 * @param cameraCenter

 * @param cameraUpDirection

 * @param octree

 */

public record MaskProjectorConfig(int canvasWidth, int canvasHeight, int panelWidth,

                                  int panelHeight, int fov, Vector3d cameraPosition,

                                  Vector3d cameraCenter, Vector3d cameraUpDirection, Octree octree) {
@@ -13,8 +25,21 @@ public record MaskProjectorConfig(int canvasWidth, int canvasHeight, int panelWi 
        return octree;

    }



    /**

     * Constructor with 9 parameters

     * @param canvasWidth

     * @param canvasHeight

     * @param panelWidth

     * @param panelHeight

     * @param fov

     * @param cameraPosition

     * @param cameraCenter

     * @param cameraUpDirection

     * @param octree

     */

    public MaskProjectorConfig(int canvasWidth, int canvasHeight, int panelWidth, int panelHeight,

                               int fov, Vector3d cameraPosition, Vector3d cameraCenter, Vector3d cameraUpDirection, Octree octree) {

                               int fov, Vector3d cameraPosition, Vector3d cameraCenter, Vector3d cameraUpDirection,

                               Octree octree) {

        this.canvasWidth = canvasWidth;

        this.canvasHeight = canvasHeight;

        this.panelWidth = panelWidth;