artisynth.core.modelbase

Class ReferenceListBase<C extends ModelComponent,R extends ReferenceComp<C>>

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ComponentList<R>

artisynth.core.modelbase.ReferenceListBase<C,R>

All Implemented Interfaces:

ComponentChangeListener, ComponentListView<R>, CompositeComponent, IndexedComponentList, ModelComponent, MutableCompositeComponent<R>, PostScannable, java.lang.Cloneable, java.lang.Iterable<R>, java.util.Collection<R>, HasProperties, HierarchyNode, ListView<R>, ParameterizedClass, Scannable

Direct Known Subclasses:

ReferenceList

public class ReferenceListBase<C extends ModelComponent,R extends ReferenceComp<C>>
extends ComponentList<R>

Base class for reference lists that can be used to create compnent groupings that are visible to the component hierarchy.

Nested Class Summary

Nested classes/interfaces inherited from interface artisynth.core.modelbase.CompositeComponent

CompositeComponent.NavpanelDisplay

Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps

Fields inherited from class artisynth.core.modelbase.ComponentList

DEFAULT_NAVPANEL_DISPLAY

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Constructor Summary

Constructors

Constructor and Description
ReferenceListBase()
ReferenceListBase(java.lang.Class<R> clazz, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
R	addReference(C comp) Adds a component reference to this list.
void	addReferences(java.util.Collection<C> comps) Adds multiple component references to this list.
boolean	containsReference(C comp) Checks if this list contains a reference to a specified component.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
C	getReference(int idx) Returns the idx-th referenced component in this list.
void	getReferences(java.util.Collection<C> comps) Get all the referenced components in this list.
int	indexOfReference(C comp) Returns the index of the first occurance of a referenced component in this list, or -1 no reference is present.
int	numReferences() Queries the number of references in this list.
void	removeAllReferences() Remove all references from this list.
boolean	removeReference(C comp) Remove the first reference to a specified component from this list.
boolean	removeReferences(java.util.Collection<C> comps) Removes alls references to the specified components from this list.

Methods inherited from class artisynth.core.modelbase.ComponentList

add, add, addAll, addComponents, addFixed, addNumbered, clear, clone, componentChanged, contains, contains, containsAll, copy, ensureCapacity, findComponent, get, get, getByNumber, getChildren, getMinNumber, getNavpanelDisplay, getNumberLimit, getOneBasedNumbering, getParameterType, getShortName, hasChildren, hasParameterizedType, hierarchyContainsReferences, incrementNumbering, indexOf, invalidateNumbers, isEditable, isEmpty, iterator, nextComponentNumber, numComponents, postscan, remove, remove, removeAll, removeAll, removeComponents, resetNumbersToIndices, retainAll, scan, set, setEditable, setNavpanelDisplay, setNumbered, setOneBasedNumbering, setShortName, size, toArray, toArray, updateNameMap

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, connectToHierarchy, createTempFlag, disconnectFromHierarchy, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasState, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, updateReferences, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface artisynth.core.modelbase.ComponentListView

getName

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface artisynth.core.modelbase.CompositeComponent

recursivelyFind

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.properties.HasProperties

getProperty

Methods inherited from interface maspack.util.Scannable

isWritable, write

Field Detail

myProps

public static PropertyList myProps

Constructor Detail

ReferenceListBase

public ReferenceListBase()

ReferenceListBase

public ReferenceListBase(java.lang.Class<R> clazz,
                         java.lang.String name)

Method Detail

getAllPropertyInfo

public PropertyList getAllPropertyInfo()

Description copied from interface: HasProperties

Returns a list giving static information about all properties exported by this object.

Specified by:

getAllPropertyInfo in interface HasProperties

Overrides:

getAllPropertyInfo in class ComponentList<R extends ReferenceComp<C>>

Returns:

static information for all exported properties

addReference

public R addReference(C comp)

Adds a component reference to this list.

Parameters:

comp - component to be referenced

addReferences

public void addReferences(java.util.Collection<C> comps)

Adds multiple component references to this list.

Parameters:

comps - components to be referenced

getReference

public C getReference(int idx)

Returns the idx-th referenced component in this list.

Parameters:

idx - index of the reference

Returns:

referenced component

getReferences

public void getReferences(java.util.Collection<C> comps)

Get all the referenced components in this list.

Parameters:

comps - collects all the referenced components.

numReferences

public int numReferences()

Queries the number of references in this list. This is simply the size of the list.

Returns:

number of references in the list

containsReference

public boolean containsReference(C comp)

Checks if this list contains a reference to a specified component.

Parameters:

comp - component to check

Returns:

true if a reference is present

indexOfReference

public int indexOfReference(C comp)

Returns the index of the first occurance of a referenced component in this list, or -1 no reference is present.

Parameters:

comp - component whose index is requested

Returns:

index of the reference, or -1 if no reference is present

removeReference

public boolean removeReference(C comp)

Remove the first reference to a specified component from this list.

Parameters:

comp - component whose reference is to be removed

Returns:

false if this list did not contain a reference to comp

removeReferences

public boolean removeReferences(java.util.Collection<C> comps)

Removes alls references to the specified components from this list.

Parameters:

comps - components whose references are to be removed

Returns:

false if this list did not contain a reference to any of the specified components

removeAllReferences

public void removeAllReferences()

Remove all references from this list.