Home Reference Source

import {Cylindrical} from 'math-ds'

public class | source

Cylindrical

A cylindrical coordinate system.

For details see: https://en.wikipedia.org/wiki/Cylindrical_coordinate_system

Constructor Summary

Public Constructor
public	constructor(radius: Number, theta: Number, y: Number) Constructs a new cylindrical system.

Member Summary

Public Members
public	radius: Number The distance from the origin to a point in the XZ-plane.
public	theta: Number The counterclockwise angle in the XZ-plane measured in radians from the positive Z-axis.
public	y: Number The height above the XZ-plane.

Method Summary

Public Methods
public	clone(): Cylindrical Clones this cylindrical system.
public	copy(c: Cylindrical): Cylindrical Copies the values of the given cylindrical system.
public	set(radius: Number, theta: Number, y: Number): Cylindrical Sets the values of this cylindrical system.
public	setFromCartesianCoords(x: Number, y: Number, z: Number): Cylindrical Sets the values of this cylindrical system based on cartesian coordinates.
public	setFromVector3(v: Vector3): Cylindrical Sets the values of this cylindrical system.

Public Constructors

public constructor(radius: Number, theta: Number, y: Number) source

Constructs a new cylindrical system.

Params:

Name	Type	Attribute	Description
radius	Number	optional default: 1	The radius of the cylinder.
theta	Number	optional default: 0	Theta.
y	Number	optional default: 0	The height.

Public Members

public radius: Number source

The distance from the origin to a point in the XZ-plane.

public theta: Number source

The counterclockwise angle in the XZ-plane measured in radians from the positive Z-axis.

public y: Number source

The height above the XZ-plane.

Public Methods

public clone(): Cylindrical source

Clones this cylindrical system.

Return:

The cloned cylindrical system.

public copy(c: Cylindrical): Cylindrical source

Copies the values of the given cylindrical system.

Params:

Name	Type	Attribute	Description
c	Cylindrical		A cylindrical system.

Return:

This cylindrical system.

public set(radius: Number, theta: Number, y: Number): Cylindrical source

Sets the values of this cylindrical system.

Params:

Name	Type	Attribute	Description
radius	Number		The radius.
theta	Number		Theta.
y	Number		The height.

Return:

This cylindrical system.

public setFromCartesianCoords(x: Number, y: Number, z: Number): Cylindrical source

Sets the values of this cylindrical system based on cartesian coordinates.

Params:

Name	Type	Attribute	Description
x	Number		The X coordinate.
y	Number		The Y coordinate.
z	Number		The Z coordinate.

Return:

This cylindrical system.

public setFromVector3(v: Vector3): Cylindrical source

Sets the values of this cylindrical system.

Params:

Name	Type	Attribute	Description
v	Vector3		A vector.

Return:

This cylindrical system.