CompositePrimitive

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

All Implemented Interfaces:

IDisposable, AutoCloseable, Iterable<Primitive>
```
public final class CompositePrimitive
extends Primitive
implements Iterable<Primitive>, IDisposable
```
A primitive that is composed of multiple other primitives. Since composites can contain other composites, they are commonly used to build hierarchies of primitives to efficiently evaluate display conditions.

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

See Also:

Composite Primitive topic, OrderedCompositePrimitive

Constructor Summary

Constructors
Constructor and Description

CompositePrimitive()
Initializes a default composite primitive.

Constructors
Constructor and Description
`CompositePrimitive()` Initializes a default 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 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.
`BoundingSphere`	`getBoundingSphere()` Gets the bounding sphere that encompasses the primitive.
`Color`	`getColor()` The 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 composite primitive does not support the translucency property.
`PrimitivesSortOrder`	`getTranslucentPrimitivesSortOrder()` Gets the sort order for translucent primitives in this composite.
`Iterator<Primitive>`	`iterator()` Returns an enumerator that iterates through the collection.
`void`	`remove(Primitive primitive)` Removes a primitive from the composite.
`void`	`setColor(Color value)` The 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 composite primitive does not support the translucency property.
`void`	`setTranslucentPrimitivesSortOrder(PrimitivesSortOrder value)` Sets the sort order for translucent primitives in this composite.

Methods inherited from class agi.foundation.graphics.Primitive
dispose, getAutomaticallyComputeBoundingSphere, 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
  - CompositePrimitive
```
public CompositePrimitive()
```
    Initializes a default composite primitive.
    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
    - TranslucentPrimitivesSortOrder: PrimitivesSortOrderByState
    - Count: 0
    Once the primitive is constructed, it must be added to Primitives (get) before it will be rendered.
- 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 composite primitive does not support the color property.
    
    Overrides:
    
    getColor in class Primitive
    
    Throws:
    
    UnsupportedOperationException - Always thrown by the composite primitive.
  - setColor
```
public void setColor(Color value)
```
    The composite primitive does not support the color property.
    
    Overrides:
    
    setColor in class Primitive
    
    Throws:
    
    UnsupportedOperationException - Always thrown by the composite primitive.
  - getTranslucency
```
public float getTranslucency()
```
    The composite primitive does not support the translucency property.
    
    Overrides:
    
    getTranslucency in class Primitive
    
    Throws:
    
    UnsupportedOperationException - Always thrown by the composite primitive.
  - setTranslucency
```
public void setTranslucency(float value)
```
    The composite primitive does not support the translucency property.
    
    Overrides:
    
    setTranslucency in class Primitive
    
    Throws:
    
    UnsupportedOperationException - Always thrown by the composite primitive.
  - getCount
```
public final int getCount()
```
    Gets the number of primitives in the composite.
  - getTranslucentPrimitivesSortOrder
```
public final PrimitivesSortOrder getTranslucentPrimitivesSortOrder()
```
    Gets the sort order for translucent primitives in this composite. This determines a trade-off between rendering speed and quality. It is only recommended to use PrimitivesSortOrderBackToFront when translucent primitives along the same line of sight cause blending artifacts.
    
    See Also:
    
    PrimitivesSortOrder
  - setTranslucentPrimitivesSortOrder
```
public final void setTranslucentPrimitivesSortOrder(PrimitivesSortOrder value)
```
    Sets the sort order for translucent primitives in this composite. This determines a trade-off between rendering speed and quality. It is only recommended to use PrimitivesSortOrderBackToFront when translucent primitives along the same line of sight cause blending artifacts.
    
    See Also:
    
    PrimitivesSortOrder
  - 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
  - getBoundingSphere
```
public BoundingSphere getBoundingSphere()
```
    Description copied from class: Primitive
    
    Gets the bounding sphere that encompasses the primitive. The center is defined in the primitive's ReferenceFrame.
    
    Overrides:
    
    getBoundingSphere in class Primitive
  - add
```
public final void add(Primitive primitive)
```
    Adds a primitive to 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 exists in another composite or the primitive manager.
  - 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.
  - 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
  - iterator
```
public Iterator<Primitive> iterator()
```
    Returns an enumerator that iterates through the collection. The order of the primitives is not guaranteed to be the order that the primitives were added.
    
    Specified by:
    
    iterator in interface Iterable<Primitive>
    
    Returns:
    
    An enumerator that can be used to iterate through the collection.

Class CompositePrimitive

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

getTranslucentPrimitivesSortOrder

setTranslucentPrimitivesSortOrder

setReferenceFrame

getBoundingSphere

add

remove

contains

clear

iterator