artisynth.core.modelbase

Interface ComponentListView<E extends ModelComponent>

Type Parameters:

E - Model component type found in this list

All Superinterfaces:

java.util.Collection<E>, java.lang.Iterable<E>, ListView<E>

All Known Subinterfaces:

RenderableComponentListView<C>

All Known Implementing Classes:

ActuatedSkinning, AjlCollisionTest, AllBodySkinning, AnalyticGeometryTests, ArgsTest, ArticulatedBeamBody, ArticulatedDemo, ArticulatedFem, AttachDemo, AttachedBeamBody, AttachedBeamDemo, AttachedMuscleBeam, AuxMaterialBundleList, AuxMaterialElementDescList, AxialSpringList, BallPlateCollide, BeamBodyCollide, BigBeam3d, BlockTest, BlockTestX, BodyBodyAttachment, BodyBodyJoint, BodyFemAttachment, BodyForceRendering, BSpline3dElementTest, CollisionBehaviorList, CollisionResponseList, CollisionTestBase, ColoredMeshDemo, ColoredSphereTest, CombinedElemFem, CombinedShellFem, CompliantConstraintDemo, ComponentList, ConditionalMarkerDemo, ConstrainedParticle, ContactForceMonitor, ContactPressureRender, ControlPanelDemo, CoordinateCouplingDemo, CSGAnimation, CSGCubeTest, CustomJointDemo, CylinderBounceTest, CylinderWrapping, CylindricalJointDemo, DeformedJointedCollide, DicomLoader, DicomTest, DoubleArmDemo, DrawModeTest, DynamicWrapTest, EdgeEdgeCollisionTest, EditableMeshTest, EFCForceTest, ElasticFoundationContact, EllipsoidJoint3dDemo, EllipsoidJointDemo, EllipsoidWrapTest, EmbeddedCollisionTest, EmbeddedEmbeddedCollide, EmbeddedHeart, EmbeddedSphere, EmbeddedSurface, EmbeddedSurfaceCollide, EmbeddedTest, EmbeddedTongue, EmbeddedWeighting, EquilibriumMuscleDemo, EquilibriumMuscleTest, FaceList, Fem3dBlock, FemBeam, FemBeam3d, FemBeamColored, FemBeamMech, FemBeamTest, FemBeamWithBlock, FemBeamWithFemSphere, FemBeamWithMuscle, FemCollision, FemCollisions, FemCutPlaneDemo, FemElement3dList, FemEmbeddedSphere, FemFieldTest, FemFrictionBeam, FemModel, FemModel3d, FemModelDeformer, FemMuscleArm, FemMuscleBeams, FemMuscleDemo, FemMuscleHeart, FemMuscleModel, FemPlaneCollide, FemSelfCollide, FemSkinCollide, FemSkinDemo, FemSkinTest, FemSurfaceTargetDemo, FemWithBeamBody, FishDemo, FixedBallContact, FixedMeshes, ForceEffectorList, ForceTargetDemo, FourBar, FourBarLinkage, FrameBodyAttachment, FrameFemAttachment, FrameSpringDemo, FrameSpringPendulum, FrameTargetDemo, FrameTrackingTest, GeneralWrapTest, GimbalJointDemo, Hello, Hex3dBlock, HexBeam3d, HexCube, HexFrame, HexTrimTest, HingeJointDemo, HollowSphere, HydrostatDemo, HydrostatInvDemo, HydrostatModel, IncompressDemo, InstancedRenderingTest, IntersectionTest, InverseFrameExciterArm, InverseMuscleArm, InverseMuscleFem, InverseMuscleFemGen, InverseParticle, InverseSpringForce, InverseTest, JointedBallCollide, JointedCollide, JointedFemBeams, JointLimitDemo, KnotDensityTest, KnotDensityTest2, KnotDensityTest3, LaymanBowl, LaymanDemo, LaymanModel, LeafBranchDemo, LeafDemo, LegTracking, LinearAuxiliaryTest, LinearPointConstraintTest, LockingDemo, LumbarFEMDisk, LumbarFrameSpring, MappingDemo, MappingTest, MassSpringDemo, MaterialBundleDemo, MaterialBundleList, MaxwellElement, MechModel, MechModelCollide, MechModelDemo, MechSystemBase, MeshBodyTest, MeshComponentList, MeshEditTest, MeshTestBase, MeshViewer, MFreeModel3d, MFreeMuscleModel, MinimizeAxialSpringForce, MinimizeFrameSpringForce, ModelBase, MonteCarloElementTests, MonteCarloTest, MultiCollisionTest, MultiMuscleDemo, MultiPointSpringList, MultiSpringDemo, MultiSpringTest, MuscleArm, MuscleBundleList, MuscleElementDescList, MyFEMonster, MyFinishedMonster, MyMonster, NetDemo, NetDemoWithPan, NetDemoWithRefs, NewtonsCradle, OneBasedNumbering, OneStrandWrapBase, OpenSimCustomJointTest, OpenSimSpine, OpenSimTest, ParametricTestBase, ParticleAttachment, ParticleSpring, PenetrationRender, PhalanxSkinWrapping, PhalanxWrapping, PlanarConnectorDemo, PlanarJointDemo, PlanarTranslationJointDemo, PlaneConstrainedFem, PointFemAttachment, PointForceDemo, PointList, PointMeshForces, PointMeshForceTest, PointMeshTest, PointModel, PointModel1d, PointModel2d, PointModel3d, PointPlaneForces, PointPlaneForceTest, PointSpringList, PointToPointMuscle, PolygonalMeshTest, PolylineMeshTest, PressureShell, ProximalHumerusWrapping, PuppetDemo, PyramidBeam3d, QuadFishDemo, QuadGridTangent, QuadhexBeam3d, QuadpyramidBeam3d, QuadraticLockingDemo, QuadraticTorus, QuadtetBeam3d, QuadwedgeBeam3d, RadialMuscle, RedundantCollisionTest, ReferenceList, ReferenceListBase, ReflectedBodies, RegularSamplingElementTests, RenderableComponentList, RenderableModelBase, RenderDemo, RigidBodyCollision, RigidBodyDemo, RigidBodyJoint, RigidBodySkinning, RigidBodySpring, RigidCollisionTest, RigidCompositeBody, RigidCompositeCollide, RigidVertexCollide, RobustCube, RollingFem, RootModel, ScalarElementFieldDemo, ScalarFaceFieldDemo, ScalarFieldVisualization, ScalarGridFieldDemo, ScalarNodalFieldDemo, ScalarSubElemFieldDemo, ScalarVertexFieldDemo, SDGridTest, SegmentedPlaneDemo, SelfCollision, ShellBlock, ShellMembraneDemo, ShellQuadPatch, ShellShellAttach, ShellTriPatch, ShellVolumeAttach, ShoulderSkinWrapping, ShoulderWrapping, SignedDistanceCollide, SimpleCollide, SimpleMuscle, SimpleMuscleWithController, SimpleMuscleWithInlineProbe, SimpleMuscleWithPanel, SimpleMuscleWithProbes, SimpleMuscleWithProperties, SinCosMonitorProbe, SingleHex, SinglePyramid, SingleQuadhex, SingleQuadpyramid, SingleQuadtet, SingleQuadwedge, SingleShellQuad, SingleShellTri, SingleTet, SingleWedge, SkinBodyCollide, SkinCollisionTest, SkinDemo, SkullParticles, SliderJointDemo, SlidingFem, SlottedHingeJointDemo, SlottedRevoluteJointDemo, SpecularTest, SphericalJointDemo, SphericalTextureMapping, SpinControlProbe, SpongeDemo, SpongeModel, SpringMeshDemo, TalusWrapping, TalusWrapTest, Template, TetBeam3d, TetCube, TextTest, TorusDemo, TorusWrapping, TorusWrapTest, TorusWrapTest, ToyMuscleArm, ToyMuscleFem, Trampoline, TransverseIsotropy, TransverseIsotropyTest, TrimmedElements, TubeDemo, TwoStrandWrapBase, TwoStrandWrapBase, UniversalJointDemo, VariableElasticContact, VariableStiffness, VectorElementFieldDemo, VectorFaceFieldDemo, VectorGridFieldDemo, VectorNodalFieldDemo, VectorSubElemFieldDemo, VectorVertexFieldDemo, VertexList, ViaPointMuscle, ViscousBeam, WedgeBeam3d, WrappedMuscleArm, WrappedShellTest, WrapTestBase

public interface ComponentListView<E extends ModelComponent>
extends ListView<E>, java.util.Collection<E>

A read-only view of a ComponentList that allows it's contents to be queried but not modified.

Author:

John E Lloyd

Method Summary

Modifier and Type	Method and Description
boolean	contains(E comp) Returns true if a particular component is contained in this list.
E	get(int idx) Get the component at a particular index, or null if there is no such component.
E	get(java.lang.String name) Get the component with particular name, or null if there is no such component.
E	getByNumber(int num) Get the component with the specified number, or null if there is no such component.
java.lang.String	getName() Gets the name of this component list.
java.lang.String	getShortName() Gets the short name of this component list.
int	indexOf(ModelComponent comp) Get the index of a particular component in this list, or -1 if the specified component is not present.
java.util.Iterator<E>	iterator() Return an iterator over all components in this list.
int	nextComponentNumber() Returns the number that will be assigned to the next component added to this list.
int	size() Get the number of components in this list.

Methods inherited from interface maspack.util.ListView

contains

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

iterator

java.util.Iterator<E> iterator()

Return an iterator over all components in this list.

Specified by:

iterator in interface java.util.Collection<E extends ModelComponent>

Specified by:

iterator in interface java.lang.Iterable<E extends ModelComponent>

Specified by:

iterator in interface ListView<E extends ModelComponent>

Returns:

iterator over list components

get

E get(int idx)

Get the component at a particular index, or null if there is no such component.

Specified by:

get in interface ListView<E extends ModelComponent>

Parameters:

idx - index of the component

Returns:

component at specified index

getByNumber

E getByNumber(int num)

Get the component with the specified number, or null if there is no such component.

Parameters:

num - number of the component

Returns:

component with specified number

get

E get(java.lang.String name)

Get the component with particular name, or null if there is no such component.

Parameters:

name - name of the component

Returns:

component with specified name

size

int size()

Get the number of components in this list.

Specified by:

size in interface java.util.Collection<E extends ModelComponent>

Specified by:

size in interface ListView<E extends ModelComponent>

Returns:

number of components

indexOf

int indexOf(ModelComponent comp)

Get the index of a particular component in this list, or -1 if the specified component is not present.

Parameters:

comp - component to search for

Returns:

index of the component within this list

contains

boolean contains(E comp)

Returns true if a particular component is contained in this list.

Parameters:

comp - component to search for

Returns:

true if the component is contained in this list

nextComponentNumber

int nextComponentNumber()

Returns the number that will be assigned to the next component added to this list.

Returns:

next component number for this list

getName

java.lang.String getName()

Gets the name of this component list.

Returns:

name of this list

getShortName

java.lang.String getShortName()

Gets the short name of this component list.

Returns:

short name of this list