org.cesiumjs.cs.core

Class NearFarScalar

java.lang.Object

org.cesiumjs.cs.core.NearFarScalar

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
double	far The upper bound of the camera range.
double	farValue The value at the upper bound of the camera range.
double	near The lower bound of the camera range.
double	nearValue The value at the lower bound of the camera range.

Constructor Summary

Constructors

Constructor and Description
NearFarScalar() Represents a scalar value's lower and upper bound at a near distance and far distance in eye space.
NearFarScalar(Number near, Number nearValue, Number far, Number farValue) Represents a scalar value's lower and upper bound at a near distance and far distance in eye space.

Method Summary

Modifier and Type	Method and Description
NearFarScalar	clone() Duplicates this instance.
NearFarScalar	clone(NearFarScalar result) Duplicates this instance.
static NearFarScalar	clone(NearFarScalar nearFarScalar, NearFarScalar result) Duplicates a NearFarScalar instance.
boolean	equals(NearFarScalar right) Compares this instance to the provided NearFarScalar and returns true if they are equal, false otherwise.
static boolean	equals(NearFarScalar left, NearFarScalar right) Compares the provided NearFarScalar and returns true if they are equal, false otherwise.
double[]	pack(NearFarScalar value, double[] array) Stores the provided instance into the provided array.
double[]	pack(NearFarScalar value, double[] array, int startingIndex) Stores the provided instance into the provided array.
static int	packedLength() The number of elements used to pack the object into an array.
static NearFarScalar	unpack(double[] array) Retrieves an instance from a packed array.
static NearFarScalar	unpack(double[] array, int startingIndex) Retrieves an instance from a packed array.
static NearFarScalar	unpack(double[] array, int startingIndex, NearFarScalar result) Retrieves an instance from a packed array.

Methods inherited from class java.lang.Object

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

Field Detail

far

@JsProperty
public double far

The upper bound of the camera range. Default: 1.0

farValue

@JsProperty
public double farValue

The value at the upper bound of the camera range. Default: 0.0

near

@JsProperty
public double near

The lower bound of the camera range. Default: 0.0

nearValue

@JsProperty
public double nearValue

The value at the lower bound of the camera range. Default: 0.0

Constructor Detail

NearFarScalar

@JsConstructor
public NearFarScalar()

Represents a scalar value's lower and upper bound at a near distance and far distance in eye space.

See Also:

Packable

NearFarScalar

@JsConstructor
public NearFarScalar(Number near,
                                    Number nearValue,
                                    Number far,
                                    Number farValue)

Represents a scalar value's lower and upper bound at a near distance and far distance in eye space.

Parameters:

near - The lower bound of the camera range. Default: 0.0.

nearValue - The value at the lower bound of the camera range. Default: 0.0.

far - The upper bound of the camera range. Default: 1.0.

farValue - The value at the upper bound of the camera range. Default: 0.0.

See Also:

Packable

Method Detail

packedLength

@JsProperty(name="packedLength")
public static int packedLength()

The number of elements used to pack the object into an array.

clone

@JsMethod
public static NearFarScalar clone(NearFarScalar nearFarScalar,
                                            NearFarScalar result)

Duplicates a NearFarScalar instance.

Parameters:

nearFarScalar - The NearFarScalar to duplicate.

result - The object onto which to store the result.

Returns:

The modified result parameter or a new NearFarScalar instance if one was not provided. (Returns undefined if nearFarScalar is undefined)

equals

@JsMethod
public static boolean equals(NearFarScalar left,
                                       NearFarScalar right)

Compares the provided NearFarScalar and returns true if they are equal, false otherwise.

Parameters:

left - The first NearFarScalar.

right - The second NearFarScalar.

Returns:

true if left and right are equal; otherwise false.

pack

@JsMethod
public double[] pack(NearFarScalar value,
                               double[] array)

Stores the provided instance into the provided array.

Parameters:

value - The value to pack.

array - The array to pack into.

Returns:

The array that was packed into

pack

@JsMethod
public double[] pack(NearFarScalar value,
                               double[] array,
                               int startingIndex)

Stores the provided instance into the provided array.

Parameters:

value - The value to pack.

array - The array to pack into.

startingIndex - The index into the array at which to start packing the elements. Default: 0.

Returns:

The array that was packed into

unpack

@JsMethod
public static NearFarScalar unpack(double[] array)

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

Returns:

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

unpack

@JsMethod
public static NearFarScalar unpack(double[] array,
                                             int startingIndex)

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

startingIndex - The starting index of the element to be unpacked. Default: 0.

Returns:

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

unpack

@JsMethod
public static NearFarScalar unpack(double[] array,
                                             int startingIndex,
                                             NearFarScalar result)

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

startingIndex - The starting index of the element to be unpacked. Default: 0.

result - The object into which to store the result.

Returns:

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

clone

@JsMethod
public NearFarScalar clone()

Duplicates this instance.

Overrides:

clone in class Object

Returns:

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

clone

@JsMethod
public NearFarScalar clone(NearFarScalar result)

Duplicates this instance.

Parameters:

result - The object onto which to store the result.

Returns:

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

equals

@JsMethod
public boolean equals(NearFarScalar right)

Compares this instance to the provided NearFarScalar and returns true if they are equal, false otherwise.

Parameters:

right - The right hand side NearFarScalar.

Returns:

true if left and right are equal; otherwise false.