OrderedCompositePrimitive

java.lang.Object
- agi.foundation.graphics.Primitive
- - agi.foundation.graphics.OrderedCompositePrimitive

All Implemented Interfaces:

IDisposable, AutoCloseable, Iterable<Primitive>
```
public final class OrderedCompositePrimitive
extends Primitive
implements Iterable<Primitive>, IDisposable
```
A primitive composed of other primitives with a well defined render order. The ordered composite is intended to contain overlapping primitives rendered on the globe's surface. Which primitives are on top of which primitives is defined by the position of the primitive in the composite, which can be controlled with Add, BringToFront, BringForward, SendBackward, and SendToBack.

The ordered composite is compatible with the following primitives:
- SurfaceMeshPrimitive
- TriangleMeshPrimitive
- PolylinePrimitive
- PointBatchPrimitive
- MarkerBatchPrimitive
- TextBatchPrimitive
- OrderedCompositePrimitive
It is not intended for use with: ModelPrimitive, SolidPrimitive, or CompositePrimitive.

Primitives in a composite must have the same agi.foundation.graphics.primitive.ReferenceFrame.
See Also:

Ordered Composite Primitive topic, Add, BringToFront, BringForward, SendBackward, SendToBack, CompositePrimitive

Constructor Summary

Constructors
Constructor and Description

OrderedCompositePrimitive()
Initializes a default ordered composite primitive.

Constructors
Constructor and Description
`OrderedCompositePrimitive()` Initializes a default ordered composite primitive.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Primitive primitive)` Adds a primitive to the front of the composite.
`void`	`bringForward(Primitive primitive)` Moves a primitive in the composite forward one slot.
`void`	`bringToFront(Primitive primitive)` Moves a primitive to the top of the composite, so that it is rendered on top of all other primitives in the composite.
`void`	`clear()` Removes all primitives from the composite.
`boolean`	`contains(Primitive primitive)` Determines whether the composite contains a primitive.
`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.
`Primitive`	`get(int index)` Returns the primitive at the given zero-based index.
`Color`	`getColor()` The ordered composite primitive does not support the color property.
`int`	`getCount()` Gets the number of primitives in the composite.
`DisplayCondition`	`getDisplayCondition()` Gets the composite's display condition.
`float`	`getTranslucency()` The ordered composite primitive does not support the translucency property.
`Iterator<Primitive>`	`iterator()` Returns an enumerator that iterates through each primitive in the composite.
`void`	`remove(Primitive primitive)` Removes a primitive from the composite.
`void`	`sendBackward(Primitive primitive)` Moves a primitive in the composite backwards one slot.
`void`	`sendToBack(Primitive primitive)` Moves a primitive to the bottom of the composite, so that it is rendered below all other primitives in the composite.
`void`	`setColor(Color value)` The ordered composite primitive does not support the color property.
`void`	`setDisplayCondition(DisplayCondition value)` Sets the composite's display condition.
`void`	`setReferenceFrame(ReferenceFrame value)` Sets the reference frame this primitive is defined and rendered in.
`void`	`setTranslucency(float value)` The ordered composite primitive does not support the translucency property.

Methods inherited from class agi.foundation.graphics.Primitive
dispose, getAutomaticallyComputeBoundingSphere, getBoundingSphere, getDisplay, getReferenceFrame, getTag, setAutomaticallyComputeBoundingSphere, setBoundingSphere, setDisplay, setTag

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface agi.foundation.compatibility.IDisposable
close, dispose

- Constructor Detail
  - OrderedCompositePrimitive
```
public OrderedCompositePrimitive()
```
    Initializes a default ordered composite primitive.
    After constructing a composite, use Add to add primitives in the order they should be rendered; primitives added first are rendered below those added later. Once primitives are added to the composite, use methods such as BringToFront and SendToBack to change the render order.
    
    The primitive's properties are initialized to the following values:
    - agi.foundation.graphics.primitive.AutomaticallyComputeBoundingSphere: true
    - BoundingSphere: BoundingSphere.MaximumRadiusBoundingSphere (get)
    - Color: undefined
    - agi.foundation.graphics.primitive.Display: true
    - DisplayCondition: null
    - ReferenceFrame: The earth's agi.foundation.celestial.earthcentralbody.FixedFrame
    - Translucency: undefined
    - Count: 0
    Once the primitive is constructed, it must be added to Primitives (get) before it will be rendered.
    See Also:
    
    Add, BringToFront, SendToBack
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: java.lang.Object
    
    Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize 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.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - the Exception raised by this method
    
    See Also:
    
    WeakReference, PhantomReference
  - dispose
```
protected void dispose(boolean disposing)
```
    Overrides:
    
    dispose in class Primitive
  - getDisplayCondition
```
public DisplayCondition getDisplayCondition()
```
    Gets the composite's display condition. During rendering, first a composite's display condition is evaluated. If it succeeds, the display condition for each primitive in the composite is evaluated.
    
    Overrides:
    
    getDisplayCondition in class Primitive
    
    See Also:
    
    Composite Primitive topic
  - setDisplayCondition
```
public void setDisplayCondition(DisplayCondition value)
```
    Sets the composite's display condition. During rendering, first a composite's display condition is evaluated. If it succeeds, the display condition for each primitive in the composite is evaluated.
    
    Overrides:
    
    setDisplayCondition in class Primitive
    
    See Also:
    
    Composite Primitive topic
  - getColor
```
public Color getColor()
```
    The ordered composite primitive does not support the color property.
    
    Overrides:
    
    getColor in class Primitive
    
    Throws:
    
    UnsupportedOperationException - Always thrown by the ordered composite primitive.
  - setColor
```
public void setColor(Color value)
```
    The ordered composite primitive does not support the color property.
    
    Overrides:
    
    setColor in class Primitive
    
    Throws:
    
    UnsupportedOperationException - Always thrown by the ordered composite primitive.
  - getTranslucency
```
public float getTranslucency()
```
    The ordered composite primitive does not support the translucency property.
    
    Overrides:
    
    getTranslucency in class Primitive
    
    Throws:
    
    UnsupportedOperationException - Always thrown by the ordered composite primitive.
  - setTranslucency
```
public void setTranslucency(float value)
```
    The ordered composite primitive does not support the translucency property.
    
    Overrides:
    
    setTranslucency in class Primitive
    
    Throws:
    
    UnsupportedOperationException - Always thrown by the ordered composite primitive.
  - getCount
```
public final int getCount()
```
    Gets the number of primitives in the composite.
  - get
```
public Primitive get(int index)
```
    Returns the primitive at the given zero-based index. The primitive at index zero is rendered on the bottom and the primitive at index Count - 1 is rendered on the top.
    
    Throws:
    
    ArgumentOutOfRangeException - index is out of range. It must be between 0 and Count - 1.
  - setReferenceFrame
```
public void setReferenceFrame(ReferenceFrame value)
```
    Description copied from class: Primitive
    
    Sets the reference frame this primitive is defined and rendered in.
    
    Overrides:
    
    setReferenceFrame in class Primitive
  - add
```
public final void add(Primitive primitive)
```
    Adds a primitive to the front of the composite. Primitives at the front are rendered on top of primitives at the bottom.
    Primitives are rendered in the order they are added, so the first primitive added to the composite is rendered on the bottom and the last primitive added is rendered on top. The order can be changed with calls such as BringToFront and SendToBack.
    
    The ordered composite primitive is intended to contain primitives rendered on the globe's surface. It is only recommonded to add the following primitives:
    In particular, it is not intended for use with: ModelPrimitive, SolidPrimitive, or CompositePrimitive.
    
    Regardless of order in the composite, all SurfaceMeshPrimitives are rendered before other primitives in the composite.
    Parameters:
    
    primitive - The primitive to add to the composite.
    
    Throws:
    
    ArgumentNullException - primitive is null.
    
    ArgumentException - primitive doesn't have the same agi.foundation.graphics.primitive.ReferenceFrame as the composite.
    
    ArgumentException - primitive already was already added to a composite or the primitive manager.
    
    See Also:
    
    BringToFront, BringForward, SendBackward, SendToBack, Remove
  - remove
```
public final void remove(Primitive primitive)
```
    Removes a primitive from the composite.
    If primitive does not exist in the composite, this call is ignored.
    
    Parameters:
    
    primitive - The primitive to remove from the composite.
    
    See Also:
    
    Add
  - contains
```
public final boolean contains(Primitive primitive)
```
    Determines whether the composite contains a primitive.
    
    Parameters:
    
    primitive - The primitive to locate in the composite.
    
    Returns:
    
    true if primitive is found in the composite; otherwise, false.
  - clear
```
public void clear()
```
    Removes all primitives from the composite.
    
    See Also:
    
    Remove
  - bringToFront
```
public final void bringToFront(Primitive primitive)
```
    Moves a primitive to the top of the composite, so that it is rendered on top of all other primitives in the composite.
    Regardless of order in the composite, all SurfaceMeshPrimitives are rendered before other primitives in the composite.
    
    Parameters:
    
    primitive - The primitive in the composite to bring to the front.
    
    Throws:
    
    ArgumentNullException - primitive is null.
    
    ArgumentException - primitive does not exist in the composite.
    
    See Also:
    
    SendToBack, BringForward, SendBackward
  - sendToBack
```
public final void sendToBack(Primitive primitive)
```
    Moves a primitive to the bottom of the composite, so that it is rendered below all other primitives in the composite.
    Regardless of order in the composite, all SurfaceMeshPrimitives are rendered before other primitives in the composite.
    
    Parameters:
    
    primitive - The primitive in the composite to send to the back.
    
    Throws:
    
    ArgumentNullException - primitive is null.
    
    ArgumentException - primitive does not exist in the composite.
    
    See Also:
    
    BringToFront, BringForward, SendBackward
  - bringForward
```
public final void bringForward(Primitive primitive)
```
    Moves a primitive in the composite forward one slot. Primitives at the front are rendered on top of primitives at the bottom.
    Regardless of order in the composite, all SurfaceMeshPrimitives are rendered before other primitives in the composite.
    
    Parameters:
    
    primitive - The primitive in the composite to bring forward.
    
    Throws:
    
    ArgumentNullException - primitive is null.
    
    ArgumentException - primitive does not exist in the composite.
    
    See Also:
    
    BringToFront, SendToBack, SendBackward
  - sendBackward
```
public final void sendBackward(Primitive primitive)
```
    Moves a primitive in the composite backwards one slot. Primitives at the bottom are rendered below primitives at the front.
    Regardless of order in the composite, all SurfaceMeshPrimitives are rendered before other primitives in the composite.
    
    Parameters:
    
    primitive - The primitive in the composite to send backwards.
    
    Throws:
    
    ArgumentNullException - primitive is null.
    
    ArgumentException - primitive does not exist in the composite.
    
    See Also:
    
    BringToFront, SendToBack, BringForward
  - iterator
```
public Iterator<Primitive> iterator()
```
    Returns an enumerator that iterates through each primitive in the composite.
    
    Specified by:
    
    iterator in interface Iterable<Primitive>
    
    Returns:
    
    An enumerator that can be used to iterate through each primitive in the composite.

Class OrderedCompositePrimitive

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.graphics.Primitive

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface agi.foundation.compatibility.IDisposable

Constructor Detail

Method Detail

finalize

dispose

getDisplayCondition

setDisplayCondition

getColor

setColor

getTranslucency

setTranslucency

getCount

get

setReferenceFrame

add

remove

contains

clear

bringToFront

sendToBack

bringForward

sendBackward

iterator