agi.foundation.terrain

(agi.foundation.models-2021r1.jar)

Class ElevationMask

java.lang.Object

agi.foundation.compatibility.BaseCollection<ElevationRise>

agi.foundation.terrain.ElevationMask

All Implemented Interfaces:

IEquatable<ElevationMask>, Iterable<ElevationRise>, Collection<ElevationRise>, List<ElevationRise>

public class ElevationMask
extends BaseCollection<ElevationRise>
implements IEquatable<ElevationMask>

The elevation mask along a particular azimuth ray of an AzimuthElevationMask. This class defines how the view is obscured in a particular direction.

Constructor Summary

Constructors

Constructor and Description
ElevationMask() Initializes a new instance.
ElevationMask(double azimuth, double elevation) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(ElevationMask other) Indicates whether another instance of this type is exactly equal to this instance.
double	getAzimuth() Gets the azimuth of the ray, in radians.
double	getElevation() Gets the maximum obscured elevation angle along the ray, in radians.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
void	setAzimuth(double value) Sets the azimuth of the ray, in radians.
void	setElevation(double value) Sets the maximum obscured elevation angle along the ray, in radians.

Methods inherited from class agi.foundation.compatibility.BaseCollection

add, add, addAll, addAll, clear, clearItems, contains, containsAll, get, getItems, indexOf, insertItem, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeItem, retainAll, set, setItem, size, subList, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ElevationMask

public ElevationMask()

Initializes a new instance.

ElevationMask

public ElevationMask(double azimuth,
                     double elevation)

Initializes a new instance.

Parameters:

azimuth - The azimuth of the ray, in radians.

elevation - The maximum obscured elevation along the ray, in radians.

Method Detail

getAzimuth

public final double getAzimuth()

Gets the azimuth of the ray, in radians.

setAzimuth

public final void setAzimuth(double value)

Sets the azimuth of the ray, in radians.

getElevation

public final double getElevation()

Gets the maximum obscured elevation angle along the ray, in radians.

setElevation

public final void setElevation(double value)

Sets the maximum obscured elevation angle along the ray, in radians.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Specified by:

equals in interface Collection<ElevationRise>

Specified by:

equals in interface List<ElevationRise>

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(ElevationMask other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<ElevationMask>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Specified by:

hashCode in interface Collection<ElevationRise>

Specified by:

hashCode in interface List<ElevationRise>

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)