Class Cylindrical

A point given as radius, theta and y: its distance from the Y axis, its angle around that axis measured from +Z toward +X, and its height

Use it to lay things out around a vertical axis, such as a ring of pillars or a spiral staircase, then convert back with Vector3#setFromCylindrical.

Example

const step = new Cylindrical();

for (let i = 0; i < stairs.length; i++) {
  step.set(4, i * 0.4, i * 0.25);
  stairs[i].position.setFromCylindrical(step);
}

Index

Constructors

constructor

new Cylindrical(radius?: number, theta?: number, y?: number): Cylindrical
Creates a new Cylindrical
Parameters
- radius: number = 1
  Distance from the Y axis
- theta: number = 0
  Azimuthal angle (radians) measured from +Z
- y: number = 0
  Height above the XZ plane
Returns Cylindrical

Properties

radius

radius: number = 0

Distance from the Y axis

Example

ring.radius = arenaRadius - 1;

theta

theta: number = 0

Angle in radians around the Y axis, measured from +Z toward +X

Example

carousel.theta += ticker.deltaMS * 0.001;

`Readonly`type

type: SHAPE_PRIMITIVE_3D = 'cylindrical'

Names the shape without an instanceof check, like the type on pixi's 2D shapes

Default

'cylindrical'

y

y: number = 0

Height above the XZ plane

Example

spiral.y += climbSpeed;

Methods

clone

clone(): Cylindrical
Creates a new Cylindrical with the same values

Returns Cylindrical
The new instance
Example
```
const start = slot.clone();
```

copyFrom

copyFrom(other: Cylindrical): this
Copies other into this instance
Parameters
- other: Cylindrical
  The coordinates to copy from
Returns this
This instance for chaining
Example
```
restingSlot.copyFrom(slot);
```

copyTo

copyTo<T extends Cylindrical>(target: T): T
Copies this instance into target and returns it
Type Parameters
- T extends Cylindrical
Parameters
- target: T
  The instance to copy into
Returns T
The given target
Example
```
slot.copyTo(restingSlot);
```

equals

equals(other: Cylindrical): boolean
Returns true when radius, theta and y match other exactly (no epsilon tolerance)
Parameters
- other: Cylindrical
  The coordinates to compare with
Returns boolean
Whether all components match
Example
```
const settled = slot.equals(restingSlot);
```

set

set(radius: number, theta: number, y: number): this
Sets radius, theta and y
Parameters
- radius: number
  Distance from the Y axis
- theta: number
  Azimuthal angle (radians) measured from +Z
- y: number
  Height above the XZ plane
Returns this
This instance for chaining
Example
```
const slot = new Cylindrical().set(6, (index / count) * Math.PI * 2, 0);
```

setFromCartesianCoords

setFromCartesianCoords(x: number, y: number, z: number): this
Sets this instance from Cartesian (x, y, z)
Parameters
- x: number
  The Cartesian x coordinate
- y: number
  The Cartesian y coordinate
- z: number
  The Cartesian z coordinate
Returns this
This instance for chaining
Example
```
const around = new Cylindrical().setFromCartesianCoords(pointer.x, 0, pointer.z);
```

setFromPoint3D

setFromPoint3D(v: PointData3D): this
Sets this instance from the Cartesian point v
Parameters
- v: PointData3D
  The Cartesian point to convert
Returns this
This instance for chaining
Example
```
const around = new Cylindrical().setFromPoint3D(player.position);
```

toString

toString(): string

Advanced
Returns a string representation of these coordinates

Returns string
A string in the form [@pixi/3d/math:Cylindrical radius=1 theta=0 y=0]

Class Cylindrical

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Cylindrical

Properties

radius

Example

theta

Example

Readonlytype

Default

y

Example

Methods

clone

Returns Cylindrical

Example

copyFrom

Parameters

Returns this

Example

copyTo

Type Parameters

Parameters

Returns T

Example

equals

Parameters

Returns boolean

Example

set

Parameters

Returns this

Example

setFromCartesianCoords

Parameters

Returns this

Example

setFromPoint3D

Parameters

Returns this

Example

toString

Returns string

Settings

On This Page

`Readonly`type