org.spongepowered.api.util.blockray

Class BlockRayHit<E extends Extent>

java.lang.Object

org.spongepowered.api.util.blockray.BlockRayHit<E>

Type Parameters:

E - The extent containing the hit

public class BlockRayHit<E extends Extent>
extends Object

Represents a block hit by a ray. Stores more information than a regular location. Extra object are lazily computed and cached.

Constructor Summary

Constructors

Constructor and Description
BlockRayHit(E extent, double x, double y, double z, com.flowpowered.math.vector.Vector3d direction, com.flowpowered.math.vector.Vector3d normal) Constructs a new block ray hit from the extent that contains it, the coordinates and the face that was entered.

Method Summary

Modifier and Type	Method and Description
com.flowpowered.math.vector.Vector3i	getBlockPosition() Returns the position of the block that was hit.
int	getBlockX() Returns the x coordinate of the block that was hit.
int	getBlockY() Returns the y coordinate of the block that was hit.
int	getBlockZ() Returns the z coordinate of the block that was hit.
com.flowpowered.math.vector.Vector3d	getDirection() Returns the direction of the ray as a normalized vector.
E	getExtent() Returns the extent that contains the block.
Direction[]	getFaces() Returns all the intersected faces.
Location<E>	getLocation() Returns the location of the hit block, not the intersection location.
com.flowpowered.math.vector.Vector3d	getNormal() Returns the normal of the entered face, edge or corner.
com.flowpowered.math.vector.Vector3d	getPosition() Returns the position of the intersection.
double	getX() Returns the x coordinate of the intersection.
double	getY() Returns the y coordinate of the intersection.
double	getZ() Returns the z coordinate of the intersection.
<T> T	map(BiFunction<E,com.flowpowered.math.vector.Vector3d,T> mapper) Calls the mapper function on the extent and position.
<T> T	mapBlock(BiFunction<E,com.flowpowered.math.vector.Vector3i,T> mapper) Calls the mapper function on the extent and block position.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BlockRayHit

public BlockRayHit(E extent,
                   double x,
                   double y,
                   double z,
                   com.flowpowered.math.vector.Vector3d direction,
                   com.flowpowered.math.vector.Vector3d normal)

Constructs a new block ray hit from the extent that contains it, the coordinates and the face that was entered.

Parameters:

extent - The extent of the block

x - The x coordinate of the block

y - The y coordinate of the block

z - The x coordinate of the block

direction - A normal vector of the ray direction

normal - The normal of the entered face, edge or corner

Method Detail

getExtent

public E getExtent()

Returns the extent that contains the block.

Returns:

The extent

getX

public double getX()

Returns the x coordinate of the intersection.

Returns:

The x coordinate

getY

public double getY()

Returns the y coordinate of the intersection.

Returns:

The y coordinate

getZ

public double getZ()

Returns the z coordinate of the intersection.

Returns:

The z coordinate

getPosition

public com.flowpowered.math.vector.Vector3d getPosition()

Returns the position of the intersection.

Returns:

The intersection coordinates

getBlockX

public int getBlockX()

Returns the x coordinate of the block that was hit.

Returns:

The x coordinate

getBlockY

public int getBlockY()

Returns the y coordinate of the block that was hit.

Returns:

The y coordinate

getBlockZ

public int getBlockZ()

Returns the z coordinate of the block that was hit.

Returns:

The z coordinate

getBlockPosition

public com.flowpowered.math.vector.Vector3i getBlockPosition()

Returns the position of the block that was hit.

Returns:

The coordinates of the hit block

getLocation

public Location<E> getLocation()

Returns the location of the hit block, not the intersection location.

Returns:

The location of the hit block

getDirection

public com.flowpowered.math.vector.Vector3d getDirection()

Returns the direction of the ray as a normalized vector.

Returns:

The ray direction

getNormal

public com.flowpowered.math.vector.Vector3d getNormal()

Returns the normal of the entered face, edge or corner. Edges and corners use the average of the surrounding faces.

Returns:

The entered face, edge or corner normal

getFaces

public Direction[] getFaces()

Returns all the intersected faces. In most cases, this is only one face, but if the ray enters an edge, two faces are returned (the ones that form it). Similarly for corners, but three faces.

Returns:

An array of intersected faces, between one and three in length

map

public <T> T map(BiFunction<E,com.flowpowered.math.vector.Vector3d,T> mapper)

Calls the mapper function on the extent and position.

Type Parameters:

T - The return type of the mapper

Parameters:

mapper - The mapper

Returns:

The results of the mapping

mapBlock

public <T> T mapBlock(BiFunction<E,com.flowpowered.math.vector.Vector3i,T> mapper)

Calls the mapper function on the extent and block position.

Type Parameters:

T - The return type of the mapper

Parameters:

mapper - The mapper

Returns:

The results of the mapping

toString

public String toString()

Overrides:

toString in class Object