Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AxisAlignedBB is now immutable #95

Merged
merged 13 commits into from
Dec 9, 2024
Merged

AxisAlignedBB is now immutable #95

Changes from 6 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
4bef7cb
AxisAlignedBB is now immutable
Dhaiven Dec 3, 2024
d4ce6ed
Add Copy on function thath create new AABB
Dhaiven Dec 3, 2024
142a1a1
Fiw wrong name
Dhaiven Dec 3, 2024
efcb8f1
Fix typo & documentation
Dhaiven Dec 3, 2024
3afe12a
Code is now more readable
Dhaiven Dec 3, 2024
c95581e
Add return type
Dhaiven Dec 3, 2024
1a3ef4e
Change documentation
Dhaiven Dec 4, 2024
2729986
Update src/AxisAlignedBB.php
Dhaiven Dec 9, 2024
a9e86de
Update src/AxisAlignedBB.php
Dhaiven Dec 9, 2024
feef175
Update src/AxisAlignedBB.php
Dhaiven Dec 9, 2024
83ce72b
Change documentation
Dhaiven Dec 9, 2024
0af1955
Update src/AxisAlignedBB.php
dktapps Dec 9, 2024
090f197
Update AxisAlignedBB.php
dktapps Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
178 changes: 66 additions & 112 deletions src/AxisAlignedBB.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
use function abs;
use const PHP_INT_MAX;

final class AxisAlignedBB{
final readonly class AxisAlignedBB{

public float $minX;
public float $minY;
Expand Down Expand Up @@ -90,133 +90,96 @@ public function addCoord(float $x, float $y, float $z) : AxisAlignedBB{
/**
* Outsets the bounds of this AxisAlignedBB by the specified X, Y and Z.
*
* @return $this
*/
public function expand(float $x, float $y, float $z){
$this->minX -= $x;
$this->minY -= $y;
$this->minZ -= $z;
$this->maxX += $x;
$this->maxY += $y;
$this->maxZ += $z;

return $this;
}

/**
* Returns an expanded clone of this AxisAlignedBB.
*/
public function expandedCopy(float $x, float $y, float $z) : AxisAlignedBB{
return (clone $this)->expand($x, $y, $z);
public function expandedCopy(float $x, float $y, float $z): AxisAlignedBB{
return new AxisAlignedBB(
$this->minX - $x,
$this->minY - $y,
$this->minZ - $z,
$this->maxX + $x,
$this->maxY + $y,
$this->maxZ + $z
);
}

/**
* Shifts this AxisAlignedBB by the given X, Y and Z.
*
* @return $this
*/
public function offset(float $x, float $y, float $z) : AxisAlignedBB{
$this->minX += $x;
$this->minY += $y;
$this->minZ += $z;
$this->maxX += $x;
$this->maxY += $y;
$this->maxZ += $z;

return $this;
}

/**
* Returns an offset clone of this AxisAlignedBB.
*/
public function offsetCopy(float $x, float $y, float $z) : AxisAlignedBB{
return (clone $this)->offset($x, $y, $z);
return new AxisAlignedBB(
$this->minX + $x,
$this->minY + $y,
$this->minZ + $z,
$this->maxX + $x,
$this->maxY + $y,
$this->maxZ + $z
);
}

/**
* Offsets this AxisAlignedBB in the given direction by the specified distance.
*
* @return $this
*/
public function offsetTowards(Facing $face, float $distance) : AxisAlignedBB{
[$offsetX, $offsetY, $offsetZ] = $face->offset();

return $this->offset($offsetX * $distance, $offsetY * $distance, $offsetZ * $distance);
}

/**
* Returns an offset clone of this AxisAlignedBB.
*/
public function offsetTowardsCopy(Facing $face, float $distance) : AxisAlignedBB{
return (clone $this)->offsetTowards($face, $distance);
[$offsetX, $offsetY, $offsetZ] = $face->offset();

return $this->offsetCopy($offsetX * $distance, $offsetY * $distance, $offsetZ * $distance);
}

/**
* Insets the bounds of this AxisAlignedBB by the specified X, Y and Z.
*
* @return $this
*/
public function contract(float $x, float $y, float $z) : AxisAlignedBB{
$this->minX += $x;
$this->minY += $y;
$this->minZ += $z;
$this->maxX -= $x;
$this->maxY -= $y;
$this->maxZ -= $z;

return $this;
}

/**
* Returns a contracted clone of this AxisAlignedBB.
* Returns an contracted clone of this AxisAlignedBB.
Dhaiven marked this conversation as resolved.
Show resolved Hide resolved
*/
public function contractedCopy(float $x, float $y, float $z) : AxisAlignedBB{
return (clone $this)->contract($x, $y, $z);
return new AxisAlignedBB(
$this->minX + $x,
$this->minY + $y,
$this->minZ + $z,
$this->maxX - $x,
$this->maxY - $y,
$this->maxZ - $z
);
}

/**
* Extends the AABB in the given direction.
*
* @param float $distance Negative values pull the face in, positive values push out.
*
* @return $this
* Returns an extended clone of this AxisAlignedBB.
*/
public function extend(Facing $face, float $distance) : AxisAlignedBB{
public function extendedCopy(Facing $face, float $distance) : AxisAlignedBB{
$minX = $this->minX;
$minY = $this->minY;
$minZ = $this->minZ;
$maxX = $this->maxX;
$maxY = $this->maxY;
$maxZ = $this->maxZ;

match($face){
Facing::DOWN => $this->minY -= $distance,
Facing::UP => $this->maxY += $distance,
Facing::NORTH => $this->minZ -= $distance,
Facing::SOUTH => $this->maxZ += $distance,
Facing::WEST => $this->minX -= $distance,
Facing::EAST => $this->maxX += $distance,
Facing::DOWN => $minY -= $distance,
Facing::UP => $maxY += $distance,
Facing::NORTH => $minZ -= $distance,
Facing::SOUTH => $maxZ += $distance,
Facing::WEST => $minX -= $distance,
Facing::EAST => $maxX += $distance
};

return $this;
}

/**
* Returns an extended clone of this bounding box.
* @see AxisAlignedBB::extend()
*/
public function extendedCopy(Facing $face, float $distance) : AxisAlignedBB{
return (clone $this)->extend($face, $distance);
return new AxisAlignedBB($minX, $minY, $minZ, $maxX, $maxY, $maxZ);
}

/**
* Inverse of extend().
Dhaiven marked this conversation as resolved.
Show resolved Hide resolved
* @see AxisAlignedBB::extend()
* @see AxisAlignedBB::extendedCopy()
*
* @param float $distance Positive values pull the face in, negative values push out.
*
* @return $this
*/
public function trim(Facing $face, float $distance) : AxisAlignedBB{
return $this->extend($face, -$distance);
}

/**
* Returns a trimmed clone of this bounding box.
* @see AxisAlignedBB::trim()
* Returns an trimmed clone of this AxisAlignedBB.
*/
public function trimmedCopy(Facing $face, float $distance) : AxisAlignedBB{
return $this->extendedCopy($face, -$distance);
Expand All @@ -227,44 +190,35 @@ public function trimmedCopy(Facing $face, float $distance) : AxisAlignedBB{
*
* @param float $distance Negative values reduce width, positive values increase width.
*
* @return $this
* Returns an stretched clone of this AxisAlignedBB.
*/
public function stretch(Axis $axis, float $distance) : AxisAlignedBB{
public function stretchedCopy(Axis $axis, float $distance) : AxisAlignedBB{
$minX = $this->minX;
$minY = $this->minY;
$minZ = $this->minZ;
$maxX = $this->maxX;
$maxY = $this->maxY;
$maxZ = $this->maxZ;

if($axis === Axis::Y){
$this->minY -= $distance;
$this->maxY += $distance;
$minY -= $distance;
$maxY += $distance;
}elseif($axis === Axis::Z){
$this->minZ -= $distance;
$this->maxZ += $distance;
$minZ -= $distance;
$maxZ += $distance;
}elseif($axis === Axis::X){
$this->minX -= $distance;
$this->maxX += $distance;
$minX -= $distance;
$maxX += $distance;
}

return $this;
}

/**
* Returns a stretched copy of this bounding box.
* @see AxisAlignedBB::stretch()
*/
public function stretchedCopy(Axis $axis, float $distance) : AxisAlignedBB{
return (clone $this)->stretch($axis, $distance);
return new AxisAlignedBB($minX, $minY, $minZ, $maxX, $maxY, $maxZ);
}

/**
* Reduces the dimension of the AABB on the given axis. Inverse of stretch().
* @see AxisAlignedBB::stretch()
* @see AxisAlignedBB::stretchedCopy()
*
* @return $this
*/
public function squash(Axis $axis, float $distance) : AxisAlignedBB{
return $this->stretch($axis, -$distance);
}

/**
* Returns a squashed copy of this bounding box.
* @see AxisAlignedBB::squash()
* Returns an squashed clone of this AxisAlignedBB.
*/
public function squashedCopy(Axis $axis, float $distance) : AxisAlignedBB{
return $this->stretchedCopy($axis, -$distance);
Expand Down
Loading