Vector2 Class Reference

Public Member Functions
	__construct ($x=0, $y=0)
	getX ()
	getY ()
	getFloorX ()
	getFloorY ()
	add ($x, $y=0)
	subtract ($x, $y=0)
	ceil ()
	floor ()
	round ()
	abs ()
	multiply ($number)
	divide ($number)
	distance ($x, $y=0)
	distanceSquared ($x, $y=0)
	length ()
	lengthSquared ()
	normalize ()
	dot (Vector2 $v)
	__toString ()

Static Public Member Functions
static	createRandomDirection (Random $random)

Data Fields
	$x
	$y

Constructor & Destructor Documentation

__construct()

__construct	(		$x = 0,
			$y = 0
	)

Vector2 constructor.

Parameters

int	$x
int	$y

                                               {
        $this->x = $x;
        $this->y = $y;
    }

Member Function Documentation

__toString()

__toString

(

)

Returns

string

                                {
        return "Vector2(x=" . $this->x . ",y=" . $this->y . ")";
    }

abs()

abs

(

)

Returns

Vector2

                         {
        return new Vector2(abs($this->x), abs($this->y));
    }

add()

add	(		$x,
			$y = 0
	)

Parameters

	$x
int	$y

Returns

Vector2

                                   {
        if($x instanceof Vector2){
            return $this->add($x->x, $x->y);
        }else{
            return new Vector2($this->x + $x, $this->y + $y);
        }
    }

ceil()

ceil

(

)

Returns

Vector2

                          {
        return new Vector2((int) ($this->x + 1), (int) ($this->y + 1));
    }

createRandomDirection()

static createRandomDirection ( Random  $random )

static

Parameters

Random

$random

Returns

Vector2

                                                                {
        return VectorMath::getDirection2D($random->nextFloat() * 2 * pi());
    }

distance()

distance	(		$x,
			$y = 0
	)

Parameters

	$x
int	$y

Returns

float

                                        {
        if($x instanceof Vector2){
            return sqrt($this->distanceSquared($x->x, $x->y));
        }else{
            return sqrt($this->distanceSquared($x, $y));
        }
    }

distanceSquared()

distanceSquared	(		$x,
			$y = 0
	)

Parameters

	$x
int	$y

Returns

number

                                               {
        if($x instanceof Vector2){
            return $this->distanceSquared($x->x, $x->y);
        }else{
            return pow($this->x - $x, 2) + pow($this->y - $y, 2);
        }
    }

divide()

divide

(

$number

)

Parameters

$number

Returns

Vector2

                                   {
        return new Vector2($this->x / $number, $this->y / $number);
    }

dot()

dot

(

Vector2

$v

)

Parameters

Vector2

$v

Returns

int

                                   {
        return $this->x * $v->x + $this->y * $v->y;
    }

floor()

floor

(

)

Returns

Vector2

                           {
        return new Vector2((int) $this->x, (int) $this->y);
    }

getFloorX()

getFloorX

(

)

Returns

int

                               {
        return (int) $this->x;
    }

getFloorY()

getFloorY

(

)

Returns

int

                               {
        return (int) $this->y;
    }

getX()

getX

(

)

Returns

int

                          {
        return $this->x;
    }

getY()

getY

(

)

Returns

int

                          {
        return $this->y;
    }

length()

length

(

)

Returns

float

                            {
        return sqrt($this->lengthSquared());
    }

lengthSquared()

lengthSquared

(

)

Returns

int

                                   {
        return $this->x * $this->x + $this->y * $this->y;
    }

multiply()

multiply

(

$number

)

Parameters

$number

Returns

Vector2

                                     {
        return new Vector2($this->x * $number, $this->y * $number);
    }

normalize()

normalize

(

)

Returns

Vector2

                               {
        $len = $this->lengthSquared();
        if($len != 0){
            return $this->divide(sqrt($len));
        }

        return new Vector2(0, 0);
    }

round()

round

(

)

Returns

Vector2

                           {
        return new Vector2(round($this->x), round($this->y));
    }

subtract()

subtract	(		$x,
			$y = 0
	)

Parameters

	$x
int	$y

Returns

Vector2

                                        {
        if($x instanceof Vector2){
            return $this->add(-$x->x, -$x->y);
        }else{
            return $this->add(-$x, -$y);
        }
    }

Field Documentation

$x

$x

$y

$y

---

The documentation for this class was generated from the following file:

• src/pocketmine/math/Vector2.php