artisynth.core.modelbase

Class ReferenceComp<C extends ModelComponent>

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ReferenceComp<C>

All Implemented Interfaces:

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

Direct Known Subclasses:

SourceFrameReference, SourcePointReference, WeightedReferenceComp

public class ReferenceComp<C extends ModelComponent>
extends ModelComponentBase

A simple component that provides a reference to another component. Used as the building block for ReferenceLists.

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
ReferenceComp()
ReferenceComp(C 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.
C	getReference()
boolean	scanItem(ReaderTokenizer rtok, java.util.Deque<ScanToken> tokens)
void	setReference(C ref)
void	writeItems(java.io.PrintWriter pw, NumberFormat fmt, CompositeComponent ancestor)

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

ReferenceComp

public ReferenceComp(C ref)

ReferenceComp

public ReferenceComp()

Method Detail

getReference

public C getReference()

setReference

public void setReference(C ref)

getHardReferences

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

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 ModelComponentBase

Parameters:

refs - list to which hard references are appended

scanItem

public boolean scanItem(ReaderTokenizer rtok,
                        java.util.Deque<ScanToken> tokens)
                 throws java.io.IOException

Throws:

java.io.IOException

writeItems

public void writeItems(java.io.PrintWriter pw,
                       NumberFormat fmt,
                       CompositeComponent ancestor)
                throws java.io.IOException

Throws:

java.io.IOException