PrimitiveManager | DME Component Libraries for Java 2024 r2

java.lang.Object
- agi.foundation.graphics.PrimitiveManager

All Implemented Interfaces:

IDisposable, AutoCloseable, Iterable<Primitive>
```
public final class PrimitiveManager
extends Object
implements Iterable<Primitive>, IDisposable
```
The primitive manager contains spatial data structures used to efficiently render primitives. Once a primitive is constructed, it must be added to the primitive manager before it will be rendered.

See Also:

Primitive Manager topic

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(Primitive primitive)` Adds a primitive to the manager.
`void`	`clear()` Removes all primitives from the manager.
`boolean`	`contains(Primitive primitive)` Determines whether the manager contains a primitive.
`void`	`dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`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.
`int`	`getCount()` Gets the number of primitives in the manager.
`int`	`getPrecisionExponent()` Deprecated. This property is no longer in use
`PrimitivesSortOrder`	`getTranslucentPrimitivesSortOrder()` Gets the sort order for translucent primitives in the primitive manager.
`Iterator<Primitive>`	`iterator()` Returns an enumerator that iterates through the collection.
`void`	`remove(Primitive primitive)` Removes a primitive from the manager.
`void`	`setPrecisionExponent(int value)` Deprecated. This property is no longer in use
`void`	`setTranslucentPrimitivesSortOrder(PrimitivesSortOrder value)` Sets the sort order for translucent primitives in the primitive manager.

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

- 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
```
public final void dispose()
```
    Description copied from interface: IDisposable
    
    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
    
    Specified by:
    
    dispose in interface IDisposable
  - dispose
```
protected void dispose(boolean disposing)
```
  - getCount
```
public int getCount()
```
    Gets the number of primitives in the manager. Count may be more than the number of primitives rendered per frame since the manager includes optimizations to only render visible primitives.
    
    Returns:
    
    The number of primitives in the manager.
  - getPrecisionExponent
```
@Deprecated
public int getPrecisionExponent()
```
    Deprecated. This property is no longer in use
    
    Gets the exponent used to compute the maximum precision for primitive rendering. For example, a value of -3 indicates the maximum precision of 2^-3, 0.125 m along the x, y, or z axis. The worst case precision, taking into account all axes, is sqrt(3 * (2^-3)^2), 0.2165 m. The default is -2.
  - setPrecisionExponent
```
@Deprecated
public void setPrecisionExponent(int value)
```
    Deprecated. This property is no longer in use
    
    Sets the exponent used to compute the maximum precision for primitive rendering. For example, a value of -3 indicates the maximum precision of 2^-3, 0.125 m along the x, y, or z axis. The worst case precision, taking into account all axes, is sqrt(3 * (2^-3)^2), 0.2165 m. The default is -2.
  - getTranslucentPrimitivesSortOrder
```
public PrimitivesSortOrder getTranslucentPrimitivesSortOrder()
```
    Gets the sort order for translucent primitives in the primitive manager. 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 void setTranslucentPrimitivesSortOrder(PrimitivesSortOrder value)
```
    Sets the sort order for translucent primitives in the primitive manager. 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
  - add
```
public void add(Primitive primitive)
```
    Adds a primitive to the manager. Primitives must be added to the manager to be rendered.
    When a primitive is added to the manager, the scene is not automatically re-rendered, so the primitive doesn't immediately show up. The scene can be rendered explicitly using SceneManager.Render or Scene.Render. For best performance, add several primitives to the manager before re-rendering.
    
    When a primitive is added to the manager, it appears in all scenes by default. To limit the number of scenes, assign a SceneDisplayCondition to the primitive's DisplayCondition (get).
    
    Parameters:
    
    primitive - The primitive to add to the manager.
    
    Throws:
    
    ArgumentNullException - primitive is null.
    
    ArgumentException - primitive already exists in a composite or the manager.
    
    See Also:
    
    Primitive Manager topic, CompositePrimitive
  - remove
```
public void remove(Primitive primitive)
```
    Removes a primitive from the manager. The primitive is no longer rendered unless it is added back into the manager.
    If primitive does not exist in the manager, this call is ignored.
    
    Parameters:
    
    primitive - The primitive to remove from the manager.
    
    See Also:
    
    Primitive Manager topic, CompositePrimitive
  - contains
```
public boolean contains(Primitive primitive)
```
    Determines whether the manager contains a primitive.
    
    Parameters:
    
    primitive - The primitive to locate in the manager.
    
    Returns:
    
    true if primitive is found in the manager; otherwise, false.
  - clear
```
public void clear()
```
    Removes all primitives from the manager.
    
    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 PrimitiveManager

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface agi.foundation.compatibility.IDisposable

Method Detail

finalize

dispose

dispose

getCount

getPrecisionExponent

setPrecisionExponent

getTranslucentPrimitivesSortOrder

setTranslucentPrimitivesSortOrder

add

remove

contains

clear

iterator