agi.foundation.platforms.advanced

(agi.foundation.platforms.graphics-2024r2.jar)

Class DisplayParametersHelper

java.lang.Object

agi.foundation.platforms.advanced.DisplayParametersHelper

All Implemented Interfaces:

IDisposable, IEquatableDefinition, AutoCloseable

public final class DisplayParametersHelper
extends Object
implements IDisposable, IEquatableDefinition

A utility class used by ServiceProviderVisualizers that takes a DisplayParameters and creates and maintains a set of equivalent DisplayCondition (get).

Constructor Summary

Constructors

Constructor and Description
DisplayParametersHelper(DisplayParameters displayParameters, EvaluatorGroup group, DisplayConditionType type) Creates a new instances using the provided DisplayParameters and EvaluatorGroup.

Method Summary

Modifier and Type	Method and Description
void	dispose() Releases any resources associated with this instance.
ConstantDisplayCondition	getConstantCondition() Gets the generated ConstantDisplayCondition.
int	getDefinitionHashCode() Gets a hash code representing the definition of this object.
DisplayCondition	getDisplayCondition() Gets the generated display condition.
DistanceDisplayCondition	getDistanceCondition() Gets the generated DistanceDisplayCondition.
PixelSizeDisplayCondition	getPixelSizeCondition() Gets the generated PixelSizeDisplayCondition.
SceneDisplayCondition	getSceneCondition() Gets the generated SceneDisplayCondition.
boolean	isSameDefinition(DisplayParametersHelper other) Determines if this object has the same definition as another object.
boolean	isSameDefinition(Object other) Determines if this object has the same definition as another object.
void	update(JulianDate time) Updates the display condition instances to their state at the provided time.
void	updateReferences(EvaluatorGroup group) Uses the provided group to update previously created evaluators.

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close

Constructor Detail

DisplayParametersHelper

public DisplayParametersHelper(DisplayParameters displayParameters,
                               EvaluatorGroup group,
                               @Nonnull
                               DisplayConditionType type)

Creates a new instances using the provided DisplayParameters and EvaluatorGroup.

Parameters:

displayParameters - The display parameters, which can be null.

group - The group in which to create evaluators.

type - The type of display conditions to create.

Method Detail

dispose

public final void dispose()

Releases any resources associated with this instance.

Specified by:

dispose in interface IDisposable

isSameDefinition

public final boolean isSameDefinition(Object other)

Description copied from interface: IEquatableDefinition

Determines if this object has the same definition as another object.

This method is very similar to Object.equals(Object) except that it explicitly considers the "definitions" of the two objects for objects that do not typically act like values. The definition of an object typically includes all of the fields of the object.

Specified by:

isSameDefinition in interface IEquatableDefinition

Parameters:

other - The other instance to compare to this one.

Returns:

true if this object has the same definition as the specified one. false if the other object is null, a different type than this one, or if this object and the specified one have different definitions.

isSameDefinition

public final boolean isSameDefinition(DisplayParametersHelper other)

Determines if this object has the same definition as another object.

This method is very similar to Object.equals(Object) except that it explicitly considers the "definitions" of the two objects for objects that do not typically act like values. The definition of an object typically includes all of the fields of the object.

Parameters:

other - The other instance to compare to this one.

Returns:

true if this object has the same definition as the specified one. false if the other object is null, a different type than this one, or if this object and the specified one have different definitions.

getDefinitionHashCode

public final int getDefinitionHashCode()

Gets a hash code representing the definition of this object.

This method is very similar to Object.hashCode() except that it explicitly includes the "definition" of the object even if the object does not typically act like a value. The definition of an object typically includes all of the fields of the object. The value returned by this method should NOT change. This means that two objects for which DisplayParametersHelper.isSameDefinition(java.lang.Object) returns true will not necessarily have the same hash code if one or the other was changed after the hash code was first obtained.

Specified by:

getDefinitionHashCode in interface IEquatableDefinition

Returns:

The hash code.

getDisplayCondition

public final DisplayCondition getDisplayCondition()

Gets the generated display condition.

getDistanceCondition

public final DistanceDisplayCondition getDistanceCondition()

Gets the generated DistanceDisplayCondition.

getSceneCondition

public final SceneDisplayCondition getSceneCondition()

Gets the generated SceneDisplayCondition.

getPixelSizeCondition

public final PixelSizeDisplayCondition getPixelSizeCondition()

Gets the generated PixelSizeDisplayCondition.

getConstantCondition

public final ConstantDisplayCondition getConstantCondition()

Gets the generated ConstantDisplayCondition.

update

public final void update(@Nonnull
                         JulianDate time)

Updates the display condition instances to their state at the provided time.

Parameters:

time - The time at which to evaluate.

updateReferences

public final void updateReferences(@Nonnull
                                   EvaluatorGroup group)

Uses the provided group to update previously created evaluators.

Parameters:

group - The group from which to update evaluator references.