Skip to content

Commit

Permalink
- Finished javadocs, annotations and null checkers in renderer.
Browse files Browse the repository at this point in the history
  • Loading branch information
Hakan Kargın committed Mar 18, 2022
1 parent c921d72 commit 6eaf166
Showing 1 changed file with 201 additions and 45 deletions.
246 changes: 201 additions & 45 deletions api/src/main/java/com/hakan/core/renderer/HRenderer.java
View file
Original file line number Diff line number Diff line change
@@ -1,89 +1,179 @@
package com.hakan.core.renderer;

import org.apache.commons.lang.Validate;
import org.bukkit.Bukkit;
import org.bukkit.Location;
import org.bukkit.entity.Player;

import javax.annotation.Nonnull;
import java.util.*;
import java.util.function.Consumer;

public class HRenderer {
/**
* HRenderer class.
* This class helps renders the players.
* returns players in radius.
*/
public final class HRenderer {

private double radius;
private boolean deleted;
private boolean showEveryone;
private boolean useYAxis;
private Location location;
private Set<UUID> viewers;
private Consumer<List<Player>> showConsumer;
private Consumer<List<Player>> hideConsumer;
private Consumer<HRenderer> deleteConsumer;
private final Set<UUID> shownViewers;

public HRenderer(Location location, double radius, Set<UUID> viewers,
Consumer<List<Player>> showConsumer,
Consumer<List<Player>> hideConsumer,
Consumer<HRenderer> deleteConsumer) {
this.location = location;
private final Set<UUID> shownViewers;
private final Consumer<List<Player>> showConsumer;
private final Consumer<List<Player>> hideConsumer;
private final Consumer<HRenderer> deleteConsumer;

/**
* Creates new instance of this class.
*
* @param location Center location.
* @param radius Radius.
* @param viewers Viewers.
* @param showConsumer Show consumer.
* @param hideConsumer Hide consumer.
* @param deleteConsumer Delete consumer.
*/
public HRenderer(@Nonnull Location location, double radius, @Nonnull Set<UUID> viewers,
@Nonnull Consumer<List<Player>> showConsumer,
@Nonnull Consumer<List<Player>> hideConsumer,
@Nonnull Consumer<HRenderer> deleteConsumer) {
this.location = Objects.requireNonNull(location, "location cannot be null!");
this.viewers = Objects.requireNonNull(viewers, "viewers cannot be null!");
this.showConsumer = Objects.requireNonNull(showConsumer, "show consumer cannot be null!");
this.hideConsumer = Objects.requireNonNull(hideConsumer, "hide consumer cannot be null!");
this.deleteConsumer = Objects.requireNonNull(deleteConsumer, "delete consumer cannot be null!");
this.radius = radius;
this.viewers = viewers;
this.shownViewers = new HashSet<>();
this.showEveryone = false;
this.deleted = false;
this.useYAxis = true;
this.showConsumer = showConsumer;
this.hideConsumer = hideConsumer;
this.deleteConsumer = deleteConsumer;
}

public HRenderer(Location location, double radius,
Consumer<List<Player>> showConsumer,
Consumer<List<Player>> hideConsumer,
Consumer<HRenderer> deleteConsumer) {
/**
* Creates new instance of this class.
*
* @param location Center location.
* @param radius Radius.
* @param showConsumer Show consumer.
* @param hideConsumer Hide consumer.
* @param deleteConsumer Delete consumer.
*/
public HRenderer(@Nonnull Location location, double radius,
@Nonnull Consumer<List<Player>> showConsumer,
@Nonnull Consumer<List<Player>> hideConsumer,
@Nonnull Consumer<HRenderer> deleteConsumer) {
this(location, radius, new HashSet<>(), showConsumer, hideConsumer, deleteConsumer);
this.showEveryone = true;
}

/**
* Gets radius.
*
* @return Radius.
*/
public double getRadius() {
return this.radius;
}

/**
* Sets radius.
*
* @param radius Radius.
* @return This class.
*/
@Nonnull
public HRenderer setRadius(double radius) {
this.radius = radius;
return this;
}

/**
* Checks use y-axis to calculate
* location distance.
*
* @return If use y-axis, returns true.
*/
public boolean isUseYAxis() {
return this.useYAxis;
}

/**
* Sets use y-axis to calculate
* location distance.
*
* @param useYAxis Use y-axis mode.
* @return This class
*/
@Nonnull
public HRenderer setUseYAxis(boolean useYAxis) {
this.useYAxis = useYAxis;
return this;
}

/**
* Can everyone includes this renderer.
*
* @return If includes, returns true.
*/
public boolean canShowEveryone() {
return this.showEveryone;
}

/**
* Everyone includes this renderer.
*
* @param showEveryone Show mode.
* @return This class.
*/
@Nonnull
public HRenderer showEveryone(boolean showEveryone) {
this.showEveryone = showEveryone;
return this;
}

/**
* Gets location of renderer.
*
* @return Location of renderer.
*/
@Nonnull
public Location getLocation() {
return this.location;
}

public HRenderer setLocation(Location location) {
this.location = location;
/**
* Sets center location.
*
* @param location Center location.
* @return This class.
*/
@Nonnull
public HRenderer setLocation(@Nonnull Location location) {
this.location = Objects.requireNonNull(location, "location cannot be null!");
return this;
}

/**
* Gets shown viewers.
*
* @return Shown viewers.
*/
@Nonnull
public Set<UUID> getShownViewers() {
return new HashSet<>(this.shownViewers);
}

/**
* Gets shown viewers as player list.
*
* @return Shown viewers as player list.
*/
@Nonnull
public List<Player> getShownViewersAsPlayer() {
List<Player> players = new ArrayList<>();
this.shownViewers.forEach(uid -> {
Expand All @@ -93,67 +183,127 @@ public List<Player> getShownViewersAsPlayer() {
return players;
}

/**
* Gets viewers.
*
* @return Viewers.
*/
@Nonnull
public Set<UUID> getViewers() {
return this.viewers;
}

public HRenderer setViewers(Set<UUID> viewers) {
this.viewers = viewers;
/**
* Sets viewers.
*
* @param viewers Viewers.
* @return This class.
*/
@Nonnull
public HRenderer setViewers(@Nonnull Set<UUID> viewers) {
this.viewers = Objects.requireNonNull(viewers, "viewers cannot be null!");
return this;
}

public HRenderer setViewers(List<Player> viewers) {
/**
* Set viewers.
*
* @param viewers Viewers.
* @return This class.
*/
@Nonnull
public HRenderer setViewers(@Nonnull List<Player> viewers) {
this.viewers.clear();
viewers.forEach(player -> this.viewers.add(player.getUniqueId()));
Objects.requireNonNull(viewers, "viewers cannot be null!")
.forEach(this::addViewer);
return this;
}

public HRenderer addViewer(UUID uid) {
this.viewers.add(uid);
/**
* Adds viewer to renderer.
*
* @param uid UID of player.
* @return This class.
*/
@Nonnull
public HRenderer addViewer(@Nonnull UUID uid) {
this.viewers.add(Objects.requireNonNull(uid, "uid cannot be null!"));
return this;
}

public HRenderer removeViewer(UUID uid) {
this.viewers.remove(uid);
/**
* Removes viewer from renderer.
*
* @param uid UID of player.
* @return This class.
*/
@Nonnull
public HRenderer removeViewer(@Nonnull UUID uid) {
this.viewers.remove(Objects.requireNonNull(uid, "uid cannot be null!"));
return this;
}

public HRenderer addViewer(Player player) {
return this.addViewer(player.getUniqueId());
/**
* Adds viewer to renderer.
*
* @param player Player.
* @return This class.
*/
@Nonnull
public HRenderer addViewer(@Nonnull Player player) {
return this.addViewer(Objects.requireNonNull(player, "player cannot be null!").getUniqueId());
}

public HRenderer removeViewer(Player player) {
return this.removeViewer(player.getUniqueId());
}

public void setShowConsumer(Consumer<List<Player>> showConsumer) {
this.showConsumer = showConsumer;
}

public void setHideConsumer(Consumer<List<Player>> hideConsumer) {
this.hideConsumer = hideConsumer;
}

public void setDeleteConsumer(Consumer<HRenderer> deleteConsumer) {
this.deleteConsumer = deleteConsumer;
/**
* Removes viewer from renderer.
*
* @param player Player.
* @return This class.
*/
@Nonnull
public HRenderer removeViewer(@Nonnull Player player) {
return this.removeViewer(Objects.requireNonNull(player, "player cannot be null!").getUniqueId());
}

/**
* Checks renderer is deleted.
*
* @return If renderer is deleted, returns true.
*/
public boolean isDeleted() {
return this.deleted;
}

/**
* Deletes renderer.
*/
public void delete() {
if (this.deleteConsumer != null)
this.deleteConsumer.accept(this);
this.deleted = true;
}

public double calculateDistance(Location target) {
/**
* Calculates distance between center
* and target.
*
* @param target Target location.
* @return Distance as double.
*/
public double calculateDistance(@Nonnull Location target) {
Validate.notNull(target, "target location cannot be null!");

double xDis = Math.pow(target.getX() - this.location.getX(), 2);
double zDis = Math.pow(target.getZ() - this.location.getZ(), 2);
return (this.useYAxis) ? Math.sqrt(xDis + Math.pow(target.getY() - this.location.getY(), 2) + zDis) : Math.sqrt(xDis + zDis);
}

/**
* Calculates viewers.
*
* @return Viewers.
*/
@Nonnull
public Set<UUID> calculateViewers() {
if (!this.showEveryone)
return this.viewers;
Expand All @@ -164,6 +314,12 @@ public Set<UUID> calculateViewers() {
return viewers;
}

/**
* Renders the players.
*
* @return This class.
*/
@Nonnull
public HRenderer render() {
if (this.deleted)
return this;
Expand Down

0 comments on commit 6eaf166

Please sign in to comment.