com.github.shynixn.petblocks.api.persistence.entity

Interface IPosition

All Superinterfaces:

Persistenceable

public interface IPosition
extends Persistenceable

Position entity to manage calculations between positions and velocities.

Version 1.1

MIT License

Copyright (c) 2017 by Shynixn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPosition.Direction Defines different relative positions

Method Summary

Modifier and Type	Method and Description
IPosition	addCoordinates(double x, double y, double z) Adds or Subs the given coordinates x, y, z to or from the builder.
int	getBlockX() Returns the x coordinate as int of the builder.
int	getBlockY() Returns the y coordinate as int of the builder.
int	getBlockZ() Returns the z coordinate as int of the builder.
double	getPitch() Returns the pitch of the builder.
String	getWorldName() Returns the worldname of the builder.
double	getX() Returns the x coordinate of the builder.
double	getY() Returns the y coordinate of the builder.
double	getYaw() Returns the yaw of the builder.
double	getZ() Returns the z coordinate of the builder.
IPosition	relativePosition(double distance, IPosition.Direction direction) Returns the relativePosition to a given direction.
IPosition	setCoordinates(double x, double y, double z) Sets the coordinates x, y, z.
IPosition	setPitch(double pitch) Sets the pitch of the builder.
IPosition	setRotation(double yaw, double pitch) Sets the rotation yaw, pitch.
IPosition	setWorldName(String worldName) Sets the worldName of the builder.
IPosition	setX(double x) Sets the x coordinate of the builder.
IPosition	setY(double y) Sets the y coordinate of the builder.
IPosition	setYaw(double yaw) Sets the yaw of the builder.
IPosition	setZ(double z) Sets the z coordinate of the builder.

Methods inherited from interface com.github.shynixn.petblocks.api.persistence.entity.Persistenceable

getId

Method Detail

setCoordinates

IPosition setCoordinates(double x,
                         double y,
                         double z)

Sets the coordinates x, y, z.

Parameters:

x - x

y - y

z - z

Returns:

builder

setRotation

IPosition setRotation(double yaw,
                      double pitch)

Sets the rotation yaw, pitch.

Parameters:

yaw - yaw

pitch - pitch

Returns:

builder

addCoordinates

IPosition addCoordinates(double x,
                         double y,
                         double z)

Adds or Subs the given coordinates x, y, z to or from the builder.

Parameters:

x - x

y - y

z - z

Returns:

builder

setWorldName

IPosition setWorldName(String worldName)

Sets the worldName of the builder.

Parameters:

worldName - worldName

Returns:

builder

setYaw

IPosition setYaw(double yaw)

Sets the yaw of the builder.

Parameters:

yaw - yaw

Returns:

builder

setPitch

IPosition setPitch(double pitch)

Sets the pitch of the builder.

Parameters:

pitch - pitch

Returns:

builder

setX

IPosition setX(double x)

Sets the x coordinate of the builder.

Parameters:

x - x

Returns:

builder

setY

IPosition setY(double y)

Sets the y coordinate of the builder.

Parameters:

y - y

Returns:

builder

setZ

IPosition setZ(double z)

Sets the z coordinate of the builder.

Parameters:

z - z

Returns:

builder

getYaw

double getYaw()

Returns the yaw of the builder.

Returns:

yaw

getPitch

double getPitch()

Returns the pitch of the builder.

Returns:

pitch

getX

double getX()

Returns the x coordinate of the builder.

Returns:

x

getY

double getY()

Returns the y coordinate of the builder.

Returns:

y

getZ

double getZ()

Returns the z coordinate of the builder.

Returns:

z

getBlockX

int getBlockX()

Returns the x coordinate as int of the builder.

Returns:

x

getBlockY

int getBlockY()

Returns the y coordinate as int of the builder.

Returns:

y

getBlockZ

int getBlockZ()

Returns the z coordinate as int of the builder.

Returns:

z

getWorldName

String getWorldName()

Returns the worldname of the builder.

Returns:

worldName

relativePosition

IPosition relativePosition(double distance,
                           IPosition.Direction direction)

Returns the relativePosition to a given direction.

Parameters:

distance - distance

direction - direction

Returns:

builder