artisynth.core.modelbase

Interface CompositeComponent

All Superinterfaces:

ComponentChangeListener, HasProperties, HierarchyNode, IndexedComponentList, ModelComponent, PostScannable, Scannable

All Known Subinterfaces:

MutableCompositeComponent<C>

All Known Implementing Classes:

ActuatedSkinning, AjlCollisionTest, AllBodySkinning, AnalyticGeometryTests, ArgsTest, Arm26FemElbow, Arm26FemElbowGen, Arm26FemHumerus, ArticulatedBeamBody, ArticulatedDemo, ArticulatedFem, AttachDemo, AttachedBeamBody, AttachedBeamDemo, AttachedMuscleBeam, AuxMaterialBundle, AuxMaterialBundleList, AuxMaterialElementDescList, AxialSpringList, BallPlateCollide, BeamBody, BeamBodyCollide, BigBeam3d, BlockTest, BlockTestX, BodyBodyAttachment, BodyBodyJoint, BodyFemAttachment, BodyForceRendering, BSpline3dElementTest, CollisionBehaviorList, CollisionManager, CollisionResponseList, CollisionTestBase, ColoredMeshDemo, ColoredSphereTest, CombinedElemFem, CombinedShellFem, CompliantConstraintDemo, ComponentList, CompositeComponentBase, ConditionalMarkerDemo, ConstrainedParticle, ConstraintForceTerm, ContactForceMonitor, ContactForceMonitorSavable, ContactPressureRender, ControlPanelDemo, CSGAnimation, CSGCubeTest, CustomJointDemo, CylinderBounceTest, CylinderWrapping, CylindricalJointDemo, DeformableBody, DeformedJointedCollide, DicomLoader, DicomPlaneViewer, DicomTest, DicomViewer, DoubleArmDemo, DrawModeTest, DynamicMeshComponent, DynamicWrapTest, EBBeamBody, EdgeEdgeCollisionTest, EditableMeshComp, EditableMeshTest, EditablePolygonalMeshComp, EFCForceTest, ElasticFoundationContact, EllipsoidJoint3dDemo, EllipsoidJointDemo, EllipsoidWrapTest, EmbeddedCollisionTest, EmbeddedDemo, 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, FemMeshBase, FemMeshComp, FemModel, FemModel3d, FemModelDeformer, FemMuscleArm, FemMuscleBeams, FemMuscleDemo, FemMuscleHeart, FemMuscleModel, FemPlaneCollide, FemSelfCollide, FemSkinCollide, FemSkinDemo, FemSkinTest, FemSurfaceTargetDemo, FemWithBeamBody, FishDemo, FixedBallContact, FixedMeshBody, FixedMeshes, ForceEffectorList, ForceEffectorTerm, ForceTargetDemo, ForceTargetTerm, FourBar, FourBarLinkage, FrameBodyAttachment, FrameFemAttachment, FrameSpringDemo, FrameSpringPendulum, FrameTargetDemo, FrameTrackingTest, GeneralWrapTest, GimbalJointDemo, Hello, Hex3dBlock, HexBeam3d, HexCube, HexFrame, HexTrimTest, HingeJointDemo, HollowSphere, HydrostatDemo, HydrostatInvDemo, HydrostatModel, IKInverseMuscleArm, IKInverseMuscleArmGen, IKMultiJointedArm, IKToyMuscleArm, ImageViewer, IncompressDemo, InstancedRenderingTest, IntersectionTest, InverseFrameExciterArm, InverseMuscleArm, InverseMuscleFem, InverseMuscleFemGen, InverseParticle, InverseSpringForce, InverseTest, JointedBallCollide, JointedCollide, JointedFemBeams, JointLimitDemo, KnotDensityTest, KnotDensityTest2, KnotDensityTest3, LaymanBowl, LaymanDemo, LaymanModel, LeafBranchDemo, LeafDemo, LeastSquaresTermBase, LegTracking, LinearAuxiliaryTest, LinearPointConstraintTest, LockingDemo, LumbarFEMDisk, LumbarFrameSpring, MappingDemo, MappingTest, MassSpringDemo, MaterialBundleDemo, MaterialBundleList, MaxwellElement, MechModel, MechModelCollide, MechModelDemo, MechSystemBase, MeshBodyTest, MeshComponent, MeshComponentList, MeshCurve, MeshCurveTest, MeshEditTest, MeshTestBase, MeshViewer, MFreeMeshComp, MFreeModel3d, MFreeMuscleModel, MinimizeAxialSpringForce, MinimizeFrameSpringForce, ModelBase, MonteCarloElementTests, MonteCarloTest, MotionTargetTerm, MultiCollisionTest, MultiJointedArm, MultiMuscleDemo, MultiPointMuscleOsim, MultiPointSpringList, MultiSpringDemo, MultiSpringTest, MuscleArm, MuscleBundle, MuscleBundleList, MuscleElementDescList, MyFEMonster, MyFinishedMonster, MyMonster, NetDemo, NetDemoWithPan, NetDemoWithRefs, NewtonsCradle, NiftiViewer, OneBasedNumbering, OneStrandWrapBase, OpenSimArm26, OpenSimCustomJointTest, OpenSimImport, OpenSimSpine, OpenSimTest, OpenSimTrack, 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, PositionProbes, PressureShell, ProximalHumerusWrapping, PuppetDemo, PyramidBeam3d, QuadFishDemo, QuadGridTangent, QuadhexBeam3d, QuadpyramidBeam3d, QuadraticLockingDemo, QuadraticTorus, QuadtetBeam3d, QuadwedgeBeam3d, RadialMuscle, RedundantCollisionTest, ReferenceList, ReferenceListBase, ReflectedBodies, RegularSamplingElementTests, RenderableComponentList, RenderableCompositeBase, RenderableModelBase, RenderDemo, RigidBody, RigidBodyCollision, RigidBodyDemo, RigidBodyJoint, RigidBodyOsim, RigidBodySkinning, RigidBodySpring, RigidCollisionTest, RigidCompositeBody, RigidCompositeBody, RigidCompositeCollide, RigidCylinder, RigidEllipsoid, RigidMesh, RigidMeshComp, RigidSphere, RigidTorus, RigidVertexCollide, RobustCube, RollingFem, RootModel, ScalarElementFieldDemo, ScalarFaceFieldDemo, ScalarFieldVisualization, ScalarGridFieldDemo, ScalarNodalFieldDemo, ScalarSubElemFieldDemo, ScalarVertexFieldDemo, SDGridTest, SegmentedPlaneDemo, SelfCollision, ShellBlock, ShellMembraneDemo, ShellQuadPatch, ShellShellAttach, ShellTriPatch, ShellVolumeAttach, ShoulderSkinWrapping, ShoulderWrapping, SignedDistanceCollide, SimpleBall, SimpleCollide, SimpleMuscle, SimpleMuscleWithController, SimpleMuscleWithInlineProbe, SimpleMuscleWithPanel, SimpleMuscleWithProbes, SimpleMuscleWithProperties, SinCosMonitorProbe, SingleHex, SinglePyramid, SingleQuadhex, SingleQuadpyramid, SingleQuadtet, SingleQuadwedge, SingleShellQuad, SingleShellTri, SingleTet, SingleWedge, SkinBodyCollide, SkinCollisionTest, SkinDemo, SkinMeshBase, SkinMeshBody, SkullParticles, SliderJointDemo, SlidingFem, SlottedHingeJointDemo, SlottedRevoluteJointDemo, SpecularTest, SphericalJointDemo, SphericalTextureMapping, SpinControlProbe, SpongeDemo, SpongeModel, SpringMeshDemo, StabilityTerm, TalusWrapping, TalusWrapTest, TargetFrame, Template, Template, TetBeam3d, TetCube, TextTest, TexturePlaneBase, TorusDemo, TorusWrapping, TorusWrapTest, TorusWrapTest, ToyFemSpine, ToyMuscleArm, ToyMuscleFem, ToySpine, TrackingController, Trampoline, TransverseIsotropy, TransverseIsotropyTest, TRCMultiJointedArm, TRCMultiJointedArmGen, TrimmedElements, TubeDemo, TwoStrandWrapBase, TwoStrandWrapBase, UniversalJointDemo, VariableElasticContact, VariableStiffness, VectorElementFieldDemo, VectorFaceFieldDemo, VectorGridFieldDemo, VectorNodalFieldDemo, VectorSubElemFieldDemo, VectorVertexFieldDemo, VertexList, ViaPointMuscle, ViscousBeam, WedgeBeam3d, WrappedMuscleArm, WrappedShellTest, WrapTestBase

public interface CompositeComponent
extends ModelComponent, ComponentChangeListener, IndexedComponentList

ModelComponent which contains subcomponents.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CompositeComponent.NavpanelDisplay Specifies how the a composite component should be displayed in a navigation panel.

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

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

Method Summary

Modifier and Type	Method and Description
void	componentChanged(ComponentChangeEvent e) Notifies this composite component that a change has occured within one or more of its descendants.
ModelComponent	findComponent(java.lang.String path) Recursively searches for a subcomponent of this ModelComponent, identified by a path of component names.
ModelComponent	get(int idx) Returns a specific subcomponent of this ModelComponent, identified by index.
ModelComponent	get(java.lang.String nameOrNumber) Returns a specific subcomponent of this ModelComponent, identified by name or string representation of the subcomponent's number
ModelComponent	getByNumber(int num) Returns a specific subcomponent of this ModelComponent, identified by number.
CompositeComponent.NavpanelDisplay	getNavpanelDisplay() Returns the DisplayMode for this component.
int	getNumberLimit() Returns the current upper limit for numbers among all subcomponents in this composite.
boolean	hierarchyContainsReferences() Returns true if the component hierarchy formed by this component and its descendents is closed with respect to references.
int	indexOf(ModelComponent comp) Returns the index of a specified subcomponent, or -1 if that the component is not present.
int	numComponents() Returns the number of components in this CompositeComponent.
default <T> void	recursivelyFind(java.util.List<T> list, java.lang.Class<T> type) Recursively find all components under this CompositeComponent that are of a prescribed type.
void	updateNameMap(java.lang.String newName, java.lang.String oldName, ModelComponent comp)

Methods inherited from interface artisynth.core.modelbase.ModelComponent

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

Methods inherited from interface maspack.properties.HasProperties

getAllPropertyInfo, getProperty

Methods inherited from interface maspack.properties.HierarchyNode

getChildren, hasChildren

Methods inherited from interface artisynth.core.modelbase.PostScannable

postscan

Methods inherited from interface maspack.util.Scannable

isWritable, write

Method Detail

get

ModelComponent get(java.lang.String nameOrNumber)

Returns a specific subcomponent of this ModelComponent, identified by name or string representation of the subcomponent's number

Parameters:

nameOrNumber - name or number of the subcomponent

Returns:

named subcomponent, or null if the component does not exist.

get

ModelComponent get(int idx)

Returns a specific subcomponent of this ModelComponent, identified by index.

Specified by:

get in interface IndexedComponentList

Parameters:

idx - index of the subcomponent

Returns:

indexed subcomponent, or null if the component does not exist.

getByNumber

ModelComponent getByNumber(int num)

Returns a specific subcomponent of this ModelComponent, identified by number.

Parameters:

num - number of the subcomponent

Returns:

specified subcomponent, or null if the component does not exist.

numComponents

int numComponents()

Returns the number of components in this CompositeComponent.

Specified by:

numComponents in interface IndexedComponentList

Returns:

number of subcomponents

indexOf

int indexOf(ModelComponent comp)

Returns the index of a specified subcomponent, or -1 if that the component is not present.

Parameters:

comp - component whose index is requested

Returns:

indexed subcomponent

findComponent

ModelComponent findComponent(java.lang.String path)

Recursively searches for a subcomponent of this ModelComponent, identified by a path of component names.

Parameters:

path - path leading to the subcomponent

Returns:

named subcomponent, or null if the component does not exist.

getNumberLimit

int getNumberLimit()

Returns the current upper limit for numbers among all subcomponents in this composite. This is one greater than the maximum subcomponent number currently assigned. A value of 0 means that there are no subcomponents. This method is useful for creating and sizing arrays whose contents are indexed by component numbers.

Returns:

upper limit for numbers among all subcomponents

getNavpanelDisplay

CompositeComponent.NavpanelDisplay getNavpanelDisplay()

Returns the DisplayMode for this component. This specifies how the component should be displayed in a navigation panel.

Returns:

display mode for this component

componentChanged

void componentChanged(ComponentChangeEvent e)

Notifies this composite component that a change has occured within one or more of its descendants. When this occurs, the composite may need to invalidate cached information that depends on the descendants.

This method should propagate the notification up the component hierarchy by calling notifyParentOfChange.

Specified by:

componentChanged in interface ComponentChangeListener

Parameters:

e - optional argument giving specific information about the change

updateNameMap

void updateNameMap(java.lang.String newName,
                   java.lang.String oldName,
                   ModelComponent comp)

hierarchyContainsReferences

boolean hierarchyContainsReferences()

Returns true if the component hierarchy formed by this component and its descendents is closed with respect to references. In other words, all components referenced by components within the hierarchy are themselves components within the hierarchy.

In particular, this means that one does not need to search outside the hierarchy when looking for dependencies.

Returns:

true if this component's hierarchy is closed with respect to references.

recursivelyFind

default <T> void recursivelyFind(java.util.List<T> list,
                                 java.lang.Class<T> type)

Recursively find all components under this CompositeComponent that are of a prescribed type.

Parameters:

list - list used to collect the components

type - type of the components being sought