maspack.render

Class SortedRenderableList

java.lang.Object

maspack.render.SortedRenderableList

All Implemented Interfaces:

java.lang.Iterable<IsRenderable>, java.util.Collection<IsRenderable>

public class SortedRenderableList
extends java.lang.Object
implements java.util.Collection<IsRenderable>

Set of renderables sorted in ascending order by zOrder. This is very similar to what would be a SortedSet<IsRenderable>, except I do no checks to ensure elements are distinct according to compareTo(...) with respect to zOrder. In fact, most elements will have the same zOrder=0, in which case they are sorted according to the original order they were added to the list (stable sort). Unlike List<IsRenderable>, order is not guaranteed.

The zOrder is read from render properties if the IsRenderable is an instance of HasRenderProps. Otherwise, a zOrder can be specified in add(IsRenderable,int), or is assumed to be 0.

Author:

Antonio

Field Summary

Fields

Modifier and Type	Field and Description
static int	defaultCapacity
static int	defaultIncrement

Constructor Summary

Constructors

Constructor and Description
SortedRenderableList() Constructs an empty list with an initial capacity of ten.
SortedRenderableList(java.util.Collection<? extends IsRenderable> c) Constructs a set containing the elements of the specified collection.
SortedRenderableList(int initialCapacity) Constructs an empty list with the specified initial capacity.

Method Summary

Modifier and Type	Method and Description
boolean	add(IsRenderable e) Adds an element to this set, sorted ascending by the zOrder parameter if exists (otherwise assumed zOrder = 0).
boolean	add(IsRenderable e, int zOrder) Adds an element to this set, sorted ascending by the zOrder parameter if exists.
boolean	addAll(java.util.Collection<? extends IsRenderable> c) Adds all elements in c to this set.
void	clear() Clears all elements from this set
boolean	contains(java.lang.Object o) Determines whether the set contains a specified object
boolean	containsAll(java.util.Collection<?> c) Returns true if this set contains all elements in the supplied collection
IsRenderable	first() Gets the first element in the set
IsRenderable	get(int index)
boolean	isEmpty() Returns true if set is empty
java.util.Iterator<IsRenderable>	iterator() Returns an iterator for looping through elements
IsRenderable	last() Gets the last element in the set
int	numSelectionQueriesNeeded() Returns the maximum number of selection queries required for all renderables in this list.
IsRenderable	remove(int idx)
boolean	remove(java.lang.Object o) Removes an element from this set
boolean	removeAll(java.util.Collection<?> c) Removes all elements in this set that are found in c.
boolean	retainAll(java.util.Collection<?> c) Retains only the elements that are also found in the collection c, essentially performing an intersection.
void	setIncrement(int inc) Sets the size to grow the array when we read capacity
int	size() Returns the number of elements in the set
IsRenderable[]	toArray() Returns a copy of the IsRenderable array
<T> T[]	toArray(T[] a) Fills an array with the current sorted IsRenderables.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

defaultCapacity

public static int defaultCapacity

defaultIncrement

public static int defaultIncrement

Constructor Detail

SortedRenderableList

public SortedRenderableList(int initialCapacity)

Constructs an empty list with the specified initial capacity.

Parameters:

initialCapacity - the initial capacity of the list

SortedRenderableList

public SortedRenderableList()

Constructs an empty list with an initial capacity of ten.

SortedRenderableList

public SortedRenderableList(java.util.Collection<? extends IsRenderable> c)

Constructs a set containing the elements of the specified collection.

Parameters:

c - the collection whose elements are to be placed into this list

Throws:

java.lang.NullPointerException - if the specified collection is null

Method Detail

numSelectionQueriesNeeded

public int numSelectionQueriesNeeded()

Returns the maximum number of selection queries required for all renderables in this list. This number is needed by viewer-based selection software.

setIncrement

public void setIncrement(int inc)

Sets the size to grow the array when we read capacity

size

public int size()

Returns the number of elements in the set

Specified by:

size in interface java.util.Collection<IsRenderable>

isEmpty

public boolean isEmpty()

Returns true if set is empty

Specified by:

isEmpty in interface java.util.Collection<IsRenderable>

contains

public boolean contains(java.lang.Object o)

Determines whether the set contains a specified object

Specified by:

contains in interface java.util.Collection<IsRenderable>

iterator

public java.util.Iterator<IsRenderable> iterator()

Returns an iterator for looping through elements

Specified by:

iterator in interface java.lang.Iterable<IsRenderable>

Specified by:

iterator in interface java.util.Collection<IsRenderable>

toArray

public IsRenderable[] toArray()

Returns a copy of the IsRenderable array

Specified by:

toArray in interface java.util.Collection<IsRenderable>

toArray

public <T> T[] toArray(T[] a)

Fills an array with the current sorted IsRenderables. A new array is created if 'a' is too small.

Specified by:

toArray in interface java.util.Collection<IsRenderable>

add

public boolean add(IsRenderable e)

Adds an element to this set, sorted ascending by the zOrder parameter if exists (otherwise assumed zOrder = 0). For equal zOrders, the original order is maintained (stable sort).

Specified by:

add in interface java.util.Collection<IsRenderable>

add

public boolean add(IsRenderable e,
                   int zOrder)

Adds an element to this set, sorted ascending by the zOrder parameter if exists. For equal zOrders, the original order is maintained (stable sort).

remove

public boolean remove(java.lang.Object o)

Removes an element from this set

Specified by:

remove in interface java.util.Collection<IsRenderable>

remove

public IsRenderable remove(int idx)

containsAll

public boolean containsAll(java.util.Collection<?> c)

Returns true if this set contains all elements in the supplied collection

Specified by:

containsAll in interface java.util.Collection<IsRenderable>

addAll

public boolean addAll(java.util.Collection<? extends IsRenderable> c)

Adds all elements in c to this set. Always returns true;

Specified by:

addAll in interface java.util.Collection<IsRenderable>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Retains only the elements that are also found in the collection c, essentially performing an intersection. Returns true if the collection is modified

Specified by:

retainAll in interface java.util.Collection<IsRenderable>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Removes all elements in this set that are found in c. Returns true if the set is modified.

Specified by:

removeAll in interface java.util.Collection<IsRenderable>

clear

public void clear()

Clears all elements from this set

Specified by:

clear in interface java.util.Collection<IsRenderable>

first

public IsRenderable first()

Gets the first element in the set

last

public IsRenderable last()

Gets the last element in the set

get

public IsRenderable get(int index)