artisynth.core.modelbase

Interface CopyableComponent

All Superinterfaces:

HasProperties, HierarchyNode, ModelComponent, PostScannable, Scannable

All Known Implementing Classes:

AffineNumericInputProbe, AxialSpring, BeamBody, BSpline3dElement, CylindricalJoint, DeformableBody, DicomPlaneViewer, DicomViewer, EBBeamBody, EllipsoidJoint, EllipsoidJoint3d, ExactForceProbe, ExactMomentProbe, FemCutPlane, FemElement, FemElement3d, FemElement3dBase, FemMarker, FemModel3d, FemModelDeformer, FemModelFrame, FemMuscleModel, FemNode, FemNode3d, FixedAxisJoint, ForceErrorProbe, ForceProbe, Frame, FrameAttachment, FrameFem3dAttachment, FrameFrameAttachment, FrameMarker, FrameSpring, FrameTrackingProbe, GenericMarker, GimbalJoint, HexElement, HingeJoint, HydrostatModel, IKProbe, ImageViewer, JointBasedMovingMarker, JointConditionalMarker, Marker, MeshMarker, MFreeElement3d, MFreeModel3d, MFreeMuscleModel, MFreeNode3d, MomentProbe, MultiPointMuscle, MultiPointMuscleOsim, MultiPointMuscleVia, MultiPointSpring, Muscle, NiftiViewer, NumericControlProbe, NumericDataFunctionProbe, NumericDifferenceProbe, NumericInputProbe, NumericMonitorProbe, NumericOutputProbe, Particle, PlanarConnector, PlanarJoint, PlanarPoint, PlanarTranslationJoint, Point, PointAttachment, PointFem3dAttachment, PointForce, PointFrameAttachment, PointParticleAttachment, PointSkinAttachment, PointToPointMuscle, PointTracingProbe, PositionInputProbe, PositionOutputProbe, PyramidElement, QuadhexElement, QuadpyramidElement, QuadtetElement, QuadwedgeElement, RevoluteJoint, RigidBody, RigidBodyOsim, RigidCompositeBody, RigidCylinder, RigidEllipsoid, RigidMesh, RigidSphere, RigidTorus, RollPitchJoint, SegmentedPlanarConnector, ShellElement3d, ShellNodeFem3dAttachment, ShellNodeFrameAttachment, ShellQuadElement, ShellTriElement, SkewedUniversalJoint, SkinMarker, SliderJoint, SlottedHingeJoint, SolidJoint, SphericalJoint, SphericalJointBase, SphericalRpyJoint, SpongeModel, TargetFrame, TargetPoint, TetElement, TexturePlaneBase, TracingProbe, TransparencyProbe, UniversalJoint, VectorTracingProbe, VelocityInputProbe, VelocityOutputProbe, WedgeElement

public interface CopyableComponent
extends ModelComponent

Indicates an ArtiSynth ModelComponent that can be copied.

Nested Class Summary

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

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static int	COPY_REFERENCES Indicates that any referenced model components should themselves be copied.
static int	REST_POSITION For deformable components (such as FEM models), indicates that the copy should be made in the component's rest position.

Method Summary

Modifier and Type	Method and Description
ModelComponent	copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap) Create a copy of this component.
boolean	getCopyReferences(java.util.List<ModelComponent> refs, ModelComponent ancestor) Collects external references which must also be copied in order to duplicate this component.
boolean	isDuplicatable() Returns true if this component can be duplicated.

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

Field Detail

COPY_REFERENCES

static final int COPY_REFERENCES

Indicates that any referenced model components should themselves be copied.

See Also:

Constant Field Values

REST_POSITION

static final int REST_POSITION

For deformable components (such as FEM models), indicates that the copy should be made in the component's rest position.

See Also:

Constant Field Values

Method Detail

copy

ModelComponent copy(int flags,
                    java.util.Map<ModelComponent,ModelComponent> copyMap)

Create a copy of this component. If COPY_REFERENCES is set in flags, then any component referenced by this component should itself be set to a copy. This should be done first checking copyMap for an existing copy of the referenced component. If there is no existing copy, then a copy should be created by calling copy recursively and adding the new copy to copyMap.

Parameters:

flags - flags to control the copying

copyMap - map to possible existing instances of referenced components

Returns:

copy of this component

isDuplicatable

boolean isDuplicatable()

Returns true if this component can be duplicated. Duplication means that we can expect to be able to make a complete copy of the component along with all it's external references. This method should return true if and only if getCopyReferences(java.util.List<artisynth.core.modelbase.ModelComponent>, artisynth.core.modelbase.ModelComponent) returns true.

This method is not currently used. It is intended to provide a faster way of determining if a component can be duplicated, without having to use getCopyReferences(java.util.List<artisynth.core.modelbase.ModelComponent>, artisynth.core.modelbase.ModelComponent) to build the list of copy references.

Returns:

true if this component can be duplicated.

getCopyReferences

boolean getCopyReferences(java.util.List<ModelComponent> refs,
                          ModelComponent ancestor)

Collects external references which must also be copied in order to duplicate this component. These references should exclude those which are contained within a specified component hierarchy. This method should return true if and only if isDuplicatable() returns true.

Parameters:

refs - list to which references are appended

ancestor - root node of the hierarchy from which references are to be excluded

Returns:

false if it is discovered that the component cannot be duplicated