Class OffsetScale

Describes a transformation of a point in 2D space without rotation. Typically used for to transform texture coordinates.

Hierarchy (view full)

Vector4
- OffsetScale

Constructors

constructor

new OffsetScale(offsetX?, offsetY?, scaleX?, scaleY?): OffsetScale
Parameters
- OptionaloffsetX: number
- OptionaloffsetY: number
- OptionalscaleX: number
- OptionalscaleY: number
Returns OffsetScale
Overrides Vector4.constructor
- Defined in core/OffsetScale.ts:26

Properties

height

height: number

`Readonly`isOffsetScale

isOffsetScale = true

`Readonly`isVector4

isVector4

w

w: number

Default

width

width: number

x

x: number

Default

y

y: number

Default

z

z: number

Default

Accessors

offsetX

get offsetX(): number
Returns number
- Defined in core/OffsetScale.ts:10

offsetY

get offsetY(): number
Returns number
- Defined in core/OffsetScale.ts:14

scaleX

get scaleX(): number
Returns number
- Defined in core/OffsetScale.ts:18

scaleY

get scaleY(): number
Returns number
- Defined in core/OffsetScale.ts:22

Methods

[iterator]

[iterator](): Iterator<number, any, undefined>
Iterating through a Vector4 instance will yield its components (x, y, z, w) in the corresponding order.

Returns Iterator<number, any, undefined>
Inherited from Vector4.[iterator]
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:240

add

add(v): this
Adds v to this vector.
Parameters
- v: Vector4Like
Returns this
Inherited from Vector4.add
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:91

addScalar

addScalar(scalar): this
Parameters
- scalar: number
Returns this
Inherited from Vector4.addScalar
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:93

addScaledVector

addScaledVector(v, s): this
Parameters
- v: Vector4Like
- s: number
Returns this
Inherited from Vector4.addScaledVector
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:100

addVectors

addVectors(a, b): this
Sets this vector to a + b.
Parameters
- a: Vector4Like
- b: Vector4Like
Returns this
Inherited from Vector4.addVectors
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:98

applyMatrix4

applyMatrix4(m): this
Parameters
- m: Matrix4
Returns this
Inherited from Vector4.applyMatrix4
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:120

ceil

ceil(): this
Returns this
Inherited from Vector4.ceil
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:153

clamp

clamp(min, max): this
Parameters
- min: Vector4Like
- max: Vector4Like
Returns this
Inherited from Vector4.clamp
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:150

clampScalar

clampScalar(min, max): this
Parameters
- min: number
- max: number
Returns this
Inherited from Vector4.clampScalar
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:151

clone

clone(): this
Clones this vector.

Returns this
Inherited from Vector4.clone
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:81

combine

combine(offsetScale, target?): OffsetScale
Parameters
- offsetScale: OffsetScale
- target: OffsetScale = ...
Returns OffsetScale
- Defined in core/OffsetScale.ts:47

copy

copy(v): this
Copies value of v to this vector.
Parameters
- v: Vector4Like
Returns this
Inherited from Vector4.copy
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:86

divide

divide(v): this
Parameters
- v: Vector4Like
Returns this
Inherited from Vector4.divide
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:122

divideScalar

divideScalar(s): this
Divides this vector by scalar s. Set vector to ( 0, 0, 0 ) if s == 0.
Parameters
- s: number
Returns this
Inherited from Vector4.divideScalar
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:128

dot

dot(v): number
Computes dot product of this vector and v.
Parameters
- v: Vector4Like
Returns number
Inherited from Vector4.dot
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:165

equals

equals(v): boolean
Checks for strict equality of this vector and v.
Parameters
- v: Vector4Like
Returns boolean
Inherited from Vector4.equals
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:204

floor

floor(): this
Returns this
Inherited from Vector4.floor
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:152

fromArray

fromArray(array, offset?): this
Sets this vector's x, y, z and w value from the provided array or array-like.
Parameters
- array: number[] | ArrayLike<number>
  the source array or array-like.
- Optionaloffset: number
  (optional) offset into the array. Default is 0.
Returns this
Inherited from Vector4.fromArray
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:211

fromBufferAttribute

fromBufferAttribute(attribute, index): this
Parameters
- attribute: BufferAttribute
- index: number
Returns this
Inherited from Vector4.fromBufferAttribute
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:230

getComponent

getComponent(index): number
Parameters
- index: number
Returns number
Inherited from Vector4.getComponent
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:76

length

length(): number
Computes length of this vector.

Returns number
Inherited from Vector4.length
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:175

lengthSq

lengthSq(): number
Computes squared length of this vector.

Returns number
Inherited from Vector4.lengthSq
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:170

lerp

lerp(v, alpha): this
Linearly interpolate between this vector and v with alpha factor.
Parameters
- v: Vector4Like
- alpha: number
Returns this
Inherited from Vector4.lerp
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:197

lerpVectors

lerpVectors(v1, v2, alpha): this
Parameters
- v1: Vector4Like
- v2: Vector4Like
- alpha: number
Returns this
Inherited from Vector4.lerpVectors
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:199

manhattanLength

manhattanLength(): number
Computes the Manhattan length of this vector.

see Taxicab Geometry

Returns number
Inherited from Vector4.manhattanLength
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:182

max

max(v): this
Parameters
- v: Vector4Like
Returns this
Inherited from Vector4.max
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:149

min

min(v): this
Parameters
- v: Vector4Like
Returns this
Inherited from Vector4.min
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:148

multiply

multiply(v): this
Parameters
- v: Vector4Like
Returns this
Inherited from Vector4.multiply
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:113

multiplyScalar

multiplyScalar(s): this
Multiplies this vector by scalar s.
Parameters
- s: number
Returns this
Inherited from Vector4.multiplyScalar
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:118

negate

negate(): this
Inverts this vector.

Returns this
Inherited from Vector4.negate
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:160

normalize

normalize(): this
Normalizes this vector.

Returns this
Inherited from Vector4.normalize
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:187

random

random(): this
Sets this vector's x, y, z and w from Math.random

Returns this
Inherited from Vector4.random
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:235

round

round(): this
Returns this
Inherited from Vector4.round
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:154

roundToZero

roundToZero(): this
Returns this
Inherited from Vector4.roundToZero
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:155

set

set(x, y, z, w): this
Sets value of this vector.
Parameters
- x: number
- y: number
- z: number
- w: number
Returns this
Inherited from Vector4.set
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:47

setAxisAngleFromQuaternion

setAxisAngleFromQuaternion(q): this
http://www.euclideanspace.com/maths/geometry/rotations/conversions/quaternionToAngle/index.htm
Parameters
- q: QuaternionLike
  is assumed to be normalized
Returns this
Inherited from Vector4.setAxisAngleFromQuaternion
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:134

setAxisAngleFromRotationMatrix

setAxisAngleFromRotationMatrix(m): this
http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToAngle/index.htm
Parameters
- m: Matrix4
  assumes the upper 3x3 of m is a pure rotation matrix (i.e, unscaled)
Returns this
Inherited from Vector4.setAxisAngleFromRotationMatrix
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:140

setComponent

setComponent(index, value): this
Parameters
- index: number
- value: number
Returns this
Inherited from Vector4.setComponent
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:74

setFromMatrixPosition

setFromMatrixPosition(m): this
Sets this vector to the position elements of the [transformation matrix]https://en.wikipedia.org/wiki/Transformation_matrix m.
Parameters
- m: Matrix4
Returns this
Inherited from Vector4.setFromMatrixPosition
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:146

setLength

setLength(length): this
Normalizes this vector and multiplies it by l.
Parameters
- length: number
Returns this
Inherited from Vector4.setLength
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:192

setScalar

setScalar(scalar): this
Sets all values of this vector.
Parameters
- scalar: number
Returns this
Inherited from Vector4.setScalar
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:52

setW

setW(w): this
Sets w component of this vector.
Parameters
- w: number
Returns this
Inherited from Vector4.setW
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:72

setX

setX(x): this
Sets X component of this vector.
Parameters
- x: number
Returns this
Inherited from Vector4.setX
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:57

setY

setY(y): this
Sets Y component of this vector.
Parameters
- y: number
Returns this
Inherited from Vector4.setY
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:62

setZ

setZ(z): this
Sets Z component of this vector.
Parameters
- z: number
Returns this
Inherited from Vector4.setZ
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:67

sub

sub(v): this
Subtracts v from this vector.
Parameters
- v: Vector4Like
Returns this
Inherited from Vector4.sub
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:104

subScalar

subScalar(s): this
Parameters
- s: number
Returns this
Inherited from Vector4.subScalar
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:106

subVectors

subVectors(a, b): this
Sets this vector to a - b.
Parameters
- a: Vector4Like
- b: Vector4Like
Returns this
Inherited from Vector4.subVectors
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:111

toArray

toArray(array?, offset?): number[]
Returns an array [x, y, z, w], or copies x, y, z and w into the provided array.
Parameters
- Optionalarray: number[]
  (optional) array to store the vector to. If this is not provided, a new array will be created.
- Optionaloffset: number
  (optional) optional offset into the array.
Returns number[]
The created or provided array.
Inherited from Vector4.toArray
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:219
toArray(array?, offset?): Vector4Tuple
Parameters
- Optionalarray: Vector4Tuple
- Optionaloffset: 0
Returns Vector4Tuple
Inherited from Vector4.toArray
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:220
toArray(array, offset?): ArrayLike<number>
Copies x, y, z and w into the provided array-like.
Parameters
- array: ArrayLike<number>
  array-like to store the vector to.
- Optionaloffset: number
  (optional) optional offset into the array-like.
Returns ArrayLike<number>
The provided array-like.
Inherited from Vector4.toArray
- Defined in ../node_modules/@types/three/src/math/Vector4.d.ts:228

transform

transform(point, target?): Vector2
Transforms the point.
Parameters
- point: Vector2
  The point to transform.
- target: Vector2 = ...
  The target to fill with the transformed point.
Returns Vector2
The transformed point.
- Defined in core/OffsetScale.ts:40

`Static`identity

identity(): OffsetScale
Returns OffsetScale
- Defined in core/OffsetScale.ts:30

Class OffsetScale

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OffsetScale

Properties

height

ReadonlyisOffsetScale

ReadonlyisVector4

w

Default

width

x

Default

y

Default

z

Default

Accessors

offsetX

Returns number

offsetY

Returns number

scaleX

Returns number

scaleY

Returns number

Methods

[iterator]

Returns Iterator<number, any, undefined>

add

Parameters

Returns this

addScalar

Parameters

Returns this

addScaledVector

Parameters

Returns this

addVectors

Parameters

Returns this

applyMatrix4

Parameters

Returns this

ceil

Returns this

clamp

Parameters

Returns this

clampScalar

Parameters

Returns this

clone

Returns this

combine

Parameters

Returns OffsetScale

copy

Parameters

Returns this

divide

Parameters

Returns this

divideScalar

Parameters

Returns this

dot

Parameters

Returns number

equals

Parameters

Returns boolean

floor

`Readonly`isOffsetScale

`Readonly`isVector4