artisynth.core.modelbase

Interface Traceable

All Superinterfaces:

HasProperties, HierarchyNode, ModelComponent, PostScannable, Scannable

All Known Implementing Classes:

BeamBody, DeformableBody, DicomPlaneViewer, DicomViewer, EBBeamBody, FemCutPlane, FemMarker, FemModelFrame, FemNode, FemNode3d, Frame, FrameMarker, GenericMarker, ImageViewer, JointBasedMovingMarker, JointConditionalMarker, Marker, MeshMarker, MFreeNode3d, NiftiViewer, Particle, PlanarPoint, Point, RigidBody, RigidBodyOsim, RigidCompositeBody, RigidCylinder, RigidEllipsoid, RigidMesh, RigidSphere, RigidTorus, SkinMarker, TargetFrame, TargetPoint, TexturePlaneBase

public interface Traceable
extends ModelComponent

Indicates a component that has properties which are 'traceable', meaning that a Tracing probe can be attached to them. A present, such properties must represent either a Point3d, or a vector object of length 3.

Nested Class Summary

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

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTraceablePositionProperty(java.lang.String traceableName) For a given traceable property, returns the name of a property (if any) which provides a reference position to be used for the traceable property.
java.lang.String[]	getTraceables() Returns a list of all traceable properties in this Traceable.

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

getTraceables

java.lang.String[] getTraceables()

Returns a list of all traceable properties in this Traceable.

getTraceablePositionProperty

java.lang.String getTraceablePositionProperty(java.lang.String traceableName)

For a given traceable property, returns the name of a property (if any) which provides a reference position to be used for the traceable property. The property name can be prepended with either a + or - character, which is used to control the rendering of the tracing probe in case the traceable property is a 3-vector. A prepended + character means that the vector will be rendered starting at, and directed away from the reference position (or render as pull), while a + character means that the vector will be rendered starting away from, and directed into the reference position (or render as push).

Returns:

reference position property name, or null.