Class setasign\SetaPDF2\Core\Geometry\Vector in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Geometry
    1. Collidable
    2. Matrix
    3. Point
    4. Rectangle
    5. Vector

setasign\SetaPDF2\Core\Geometry

Vector Class representing a vector.

File: /SetaPDF v2/Core/Geometry/Vector.php
Old class name (alias): \SetaPDF_Core_Geometry_Vector

Internally the matrix is represented as a 3x3 matrix.

Class hierarchy

Vector

Summary

Methods

__construct()
add()
cross()
divide()
getLength()
getLengthSquared()
getValues()
getX()
getY()
getZ()
multiply()
normalize()
scalar()
subtract()
toPoint()

Properties

$_x

protected float Vector::$_x

The X value.

$_y

protected float Vector::$_y

The Y value.

$_z

protected float Vector::$_z

The Z value.

Static Methods

byArray()

public static Vector::byArray (

array $array

): \SetaPDF_Core_Geometry_Vector

Creates an instance by an array.

Parameters

$array : array

byPoint()

public static Vector::byPoint (

\SetaPDF_Core_Geometry_Point $point

): \SetaPDF_Core_Geometry_Vector

Creates an instance by a point.

Parameters

$point : \SetaPDF_Core_Geometry_Point

Methods

__construct()

public Vector::__construct (

int|float $x = 0.0,
int|float $y = 0.0,
int|float $z = 0.0

)

The constructor.

Parameters

$x : int|float
$y : int|float
$z : int|float

add()

public Vector::add (

\SetaPDF_Core_Geometry_Vector $vector

): \SetaPDF_Core_Geometry_Vector

Add a vector to this vector and return the resulting vector.

Parameters

$vector : \SetaPDF_Core_Geometry_Vector

cross()

public Vector::cross (

self $with

): \SetaPDF_Core_Geometry_Vector

Compute the cross product of this and another vector and return the resulting vector.

Parameters

$with : self

divide()

public Vector::divide (

float|int $by

): \SetaPDF_Core_Geometry_Vector

Devide the vector by a float value and return the resulting vector.

Parameters

$by : float|int

getLength()

public Vector::getLength (

void

): float

Get the length of the vector.

getLengthSquared()

public Vector::getLengthSquared (

void

): float

Get the squared length of the vector.

getValues()

public Vector::getValues (

void

): array

Get all vector values.

getX()

public Vector::getX (

void

): float

Get the value of X.

getY()

public Vector::getY (

void

): float

Get the value of Y.

getZ()

public Vector::getZ (

void

): float

Get the value of Z.

multiply()

public Vector::multiply (

float|int|\SetaPDF_Core_Geometry_Matrix $with

): \SetaPDF_Core_Geometry_Vector

Multiply the vector with a float value or a matrix and return the resulting vector.

Parameters

$with : float|int|\SetaPDF_Core_Geometry_Matrix

normalize()

public Vector::normalize (

void

): \SetaPDF_Core_Geometry_Vector

Normalize the vector.

scalar()

public Vector::scalar (

\SetaPDF_Core_Geometry_Vector $with

): float

Computes the scalar/dot/inner product of this and another vector.

Parameters

$with : \SetaPDF_Core_Geometry_Vector

subtract()

public Vector::subtract (

\SetaPDF_Core_Geometry_Vector $vector

): \SetaPDF_Core_Geometry_Vector

Subtract a vector from this vector and return the resulting vector.

Parameters

$vector : \SetaPDF_Core_Geometry_Vector

toPoint()

public Vector::toPoint (

void

): \SetaPDF_Core_Geometry_Point