agi.foundation.graphics

(agi.foundation.graphics-2024r2.jar)

Class BatchPrimitiveIndex

java.lang.Object

agi.foundation.graphics.BatchPrimitiveIndex

public final class BatchPrimitiveIndex
extends Object

Represents an individual item index that is associated with a batch primitive. Provides the Index (get / set) of the individual item and the Primitive (get / set) that contains that index. When the PerItemPickingEnabled property is set to true for a batch primitive, the PickResults returned from Scene.pick(int, int) will contain BatchPrimitiveIndex types referencing particular indices within that batch.

See Also:

Picking topic, MarkerBatchPrimitive, TextBatchPrimitive, PointBatchPrimitive, PolylinePrimitive

Constructor Summary

Constructors

Constructor and Description
BatchPrimitiveIndex(int index, Primitive primitive) Initializes a new instance with an index and Primitive.

Method Summary

Modifier and Type	Method and Description
int	getIndex() The index of the item contained by the Primitive (get / set).
Primitive	getPrimitive() The Primitive that contains the item at the Index (get / set) specified.
void	setIndex(int value) The index of the item contained by the Primitive (get / set).
void	setPrimitive(Primitive value) The Primitive that contains the item at the Index (get / set) specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchPrimitiveIndex

public BatchPrimitiveIndex(int index,
                           Primitive primitive)

Initializes a new instance with an index and Primitive.

Parameters:

index - The index of the item contained by the Primitive (get / set).

primitive - The Primitive that contains the item at the Index (get / set) specified.

Method Detail

getIndex

public final int getIndex()

The index of the item contained by the Primitive (get / set).

setIndex

public final void setIndex(int value)

The index of the item contained by the Primitive (get / set).

getPrimitive

public final Primitive getPrimitive()

The Primitive that contains the item at the Index (get / set) specified.

setPrimitive

public final void setPrimitive(Primitive value)

The Primitive that contains the item at the Index (get / set) specified.