agi.foundation.platforms.advanced

(agi.foundation.platforms.graphics-2023r1.jar)

Class GraphicsParameter<T>

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.platforms.advanced.GraphicsParameter<T>

Type Parameters:

T - The type of parameter.

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IGraphicsParameter

Direct Known Subclasses:

AccessQueryGraphicsParameter, AxesGraphicsParameter, ConstantGraphicsParameter, GraphicsParameterFormatter, GraphicsParameterTransform, PointGraphicsParameter, ScalarGraphicsParameter, TimeIntervalGraphicsParameter, VectorGraphicsParameter

public abstract class GraphicsParameter<T>
extends DefinitionalObject
implements IGraphicsParameter

Base class for all graphics parameters, which define the individual properties of graphics over time.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GraphicsParameter() Initializes a new instance.
protected	GraphicsParameter(GraphicsParameter<T> existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(GraphicsParameter<T> other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
abstract Evaluator<T>	getEvaluator(EvaluatorGroup group) Gets an evaluator which returns T
Evaluator<Object>	getObjectEvaluator(EvaluatorGroup group) Gets an evaluator which returns an object.
boolean	isSameDefinition(GraphicsParameter<T> other) Determines if this object has the same definition as another object.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicsParameter

protected GraphicsParameter()

Initializes a new instance.

GraphicsParameter

protected GraphicsParameter(@Nonnull
                            GraphicsParameter<T> existingInstance,
                            @Nonnull
                            CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

isSameDefinition

public final boolean isSameDefinition(GraphicsParameter<T> 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.

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(GraphicsParameter<T> other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the GraphicsParameter.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getEvaluator

@Nonnull
public abstract Evaluator<T> getEvaluator(@Nonnull
                                                    EvaluatorGroup group)

Gets an evaluator which returns T

Parameters:

group - The group in which to create the Evaluator.

Returns:

An evaluator that returns the value of T at the specified time.

getObjectEvaluator

public final Evaluator<Object> getObjectEvaluator(EvaluatorGroup group)

Gets an evaluator which returns an object.

Specified by:

getObjectEvaluator in interface IGraphicsParameter

Parameters:

group - The group in which to create the Evaluator.

Returns:

An evaluator that returns the object at the specified time.