artisynth.core.mechmodels

Class CollisionBehaviorList

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ComponentList<CollisionBehavior>

artisynth.core.mechmodels.CollisionBehaviorList

All Implemented Interfaces:

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

public class CollisionBehaviorList
extends ComponentList<CollisionBehavior>

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.NavpanelVisibility

Field Summary

Fields inherited from class artisynth.core.modelbase.ComponentList

DEFAULT_NAVPANEL_DISPLAY, myProps

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Constructor Summary

Constructors

Constructor and Description
CollisionBehaviorList()
CollisionBehaviorList(java.lang.String name, java.lang.String shortName)

Method Summary

Modifier and Type	Method and Description
boolean	add(CollisionBehavior behav) Adds a component to this MutableCompositeComponent.
void	addComponents(ModelComponent[] comps, int[] indices, int num) Adds a set of components to this MutableCompositeComponent.
CollisionBehavior	get(CollidablePair pair)
boolean	hasParameterizedType() Queries whether this class explicitly utilizes a parameterized type.
void	postscan(java.util.Deque<ScanToken> tokens, CompositeComponent ancestor) Performs any required post-scanning for this component.
CollisionBehavior	remove(int idx)
boolean	remove(java.lang.Object comp) Removes a component from this MutableCompositeComponent, returning true if the componet was in fact found and removed.
void	removeAll()
void	removeComponents(ModelComponent[] comps, int[] indices, int num) Removes a set of components from this MutableCompositeComponent.

Methods inherited from class artisynth.core.modelbase.ComponentList

add, addAll, addFixed, addNumbered, clear, clone, componentChanged, contains, contains, containsAll, copy, ensureCapacity, findComponent, get, get, getAllPropertyInfo, getByNumber, getChildren, getNavpanelDisplay, getNumberLimit, getOneBasedNumbering, getParameterType, getShortName, hasChildren, hierarchyContainsReferences, indexOf, invalidateNumbers, isEditable, isEmpty, iterator, nextComponentNumber, numComponents, removeAll, 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.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

Constructor Detail

CollisionBehaviorList

public CollisionBehaviorList()

CollisionBehaviorList

public CollisionBehaviorList(java.lang.String name,
                             java.lang.String shortName)

Method Detail

hasParameterizedType

public boolean hasParameterizedType()

Description copied from interface: ParameterizedClass

Queries whether this class explicitly utilizes a parameterized type. This methods allows ParameterizedType subclasses to not be explicitly parameterized.

Specified by:

hasParameterizedType in interface ParameterizedClass

Overrides:

hasParameterizedType in class ComponentList<CollisionBehavior>

Returns:

true if this class utilizes a parameterized type.

add

public boolean add(CollisionBehavior behav)

Description copied from class: ComponentList

Adds a component to this MutableCompositeComponent. The component is placed in the last position and its index value is set accordingly.

Specified by:

add in interface MutableCompositeComponent<CollisionBehavior>

Specified by:

add in interface java.util.Collection<CollisionBehavior>

Overrides:

add in class ComponentList<CollisionBehavior>

Parameters:

behav - component to be adde

Returns:

true if the component was actually added

addComponents

public void addComponents(ModelComponent[] comps,
                          int[] indices,
                          int num)

Description copied from class: ComponentList

Adds a set of components to this MutableCompositeComponent. This routine is intended to provide greater efficiency for adding a large number of components at one time. If the argument indices is not null, it specified the index locations at which the components should be added. It is up to the caller to insure that the specified index values make sense; in particular, they must not exceed the final size of the component and no two specified indices can be the same.

Specified by:

addComponents in interface MutableCompositeComponent<CollisionBehavior>

Overrides:

addComponents in class ComponentList<CollisionBehavior>

Parameters:

comps - list of components to be added

indices - (optional) index locations of components

num - number of components to be added

remove

public boolean remove(java.lang.Object comp)

Description copied from class: ComponentList

Removes a component from this MutableCompositeComponent, returning true if the componet was in fact found and removed.

Specified by:

remove in interface MutableCompositeComponent<CollisionBehavior>

Specified by:

remove in interface java.util.Collection<CollisionBehavior>

Overrides:

remove in class ComponentList<CollisionBehavior>

Parameters:

comp - component to be added

Returns:

true if the component was removed

remove

public CollisionBehavior remove(int idx)

Overrides:

remove in class ComponentList<CollisionBehavior>

removeComponents

public void removeComponents(ModelComponent[] comps,
                             int[] indices,
                             int num)

Description copied from class: ComponentList

Removes a set of components from this MutableCompositeComponent. This routine is intended to provide greater efficiency for adding a large number of components at one time. If the argument indices is not null, it is used to return the indices where the components were located.

Specified by:

removeComponents in interface MutableCompositeComponent<CollisionBehavior>

Overrides:

removeComponents in class ComponentList<CollisionBehavior>

Parameters:

comps - components to be removed

indices - (optional) stores the indices of the removed components

num - number of components to be removed

get

public CollisionBehavior get(CollidablePair pair)

postscan

public void postscan(java.util.Deque<ScanToken> tokens,
                     CompositeComponent ancestor)
              throws java.io.IOException

Description copied from interface: PostScannable

Performs any required post-scanning for this component. This involves handling any information whose processing was deferred during the scan() method and stored in the token queue. The most common use of this method is to resolve the paths of component references, which may not have been created at the time of the initial scan() call.

Specified by:

postscan in interface PostScannable

Overrides:

postscan in class ComponentList<CollisionBehavior>

Parameters:

tokens - token information that was stored during scan().

ancestor - ancestor component with respect to which reference component paths are defined.

Throws:

java.io.IOException - if an error is encountered (such as a reference to a non-existent component)

removeAll

public void removeAll()

Overrides:

removeAll in class ComponentList<CollisionBehavior>