artisynth.core.modelbase

Interface MutableCompositeComponent<C extends ModelComponent>

All Superinterfaces:

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

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 MutableCompositeComponent<C extends ModelComponent>
extends CompositeComponent

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

Method Summary

Modifier and Type	Method and Description
boolean	add(C comp) Adds a component to this MutableCompositeComponent.
void	addComponents(ModelComponent[] comps, int[] indices, int num) Adds a set of components to this MutableCompositeComponent.
boolean	isEditable() Queries whether or not this component is editable from the ArtiSynth GUI.
boolean	remove(java.lang.Object comp) Removes a component from this MutableCompositeComponent, returning true if the componet was in fact found and removed.
void	removeComponents(ModelComponent[] comps, int[] indices, int num) Removes a set of components from this MutableCompositeComponent.

Methods inherited from interface artisynth.core.modelbase.CompositeComponent

componentChanged, findComponent, get, get, getByNumber, getNavpanelDisplay, getNumberLimit, hierarchyContainsReferences, indexOf, numComponents, updateNameMap

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

add

boolean add(C comp)

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

Parameters:

comp - component to be adde

Returns:

true if the component was actually added

addComponents

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

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.

Parameters:

comps - list of components to be added

indices - (optional) index locations of components

num - number of components to be added

remove

boolean remove(java.lang.Object comp)

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

Parameters:

comp - component to be added

Returns:

true if the component was removed

removeComponents

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

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.

Parameters:

comps - components to be removed

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

num - number of components to be removed

isEditable

boolean isEditable()

Queries whether or not this component is editable from the ArtiSynth GUI. In particular, if this method returns false, it should not be possible to use the GUU to delete child components.

Returns:

true if this component can be edited from the GUI.