RenderList (Artisynth API documentation)

java.lang.Object
- maspack.render.RenderList

```
public class RenderList
extends java.lang.Object
```
Maintains a list of renderable objects for use by GLViewer. As renderables are added to this list, they are sorted into four sublists depending on whether they are opaque, transparent, 2d opaque, and 2d transparent. As renderables are added to the list, their IsRenderable.prerender(maspack.render.RenderList) method is also called.
The sublist to which each renderable is added is determined based on whether the flags returned by the its IsRenderable.getRenderHints() method contains the settings IsRenderable.TRANSPARENT and IsRenderable.TWO_DIMENSIONAL. Renderables are also added to their appropriate sublist in increasing order according to a z-order value, where z denotes the viewing axis and a higher z-order indicates an object which is ``closer to the eye''. If the renderable is an instance of HasRenderProps and its HasRenderProps.getRenderProps() methods returns a non-null set of render properties, then the z-order is given by RenderProps.getZOrder() for those properties. Otherwise, the z-order is assumed to be 0.
Sorting the renderables is done because it allows some renderers to render the scene more realistically. For example, in OpenGL, better results are obtained in opaque objects are drawn before transparent ones, and transparent objects are drawn in increasing z-order.

Constructor Summary

Constructors
Constructor and Description

RenderList()

Constructors
Constructor and Description
`RenderList()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<C extends IsRenderable> boolean`	`addIfVisible(C r)` Calls the `IsRenderable.prerender(maspack.render.RenderList)` method for a specified renderable, and then adds it to this list if it is also visible.
`void`	`addIfVisibleAll(java.util.Collection<? extends IsRenderable> renderables)` Calls `addIfVisible(C)` for every renderable in a specified collection.
`void`	`clear()` Clears all renderables in this list.
`IsRenderable`	`get(int idx)` Returns the `idx`-th renderable in this list.
`SortedRenderableList`	`getOpaque()`
`IsRenderable`	`getOpaque(int i)` Returns the `i`-th opaque renderable in this list.
`SortedRenderableList`	`getOpaque2d()`
`IsRenderable`	`getOpaque2d(int i)` Returns the `i`-th 2d opaque renderable in this list.
`SortedRenderableList`	`getTransparent()`
`IsRenderable`	`getTransparent(int i)` Returns the `i`-th transparent renderable in this list.
`SortedRenderableList`	`getTransparent2d()`
`IsRenderable`	`getTransparent2d(int i)` Returns the `i`-th 2d transparent renderable in this list.
`int`	`numOpaque()` Returns the number of opaque objects in this list.
`int`	`numOpaque2d()` Returns the number of 2d opaque objects in this list.
`int`	`numSelectionQueriesNeeded()`
`int`	`numTransparent()` Returns the number of transparent objects in this list.
`int`	`numTransparent2d()` Returns the number of 2d transparent objects in this list.
`void`	`printOpaqueSelectionQueries()`
`int`	`renderOpaque(Renderer renderer, int qid, int flags)`
`int`	`renderOpaque2d(Renderer renderer, int qid, int flags)`
`int`	`renderTransparent(Renderer renderer, int qid, int flags)`
`int`	`renderTransparent2d(Renderer renderer, int qid, int flags)`
`int`	`size()` Returns the total number of renderables in this list.
`void`	`updateBounds(Vector3d pmin, Vector3d pmax)`

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

- Constructor Detail
  - RenderList
```
public RenderList()
```
- Method Detail
  - addIfVisible
```
public <C extends IsRenderable> boolean addIfVisible(C r)
```
    Calls the IsRenderable.prerender(maspack.render.RenderList) method for a specified renderable, and then adds it to this list if it is also visible. The renderable is considered to be visible if either
    1. it is not an instance of HasRenderProps, or
    2. it is an instance of HasRenderProps and its HasRenderProps.getRenderProps() method returns a non-null value for which RenderProps.isVisible() returns true.
    The renderable is added to either the opaque, transparent, 2d opaque, or 2d transparent sublist, according to increasing z-order, as described in the class documentation.
    Parameters:
    
    r - renderable to maybe add to this list
    
    Returns:
    
    true if c was added.
  - addIfVisibleAll
```
public void addIfVisibleAll(java.util.Collection<? extends IsRenderable> renderables)
```
    Calls addIfVisible(C) for every renderable in a specified collection.
    
    Parameters:
    
    renderables - collection of renderables to maybe add to this list.
  - getOpaque
```
public IsRenderable getOpaque(int i)
```
    Returns the i-th opaque renderable in this list.
    
    Parameters:
    
    i - index of the renderable
    
    Returns:
    
    i-th opaque renderable
  - getOpaque
```
public SortedRenderableList getOpaque()
```
  - getTransparent
```
public IsRenderable getTransparent(int i)
```
    Returns the i-th transparent renderable in this list.
    
    Parameters:
    
    i - index of the renderable
    
    Returns:
    
    i-th transparent renderable
  - getTransparent
```
public SortedRenderableList getTransparent()
```
  - getOpaque2d
```
public IsRenderable getOpaque2d(int i)
```
    Returns the i-th 2d opaque renderable in this list.
    
    Parameters:
    
    i - index of the renderable
    
    Returns:
    
    i-th 2d opaque renderable
  - getOpaque2d
```
public SortedRenderableList getOpaque2d()
```
  - getTransparent2d
```
public IsRenderable getTransparent2d(int i)
```
    Returns the i-th 2d transparent renderable in this list.
    
    Parameters:
    
    i - index of the renderable
    
    Returns:
    
    i-th 2d transparent renderable
  - getTransparent2d
```
public SortedRenderableList getTransparent2d()
```
  - clear
```
public void clear()
```
    Clears all renderables in this list.
  - numTransparent
```
public int numTransparent()
```
    Returns the number of transparent objects in this list.
    
    Returns:
    
    number of transparent objects
  - numOpaque
```
public int numOpaque()
```
    Returns the number of opaque objects in this list.
    
    Returns:
    
    number of opaque objects
  - numTransparent2d
```
public int numTransparent2d()
```
    Returns the number of 2d transparent objects in this list.
    
    Returns:
    
    number of 2d transparent objects
  - numOpaque2d
```
public int numOpaque2d()
```
    Returns the number of 2d opaque objects in this list.
    
    Returns:
    
    number of 2d opaque objects
  - numSelectionQueriesNeeded
```
public int numSelectionQueriesNeeded()
```
  - printOpaqueSelectionQueries
```
public void printOpaqueSelectionQueries()
```
  - size
```
public int size()
```
    Returns the total number of renderables in this list.
    
    Returns:
    
    total number of renderables
  - updateBounds
```
public void updateBounds(Vector3d pmin,
                         Vector3d pmax)
```
  - renderOpaque
```
public int renderOpaque(Renderer renderer,
                        int qid,
                        int flags)
```
  - renderTransparent
```
public int renderTransparent(Renderer renderer,
                             int qid,
                             int flags)
```
  - renderOpaque2d
```
public int renderOpaque2d(Renderer renderer,
                          int qid,
                          int flags)
```
  - renderTransparent2d
```
public int renderTransparent2d(Renderer renderer,
                               int qid,
                               int flags)
```
  - get
```
public IsRenderable get(int idx)
```
    Returns the idx-th renderable in this list.
    
    Parameters:
    
    idx - index of the desired renderable
    
    Returns:
    
    idx-th renderable
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if idx is out of bounds.

Class RenderList

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RenderList

Method Detail

addIfVisible

addIfVisibleAll

getOpaque

getOpaque

getTransparent

getTransparent

getOpaque2d

getOpaque2d

getTransparent2d

getTransparent2d

clear

numTransparent

numOpaque

numTransparent2d

numOpaque2d

numSelectionQueriesNeeded

printOpaqueSelectionQueries

size

updateBounds

renderOpaque

renderTransparent

renderOpaque2d

renderTransparent2d

get