Skip to content

Commit

Permalink
clean(geomath): fixed javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
kschrab committed Aug 14, 2024
1 parent 5be271a commit b87312c
Showing 1 changed file with 6 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,9 @@ public static class Point extends Vector3d {
private final float distance;

/**
* Creates a new point to add to a {@link PointCloud} by specifying the distance
* to origin and the type of hit object (encoded in byte) next to the location of the point.
*
* @param endPoint the coordinates of the point cloud
* @param distance the distance to the origin of the point cloud
* @param hitType the type of hit object represented by this point. 0 = no hit
Expand All @@ -227,21 +230,21 @@ public Point(Vector3d endPoint, float distance, byte hitType) {
}

/**
* @return true if the ray generating this {@link Point} has hit an object
* Returns true if the ray generating this {@link Point} has hit an object.
*/
public boolean hasHit() {
return hitType != 0;
}

/**
* @return the type of the object the ray generating this point has hit. (0 = no hit)
* Returns the type of the object the ray generating this point has hit. (0 = no hit)
*/
public byte getHitType() {
return hitType;
}

/**
* @return the distance to the origin of point cloud this point belongs to
* Returns the distance to the origin of point cloud this point belongs to.
*/
public float getDistance() {
return distance;
Expand Down

0 comments on commit b87312c

Please sign in to comment.