public final class DistanceToPrimitiveDisplayCondition extends DisplayCondition implements IDisposable
Primitive.
This is different from DistanceDisplayCondition because it
is based on the camera's distance to a specified Primitive, rather than the camera's
distance to the object that uses this display condition.| Constructor and Description |
|---|
DistanceToPrimitiveDisplayCondition()
Initializes a default distance to primitive display condition.
|
DistanceToPrimitiveDisplayCondition(Primitive primitive,
double minimumDistance,
double maximumDistance)
Initializes a distance to primitive display condition with the inclusive distance interval
[
minimumDistance, maximumDistance]. |
| Modifier and Type | Method and Description |
|---|---|
protected void |
dispose(boolean disposing) |
protected void |
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
double |
getMaximumDistance()
Gets the maximum distance, in meters, of the inclusive distance interval.
|
double |
getMaximumDistanceSquared()
Gets the squared maximum distance, in meters, of the inclusive distance interval.
|
double |
getMinimumDistance()
Gets the minimum distance, in meters, of the inclusive distance interval.
|
double |
getMinimumDistanceSquared()
Gets the squared minimum distance, in meters, of the inclusive distance interval.
|
Primitive |
getPrimitive()
Gets the primitive associated with this instance.
|
void |
setMaximumDistance(double maximumDistance)
Sets the maximum distance, in meters, of the inclusive distance interval.
|
void |
setMinimumDistance(double minimumDistance)
Sets the minimum distance, in meters, of the inclusive distance interval.
|
void |
setPrimitive(Primitive value)
Sets the primitive associated with this instance.
|
disposeclone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclose, disposepublic DistanceToPrimitiveDisplayCondition()
Primitive.
The display condition's properties are initialized to the following values:
MinimumDistance: -1.7976931348623158e+308MaximumDistance: 1.7976931348623158e+308public DistanceToPrimitiveDisplayCondition(Primitive primitive, double minimumDistance, double maximumDistance)
minimumDistance, maximumDistance]. When this
display condition is assigned to an object, such as a
screen overlay,
the object is only
rendered
when the distance, in meters, from the camera to the Primitive, is within the interval.primitive - The primitive associated with this instance.minimumDistance - The minimum distance, in meters, of the inclusive distance interval.maximumDistance - The maximum distance, in meters, of the inclusive distance interval.
Use Double.MaxValue to ignore checking the maximum distance.ArgumentOutOfRangeException - minimumDistance and maximumDistance
must be greater than or equal to zero.protected void finalize()
throws Throwable
java.lang.Objectfinalize method to dispose of
system resources or to perform other cleanup.
The general contract of finalize is that it is invoked
if and when the Java™ virtual
machine has determined that there is no longer any
means by which this object can be accessed by any thread that has
not yet died, except as a result of an action taken by the
finalization of some other object or class which is ready to be
finalized. The finalize method may take any action, including
making this object available again to other threads; the usual purpose
of finalize, however, is to perform cleanup actions before
the object is irrevocably discarded. For example, the finalize method
for an object that represents an input/output connection might perform
explicit I/O transactions to break the connection before the object is
permanently discarded.
The finalize method of class Object performs no
special action; it simply returns normally. Subclasses of
Object may override this definition.
The Java programming language does not guarantee which thread will
invoke the finalize method for any given object. It is
guaranteed, however, that the thread that invokes finalize will not
be holding any user-visible synchronization locks when finalize is
invoked. If an uncaught exception is thrown by the finalize method,
the exception is ignored and finalization of that object terminates.
After the finalize method has been invoked for an object, no
further action is taken until the Java virtual machine has again
determined that there is no longer any means by which this object can
be accessed by any thread that has not yet died, including possible
actions by other objects or classes which are ready to be finalized,
at which point the object may be discarded.
The finalize method is never invoked more than once by a Java
virtual machine for any given object.
Any exception thrown by the finalize method causes
the finalization of this object to be halted, but is otherwise
ignored.
finalize in class ObjectThrowable - the Exception raised by this methodWeakReference,
PhantomReferenceprotected void dispose(boolean disposing)
dispose in class DisplayConditionpublic final Primitive getPrimitive()
public final void setPrimitive(Primitive value)
public final double getMinimumDistance()
ArgumentOutOfRangeException - MinimumDistance must be greater than or equal to zero.DistanceToPrimitiveDisplayCondition.DistanceToPrimitiveDisplayCondition(agi.foundation.graphics.Primitive,double,double)public final void setMinimumDistance(double minimumDistance)
ArgumentOutOfRangeException - MinimumDistance must be greater than or equal to zero.DistanceToPrimitiveDisplayCondition.DistanceToPrimitiveDisplayCondition(agi.foundation.graphics.Primitive,double,double)public final double getMinimumDistanceSquared()
MinimumDistancepublic final double getMaximumDistance()
Double.MaxValue to ignore checking the maximum distance.ArgumentOutOfRangeException - MaximumDistance must be greater than or equal to zero.DistanceToPrimitiveDisplayCondition.DistanceToPrimitiveDisplayCondition(agi.foundation.graphics.Primitive,double,double)public final void setMaximumDistance(double maximumDistance)
Double.MaxValue to ignore checking the maximum distance.ArgumentOutOfRangeException - MaximumDistance must be greater than or equal to zero.DistanceToPrimitiveDisplayCondition.DistanceToPrimitiveDisplayCondition(agi.foundation.graphics.Primitive,double,double)public final double getMaximumDistanceSquared()
MaximumDistance