RenderInstances (Artisynth API documentation)

java.lang.Object
- maspack.render.RenderInstances

All Implemented Interfaces:

Disposable, DisposeObservable, Versioned
```
public class RenderInstances
extends java.lang.Object
implements Versioned, DisposeObservable, Disposable
```
Object containing information for repetitively drawing instances of RenderObjects, with varying transforms:
- point, a simple 3 degree-of-freedom translation
- frame, a rigid 6 degree-of-freedom transform
- affine, a non-rigid 12 degree-of-freedom transform

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RenderInstances.InstanceTransformType`
`static interface`	`RenderInstances.RenderInstanceConsumer` Interface to allow simplified iterations through all instance transforms
`static class`	`RenderInstances.RenderInstancesIdentifier`
`static class`	`RenderInstances.RenderInstancesState` Stores exposable state of the object, tracking the current primitive group indices.
`static class`	`RenderInstances.RenderInstancesVersion` Keeps track of versions for detecting changes.

Constructor Summary

Constructors
Constructor and Description

RenderInstances()

Constructors
Constructor and Description
`RenderInstances()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addAffine(AffineTransform3d affine)` Adds a new affine transform that can be referenced to create an instance.
`int`	`addAffineInstance(int aidx)` Adds an instance based on affine index
`int`	`addColor(byte[] rgba)` Adds an indexable color by reference.
`int`	`addColor(byte r, byte g, byte b, byte a)` Adds an indexable color
`int`	`addColor(java.awt.Color color)` Adds an indexable color
`int`	`addColor(float[] rgba)` Adds an indexable color.
`int`	`addColor(float r, float g, float b, float a)` Adds an indexable color
`int`	`addColor(int r, int g, int b, int a)` Adds an indexable color
`int`	`addFrame(RigidTransform3d frame)` Adds a new frame that can be referenced to create an instance.
`int`	`addFrameInstance(int fidx)` Adds an instance based on frame index
`int`	`addInstance(AffineTransform3d affine)` Adds an instance by affine
`int`	`addInstance(float[] xyz)` Adds an instance by point
`int`	`addInstance(float px, float py, float pz)` Adds an instance by point
`int`	`addInstance(RenderInstances.InstanceTransformType type, int tidx)` Adds an instance with supplied transform index, scale index and current color and scale
`int`	`addInstance(RenderInstances.InstanceTransformType type, int tidx, int sidx, int cidx)` Adds an instance with supplied transform index, scale index and color index
`int`	`addInstance(RigidTransform3d frame)` Adds an instance by frame
`int`	`addInstance(Vector3d pos)` Adds an instance by point
`int`	`addPoint(double x, double y, double z)` Adds a new point that can be referenced to create an instance.
`int`	`addPoint(float[] pos)` Adds a new point that can be referenced to create an instance.
`int`	`addPoint(Vector3d pos)` Adds a new point that can be referenced to create an instance.
`int`	`addPointInstance(int pidx)` Adds an instance based on point index
`int`	`addScale(java.lang.Double s)` Adds a new indexable scale.
`void`	`clearAll()` Clears everything in the RenderInstances, allowing it to be recreated.
`RenderInstances`	`copy()`
`void`	`dispose()` Signal a destruction of the object.
`void`	`ensureAffineCapacity(int cap)` Hint for ensuring sufficient storage
`void`	`ensureColorCapacity(int cap)` Hint for ensuring sufficient storage
`void`	`ensureFrameCapacity(int cap)` Hint for ensuring sufficient storage
`void`	`ensureInstanceCapacity(int cap)` Hint for ensuring sufficient storage
`void`	`ensurePointCapacity(int cap)` Hint for ensuring sufficient storage
`void`	`ensureScaleCapacity(int cap)` Hint for ensuring sufficient storage
`void`	`forEachInstance(RenderInstances.RenderInstanceConsumer consumer)` Apply a function to each instance, separating points, frames, and affines.
`AffineTransform3d`	`getAffine(int pidx)` Retrieves the affine stored with supplied index
`java.util.List<AffineTransform3d>`	`getAffines()` Retrieves the full list of Affines.
`int`	`getAffinesVersion()` Returns the latest affines version number, for use in detecting if changes are present.
`byte[]`	`getColor(int cidx)` Retrieves the color at the supplied index.
`java.util.List<byte[]>`	`getColors()` Retrieves the full list of Colors.
`int`	`getColorsVersion()` Returns the latest colors version number, for use in detecting if changes are present.
`int`	`getCurrentColor()` Returns the index associated with the current color, or -1 if there is no current color.
`int`	`getCurrentScale()` Returns the index associated with the current scale, or -1 if there is no current scale.
`RenderInstances.RenderInstancesIdentifier`	`getDisposeObserver()` Return an "observer" object that tracks the dispose status of this object.
`RigidTransform3d`	`getFrame(int fidx)` Retrieves the frame stored with supplied index
`java.util.List<RigidTransform3d>`	`getFrames()` Retrieves the full list of Frames.
`int`	`getFramesVersion()` Returns the latest frames version number, for use in detecting if changes are present.
`RenderInstances.RenderInstancesIdentifier`	`getIdentifier()` Returns a special identifier for this RenderInstances object.
`int`	`getInstanceColorOffset()`
`int[]`	`getInstances()`
`java.lang.Double`	`getInstanceScale(int idx)`
`int`	`getInstanceScaleOffset()`
`int`	`getInstanceStride()`
`int`	`getInstancesVersion()` Returns the latest colors version number, for use in detecting if changes are present.
`int`	`getInstanceTransformOffset()`
`RenderInstances.InstanceTransformType`	`getInstanceType(int idx)`
`int`	`getInstanceTypeOffset()`
`float[]`	`getPoint(int pidx)` Retrieves the point stored with supplied index
`java.util.List<float[]>`	`getPoints()` Retrieves the full list of Points.
`int`	`getPointsVersion()` Returns the latest points version number, for use in detecting if changes are present.
`java.lang.Double`	`getScale(int sidx)` Retrieves the scale stored with supplied index
`java.util.List<java.lang.Double>`	`getScales()` Retrieves the full list of Scales.
`int`	`getScalesVersion()` Returns the latest scales version number, for use in detecting if changes are present.
`RenderInstances.RenderInstancesState`	`getStateInfo()`
`static RenderInstances.InstanceTransformType[]`	`getTransformTypes()`
`int`	`getVersion()` Retrieves the version of the object, for use in detecting whether any information has changed since last use.
`RenderInstances.RenderInstancesVersion`	`getVersionInfo()` Returns an immutable copy of all version information in this RenderInstances, safe for sharing between threads.
`boolean`	`hasAffineInstances()`
`boolean`	`hasAffines()` Whether or not any affines have been defined.
`boolean`	`hasColors()` Whether or not any colors have been defined.
`boolean`	`hasFrameInstances()`
`boolean`	`hasFrames()` Whether or not any frames have been defined.
`boolean`	`hasInstances()` Whether or not any instances have been defined.
`boolean`	`hasPointInstances()`
`boolean`	`hasPoints()` Whether or not any points have been defined.
`boolean`	`hasScales()` Whether or not any scales have been defined.
`boolean`	`isDisposed()` Whether or not the current object is disposed
`boolean`	`isValid()` Returns whether or not this RenderObject is valid.
`void`	`notifyAffinesModified()` Indicate that the positions have been modified.
`void`	`notifyColorsModified()`
`void`	`notifyFramesModified()` Indicate that the positions have been modified.
`void`	`notifyInstancesModified()` Indicate that the instances have been modified.
`void`	`notifyPointsModified()` Indicate that the positions have been modified.
`void`	`notifyScalesModified()` Indicate that the scales have been modified.
`int`	`numAffineInstances()`
`int`	`numAffines()` Number of affines defined
`int`	`numColors()` Number of colors defined
`int`	`numFrameInstances()`
`int`	`numFrames()` Number of frames defined
`int`	`numInstances()` Number of instances defined
`int`	`numPointInstances()`
`int`	`numPoints()` Number of points defined
`int`	`numScales()` Number of scales defined
`void`	`readLock()` Prevents modifications until object is unlocked
`void`	`readUnlock()` Release a read lock on the object, allowing modifications.
`void`	`setAffine(int aidx, AffineTransform3d affine)` Sets the affine position by reference
`void`	`setColor(int cidx, byte[] rgba)` Updates the values of the color, by reference, with index cidx.
`void`	`setColor(int cidx, byte r, byte g, byte b, byte a)` Updates the values of the color with index cidx.
`void`	`setColor(int cidx, java.awt.Color color)` Updates the values of the color with index cidx.
`void`	`setColor(int cidx, float r, float g, float b, float a)` Updates the values of the color with index cidx.
`void`	`setColor(int cidx, int r, int g, int b, int a)` Updates the values of the color with index cidx.
`void`	`setCurrentColor(int cidx)` Sets the current color to be used in following instances based on color index.
`void`	`setCurrentScale(int sidx)` Sets the current scale to be used in following instances based on scale index.
`void`	`setFrame(int fidx, RigidTransform3d frame)` Sets the frame position by reference
`void`	`setInstance(int idx, RenderInstances.InstanceTransformType type, int tidx, int sidx, int cidx)`
`void`	`setPoint(int pidx, double x, double y, double z)` Sets the point position
`void`	`setPoint(int pidx, float[] pos)` Sets the point position by reference
`void`	`setPoint(int pidx, Vector3d pos)` Sets the point position
`void`	`setScale(int sidx, java.lang.Double s)` Sets the scale by reference
`void`	`writeLock()` Prevents reading until object is unlocked
`void`	`writeUnlock()` Release a write lock on the object, allowing reads

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

- Constructor Detail
  - RenderInstances
```
public RenderInstances()
```
- Method Detail
  - readLock
```
public void readLock()
```
    Prevents modifications until object is unlocked
  - readUnlock
```
public void readUnlock()
```
    Release a read lock on the object, allowing modifications.
  - writeLock
```
public void writeLock()
```
    Prevents reading until object is unlocked
  - writeUnlock
```
public void writeUnlock()
```
    Release a write lock on the object, allowing reads
  - getIdentifier
```
public RenderInstances.RenderInstancesIdentifier getIdentifier()
```
    Returns a special identifier for this RenderInstances object. It contains a unique ID number, as well as a flag for determining whether the object still persists and is valid. This should be as the key in HashMaps etc... so that the original RenderObject can be cleared and garbage-collected when it runs out of scope.
  - getVersionInfo
```
public RenderInstances.RenderInstancesVersion getVersionInfo()
```
    Returns an immutable copy of all version information in this RenderInstances, safe for sharing between threads. This can be used to detect whether the RenderObject has been modified since last observed.
  - getStateInfo
```
public RenderInstances.RenderInstancesState getStateInfo()
```
  - ensurePointCapacity
```
public void ensurePointCapacity(int cap)
```
    Hint for ensuring sufficient storage
    
    Parameters:
    
    cap - capacity
  - addPoint
```
public int addPoint(float[] pos)
```
    Adds a new point that can be referenced to create an instance. Note that this does not create a new instance.
    
    Parameters:
    
    pos - position of point added, by reference
    
    Returns:
    
    index of the new point added
  - addPoint
```
public int addPoint(Vector3d pos)
```
    Adds a new point that can be referenced to create an instance. Note that this does not create a new instance.
    
    Parameters:
    
    pos - position of point added
    
    Returns:
    
    index of the new point added
  - addPoint
```
public int addPoint(double x,
                    double y,
                    double z)
```
    Adds a new point that can be referenced to create an instance. Note that this does not create a new instance.
    
    Parameters:
    
    x - x-coordinate
    
    y - y-coordinate
    
    z - z-coordinate
    
    Returns:
    
    index of new point
  - setPoint
```
public void setPoint(int pidx,
                     double x,
                     double y,
                     double z)
```
    Sets the point position
    
    Parameters:
    
    pidx - index of point to modify
    
    x - x-coordinate
    
    y - y-coordinate
    
    z - z-coordinate
  - setPoint
```
public void setPoint(int pidx,
                     float[] pos)
```
    Sets the point position by reference
  - setPoint
```
public void setPoint(int pidx,
                     Vector3d pos)
```
    Sets the point position
  - getPoint
```
public float[] getPoint(int pidx)
```
    Retrieves the point stored with supplied index
    
    Parameters:
    
    pidx - index of point
    
    Returns:
    
    point, by reference
  - notifyPointsModified
```
public void notifyPointsModified()
```
    Indicate that the positions have been modified.
  - hasPoints
```
public boolean hasPoints()
```
    Whether or not any points have been defined.
  - numPoints
```
public int numPoints()
```
    Number of points defined
  - getPoints
```
public java.util.List<float[]> getPoints()
```
    Retrieves the full list of Points. This list should not be modified.
    
    Returns:
    
    list of points.
  - getPointsVersion
```
public int getPointsVersion()
```
    Returns the latest points version number, for use in detecting if changes are present.
  - ensureFrameCapacity
```
public void ensureFrameCapacity(int cap)
```
    Hint for ensuring sufficient storage
    
    Parameters:
    
    cap - capacity
  - addFrame
```
public int addFrame(RigidTransform3d frame)
```
    Adds a new frame that can be referenced to create an instance. Note that this does not create a new instance.
    
    Parameters:
    
    frame - frame to be added, by reference
    
    Returns:
    
    index of the new frame added
  - setFrame
```
public void setFrame(int fidx,
                     RigidTransform3d frame)
```
    Sets the frame position by reference
    
    Parameters:
    
    fidx - frame index
    
    frame - frame pose
  - getFrame
```
public RigidTransform3d getFrame(int fidx)
```
    Retrieves the frame stored with supplied index
    
    Parameters:
    
    fidx - index of frame
    
    Returns:
    
    frame, by reference
  - notifyFramesModified
```
public void notifyFramesModified()
```
    Indicate that the positions have been modified.
  - hasFrames
```
public boolean hasFrames()
```
    Whether or not any frames have been defined.
  - numFrames
```
public int numFrames()
```
    Number of frames defined
  - getFrames
```
public java.util.List<RigidTransform3d> getFrames()
```
    Retrieves the full list of Frames. This list should not be modified.
    
    Returns:
    
    list of frames.
  - getFramesVersion
```
public int getFramesVersion()
```
    Returns the latest frames version number, for use in detecting if changes are present.
  - ensureAffineCapacity
```
public void ensureAffineCapacity(int cap)
```
    Hint for ensuring sufficient storage
    
    Parameters:
    
    cap - capacity
  - addAffine
```
public int addAffine(AffineTransform3d affine)
```
    Adds a new affine transform that can be referenced to create an instance. Note that this does not create a new instance.
    
    Parameters:
    
    affine - affine transform to add, by reference
    
    Returns:
    
    index of the new affine added
  - setAffine
```
public void setAffine(int aidx,
                      AffineTransform3d affine)
```
    Sets the affine position by reference
    
    Parameters:
    
    aidx - affine index
    
    affine - affine transform
  - getAffine
```
public AffineTransform3d getAffine(int pidx)
```
    Retrieves the affine stored with supplied index
    
    Parameters:
    
    pidx - index of affine
    
    Returns:
    
    affine, by reference
  - notifyAffinesModified
```
public void notifyAffinesModified()
```
    Indicate that the positions have been modified.
  - hasAffines
```
public boolean hasAffines()
```
    Whether or not any affines have been defined.
  - numAffines
```
public int numAffines()
```
    Number of affines defined
  - getAffines
```
public java.util.List<AffineTransform3d> getAffines()
```
    Retrieves the full list of Affines. This list should not be modified.
    
    Returns:
    
    list of affines.
  - getAffinesVersion
```
public int getAffinesVersion()
```
    Returns the latest affines version number, for use in detecting if changes are present.
  - ensureColorCapacity
```
public void ensureColorCapacity(int cap)
```
    Hint for ensuring sufficient storage
    
    Parameters:
    
    cap - capacity
  - addColor
```
public int addColor(byte r,
                    byte g,
                    byte b,
                    byte a)
```
    Adds an indexable color
    
    Parameters:
    
    r - red
    
    g - green
    
    b - blue
    
    a - alpha
    
    Returns:
    
    the index of the color added
  - addColor
```
public int addColor(int r,
                    int g,
                    int b,
                    int a)
```
    Adds an indexable color
    
    Parameters:
    
    r - red [0-255]
    
    g - green [0-255]
    
    b - blue [0-255]
    
    a - alpha [0-255]
    
    Returns:
    
    the index of the color added
  - addColor
```
public int addColor(float r,
                    float g,
                    float b,
                    float a)
```
    Adds an indexable color
    
    Parameters:
    
    r - red [0-1]
    
    g - green [0-1]
    
    b - blue [0-1]
    
    a - alpha [0-1]
    
    Returns:
    
    the index of the color added
  - addColor
```
public int addColor(float[] rgba)
```
    Adds an indexable color.
    
    Parameters:
    
    rgba - 4-float vector
    
    Returns:
    
    the index of the color added
  - addColor
```
public int addColor(java.awt.Color color)
```
    Adds an indexable color
    
    Parameters:
    
    color - color from which RGBA values are determines
  - addColor
```
public int addColor(byte[] rgba)
```
    Adds an indexable color by reference. If the color is modified outside of this object, then notifyColorsModified() must be called. Otherwise, renderers are free to assume the render object has not changed.
    
    Parameters:
    
    rgba - {red, green, blue, alpha}
    
    Returns:
    
    the index of the color added
  - notifyColorsModified
```
public void notifyColorsModified()
```
  - setCurrentColor
```
public void setCurrentColor(int cidx)
```
    Sets the current color to be used in following instances based on color index.
    
    Parameters:
    
    cidx - index of a previously added color
  - getCurrentColor
```
public int getCurrentColor()
```
    Returns the index associated with the current color, or -1 if there is no current color.
    
    Returns:
    
    current color index
  - setColor
```
public void setColor(int cidx,
                     byte r,
                     byte g,
                     byte b,
                     byte a)
```
    Updates the values of the color with index cidx.
    
    Parameters:
    
    cidx - color to modify
    
    r - red
    
    g - green
    
    b - blue
    
    a - alpha
  - setColor
```
public void setColor(int cidx,
                     int r,
                     int g,
                     int b,
                     int a)
```
    Updates the values of the color with index cidx.
    
    Parameters:
    
    cidx - color to modify
    
    r - red
    
    g - green
    
    b - blue
    
    a - alpha
  - setColor
```
public void setColor(int cidx,
                     float r,
                     float g,
                     float b,
                     float a)
```
    Updates the values of the color with index cidx.
    
    Parameters:
    
    cidx - color to modify
    
    r - red
    
    g - green
    
    b - blue
    
    a - alpha
  - setColor
```
public void setColor(int cidx,
                     java.awt.Color color)
```
    Updates the values of the color with index cidx.
    
    Parameters:
    
    cidx - color to modify
    
    color - new color values
  - setColor
```
public void setColor(int cidx,
                     byte[] rgba)
```
    Updates the values of the color, by reference, with index cidx.
    
    Parameters:
    
    cidx - color to modify
    
    rgba - {red, green, blue, alpha}
  - getColor
```
public byte[] getColor(int cidx)
```
    Retrieves the color at the supplied index. If the returned color is modified, then notifyColorsModified() must be manually called.
    
    Parameters:
    
    cidx - color index
    
    Returns:
    
    color {red, green, blue, alpha}
  - hasColors
```
public boolean hasColors()
```
    Whether or not any colors have been defined.
  - numColors
```
public int numColors()
```
    Number of colors defined
  - getColors
```
public java.util.List<byte[]> getColors()
```
    Retrieves the full list of Colors. This list should not be modified.
    
    Returns:
    
    list of colors.
  - getColorsVersion
```
public int getColorsVersion()
```
    Returns the latest colors version number, for use in detecting if changes are present.
  - ensureScaleCapacity
```
public void ensureScaleCapacity(int cap)
```
    Hint for ensuring sufficient storage
    
    Parameters:
    
    cap - capacity
  - addScale
```
public int addScale(java.lang.Double s)
```
    Adds a new indexable scale.
    
    Parameters:
    
    s - scale, by reference
    
    Returns:
    
    index of the new scale added
  - setCurrentScale
```
public void setCurrentScale(int sidx)
```
    Sets the current scale to be used in following instances based on scale index.
    
    Parameters:
    
    sidx - index of a previously added scale
  - getCurrentScale
```
public int getCurrentScale()
```
    Returns the index associated with the current scale, or -1 if there is no current scale.
    
    Returns:
    
    current scale index
  - setScale
```
public void setScale(int sidx,
                     java.lang.Double s)
```
    Sets the scale by reference
    
    Parameters:
    
    sidx - index of scale to modify
    
    s - scale
  - getScale
```
public java.lang.Double getScale(int sidx)
```
    Retrieves the scale stored with supplied index
    
    Parameters:
    
    sidx - index of scale
    
    Returns:
    
    scale, by reference
  - notifyScalesModified
```
public void notifyScalesModified()
```
    Indicate that the scales have been modified.
  - hasScales
```
public boolean hasScales()
```
    Whether or not any scales have been defined.
  - numScales
```
public int numScales()
```
    Number of scales defined
  - getScales
```
public java.util.List<java.lang.Double> getScales()
```
    Retrieves the full list of Scales. This list should not be modified.
    
    Returns:
    
    list of scales.
  - getScalesVersion
```
public int getScalesVersion()
```
    Returns the latest scales version number, for use in detecting if changes are present.
  - ensureInstanceCapacity
```
public void ensureInstanceCapacity(int cap)
```
    Hint for ensuring sufficient storage
    
    Parameters:
    
    cap - capacity
  - addInstance
```
public int addInstance(RenderInstances.InstanceTransformType type,
                       int tidx,
                       int sidx,
                       int cidx)
```
    Adds an instance with supplied transform index, scale index and color index
    
    Parameters:
    
    type - type of instance
    
    tidx - transform index (either point, frame, or affine index)
    
    sidx - scale index
    
    cidx - color index
    
    Returns:
    
    index of instance
  - setInstance
```
public void setInstance(int idx,
                        RenderInstances.InstanceTransformType type,
                        int tidx,
                        int sidx,
                        int cidx)
```
  - getTransformTypes
```
public static RenderInstances.InstanceTransformType[] getTransformTypes()
```
  - getInstanceType
```
public RenderInstances.InstanceTransformType getInstanceType(int idx)
```
  - getInstanceScale
```
public java.lang.Double getInstanceScale(int idx)
```
  - getInstances
```
public int[] getInstances()
```
  - getInstanceTypeOffset
```
public int getInstanceTypeOffset()
```
  - getInstanceTransformOffset
```
public int getInstanceTransformOffset()
```
  - getInstanceScaleOffset
```
public int getInstanceScaleOffset()
```
  - getInstanceColorOffset
```
public int getInstanceColorOffset()
```
  - getInstanceStride
```
public int getInstanceStride()
```
  - forEachInstance
```
public void forEachInstance(RenderInstances.RenderInstanceConsumer consumer)
```
    Apply a function to each instance, separating points, frames, and affines. Each instance type is assigned an index corresponding to its position within its own group in order of appearance (i.e. point index 0 is the first point, 1 the second point, ..., frame index 0 is the first frame, ...). order.
    
    Parameters:
    
    consumer - consumer object for processing instances
  - notifyInstancesModified
```
public void notifyInstancesModified()
```
    Indicate that the instances have been modified.
  - getInstancesVersion
```
public int getInstancesVersion()
```
    Returns the latest colors version number, for use in detecting if changes are present.
  - hasInstances
```
public boolean hasInstances()
```
    Whether or not any instances have been defined.
  - numInstances
```
public int numInstances()
```
    Number of instances defined
  - hasPointInstances
```
public boolean hasPointInstances()
```
  - numPointInstances
```
public int numPointInstances()
```
  - hasFrameInstances
```
public boolean hasFrameInstances()
```
  - numFrameInstances
```
public int numFrameInstances()
```
  - hasAffineInstances
```
public boolean hasAffineInstances()
```
  - numAffineInstances
```
public int numAffineInstances()
```
  - addInstance
```
public int addInstance(RenderInstances.InstanceTransformType type,
                       int tidx)
```
    Adds an instance with supplied transform index, scale index and current color and scale
    
    Parameters:
    
    type - type of instance
    
    tidx - transform index (either point, frame, or affine index)
    
    Returns:
    
    index of the instance added
  - addPointInstance
```
public int addPointInstance(int pidx)
```
    Adds an instance based on point index
    
    Parameters:
    
    pidx - point index
    
    Returns:
    
    index of new instance
  - addFrameInstance
```
public int addFrameInstance(int fidx)
```
    Adds an instance based on frame index
    
    Parameters:
    
    fidx - frame index
    
    Returns:
    
    index of new instance
  - addAffineInstance
```
public int addAffineInstance(int aidx)
```
    Adds an instance based on affine index
    
    Parameters:
    
    aidx - affine index
    
    Returns:
    
    index of new instance
  - addInstance
```
public int addInstance(float px,
                       float py,
                       float pz)
```
    Adds an instance by point
    
    Parameters:
    
    px - x-coordinate of instance
    
    py - y-coordinate of instance
    
    pz - z-coordinate of instance
    
    Returns:
    
    the index of the instance added
  - addInstance
```
public int addInstance(float[] xyz)
```
    Adds an instance by point
    
    Parameters:
    
    xyz - coordinates
    
    Returns:
    
    the index of the instance added
  - addInstance
```
public int addInstance(Vector3d pos)
```
    Adds an instance by point
    
    Parameters:
    
    pos - position of instance
    
    Returns:
    
    the index of the instance added
  - addInstance
```
public int addInstance(RigidTransform3d frame)
```
    Adds an instance by frame
    
    Parameters:
    
    frame - frame transform for instance
    
    Returns:
    
    the index of the instance added
  - addInstance
```
public int addInstance(AffineTransform3d affine)
```
    Adds an instance by affine
    
    Parameters:
    
    affine - transform to be added, by reference
    
    Returns:
    
    the index of the instance added
  - clearAll
```
public void clearAll()
```
    Clears everything in the RenderInstances, allowing it to be recreated. This can be used when the object becomes invalid, in place of discarding and regenerating a new one. The object becomes a clean slate, with no instance attributes.
  - getVersion
```
public int getVersion()
```
    Retrieves the version of the object, for use in detecting whether any information has changed since last use.
    
    Specified by:
    
    getVersion in interface Versioned
    
    Returns:
    
    the overall modification version
  - isValid
```
public boolean isValid()
```
    Returns whether or not this RenderObject is valid. If valid, this object can be safely passed to a renderer for drawing. If not, it needs to be discarded.
    
    Returns:
    
    true if this RenderObject is valid
  - dispose
```
public void dispose()
```
    Signal a destruction of the object.
    
    Specified by:
    
    dispose in interface Disposable
  - copy
```
public RenderInstances copy()
```
    Returns:
    
    a new copy of the object
  - isDisposed
```
public boolean isDisposed()
```
    Description copied from interface: DisposeObservable
    
    Whether or not the current object is disposed
    
    Specified by:
    
    isDisposed in interface DisposeObservable
    
    Returns:
    
    dispose status
  - getDisposeObserver
```
public RenderInstances.RenderInstancesIdentifier getDisposeObserver()
```
    Description copied from interface: DisposeObservable
    
    Return an "observer" object that tracks the dispose status of this object.
    
    Specified by:
    
    getDisposeObserver in interface DisposeObservable

Class RenderInstances

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RenderInstances

Method Detail

readLock

readUnlock

writeLock

writeUnlock

getIdentifier

getVersionInfo

getStateInfo

ensurePointCapacity

addPoint

addPoint

addPoint

setPoint

setPoint

setPoint

getPoint

notifyPointsModified

hasPoints

numPoints

getPoints

getPointsVersion

ensureFrameCapacity

addFrame

setFrame

getFrame

notifyFramesModified

hasFrames

numFrames

getFrames

getFramesVersion

ensureAffineCapacity

addAffine

setAffine

getAffine

notifyAffinesModified

hasAffines

numAffines

getAffines

getAffinesVersion

ensureColorCapacity

addColor

addColor

addColor

addColor

addColor

addColor

notifyColorsModified

setCurrentColor

getCurrentColor

setColor

setColor

setColor

setColor

setColor

getColor

hasColors

numColors

getColors

getColorsVersion

ensureScaleCapacity

addScale

setCurrentScale

getCurrentScale

setScale

getScale

notifyScalesModified

hasScales

numScales

getScales

getScalesVersion

ensureInstanceCapacity

addInstance

setInstance