artisynth.core.inverse

Class SourceFrameReference

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ReferenceComp<Frame>

artisynth.core.inverse.SourceFrameReference

All Implemented Interfaces:

ModelComponent, PostScannable, java.lang.Cloneable, HasProperties, HierarchyNode, Scannable

public class SourceFrameReference
extends ReferenceComp<Frame>

Special reference component for source frames that also returns the associated target frame as a hard reference. This ensures that the reference will be removed if the target frame is removed via the GUI.

Nested Class Summary

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

ModelComponent.NavpanelVisibility

Field Summary

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, myProps, NULL_OBJ, useCompactPathNames

Constructor Summary

Constructors

Constructor and Description
SourceFrameReference()
SourceFrameReference(Frame ref)

Method Summary

Modifier and Type	Method and Description
void	getHardReferences(java.util.List<ModelComponent> refs) Appends all hard references for this component to a list.

Methods inherited from class artisynth.core.modelbase.ReferenceComp

getReference, scanItem, setReference, writeItems

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, copy, createTempFlag, disconnectFromHierarchy, getAllPropertyInfo, getChildren, getGrandParent, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasChildren, hasState, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, 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

Constructor Detail

SourceFrameReference

public SourceFrameReference()

SourceFrameReference

public SourceFrameReference(Frame ref)

Method Detail

getHardReferences

public void getHardReferences(java.util.List<ModelComponent> refs)

Description copied from class: ReferenceComp

Appends all hard references for this component to a list. References are other components, outside of this component's immediate ancestry, on which this component depends. For example, an AxialSpring refers to two Point components as for it's end points. A hard reference is one which the referring component must have, and which if deleted, implies that the referring component should be deleted too.

Specified by:

getHardReferences in interface ModelComponent

Overrides:

getHardReferences in class ReferenceComp<Frame>

Parameters:

refs - list to which hard references are appended