org.cesiumjs.cs.core

Class Spherical

java.lang.Object

org.cesiumjs.cs.core.Spherical

@JsType(isNative=true,
        namespace="Cesium",
        name="Spherical")
public class Spherical
extends Object

A set of curvilinear 3-dimensional coordinates.

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
Spherical() A set of curvilinear 3-dimensional coordinates.
Spherical(double clock, double cone, double magnitude) A set of curvilinear 3-dimensional coordinates.

Method Summary

Modifier and Type	Method and Description
Spherical	clone() Creates a duplicate of this Spherical.
Spherical	clone(Spherical result) Creates a duplicate of this Spherical.
static Spherical	clone(Spherical spherical, Spherical result) Creates a duplicate of a Spherical.
boolean	equals(Spherical other) Returns true if this spherical is equal to the provided spherical, false otherwise.
static boolean	equals(Spherical left, Spherical right) Returns true if the first spherical is equal to the second spherical, false otherwise.
boolean	equalsEpsilon(Spherical other, double epsilon) Returns true if this spherical is within the provided epsilon of the provided spherical, false otherwise.
static boolean	equalsEpsilon(Spherical left, Spherical right) Returns true if the first spherical is within the provided epsilon of the second spherical, false otherwise.
static boolean	equalsEpsilon(Spherical left, Spherical right, double epsilon) Returns true if the first spherical is within the provided epsilon of the second spherical, false otherwise.
static Spherical	fromCartesian3(Cartesian3 cartesian3) Converts the provided Cartesian3 into Spherical coordinates.
static Spherical	fromCartesian3(Cartesian3 cartesian3, Spherical spherical) Converts the provided Cartesian3 into Spherical coordinates.
static Spherical	normalize(Spherical spherical) Computes the normalized version of the provided spherical.
static Spherical	normalize(Spherical spherical, Spherical result) Computes the normalized version of the provided spherical.
String	toString() Returns a string representing this instance in the format (clock, cone, magnitude).

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Spherical

@JsConstructor
public Spherical()

A set of curvilinear 3-dimensional coordinates.

Spherical

@JsConstructor
public Spherical(double clock,
                                double cone,
                                double magnitude)

A set of curvilinear 3-dimensional coordinates.

Parameters:

clock - The angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. Default: 0.0.

cone - The angular coordinate measured from the positive z-axis and toward the negative z-axis. Optional. Defaule: 0.0.

magnitude - The linear coordinate measured from the origin. Optional. Default: 1.0.

Method Detail

clone

public static Spherical clone(Spherical spherical,
                              Spherical result)

Creates a duplicate of a Spherical.

Parameters:

spherical - The spherical to clone.

result - The object to store the result into, if undefined a new instance will be created. Optional.

Returns:

The modified result parameter or a new instance if result was undefined. (Returns undefined if spherical is undefined)

equals

public static boolean equals(Spherical left,
                             Spherical right)

Returns true if the first spherical is equal to the second spherical, false otherwise.

Parameters:

left - The first Spherical to be compared.

right - The second Spherical to be compared.

Returns:

true if the first spherical is equal to the second spherical, false otherwise.

equalsEpsilon

public static boolean equalsEpsilon(Spherical left,
                                    Spherical right)

Returns true if the first spherical is within the provided epsilon of the second spherical, false otherwise.

Parameters:

left - The first Spherical to be compared.

right - The second Spherical to be compared.

Returns:

true if the first spherical is within the provided epsilon of the second spherical, false otherwise.

equalsEpsilon

public static boolean equalsEpsilon(Spherical left,
                                    Spherical right,
                                    double epsilon)

Returns true if the first spherical is within the provided epsilon of the second spherical, false otherwise.

Parameters:

left - The first Spherical to be compared.

right - The second Spherical to be compared.

epsilon - The epsilon to compare against. Optional. Default: 0.0.

Returns:

true if the first spherical is within the provided epsilon of the second spherical, false otherwise.

fromCartesian3

public static Spherical fromCartesian3(Cartesian3 cartesian3)

Converts the provided Cartesian3 into Spherical coordinates.

Parameters:

cartesian3 - The Cartesian3 to be converted to Spherical.

Returns:

The modified result parameter, or a new instance if one was not provided.

fromCartesian3

public static Spherical fromCartesian3(Cartesian3 cartesian3,
                                       Spherical spherical)

Converts the provided Cartesian3 into Spherical coordinates.

Parameters:

cartesian3 - The Cartesian3 to be converted to Spherical.

spherical - The object in which the result will be stored, if undefined a new instance will be created. Optional.

Returns:

The modified result parameter, or a new instance if one was not provided.

normalize

public static Spherical normalize(Spherical spherical)

Computes the normalized version of the provided spherical.

Parameters:

spherical - The spherical to be normalized.

Returns:

The modified result parameter or a new instance if result was undefined.

normalize

public static Spherical normalize(Spherical spherical,
                                  Spherical result)

Computes the normalized version of the provided spherical.

Parameters:

spherical - The spherical to be normalized.

result - The object to store the result into, if undefined a new instance will be created. Optional.

Returns:

The modified result parameter or a new instance if result was undefined.

clone

public Spherical clone()

Creates a duplicate of this Spherical.

Overrides:

clone in class Object

Returns:

The modified result parameter or a new instance if result was undefined.

clone

public Spherical clone(Spherical result)

Creates a duplicate of this Spherical.

Parameters:

result - The object to store the result into, if undefined a new instance will be created. Optional.

Returns:

The modified result parameter or a new instance if result was undefined.

equals

public boolean equals(Spherical other)

Returns true if this spherical is equal to the provided spherical, false otherwise.

Parameters:

other - The Spherical to be compared.

Returns:

true if this spherical is equal to the provided spherical, false otherwise.

equalsEpsilon

public boolean equalsEpsilon(Spherical other,
                             double epsilon)

Returns true if this spherical is within the provided epsilon of the provided spherical, false otherwise.

Parameters:

other - The Spherical to be compared.

epsilon - The epsilon to compare against.

Returns:

true if this spherical is within the provided epsilon of the provided spherical, false otherwise.

toString

public String toString()

Returns a string representing this instance in the format (clock, cone, magnitude).

Overrides:

toString in class Object

Returns:

A string representing this instance.